2021-06-01 23:13:47 +07:00
|
|
|
|
:show-content:
|
|
|
|
|
|
|
[REF][MOV] documentation apocalypse
Prior to this commit, the Odoo documentation was mainly split between
two repositories: odoo/odoo/doc and odoo/documentation-user. Some bits
of documentation were also hosted elsewhere (e.g., wiki, upgrade, ...).
This was causing several problems among which:
- The theme, config, Makefile, and similar technical resources had to
be duplicated. This resulted in inconsistent layout, features, and
build environments from one documentation to another.
- Some pages did not fit either documentation as they were relevant
for both users and developers. Some were relevant to neither of the
two (e.g., DB management).
- Cross-doc references had to be absolute links and they broke often.
- Merging large image files in the developer documentation would bloat
the odoo/odoo repository. Some contributions had to be lightened to
avoid merging too many images (e.g., Odoo development tutorials).
- Long-time contributors to the user documentation were chilly about
going through the merging process of the developer documentation
because of the runbot, mergebot, `odoo-dev` repository, etc.
- Some contributors would look for the developer documentation in the
`odoo/documentation-user` repository.
- Community issues about the user documentation were submitted on the
`odoo/odoo` repository and vice-versa.
Merging all documentations in one repository will allow us to have one
place, one theme, one work process, and one set of tools (build
environment, ...) for all of the Odoo docs.
As this is a good opportunity to revamp the layout of the documentation,
a brand new theme replaces the old one. It features a new way to
navigate the documentation, centered on the idea of always letting the
reader know what is the context (enclosing section, child pages, page
structure ...) of the page they are reading. The previous theme would
quickly confuse readers as they navigated the documentation and followed
cross-application links.
The chance is also taken to get rid of all the technical dangling parts,
performance issues, and left-overs. Except for some page-specific JS
scripts, the Odoo theme Sphinx extension is re-written from scratch
based on the latest Sphinx release to benefit from the improvements and
ease future contributions.
task-2351938
task-2352371
task-2205684
task-2352544
Closes #945
2021-04-30 17:40:29 +07:00
|
|
|
|
=======
|
|
|
|
|
|
General
|
|
|
|
|
|
=======
|
|
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
|
|
2021-05-28 19:26:18 +07:00
|
|
|
|
general/users
|
2021-05-27 23:42:42 +07:00
|
|
|
|
general/export_import_data
|
2021-05-04 21:31:06 +07:00
|
|
|
|
general/multi_companies
|
[REF][MOV] documentation apocalypse
Prior to this commit, the Odoo documentation was mainly split between
two repositories: odoo/odoo/doc and odoo/documentation-user. Some bits
of documentation were also hosted elsewhere (e.g., wiki, upgrade, ...).
This was causing several problems among which:
- The theme, config, Makefile, and similar technical resources had to
be duplicated. This resulted in inconsistent layout, features, and
build environments from one documentation to another.
- Some pages did not fit either documentation as they were relevant
for both users and developers. Some were relevant to neither of the
two (e.g., DB management).
- Cross-doc references had to be absolute links and they broke often.
- Merging large image files in the developer documentation would bloat
the odoo/odoo repository. Some contributions had to be lightened to
avoid merging too many images (e.g., Odoo development tutorials).
- Long-time contributors to the user documentation were chilly about
going through the merging process of the developer documentation
because of the runbot, mergebot, `odoo-dev` repository, etc.
- Some contributors would look for the developer documentation in the
`odoo/documentation-user` repository.
- Community issues about the user documentation were submitted on the
`odoo/odoo` repository and vice-versa.
Merging all documentations in one repository will allow us to have one
place, one theme, one work process, and one set of tools (build
environment, ...) for all of the Odoo docs.
As this is a good opportunity to revamp the layout of the documentation,
a brand new theme replaces the old one. It features a new way to
navigate the documentation, centered on the idea of always letting the
reader know what is the context (enclosing section, child pages, page
structure ...) of the page they are reading. The previous theme would
quickly confuse readers as they navigated the documentation and followed
cross-application links.
The chance is also taken to get rid of all the technical dangling parts,
performance issues, and left-overs. Except for some page-specific JS
scripts, the Odoo theme Sphinx extension is re-written from scratch
based on the latest Sphinx release to benefit from the improvements and
ease future contributions.
task-2351938
task-2352371
task-2205684
task-2352544
Closes #945
2021-04-30 17:40:29 +07:00
|
|
|
|
general/auth
|
2021-05-04 21:31:06 +07:00
|
|
|
|
general/payment_acquirers
|
|
|
|
|
|
general/voip
|
2021-06-23 20:27:39 +07:00
|
|
|
|
general/calendars
|
2021-05-04 21:31:06 +07:00
|
|
|
|
general/in_app_purchase
|
2021-05-27 23:11:23 +07:00
|
|
|
|
general/unsplash
|
2021-06-23 20:27:39 +07:00
|
|
|
|
general/email_communication
|
2021-06-01 23:13:47 +07:00
|
|
|
|
|
2021-06-23 20:27:39 +07:00
|
|
|
|
.. _general/users-features:
|
|
|
|
|
|
|
|
|
|
|
|
Users and Features
|
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
|
|
As the administrator of your database, you are responsible for its usage.
|
|
|
|
|
|
This includes the Apps you install as well as the number of users currently
|
|
|
|
|
|
in use.
|
|
|
|
|
|
|
|
|
|
|
|
Odoo is many things (ERP, CMS, CRM application, e-Commerce backend, etc.)
|
|
|
|
|
|
but it is *not* a smartphone. You should apply caution when adding/removing
|
|
|
|
|
|
features (especially Apps) on your database since this may impact your
|
|
|
|
|
|
subscription amount significantly (or switch you from a free account
|
|
|
|
|
|
to a paying one on our online platform).
|
|
|
|
|
|
|
|
|
|
|
|
This section contains some information as to how you can manage your Odoo
|
|
|
|
|
|
instances. Before carrying any of these procedures, we **strongly** advise
|
|
|
|
|
|
to test them on a duplicate of your database first. That way, if something goes
|
|
|
|
|
|
wrong, your day-to-day business is not impacted.
|
|
|
|
|
|
|
|
|
|
|
|
.. note:: You can find guides on how to duplicate your databases both for
|
|
|
|
|
|
:ref:`online <duplicate_online>` and :ref:`on premise <duplicate_premise>`
|
|
|
|
|
|
installations.
|
|
|
|
|
|
|
|
|
|
|
|
.. note:: If you have questions about the content of this section or if you
|
|
|
|
|
|
encounter an issue while carrying out these procedures, please contact
|
|
|
|
|
|
us through our `support form <https://www.odoo.com/help>`__.
|
2021-06-18 12:05:55 +07:00
|
|
|
|
|
2021-06-23 15:07:14 +07:00
|
|
|
|
You can :ref:`install <general/install>`, :ref:`upgrade <general/upgrade>` and :ref:`uninstall
|
|
|
|
|
|
<general/uninstall>` all apps and modules from the :menuselection:`Apps` dashboard.
|
|
|
|
|
|
|
|
|
|
|
|
By default, an *Apps* filter is applied. If you want to search for modules (including :doc:`Fiscal
|
|
|
|
|
|
Localization Packages
|
|
|
|
|
|
<finance/accounting/fiscal_localizations/overview/fiscal_localization_packages>`), click on
|
|
|
|
|
|
*Filters* and select *Extra*.
|
|
|
|
|
|
|
|
|
|
|
|
.. image:: general/apps-search-filter.png
|
|
|
|
|
|
:align: center
|
|
|
|
|
|
:alt: Add "Extra" filter in Odoo Apps
|
|
|
|
|
|
|
|
|
|
|
|
.. warning::
|
|
|
|
|
|
Odoo is *not a smartphone*, and its apps shouldn't be installed or uninstalled carelessly. Apply
|
|
|
|
|
|
caution when adding or removing apps and modules on your database since this may impact your
|
|
|
|
|
|
subscription costs.
|
|
|
|
|
|
|
|
|
|
|
|
.. _general/install:
|
|
|
|
|
|
|
|
|
|
|
|
Install apps and modules
|
|
|
|
|
|
------------------------
|
|
|
|
|
|
|
|
|
|
|
|
Go to :menuselection:`Apps`, and click on the *Install* button of the app you want to install.
|
|
|
|
|
|
|
|
|
|
|
|
.. note::
|
|
|
|
|
|
If the module you are looking for is not listed, you can **update the app list**.
|
|
|
|
|
|
|
|
|
|
|
|
To do so, activate the :ref:`developer mode <developer-mode>`, then go to :menuselection:`Apps
|
|
|
|
|
|
--> Update Apps List` and click on *Update*.
|
|
|
|
|
|
|
|
|
|
|
|
.. _general/upgrade:
|
|
|
|
|
|
|
|
|
|
|
|
Upgrade apps and modules
|
|
|
|
|
|
------------------------
|
|
|
|
|
|
|
|
|
|
|
|
On some occasions, new improvements or app features are added to :doc:`supported versions of Odoo
|
|
|
|
|
|
</services/support/supported_versions>`. To be able to use them, you must **upgrade** your app.
|
|
|
|
|
|
|
|
|
|
|
|
Go to :menuselection:`Apps`, click on the *dropdown menu* of the app you want to upgrade, then on
|
|
|
|
|
|
*Upgrade*.
|
2021-08-06 20:36:57 +07:00
|
|
|
|
|
|
|
|
|
|
Deactivating Users
|
|
|
|
|
|
------------------
|
|
|
|
|
|
|
|
|
|
|
|
.. note:: Make sure you have sufficient **administrative rights** if
|
|
|
|
|
|
you want to change the status of any of your users.
|
|
|
|
|
|
|
|
|
|
|
|
In your Odoo instance, click on **Settings**. You will have a section
|
|
|
|
|
|
showing you the active users on your database. Click on **Manage Users.**
|
|
|
|
|
|
|
|
|
|
|
|
+----------------+----------------+
|
|
|
|
|
|
| |settings| | |browse_users| |
|
|
|
|
|
|
+----------------+----------------+
|
|
|
|
|
|
|
|
|
|
|
|
You'll then see the list of your users.
|
|
|
|
|
|
|
2021-06-23 20:27:39 +07:00
|
|
|
|
=======
|
|
|
|
|
|
|
|
|
|
|
|
Deactivating Users
|
|
|
|
|
|
------------------
|
|
|
|
|
|
|
|
|
|
|
|
.. note:: Make sure you have sufficient **administrative rights** if
|
|
|
|
|
|
you want to change the status of any of your users.
|
|
|
|
|
|
|
|
|
|
|
|
In your Odoo instance, click on **Settings**. You will have a section
|
|
|
|
|
|
showing you the active users on your database. Click on **Manage Users.**
|
|
|
|
|
|
|
|
|
|
|
|
+----------------+----------------+
|
|
|
|
|
|
| |settings| | |browse_users| |
|
|
|
|
|
|
+----------------+----------------+
|
|
|
|
|
|
|
|
|
|
|
|
You'll then see the list of your users.
|
|
|
|
|
|
|
|
|
|
|
|
.. image:: general/list_users.png
|
|
|
|
|
|
:align: center
|
|
|
|
|
|
|
|
|
|
|
|
.. note:: The pre-selected filter *Internal Users* shows your paying
|
|
|
|
|
|
users (different from the *Portal Users* which are free). If you
|
|
|
|
|
|
remove this filter, you'll get all your users (the ones you pay for
|
|
|
|
|
|
and the portal ones)
|
2021-06-18 12:05:55 +07:00
|
|
|
|
|
2021-06-23 20:27:39 +07:00
|
|
|
|
In your list of users, click on the user you want to deactivate. As soon
|
|
|
|
|
|
as you are on the userform, click on the Action drop down menu, and
|
|
|
|
|
|
then click on Archive.
|
2021-06-18 12:05:55 +07:00
|
|
|
|
|
2021-06-23 20:27:39 +07:00
|
|
|
|
.. image:: general/deactivate_user.png
|
|
|
|
|
|
:align: center
|
2021-06-18 12:05:55 +07:00
|
|
|
|
|
2021-06-23 20:27:39 +07:00
|
|
|
|
|
|
|
|
|
|
The user is now deactivated.
|
|
|
|
|
|
|
|
|
|
|
|
.. danger:: **Never** deactivate the main user (*admin*)
|
|
|
|
|
|
|
|
|
|
|
|
Uninstalling Apps
|
|
|
|
|
|
-----------------
|
|
|
|
|
|
|
|
|
|
|
|
.. warning:: Make sure you first test what you are about to do on a
|
|
|
|
|
|
:ref:`duplicate <duplicate_online>` of your database before making any
|
|
|
|
|
|
changes (*especially* installing/uninstalling apps).
|
|
|
|
|
|
|
|
|
|
|
|
In your Odoo instance click on **Settings**; in this app, you will be
|
|
|
|
|
|
able to see how many applications you have installed. Click on **Browse
|
|
|
|
|
|
Apps** to access the list of your installed applications.
|
|
|
|
|
|
|
|
|
|
|
|
+----------------+----------------+
|
|
|
|
|
|
| |settings| | |browse_apps| |
|
|
|
|
|
|
+----------------+----------------+
|
|
|
|
|
|
|
|
|
|
|
|
In your applications' dashboard, you will see all the icons of your
|
|
|
|
|
|
applications. Click on the application you want to uninstall. Then, on
|
|
|
|
|
|
the form of the application, click on **Uninstall**.
|
2021-06-01 23:13:47 +07:00
|
|
|
|
|
|
|
|
|
|
.. image:: general/uninstall.png
|
2021-06-23 20:27:39 +07:00
|
|
|
|
:align: center
|
|
|
|
|
|
|
|
|
|
|
|
.. danger:: Some applications have dependencies, like Invoicing, eCommerce,
|
|
|
|
|
|
etc. Therefore, the system will give you a warning message to advise
|
|
|
|
|
|
you of what is about to be removed. If you uninstall your application,
|
|
|
|
|
|
all its dependencies will be uninstalled as well (and the data in them
|
|
|
|
|
|
will permanently disappear). If you are sure you still want to uninstall
|
|
|
|
|
|
it, then click **Confirm**.
|
2021-06-01 23:13:47 +07:00
|
|
|
|
|
2021-06-23 20:27:39 +07:00
|
|
|
|
Last, after having checked the warning message (if any), click **Confirm**.
|
2021-06-01 23:13:47 +07:00
|
|
|
|
|
|
|
|
|
|
.. image:: general/uninstall_deps.png
|
2021-06-23 20:27:39 +07:00
|
|
|
|
:align: center
|
|
|
|
|
|
|
|
|
|
|
|
You have finished uninstalling your application.
|
|
|
|
|
|
|
|
|
|
|
|
Good to know
|
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
|
|
* **Uninstalling apps, managing users, etc. is up to you**: no one else can
|
|
|
|
|
|
know if your business flow is broken better than you. If we were to uninstall
|
|
|
|
|
|
applications for you, we would never be able to tell if relevant data had
|
|
|
|
|
|
been removed or if one of your business flow was broken because we *do not
|
|
|
|
|
|
know how you work* and therefore cannot validate these kinds of operations.
|
|
|
|
|
|
|
|
|
|
|
|
* **Odoo Apps have dependencies**: this means that you may need to install
|
|
|
|
|
|
modules that you do not actively use to access some features of Odoo
|
|
|
|
|
|
you might need. For example, the Website Builder app is needed to be
|
|
|
|
|
|
able to show your customer their Quotes in a web page. Even though you
|
|
|
|
|
|
might not need or use the Website itself, it is needed for the Online
|
|
|
|
|
|
Quotes feature to work properly.
|
2021-06-01 23:13:47 +07:00
|
|
|
|
|
2021-06-23 20:27:39 +07:00
|
|
|
|
* **Always test app installation/removal on a duplicate** (or on a
|
|
|
|
|
|
free trial database): that way you can know what other apps may
|
|
|
|
|
|
be required, etc. This will avoid surprises when uninstalling
|
|
|
|
|
|
or when receiving your invoices.
|
2021-06-01 23:13:47 +07:00
|
|
|
|
|
2021-06-23 20:27:39 +07:00
|
|
|
|
.. |settings| image:: general/settings_app.png
|
|
|
|
|
|
.. |browse_apps| image:: general/browse_apps.png
|
|
|
|
|
|
.. |browse_users| image:: general/browse_users.png
|
2021-06-01 23:13:47 +07:00
|
|
|
|
|
|
|
|
|
|
.. _developer-mode:
|
|
|
|
|
|
|
|
|
|
|
|
Activate the developer mode (debug mode)
|
|
|
|
|
|
========================================
|
|
|
|
|
|
|
|
|
|
|
|
The developer mode (or debug mode) gives you access to extra and advanced tools.
|
|
|
|
|
|
|
2021-06-23 20:27:39 +07:00
|
|
|
|
Through the Settings application
|
|
|
|
|
|
--------------------------------
|
2021-06-01 23:13:47 +07:00
|
|
|
|
|
|
|
|
|
|
Go to :menuselection:`Settings --> Activate the developer mode`.
|
|
|
|
|
|
|
|
|
|
|
|
.. image:: general/settings.png
|
|
|
|
|
|
:align: center
|
|
|
|
|
|
:alt: Overview of the debug options under settings in Odoo
|
|
|
|
|
|
|
|
|
|
|
|
.. note::
|
|
|
|
|
|
*Activate the developer mode (with assets)* is used by developers; *Activate the developer mode
|
|
|
|
|
|
(with tests assets)* is used by developers and testers.
|
|
|
|
|
|
|
|
|
|
|
|
Once activated, the *Deactivate the developer mode* option becomes available.
|
|
|
|
|
|
|
|
|
|
|
|
Through a browser extension
|
|
|
|
|
|
---------------------------
|
|
|
|
|
|
|
|
|
|
|
|
| Go to the settings and extensions of your web browser, and search for *Odoo Debug*. Once the
|
|
|
|
|
|
extension is installed, a new icon will be shown on your toolbar.
|
|
|
|
|
|
| For the *Odoo Debug* extension, a single click enables a normal version of the mode, while a
|
|
|
|
|
|
double click enables it with assets. To deactivate it, use a single click.
|
|
|
|
|
|
|
|
|
|
|
|
.. image:: general/monkey.png
|
|
|
|
|
|
:align: center
|
|
|
|
|
|
:alt: View of odoo’s debug icon in a chrome’s toolbar
|
|
|
|
|
|
|
|
|
|
|
|
Through the URL
|
|
|
|
|
|
---------------
|
|
|
|
|
|
|
|
|
|
|
|
In the URL add ``?debug=1`` or ``?debug=true`` after *web*.
|
|
|
|
|
|
|
|
|
|
|
|
.. image:: general/url.png
|
|
|
|
|
|
:align: center
|
|
|
|
|
|
:alt: Overview of an url with the debug mode command added in Odoo
|
|
|
|
|
|
|
|
|
|
|
|
.. tip::
|
|
|
|
|
|
Developers: type ``?debug=assets`` and activate the mode with assets.
|
|
|
|
|
|
|
|
|
|
|
|
Locate the mode tools
|
|
|
|
|
|
---------------------
|
|
|
|
|
|
|
|
|
|
|
|
The Developer mode tools can be accessed from the *Open Developer Tools* button, located on the
|
|
|
|
|
|
header of your pages.
|
|
|
|
|
|
|
|
|
|
|
|
.. image:: general/button_location.png
|
|
|
|
|
|
:align: center
|
|
|
|
|
|
:alt: Overview of a console page and the debug icon being shown in Odoo
|
|
|
|
|
|
|
|
|
|
|
|
Mobile Push Notifications
|
|
|
|
|
|
=========================
|
|
|
|
|
|
|
|
|
|
|
|
As of Odoo 12.0, 13.0 or above, there is no more complex configuration to enable push
|
|
|
|
|
|
notifications in the mobile app.
|
|
|
|
|
|
|
|
|
|
|
|
Simply go to :menuselection:`Settings --> General Settings --> Odoo Cloud Notification (OCN)`
|
2021-06-23 20:27:39 +07:00
|
|
|
|
and make sure that **Push Notifications** is checked.
|