[MERGE] Forward-port of branch 14.0 to master

This commit is contained in:
Antoine Vandevenne (anv) 2021-07-07 15:40:27 +02:00
commit f8f784c0b0
220 changed files with 1841 additions and 2574 deletions

View File

@ -1,16 +1,21 @@
:nosearch:
:show-content:
:hide-page-toc:
:show-toc:
==============
Administration
==============
====================
Install and Maintain
====================
These guides provide instructions on how to install, maintain and upgrade Odoo databases.
.. seealso::
:doc:`History of Versions <administration/maintain/supported_versions>`
.. toctree::
:titlesonly:
administration/install
administration/deployment
administration/update
administration/db_upgrade
administration/maintain
administration/odoo_sh
administration/db_management
administration/enterprise

View File

@ -1,12 +0,0 @@
:nosearch:
===================
Database Management
===================
.. toctree::
db_management/db_online
db_management/db_premise
db_management/hosting_changes

View File

@ -1,233 +0,0 @@
.. _db_online:
==========================
Online Database management
==========================
To manage your databases, access the `database management page
<https://www.odoo.com/my/databases>`__ (you will have to sign in). Then click
on the `Manage Your Databases <https://www.odoo.com/my/databases/manage>`__
button.
.. image:: media/databases.png
:align: center
Make sure you are connected as the administrator of the database you
want to manage - many operations depends on identifying you remotely to that
database.
Several actions are available:
.. image:: media/db_buttons.png
:align: center
* :ref:`Upgrade <upgrade_button>`
Upgrade your database to the latest Odoo version to enjoy cutting-edge
features
* :ref:`Duplicate <duplicate_online>`
Make an exact copy of your database, if you want
to try out new apps or new flows without compromising
your daily operations
* :ref:`Rename <rename_online_database>`
Rename your database (and its URL)
* **Backup**
Download an instant backup of your database; note that we
back up databases daily according to our Odoo Cloud SLA
* :ref:`Domains <custom_domain>`
Configure custom domains to access your
database via another URL
* :ref:`Delete <delete_online_database>`
Delete a database instantly
* Contact Support
Access our `support page <https://www.odoo.com/help>`__
with the correct database already selected
.. _upgrade_button:
Upgrade
=======
.. warning:: Upgrading your database to a newer version of Odoo is a complex operation
that require time and caution. It is extremely important that you
fully test the process before upgrading your production database.
Odoo releases new versions regularly (at least once a year), and upgrading your
database to enjoy new Odoo features is part of the Odoo Online experience.
The upgrade process can take some time, especially if you use multiple apps or
apps that manage sensitive data (e.g. Accounting, Inventory, etc.). In general,
the 'smaller' the database, the quickest the upgrade. A single-user
database that uses only CRM will be processed faster than a multi-company,
multi-user database that uses Accounting, Sales, Purchase and Manufacturing.
Unfortunately, it is impossible to give time estimates for every upgrade request,
since Odoo.com will test manually every database upgrade at least once and will
need to correct/adapt changes made to the standard Odoo Apps (e.g. through Studio
or through a Success Pack) on a case-by-case basis. This can make the process
slower, since requests are treated in the order they arrive. This is especially
true in the months following the release of a new major version, which can lengthen
the upgrade delay significantly.
The upgrade process is quite simple from your point of view:
1. You request a test upgrade
2. Once all tests have been validated **by you**, you upgrade your actual database
The process to request a test or a production (*actual*) upgrade is the same.
First, make sure to be connected to the database you want to upgrade and access the
`database management page <https://www.odoo.com/my/databases>`__.
.. note:: You have to have an active session with access to the Settings app
in the database you want to upgrade for the button to be visible.
On the line of the database you want to upgrade, click
on the "Cog" menu. If an newer version of Odoo is available, you will see an 'Upgrade'
button.
.. image:: media/upgrade1.png
:align: center
You have the possibility to choose the target version of the upgrade. By default,
we select the highest available version available for your database; if you were
already in the process of testing an upgrade, we will automatically select the
version you were already testing (even if we released a more recent version during
your tests).
.. image:: media/upgrade_test.png
:align: center
By clicking on the "Test upgrade" button, an upgrade request will be generated.
Only one request can be made at time for each database; if a request has already
been made, you will see an 'Upgrade Queued' note instead and asking another
request will not be possible.
A test upgrade will create a copy of your database, upgrade it and make it
available to you automatically once successful. If this is the first test you
request for this particular database, a manual testing phase will be done by
Odoo.com - this could take time (up to several weeks). Subsequent requests
will not go through that manual testing step and will usually be made
available in a few hours. Once the test database is available, you should
receive an e-mail with the URL of the test database.
**Testing your database is the most important step of the upgrade process!**
Even though we test all upgrades manually, we do not know your work processes.
A change in standard workflows of Odoo in new versions might require you to
change internal processes, or some of the customizations you made through Odoo
Studio might not work properly. *It is up to you to make sure that everything
works as it should!* You can report issues with your test database through our
`Support page <https://www.odoo.com/help>`__.
Make sure to do one last test of your upgrade right before the final upgrade
(e.g. the day before) to ensure everything will run smoothly. Downgrading is
not possible and post-poning an upgrade is always easier than being prevented
to work by an upgrade issue after the fact!
Once you are ready and you have validated all your tests, you can click
again on the Upgrade button and confirm by clicking on Upgrade (the button
with the little rocket!) to switch your production database to the new version.
Your database will then be taken offline within the next 10 minutes and will be
upgraded automatically; you receive a confirmation
e-mail once the process is completed.
.. image:: media/upgrade_prod.png
:align: center
.. warning::
Your database will be taken offline during the upgrade (usually between 30min up to several hours
for big databases), so make sure to plan your migration during non-business hours.
.. _duplicate_online:
Duplicating a database
======================
.. note:: Database duplication, renaming, custom DNS, etc. is not available
for trial databases on our Online platform. Paid Databases and "One App
Free" database can duplicate without problem.
In the line of the database you want to duplicate, you will have a few
buttons. To duplicate your database, just click **Duplicate**. You will
have to give a name to your duplicate, then click **Duplicate Database**.
.. image:: media/db_duplicate.png
:align: center
.. danger:: If you do not check the "For testing purposes" checkbox when
duplicating a database, all external communication will remain active:
* Emails are sent
* Payments are processed (in the e-commerce or Subscriptions apps, for
example)
* Delivery orders (shipping providers) are sent
* Etc.
Make sure to check the checkbox "For testing purposes" if you want these
behaviours to be disabled.
After a few seconds, you will be logged in your duplicated database.
Notice that the url uses the name you chose for your duplicated
database.
.. note::
Duplicate databases expire automatically after 15 days.
.. image:: media/dup_expires.png
:align: center
.. _rename_online_database:
Rename a Database
===================
To rename your database, make sure you are connected to the database you want
to rename, access the `database management page <https://www.odoo.com/my/databases>`__
and click **Rename**. You will have to give a new name to your database,
then click **Rename Database**.
.. image:: media/rename.png
:align: center
.. _delete_online_database:
Deleting a Database
===================
You can only delete databases of which you are the administrator.
.. danger:: When you delete your database all the data will be permanently lost.
The deletion is instant and for all the Users. We advise you to do an
instant backup of your database before deleting it, since the last automated
daily backup may be several hours old at that point.
From the `database management page <https://www.odoo.com/my/databases>`__,
on the line of the database you want to delete, click on the "Delete" button.
.. image:: media/delete_button.png
:align: center
Read carefully the warning message that will appear and proceed only if you
fully understand the implications of deleting a database:
.. image:: media/delete_warning.png
:align: center
After a few seconds, the database will be deleted and the page will
reload automatically.
.. note::
* If you need to re-use this database name, it will be immediately available.
* It is not possible to delete a database if it is expired or linked
to a Subscription. In these cases contact
`Odoo Support <https://www.odoo.com/help>`__
* If you want to delete your Account, please contact
`Odoo Support <https://www.odoo.com/help>`__

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 35 KiB

View File

@ -1,12 +0,0 @@
:nosearch:
==========
Deployment
==========
.. toctree::
deployment/deploy
deployment/cdn
deployment/email_gateway

View File

@ -1,756 +1,12 @@
:nosearch:
.. _setup/install:
=======
Install
=======
===============
Installing Odoo
===============
.. toctree::
There are multiple ways to install Odoo, or not install it at all, depending
on the intended use case.
This documents attempts to describe most of the installation options.
:ref:`setup/install/online`
The easiest way to use Odoo in production or to try it.
:ref:`setup/install/packaged`
Suitable for testing Odoo, developing modules and can be used for
long-term production use with additional deployment and maintenance work.
:ref:`setup/install/source`
Provides greater flexibility: e.g. allow multiple running Odoo versions on
the same system. Good for developing modules, can be used as base for
production deployment.
:ref:`setup/install/docker`
If you usually use docker_ for development or deployment, an official
docker_ base image is available.
.. _setup/install/editions:
Editions
========
There are two different Editions_ of Odoo: the Community and Enterprise versions.
Using the Enterprise version is possible on our SaaS_ and accessing the code is
restricted to Enterprise customers and partners. The Community version is freely
available to anyone.
If you already use the Community version and wish to upgrade to Enterprise, please
refer to :ref:`setup/enterprise` (except for :ref:`setup/install/source`).
.. _setup/install/online:
Online
======
Demo
----
To simply get a quick idea of Odoo, demo_ instances are available. They are
shared instances which only live for a few hours, and can be used to browse
around and try things out with no commitment.
Demo_ instances require no local installation, just a web browser.
SaaS
----
Trivial to start with, fully managed and migrated by Odoo S.A., Odoo's SaaS_
provides private instances and starts out free. It can be used to discover and
test Odoo and do non-code customizations (i.e. incompatible with custom modules
or the Odoo Apps Store) without having to install it locally.
Can be used for both testing Odoo and long-term production use.
Like demo_ instances, SaaS_ instances require no local installation, a web
browser is sufficient.
.. _setup/install/packaged:
Packaged installers
===================
Odoo provides packaged installers for Windows, deb-based distributions
(Debian, Ubuntu, …) and RPM-based distributions (Fedora, CentOS, RHEL, …) for
both the Community and Enterprise versions.
These packages automatically set up all dependencies (for the Community version),
but may be difficult to keep up-to-date.
Official Community packages with all relevant dependency requirements are
available on our nightly_ server. Both Communtiy and Enterprise packages can
be downloaded from our download_ page (you must to be logged in as a paying
customer or partner to download the Enterprise packages).
Windows
-------
#. Download the installer from our nightly_ server (Community only) or the Windows installer from
the download_ page (any edition).
#. Execute the downloaded file.
.. warning:: | On Windows 8 and later you may see a warning titled "Windows protected your PC".
| Click on **More Info** and then on **Run anyway**.
#. Accept the UAC_ prompt.
#. Go through the various installation steps.
Odoo will automatically be started at the end of the installation.
Linux
-----
Debian/Ubuntu
'''''''''''''
Odoo 14.0 'deb' package currently supports `Debian Buster`_, `Ubuntu 20.04`_ or above.
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
details on the various versions.
Repository
^^^^^^^^^^
Odoo S.A. provides a repository that can be used with Debian and Ubuntu distributions. It can be
used to install *Odoo Community Edition* by executing the following commands:
.. code-block:: console
$ wget -O - https://nightly.odoo.com/odoo.key | sudo apt-key add -
$ sudo sh -c 'echo "deb http://nightly.odoo.com/14.0/nightly/deb/ ./" >> /etc/apt/sources.list.d/odoo.list'
$ sudo apt-get update && sudo apt-get install odoo
You can then use the usual `apt-get upgrade` command to keep your installation up-to-date.
At this moment, there is no nightly repository for the Enterprise Edition.
Deb Package
^^^^^^^^^^^
Instead of using the repository as described above, the 'deb' packages for both the *Community* and
*Enterprise* editions can be downloaded from the `official download page <download_>`_.
Next, execute the following commands:
.. code-block:: console
$ sudo apt-get install <path_to_installation_package>
This will install Odoo as a service, create the necessary PostgreSQL_ user
and automatically start the server.
.. note:: The recommended `postgresql-server` package will be installed by the Debian Odoo package.
The `--no-install-recommends` argument of the `apt-get` tool should be used if you plan
to install the Postgresql server on another machine.
Fedora
''''''
Odoo 14.0 'rpm' package supports Fedora 32.
.. warning:: The Odoo 14.0 rpm package does not support Fedora 33 or above.
Prepare
^^^^^^^
Odoo needs a `PostgreSQL`_ server to run properly. Make sure that the `sudo` command is available
and well configured and, only then, execute the following command in order to install the PostgreSQL
server:
.. code-block:: console
$ sudo dnf install -y postgresql-server
$ sudo postgresql-setup --initdb --unit postgresql
$ sudo systemctl enable postgresql
$ sudo systemctl start postgresql
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
details on the various versions.
Repository
^^^^^^^^^^
Odoo S.A. provides a repository that can be used with the Fedora distributions.
It can be used to install *Odoo Community Edition* by executing the following
commands:
.. code-block:: console
$ sudo dnf config-manager --add-repo=https://nightly.odoo.com/14.0/nightly/rpm/odoo.repo
$ sudo dnf install -y odoo
$ sudo systemctl enable odoo
$ sudo systemctl start odoo
RPM package
^^^^^^^^^^^
Instead of using the repository as described above, the 'rpm' packages for both the *Community* and
*Enterprise* editions can be downloaded from the `official download page <download_>`_.
Once downloaded, the package can be installed using the 'dnf' package manager:
.. code-block:: console
$ sudo dnf localinstall odoo_14.0.latest.noarch.rpm
$ sudo systemctl enable odoo
$ sudo systemctl start odoo
.. _setup/install/source:
Source Install
==============
The source "installation" is really about not installing Odoo, and running it directly from source
instead.
This can be more convenient for module developers as the Odoo source is more easily accessible
than using packaged installation (for information or to build this documentation and have it
available offline).
It also makes starting and stopping Odoo more flexible and explicit than the services set up by the
packaged installations, and allows overriding settings using
:ref:`command-line parameters <reference/cmdline>` without needing to edit a configuration file.
Finally it provides greater control over the system's set up, and allows to more easily keep
(and run) multiple versions of Odoo side-by-side.
Windows
-------
Fetch the sources
'''''''''''''''''
There are two ways to obtain the source code of Odoo: as a zip **archive** or through **git**.
Archive
^^^^^^^
Community Edition:
* `Official download page <download_>`_
* `GitHub repository <community-repository_>`_
* `Nightly server <nightly_>`_
Enterprise Edition:
* `Official download page <download_>`_
* `GitHub repository <enterprise-repository_>`_
Git
^^^
The following requires git_ to be installed on your machine and that you have basic knowledge of
git commands.
Community Edition:
.. code-block:: doscon
C:\> git clone https://github.com/odoo/odoo.git
Enterprise Edition: (see :ref:`setup/install/editions` to get access)
.. code-block:: doscon
C:\> git clone https://github.com/odoo/enterprise.git
.. note:: **The Enterprise git repository does not contain the full Odoo source code**. It is only
a collection of extra add-ons. The main server code is in the Community version. Running
the Enterprise version actually means running the server from the Community version with
the addons-path option set to the folder with the Enterprise version. You need to clone
both the Community and Enterprise repository to have a working Odoo Enterprise
installation.
Prepare
'''''''
Python
^^^^^^
Odoo requires Python 3.6 or later to run. Visit `Python's download page <https://www.python.org/downloads/windows/>`_
to download and install the latest version of Python 3 on your machine.
During installation, check **Add Python 3 to PATH**, then click **Customize Installation** and make
sure that **pip** is checked.
.. note:: If Python 3 is already installed, make sure that the version is 3.6 or above, as previous
versions are not compatible with Odoo.
.. code-block:: doscon
C:\> python --version
Verify also that pip_ is installed for this version.
.. code-block:: doscon
C:\> pip --version
PostgreSQL
^^^^^^^^^^
Odoo uses PostgreSQL as database management system. `Download and install PostgreSQL <https://www.postgresql.org/download/windows/>`_
(supported version: 10.0 and later).
By default, the only user is `postgres` but Odoo forbids connecting as `postgres`, so you need to
create a new PostgreSQL user:
#. Add PostgreSQL's `bin` directory (by default: `C:\\Program Files\\PostgreSQL\\<version>\\bin`) to
your `PATH`.
#. Create a postgres user with a password using the pg admin gui:
1. Open **pgAdmin**.
2. Double-click the server to create a connection.
3. Select :menuselection:`Object --> Create --> Login/Group Role`.
4. Enter the username in the **Role Name** field (e.g. `odoo`).
5. Open the **Definition** tab and enter the password (e.g. ``odoo``), then click **Save**.
6. Open the **Privileges** tab and switch **Can login?** to `Yes` and **Create database?** to
`Yes`.
Dependencies
^^^^^^^^^^^^
Before installing the dependencies, you must download and install the
`Build Tools for Visual Studio <https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2019>`_.
When prompted, select **C++ build tools** in the **Workloads** tab and install them.
Odoo dependencies are listed in the `requirements.txt` file located at the root of the Odoo
community directory.
.. tip:: It can be preferable to not mix python modules packages between different instances of Odoo
or with your system. You can use virtualenv_ to create isolated Python environments.
Navigate to the path of your Odoo Community installation (`CommunityPath`) and run **pip**
on the requirements file in a terminal **with Administrator privileges**:
.. code-block:: doscon
C:\> cd \CommunityPath
C:\> pip install setuptools wheel
C:\> pip install -r requirements.txt
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
details on the various versions.
For languages with right-to-left interface (such as Arabic or Hebrew), the package `rtlcss` is
needed:
#. Download and install `nodejs <https://nodejs.org/en/download/>`_.
#. Install `rtlcss`:
.. code-block:: doscon
C:\> npm install -g rtlcss
#. Edit the System Environment's variable `PATH` to add the folder where `rtlcss.cmd` is located
(typically: `C:\\Users\\<user>\\AppData\\Roaming\\npm\\`).
Running Odoo
''''''''''''
Once all dependencies are set up, Odoo can be launched by running `odoo-bin`, the
command-line interface of the server. It is located at the root of the Odoo Community directory.
To configure the server, you can either specify :ref:`command-line arguments <reference/cmdline/server>` or a
:ref:`configuration file <reference/cmdline/config>`.
.. tip:: For the Enterprise edition, you must add the path to the `enterprise` addons to the
`addons-path` argument. Note that it must come before the other paths in `addons-path` for
addons to be loaded correctly.
Common necessary configurations are:
* PostgreSQL user and password.
* Custom addon paths beyond the defaults, to load your own modules.
A typical way to run the server would be:
.. code-block:: doscon
C:\> cd CommunityPath/
C:\> python odoo-bin -r dbuser -w dbpassword --addons-path=addons -d mydb
Where `CommunityPath` is the path of the Odoo Community installation, `dbuser` is the
PostgreSQL login, `dbpassword` is the PostgreSQL password
and `mydb` is the default database to serve on `localhost:8069`. You can add other
directory paths separated by a comma to ``addons`` at the end of the addons-path option.
Linux
-----
Fetch the sources
'''''''''''''''''
There are two ways to obtain the source code of Odoo: as a zip **archive** or through **git**.
Archive
^^^^^^^
Community Edition:
* `Official download page <download_>`_
* `GitHub repository <community-repository_>`_
* `Nightly server <nightly_>`_
Enterprise Edition:
* `Official download page <download_>`_
* `GitHub repository <enterprise-repository_>`_
Git
^^^
The following requires git_ to be installed on your machine and that you have basic knowledge of
git commands.
Community Edition:
.. code-block:: console
$ git clone https://github.com/odoo/odoo.git
Enterprise Edition: (see :ref:`setup/install/editions` to get access)
.. code-block:: console
$ git clone https://github.com/odoo/enterprise.git
.. note:: **The Enterprise git repository does not contain the full Odoo source code**. It is only
a collection of extra add-ons. The main server code is in the Community version. Running
the Enterprise version actually means running the server from the Community version with
the addons-path option set to the folder with the Enterprise version. You need to clone
both the Community and Enterprise repository to have a working Odoo Enterprise
installation.
Prepare
'''''''
Python
^^^^^^
Odoo requires Python 3.6 or later to run. Use your package manager to download and install Python 3
on your machine if it is not already done.
.. note:: If Python 3 is already installed, make sure that the version is 3.6 or above, as previous
versions are not compatible with Odoo.
.. code-block:: console
$ python3 --version
Verify also that pip_ is installed for this version.
.. code-block:: console
$ pip3 --version
PostgreSQL
^^^^^^^^^^
Odoo uses PostgreSQL as database management system. Use your package manager to download and install
PostgreSQL (supported version: 10.0 and later).
On Debian/Unbuntu, it can be achieved by executing the following:
.. code-block:: console
$ sudo apt install postgresql postgresql-client
By default, the only user is `postgres` but Odoo forbids connecting as `postgres`, so you need to
create a new PostgreSQL user:
.. code-block:: console
$ sudo -u postgres createuser -s $USER
$ createdb $USER
.. note:: Because your PostgreSQL user has the same name as your Unix login, you will be able to
connect to the database without password.
Dependencies
^^^^^^^^^^^^
For libraries using native code, it is necessary to install development tools and native
dependencies before the Python dependencies of Odoo. They are available in `-dev` or `-devel`
packages for Python, PostgreSQL, libxml2, libxslt1, libevent, libsasl2 and libldap2.
On Debian/Unbuntu, the following command should install all the required libraries:
.. code-block:: console
$ sudo apt install python3-dev libxml2-dev libxslt1-dev libldap2-dev libsasl2-dev \
libtiff5-dev libjpeg8-dev libopenjp2-7-dev zlib1g-dev libfreetype6-dev \
liblcms2-dev libwebp-dev libharfbuzz-dev libfribidi-dev libxcb1-dev libpq-dev
Odoo dependencies are listed in the `requirements.txt` file located at the root of the Odoo
community directory.
.. tip:: It can be preferable to not mix python modules packages between different instances of Odoo
or with your system. You can use virtualenv_ to create isolated Python environments.
Navigate to the path of your Odoo Community installation (`CommunityPath`) and run **pip**
on the requirements file:
.. code-block:: console
$ cd /CommunityPath
$ pip3 install setuptools wheel
$ pip3 install -r requirements.txt
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
details on the various versions.
For languages with right-to-left interface (such as Arabic or Hebrew), the package `rtlcss` is
needed:
#. Download and install **nodejs** and **npm** with your package manager.
#. Install `rtlcss`:
.. code-block:: console
$ sudo npm install -g rtlcss
Running Odoo
''''''''''''
Once all dependencies are set up, Odoo can be launched by running `odoo-bin`, the
command-line interface of the server. It is located at the root of the Odoo Community directory.
To configure the server, you can either specify :ref:`command-line arguments <reference/cmdline/server>` or a
:ref:`configuration file <reference/cmdline/config>`.
.. tip:: For the Enterprise edition, you must add the path to the `enterprise` addons to the
`addons-path` argument. Note that it must come before the other paths in `addons-path` for
addons to be loaded correctly.
Common necessary configurations are:
* PostgreSQL user and password. Odoo has no defaults beyond
`psycopg2's defaults <http://initd.org/psycopg/docs/module.html>`_: connects over a UNIX socket on
port `5432` with the current user and no password.
* Custom addon paths beyond the defaults, to load your own modules.
A typical way to run the server would be:
.. code-block:: console
$ cd /CommunityPath
$ python3 odoo-bin --addons-path=addons -d mydb
Where `CommunityPath` is the path of the Odoo Community installation
and `mydb` is the default database to serve on `localhost:8069`. You can add other
directory paths separated by a comma to ``addons`` at the end of the addons-path option.
Mac OS
------
Fetch the sources
'''''''''''''''''
There are two ways to obtain the source code of Odoo: as a zip **archive** or through **git**.
Archive
^^^^^^^
Community Edition:
* `Official download page <download_>`_
* `GitHub repository <community-repository_>`_
* `Nightly server <nightly_>`_
Enterprise Edition:
* `Official download page <download_>`_
* `GitHub repository <enterprise-repository_>`_
Git
^^^
The following requires git_ to be installed on your machine and that you have basic knowledge of
git commands.
Community Edition:
.. code-block:: console
$ git clone https://github.com/odoo/odoo.git
Enterprise Edition: (see :ref:`setup/install/editions` to get access)
.. code-block:: console
$ git clone https://github.com/odoo/enterprise.git
.. note:: **The Enterprise git repository does not contain the full Odoo source code**. It is only
a collection of extra add-ons. The main server code is in the Community version. Running
the Enterprise version actually means running the server from the Community version with
the addons-path option set to the folder with the Enterprise version. You need to clone
both the Community and Enterprise repository to have a working Odoo Enterprise
installation.
Prepare
'''''''
Python
^^^^^^
Odoo requires Python 3.6 or later to run. Use your preferred package manager (homebrew_, macports_)
to download and install Python 3 on your machine if it is not already done.
.. note:: If Python 3 is already installed, make sure that the version is 3.6 or above, as previous
versions are not compatible with Odoo.
.. code-block:: console
$ python3 --version
Verify also that pip_ is installed for this version.
.. code-block:: console
$ pip3 --version
PostgreSQL
^^^^^^^^^^
Odoo uses PostgreSQL as database management system. Use `postgres.app <https://postgresapp.com>`_
to download and install PostgreSQL (supported version: 10.0 and later).
By default, the only user is `postgres` but Odoo forbids connecting as `postgres`, so you need to
create a new PostgreSQL user:
.. code-block:: console
$ sudo -u postgres createuser -s $USER
$ createdb $USER
.. note:: Because your PostgreSQL user has the same name as your Unix login, you will be able to
connect to the database without password.
Dependencies
^^^^^^^^^^^^
Odoo dependencies are listed in the `requirements.txt` file located at the root of the Odoo
community directory.
.. tip:: It can be preferable to not mix python modules packages between different instances of Odoo
or with your system. You can use virtualenv_ to create isolated Python environments.
Navigate to the path of your Odoo Community installation (`CommunityPath`) and run **pip**
on the requirements file:
.. code-block:: console
$ cd /CommunityPath
$ pip3 install setuptools wheel
$ pip3 install -r requirements.txt
.. warning:: Non-Python dependencies need to be installed with a package manager:
#. Download and install the **Command Line Tools**:
.. code-block:: console
$ xcode-select --install
#. Download and install the package manager of your choice (homebrew_, macports_).
#. Install non-python dependencies.
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
details on the various versions.
For languages with right-to-left interface (such as Arabic or Hebrew), the package `rtlcss` is
needed:
#. Download and install **nodejs** with your preferred package manager (homebrew_, macports_).
#. Install `rtlcss`:
.. code-block:: console
$ sudo npm install -g rtlcss
Running Odoo
''''''''''''
Once all dependencies are set up, Odoo can be launched by running `odoo-bin`, the
command-line interface of the server. It is located at the root of the Odoo Community directory.
To configure the server, you can either specify :ref:`command-line arguments <reference/cmdline/server>` or a
:ref:`configuration file <reference/cmdline/config>`.
.. tip:: For the Enterprise edition, you must add the path to the `enterprise` addons to the
`addons-path` argument. Note that it must come before the other paths in `addons-path` for
addons to be loaded correctly.
Common necessary configurations are:
* PostgreSQL user and password. Odoo has no defaults beyond
`psycopg2's defaults <http://initd.org/psycopg/docs/module.html>`_: connects over a UNIX socket on
port `5432` with the current user and no password.
* Custom addon paths beyond the defaults, to load your own modules.
A typical way to run the server would be:
.. code-block:: console
$ cd /CommunityPath
$ python3 odoo-bin --addons-path=addons -d mydb
Where `CommunityPath` is the path of the Odoo Community installation
and `mydb` is the default database to serve on `localhost:8069`. You can add other
directory paths separated by a comma to ``addons`` at the end of the addons-path option.
.. _setup/install/docker:
Docker
======
The full documentation on how to use Odoo with Docker can be found on the
official Odoo `docker image <https://registry.hub.docker.com/_/odoo/>`_ page.
.. _Debian Buster: https://www.debian.org/releases/buster/
.. _demo: https://demo.odoo.com
.. _docker: https://www.docker.com
.. _download: https://www.odoo.com/page/download
.. _Ubuntu 20.04: http://releases.ubuntu.com/20.04/
.. _EPEL: https://fedoraproject.org/wiki/EPEL
.. _PostgreSQL: http://www.postgresql.org
.. _the official installer:
.. _install pip:
https://pip.pypa.io/en/latest/installing.html#install-pip
.. _Quilt: http://en.wikipedia.org/wiki/Quilt_(software)
.. _saas: https://www.odoo.com/page/start
.. _the wkhtmltopdf download page: https://github.com/wkhtmltopdf/wkhtmltopdf/releases/tag/0.12.5
.. _UAC: http://en.wikipedia.org/wiki/User_Account_Control
.. _wkhtmltopdf: http://wkhtmltopdf.org
.. _pip: https://pip.pypa.io
.. _macports: https://www.macports.org
.. _homebrew: http://brew.sh
.. _wheels: https://wheel.readthedocs.org/en/latest/
.. _virtualenv: https://pypi.python.org/pypi/virtualenv
.. _virtualenvwrapper: https://virtualenvwrapper.readthedocs.io/en/latest/
.. _pywin32: http://sourceforge.net/projects/pywin32/files/pywin32/
.. _community-repository: https://github.com/odoo/odoo
.. _enterprise-repository: https://github.com/odoo/enterprise
.. _git: https://git-scm.com/
.. _Editions: https://www.odoo.com/pricing#pricing_table_features
.. _nightly: https://nightly.odoo.com/
.. _extra: https://nightly.odoo.com/extra/
install/install
install/deploy
install/cdn
install/email_gateway

View File

@ -1,7 +1,6 @@
========================================
Deploying with Content Delivery Networks
========================================
===========================================
Setting up a Content Delivery Network (CDN)
===========================================
.. _reference/cdn/keycdn:

View File

Before

Width:  |  Height:  |  Size: 41 KiB

After

Width:  |  Height:  |  Size: 41 KiB

View File

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 10 KiB

View File

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 28 KiB

View File

Before

Width:  |  Height:  |  Size: 9.8 KiB

After

Width:  |  Height:  |  Size: 9.8 KiB

View File

Before

Width:  |  Height:  |  Size: 33 KiB

After

Width:  |  Height:  |  Size: 33 KiB

View File

Before

Width:  |  Height:  |  Size: 6.3 KiB

After

Width:  |  Height:  |  Size: 6.3 KiB

View File

Before

Width:  |  Height:  |  Size: 7.2 KiB

After

Width:  |  Height:  |  Size: 7.2 KiB

View File

@ -1,7 +1,6 @@
==============
Deploying Odoo
==============
====================
System configuration
====================
This document describes basic steps to set up Odoo in production or on an
internet-facing server. It follows :ref:`installation <setup/install>`, and is

View File

@ -1,7 +1,6 @@
==================
Odoo email gateway
==================
=============
Email gateway
=============
The Odoo mail gateway allows you to inject directly all the received emails in Odoo.

View File

@ -0,0 +1,782 @@
.. _setup/install:
===============
Installing Odoo
===============
There are multiple ways to install Odoo, or not install it at all, depending
on the intended use case.
This documents attempts to describe most of the installation options.
:ref:`setup/install/online`
The easiest way to use Odoo in production or to try it.
:ref:`setup/install/packaged`
Suitable for testing Odoo, developing modules and can be used for
long-term production use with additional deployment and maintenance work.
:ref:`setup/install/source`
Provides greater flexibility: e.g. allow multiple running Odoo versions on
the same system. Good for developing modules, can be used as base for
production deployment.
:ref:`setup/install/docker`
If you usually use docker_ for development or deployment, an official
docker_ base image is available.
.. _setup/install/editions:
Editions
========
There are two different Editions_ of Odoo: the Community and Enterprise versions.
Using the Enterprise version is possible on our SaaS_ and accessing the code is
restricted to Enterprise customers and partners. The Community version is freely
available to anyone.
If you already use the Community version and wish to upgrade to Enterprise, please
refer to :ref:`setup/enterprise` (except for :ref:`setup/install/source`).
.. _setup/install/online:
Online
======
Demo
----
To simply get a quick idea of Odoo, demo_ instances are available. They are
shared instances which only live for a few hours, and can be used to browse
around and try things out with no commitment.
Demo_ instances require no local installation, just a web browser.
SaaS
----
Trivial to start with, fully managed and migrated by Odoo S.A., Odoo's SaaS_
provides private instances and starts out free. It can be used to discover and
test Odoo and do non-code customizations (i.e. incompatible with custom modules
or the Odoo Apps Store) without having to install it locally.
Can be used for both testing Odoo and long-term production use.
Like demo_ instances, SaaS_ instances require no local installation, a web
browser is sufficient.
.. _setup/install/packaged:
Packaged installers
===================
Odoo provides packaged installers for Windows, deb-based distributions
(Debian, Ubuntu, …) and RPM-based distributions (Fedora, CentOS, RHEL, …) for
both the Community and Enterprise versions.
These packages automatically set up all dependencies (for the Community version),
but may be difficult to keep up-to-date.
Official Community packages with all relevant dependency requirements are
available on our nightly_ server. Both Communtiy and Enterprise packages can
be downloaded from our download_ page (you must to be logged in as a paying
customer or partner to download the Enterprise packages).
Windows
-------
#. Download the installer from our nightly_ server (Community only) or the Windows installer from
the download_ page (any edition).
#. Execute the downloaded file.
.. warning:: | On Windows 8 and later you may see a warning titled "Windows protected your PC".
| Click on **More Info** and then on **Run anyway**.
#. Accept the UAC_ prompt.
#. Go through the various installation steps.
Odoo will automatically be started at the end of the installation.
Linux
-----
Debian/Ubuntu
'''''''''''''
Odoo 13.0 'deb' package currently supports `Debian Buster`_, `Ubuntu 18.04`_ or above.
Prepare
^^^^^^^
Odoo needs a `PostgreSQL`_ server to run properly. The default configuration for
the Odoo 'deb' package is to use the PostgreSQL server on the same host as your
Odoo instance. Execute the following command in order to install the PostgreSQL server:
.. code-block:: console
$ sudo apt install postgresql -y
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
details on the various versions.
Repository
^^^^^^^^^^
Odoo S.A. provides a repository that can be used with Debian and Ubuntu distributions. It can be
used to install *Odoo Community Edition* by executing the following commands **as root**:
.. code-block:: console
# wget -O - https://nightly.odoo.com/odoo.key | apt-key add -
# echo "deb http://nightly.odoo.com/13.0/nightly/deb/ ./" >> /etc/apt/sources.list.d/odoo.list
# apt-get update && apt-get install odoo
You can then use the usual `apt-get upgrade` command to keep your installation up-to-date.
At this moment, there is no nightly repository for the Enterprise Edition.
Deb Package
^^^^^^^^^^^
Instead of using the repository as described above, the 'deb' packages for both the *Community* and
*Enterprise* editions can be downloaded from the `official download page <download_>`_.
Next, execute the following commands **as root**:
.. code-block:: console
# dpkg -i <path_to_installation_package> # this probably fails with missing dependencies
# apt-get install -f # should install the missing dependencies
# dpkg -i <path_to_installation_package>
This will install Odoo as a service, create the necessary PostgreSQL_ user
and automatically start the server.
.. warning:: The `python3-xlwt` Debian package does not exists in Debian Buster nor Ubuntu 18.04.
This python module is needed to export into xls format.
If you need the feature, you can install it manually with:
.. code-block:: console
$ sudo pip3 install xlwt
.. warning:: The `num2words` python package does not exists in Debian Buster nor Ubuntu 18.04.
Textual amounts will not be rendered by Odoo and this could cause problems with the
`l10n_mx_edi` module.
If you need this feature, you can install manually with:
.. code-block:: console
$ sudo pip3 install num2words
Fedora
''''''
Odoo 13.0 'rpm' package supports Fedora 30.
Prepare
^^^^^^^
Odoo needs a `PostgreSQL`_ server to run properly. Make sure that the `sudo` command is available
and well configured and, only then, execute the following command in order to install the PostgreSQL
server:
.. code-block:: console
$ sudo dnf install -y postgresql-server
$ sudo postgresql-setup --initdb --unit postgresql
$ sudo systemctl enable postgresql
$ sudo systemctl start postgresql
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
details on the various versions.
Repository
^^^^^^^^^^
Odoo S.A. provides a repository that can be used with the Fedora distributions.
It can be used to install *Odoo Community Edition* by executing the following
commands:
.. code-block:: console
$ sudo dnf config-manager --add-repo=https://nightly.odoo.com/13.0/nightly/rpm/odoo.repo
$ sudo dnf install -y odoo
$ sudo systemctl enable odoo
$ sudo systemctl start odoo
RPM package
^^^^^^^^^^^
Instead of using the repository as described above, the 'rpm' packages for both the *Community* and
*Enterprise* editions can be downloaded from the `official download page <download_>`_.
Once downloaded, the package can be installed using the 'dnf' package manager:
.. code-block:: console
$ sudo dnf localinstall odoo_13.0.latest.noarch.rpm
$ sudo systemctl enable odoo
$ sudo systemctl start odoo
.. _setup/install/source:
Source Install
==============
The source "installation" is really about not installing Odoo, and running it directly from source
instead.
This can be more convenient for module developers as the Odoo source is more easily accessible
than using packaged installation (for information or to build this documentation and have it
available offline).
It also makes starting and stopping Odoo more flexible and explicit than the services set up by the
packaged installations, and allows overriding settings using
:ref:`command-line parameters <reference/cmdline>` without needing to edit a configuration file.
Finally it provides greater control over the system's set up, and allows to more easily keep
(and run) multiple versions of Odoo side-by-side.
Windows
-------
Fetch the sources
'''''''''''''''''
There are two ways to obtain the source code of Odoo: as a zip **archive** or through **git**.
Archive
^^^^^^^
Community Edition:
* `Official download page <download_>`_
* `GitHub repository <community-repository_>`_
* `Nightly server <nightly_>`_
Enterprise Edition:
* `Official download page <download_>`_
* `GitHub repository <enterprise-repository_>`_
Git
^^^
The following requires git_ to be installed on your machine and that you have basic knowledge of
git commands.
Community Edition:
.. code-block:: doscon
C:\> git clone https://github.com/odoo/odoo.git
Enterprise Edition: (see :ref:`setup/install/editions` to get access)
.. code-block:: doscon
C:\> git clone https://github.com/odoo/enterprise.git
.. note:: **The Enterprise git repository does not contain the full Odoo source code**. It is only
a collection of extra add-ons. The main server code is in the Community version. Running
the Enterprise version actually means running the server from the Community version with
the addons-path option set to the folder with the Enterprise version. You need to clone
both the Community and Enterprise repository to have a working Odoo Enterprise
installation.
Prepare
'''''''
Python
^^^^^^
Odoo requires Python 3.6 or later to run. Visit `Python's download page <https://www.python.org/downloads/windows/>`_
to download and install the latest version of Python 3 on your machine.
During installation, check **Add Python 3 to PATH**, then click **Customize Installation** and make
sure that **pip** is checked.
.. note:: If Python 3 is already installed, make sure that the version is 3.6 or above, as previous
versions are not compatible with Odoo.
.. code-block:: doscon
C:\> python --version
Verify also that pip_ is installed for this version.
.. code-block:: doscon
C:\> pip --version
PostgreSQL
^^^^^^^^^^
Odoo uses PostgreSQL as database management system. `Download and install PostgreSQL <https://www.postgresql.org/download/windows/>`_
(supported version: 10.0 and later).
By default, the only user is `postgres` but Odoo forbids connecting as `postgres`, so you need to
create a new PostgreSQL user:
#. Add PostgreSQL's `bin` directory (by default: `C:\\Program Files\\PostgreSQL\\<version>\\bin`) to
your `PATH`.
#. Create a postgres user with a password using the pg admin gui:
1. Open **pgAdmin**.
2. Double-click the server to create a connection.
3. Select :menuselection:`Object --> Create --> Login/Group Role`.
4. Enter the username in the **Role Name** field (e.g. `odoo`).
5. Open the **Definition** tab and enter the password (e.g. ``odoo``), then click **Save**.
6. Open the **Privileges** tab and switch **Can login?** to `Yes` and **Create database?** to
`Yes`.
Dependencies
^^^^^^^^^^^^
Before installing the dependencies, you must download and install the
`Build Tools for Visual Studio <https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2019>`_.
When prompted, select **C++ build tools** in the **Workloads** tab and install them.
Odoo dependencies are listed in the `requirements.txt` file located at the root of the Odoo
community directory.
.. tip:: It can be preferable to not mix python modules packages between different instances of Odoo
or with your system. You can use virtualenv_ to create isolated Python environments.
Navigate to the path of your Odoo Community installation (`CommunityPath`) and run **pip**
on the requirements file in a terminal **with Administrator privileges**:
.. code-block:: doscon
C:\> cd \CommunityPath
C:\> pip install setuptools wheel
C:\> pip install -r requirements.txt
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
details on the various versions.
For languages with right-to-left interface (such as Arabic or Hebrew), the package `rtlcss` is
needed:
#. Download and install `nodejs <https://nodejs.org/en/download/>`_.
#. Install `rtlcss`:
.. code-block:: doscon
C:\> npm install -g rtlcss
#. Edit the System Environment's variable `PATH` to add the folder where `rtlcss.cmd` is located
(typically: `C:\\Users\\<user>\\AppData\\Roaming\\npm\\`).
Running Odoo
''''''''''''
Once all dependencies are set up, Odoo can be launched by running `odoo-bin`, the
command-line interface of the server. It is located at the root of the Odoo Community directory.
To configure the server, you can either specify :ref:`command-line arguments <reference/cmdline/server>` or a
:ref:`configuration file <reference/cmdline/config>`.
.. tip:: For the Enterprise edition, you must add the path to the `enterprise` addons to the
`addons-path` argument. Note that it must come before the other paths in `addons-path` for
addons to be loaded correctly.
Common necessary configurations are:
* PostgreSQL user and password.
* Custom addon paths beyond the defaults, to load your own modules.
A typical way to run the server would be:
.. code-block:: doscon
C:\> cd CommunityPath/
C:\> python odoo-bin -r dbuser -w dbpassword --addons-path=addons -d mydb
Where `CommunityPath` is the path of the Odoo Community installation, `dbuser` is the
PostgreSQL login, `dbpassword` is the PostgreSQL password
and `mydb` is the default database to serve on `localhost:8069`. You can add other
directory paths separated by a comma to ``addons`` at the end of the addons-path option.
Linux
-----
Fetch the sources
'''''''''''''''''
There are two ways to obtain the source code of Odoo: as a zip **archive** or through **git**.
Archive
^^^^^^^
Community Edition:
* `Official download page <download_>`_
* `GitHub repository <community-repository_>`_
* `Nightly server <nightly_>`_
Enterprise Edition:
* `Official download page <download_>`_
* `GitHub repository <enterprise-repository_>`_
Git
^^^
The following requires git_ to be installed on your machine and that you have basic knowledge of
git commands.
Community Edition:
.. code-block:: console
$ git clone https://github.com/odoo/odoo.git
Enterprise Edition: (see :ref:`setup/install/editions` to get access)
.. code-block:: console
$ git clone https://github.com/odoo/enterprise.git
.. note:: **The Enterprise git repository does not contain the full Odoo source code**. It is only
a collection of extra add-ons. The main server code is in the Community version. Running
the Enterprise version actually means running the server from the Community version with
the addons-path option set to the folder with the Enterprise version. You need to clone
both the Community and Enterprise repository to have a working Odoo Enterprise
installation.
Prepare
'''''''
Python
^^^^^^
Odoo requires Python 3.6 or later to run. Use your package manager to download and install Python 3
on your machine if it is not already done.
.. note:: If Python 3 is already installed, make sure that the version is 3.6 or above, as previous
versions are not compatible with Odoo.
.. code-block:: console
$ python3 --version
Verify also that pip_ is installed for this version.
.. code-block:: console
$ pip3 --version
PostgreSQL
^^^^^^^^^^
Odoo uses PostgreSQL as database management system. Use your package manager to download and install
PostgreSQL (supported version: 10.0 and later).
On Debian/Unbuntu, it can be achieved by executing the following:
.. code-block:: console
$ sudo apt install postgresql postgresql-client
By default, the only user is `postgres` but Odoo forbids connecting as `postgres`, so you need to
create a new PostgreSQL user:
.. code-block:: console
$ sudo -u postgres createuser -s $USER
$ createdb $USER
.. note:: Because your PostgreSQL user has the same name as your Unix login, you will be able to
connect to the database without password.
Dependencies
^^^^^^^^^^^^
For libraries using native code, it is necessary to install development tools and native
dependencies before the Python dependencies of Odoo. They are available in `-dev` or `-devel`
packages for Python, PostgreSQL, libxml2, libxslt1, libevent, libsasl2 and libldap2.
On Debian/Unbuntu, the following command should install all the required libraries:
.. code-block:: console
$ sudo apt install python3-dev libxml2-dev libxslt1-dev libldap2-dev libsasl2-dev \
libtiff5-dev libjpeg8-dev libopenjp2-7-dev zlib1g-dev libfreetype6-dev \
liblcms2-dev libwebp-dev libharfbuzz-dev libfribidi-dev libxcb1-dev libpq-dev
Odoo dependencies are listed in the `requirements.txt` file located at the root of the Odoo
community directory.
.. tip:: It can be preferable to not mix python modules packages between different instances of Odoo
or with your system. You can use virtualenv_ to create isolated Python environments.
Navigate to the path of your Odoo Community installation (`CommunityPath`) and run **pip**
on the requirements file:
.. code-block:: console
$ cd /CommunityPath
$ pip3 install setuptools wheel
$ pip3 install -r requirements.txt
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
details on the various versions.
For languages with right-to-left interface (such as Arabic or Hebrew), the package `rtlcss` is
needed:
#. Download and install **nodejs** and **npm** with your package manager.
#. Install `rtlcss`:
.. code-block:: console
$ sudo npm install -g rtlcss
Running Odoo
''''''''''''
Once all dependencies are set up, Odoo can be launched by running `odoo-bin`, the
command-line interface of the server. It is located at the root of the Odoo Community directory.
To configure the server, you can either specify :ref:`command-line arguments <reference/cmdline/server>` or a
:ref:`configuration file <reference/cmdline/config>`.
.. tip:: For the Enterprise edition, you must add the path to the `enterprise` addons to the
`addons-path` argument. Note that it must come before the other paths in `addons-path` for
addons to be loaded correctly.
Common necessary configurations are:
* PostgreSQL user and password. Odoo has no defaults beyond
`psycopg2's defaults <http://initd.org/psycopg/docs/module.html>`_: connects over a UNIX socket on
port `5432` with the current user and no password.
* Custom addon paths beyond the defaults, to load your own modules.
A typical way to run the server would be:
.. code-block:: console
$ cd /CommunityPath
$ python3 odoo-bin --addons-path=addons -d mydb
Where `CommunityPath` is the path of the Odoo Community installation
and `mydb` is the default database to serve on `localhost:8069`. You can add other
directory paths separated by a comma to ``addons`` at the end of the addons-path option.
Mac OS
------
Fetch the sources
'''''''''''''''''
There are two ways to obtain the source code of Odoo: as a zip **archive** or through **git**.
Archive
^^^^^^^
Community Edition:
* `Official download page <download_>`_
* `GitHub repository <community-repository_>`_
* `Nightly server <nightly_>`_
Enterprise Edition:
* `Official download page <download_>`_
* `GitHub repository <enterprise-repository_>`_
Git
^^^
The following requires git_ to be installed on your machine and that you have basic knowledge of
git commands.
Community Edition:
.. code-block:: console
$ git clone https://github.com/odoo/odoo.git
Enterprise Edition: (see :ref:`setup/install/editions` to get access)
.. code-block:: console
$ git clone https://github.com/odoo/enterprise.git
.. note:: **The Enterprise git repository does not contain the full Odoo source code**. It is only
a collection of extra add-ons. The main server code is in the Community version. Running
the Enterprise version actually means running the server from the Community version with
the addons-path option set to the folder with the Enterprise version. You need to clone
both the Community and Enterprise repository to have a working Odoo Enterprise
installation.
Prepare
'''''''
Python
^^^^^^
Odoo requires Python 3.6 or later to run. Use your preferred package manager (homebrew_, macports_)
to download and install Python 3 on your machine if it is not already done.
.. note:: If Python 3 is already installed, make sure that the version is 3.6 or above, as previous
versions are not compatible with Odoo.
.. code-block:: console
$ python3 --version
Verify also that pip_ is installed for this version.
.. code-block:: console
$ pip3 --version
PostgreSQL
^^^^^^^^^^
Odoo uses PostgreSQL as database management system. Use `postgres.app <https://postgresapp.com>`_
to download and install PostgreSQL (supported version: 10.0 and later).
By default, the only user is `postgres` but Odoo forbids connecting as `postgres`, so you need to
create a new PostgreSQL user:
.. code-block:: console
$ sudo -u postgres createuser -s $USER
$ createdb $USER
.. note:: Because your PostgreSQL user has the same name as your Unix login, you will be able to
connect to the database without password.
Dependencies
^^^^^^^^^^^^
Odoo dependencies are listed in the `requirements.txt` file located at the root of the Odoo
community directory.
.. tip:: It can be preferable to not mix python modules packages between different instances of Odoo
or with your system. You can use virtualenv_ to create isolated Python environments.
Navigate to the path of your Odoo Community installation (`CommunityPath`) and run **pip**
on the requirements file:
.. code-block:: console
$ cd /CommunityPath
$ pip3 install setuptools wheel
$ pip3 install -r requirements.txt
.. warning:: Non-Python dependencies need to be installed with a package manager:
#. Download and install the **Command Line Tools**:
.. code-block:: console
$ xcode-select --install
#. Download and install the package manager of your choice (homebrew_, macports_).
#. Install non-python dependencies.
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
details on the various versions.
For languages with right-to-left interface (such as Arabic or Hebrew), the package `rtlcss` is
needed:
#. Download and install **nodejs** with your preferred package manager (homebrew_, macports_).
#. Install `rtlcss`:
.. code-block:: console
$ sudo npm install -g rtlcss
Running Odoo
''''''''''''
Once all dependencies are set up, Odoo can be launched by running `odoo-bin`, the
command-line interface of the server. It is located at the root of the Odoo Community directory.
To configure the server, you can either specify :ref:`command-line arguments <reference/cmdline/server>` or a
:ref:`configuration file <reference/cmdline/config>`.
.. tip:: For the Enterprise edition, you must add the path to the `enterprise` addons to the
`addons-path` argument. Note that it must come before the other paths in `addons-path` for
addons to be loaded correctly.
Common necessary configurations are:
* PostgreSQL user and password. Odoo has no defaults beyond
`psycopg2's defaults <http://initd.org/psycopg/docs/module.html>`_: connects over a UNIX socket on
port `5432` with the current user and no password.
* Custom addon paths beyond the defaults, to load your own modules.
A typical way to run the server would be:
.. code-block:: console
$ cd /CommunityPath
$ python3 odoo-bin --addons-path=addons -d mydb
Where `CommunityPath` is the path of the Odoo Community installation
and `mydb` is the default database to serve on `localhost:8069`. You can add other
directory paths separated by a comma to ``addons`` at the end of the addons-path option.
.. _setup/install/docker:
Docker
======
The full documentation on how to use Odoo with Docker can be found on the
official Odoo `docker image <https://registry.hub.docker.com/_/odoo/>`_ page.
.. _Debian Buster: https://www.debian.org/releases/buster/
.. _demo: https://demo.odoo.com
.. _docker: https://www.docker.com
.. _download: https://www.odoo.com/page/download
.. _Ubuntu 18.04: http://releases.ubuntu.com/18.04/
.. _EPEL: https://fedoraproject.org/wiki/EPEL
.. _PostgreSQL: http://www.postgresql.org
.. _the official installer:
.. _install pip:
https://pip.pypa.io/en/latest/installing.html#install-pip
.. _Quilt: http://en.wikipedia.org/wiki/Quilt_(software)
.. _saas: https://www.odoo.com/page/start
.. _the wkhtmltopdf download page: https://github.com/wkhtmltopdf/wkhtmltopdf/releases/tag/0.12.5
.. _UAC: http://en.wikipedia.org/wiki/User_Account_Control
.. _wkhtmltopdf: http://wkhtmltopdf.org
.. _pip: https://pip.pypa.io
.. _macports: https://www.macports.org
.. _homebrew: http://brew.sh
.. _wheels: https://wheel.readthedocs.org/en/latest/
.. _virtualenv: https://pypi.python.org/pypi/virtualenv
.. _virtualenvwrapper: https://virtualenvwrapper.readthedocs.io/en/latest/
.. _pywin32: http://sourceforge.net/projects/pywin32/files/pywin32/
.. _community-repository: https://github.com/odoo/odoo
.. _enterprise-repository: https://github.com/odoo/enterprise
.. _git: https://git-scm.com/
.. _Editions: https://www.odoo.com/pricing#pricing_table_features
.. _nightly: https://nightly.odoo.com/
.. _extra: https://nightly.odoo.com/extra/

View File

@ -0,0 +1,14 @@
:nosearch:
========
Maintain
========
.. toctree::
maintain/update
maintain/db_upgrade
maintain/enterprise
maintain/hosting_changes
maintain/db_premise
maintain/supported_versions

View File

@ -6,9 +6,9 @@
.. _db-upgrade:
=======
Upgrade
=======
================
Versions upgrade
================
.. _db-upgrade/overview:
@ -20,8 +20,7 @@ Overview
The upgrade process
-------------------
This documentation is for our *On-Premise* (self-hosted) and *Odoo.sh* customers. If you are hosted
Online, please check our :ref:`instruction page for our Online (SaaS) customers <upgrade_button>`.
This documentation is for our *On-Premise* (self-hosted) and *Odoo.sh* customers.
.. _db-upgrade/definition:
@ -109,8 +108,7 @@ The upgrade process varies depending on where your database is hosted.
Online (SaaS)
-------------
If you are hosted Online, please check our :ref:`instruction page for our Online (SaaS) customers
<upgrade_button>`.
If you are hosted Online, please check your `database manager <https://www.odoo.com/my/databases>`_.
.. _db-upgrade/odoo-sh:
@ -118,7 +116,7 @@ Odoo.sh
-------
If you are Odoo.sh hosted, check our :doc:`specific instructions to be able to upgrade
<odoo_sh/advanced/upgrade_your_database>`.
<../odoo_sh/advanced/upgrade_your_database>`.
.. _db-upgrade/on-premise:
@ -351,7 +349,7 @@ for the production request.
Upgrade of the custom modules
-----------------------------
As stated in our :doc:`../legal/terms/enterprise`, section :ref:`charges_standard`, this optional
As stated in our :doc:`/legal/terms/enterprise`, section :ref:`charges_standard`, this optional
service is subject to additional fees.
If you have a custom code, you can choose to have it upgraded by our services, by one of our
@ -376,7 +374,7 @@ Switching the hosting types (Self-hosted vs Online vs Odoo.sh)
An upgrade does not cover a change of `Hosting types <https://www.odoo.com/page/hosting-types>`_.
Open the following link to get :doc:`more information about how to change your hosting type
<db_management/hosting_changes>`.
<hosting_changes>`.
.. note:: |assistance-contact|
@ -412,4 +410,4 @@ This is a factor to take into consideration before upgrading. If you are on an o
suggest you to prefer the most recent version to benefit from a longer support (before having to
upgrade again).
You can get more information about our :doc:`supported versions <../services/support/supported_versions>`.
You can get more information about our :doc:`supported versions <supported_versions>`.

View File

@ -1,9 +1,9 @@
.. _setup/enterprise:
============================
From Community to Enterprise
============================
===============================
Upgrade Community to Enterprise
===============================
Depending on your current installation, there are multiple ways to upgrade
your community version.

View File

Before

Width:  |  Height:  |  Size: 6.9 KiB

After

Width:  |  Height:  |  Size: 6.9 KiB

View File

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 22 KiB

View File

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 12 KiB

View File

Before

Width:  |  Height:  |  Size: 27 KiB

After

Width:  |  Height:  |  Size: 27 KiB

View File

@ -1,9 +1,9 @@
.. _db_management/hosting_changes:
===============
Hosting Changes
===============
=======================
Change hosting solution
=======================
You may want to move your Odoo database from one hosting solution to another.
Depending on the platforms, you have to do it by yourself or contact our support team first.
@ -59,4 +59,3 @@ From Odoo.sh to on-premises
1. Grab a :ref:`backup of your Odoo.sh production database <odoo_sh_branches_backups>`.
2. Restore it from the database manager on your local server.

View File

Before

Width:  |  Height:  |  Size: 9.5 KiB

After

Width:  |  Height:  |  Size: 9.5 KiB

View File

Before

Width:  |  Height:  |  Size: 4.6 KiB

After

Width:  |  Height:  |  Size: 4.6 KiB

View File

Before

Width:  |  Height:  |  Size: 2.8 KiB

After

Width:  |  Height:  |  Size: 2.8 KiB

View File

Before

Width:  |  Height:  |  Size: 8.7 KiB

After

Width:  |  Height:  |  Size: 8.7 KiB

View File

Before

Width:  |  Height:  |  Size: 2.9 KiB

After

Width:  |  Height:  |  Size: 2.9 KiB

View File

Before

Width:  |  Height:  |  Size: 89 KiB

After

Width:  |  Height:  |  Size: 89 KiB

View File

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 17 KiB

View File

Before

Width:  |  Height:  |  Size: 6.9 KiB

After

Width:  |  Height:  |  Size: 6.9 KiB

View File

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 18 KiB

View File

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 14 KiB

View File

@ -82,4 +82,4 @@ OpenERP 7.0, 6.1, 6.0 and 5.0 is not supported anymore, on any platform.
TinyERP 4.0, 3.0, 2.0 and 1.0 is not supported anymore, on any platform.
You should consider `upgrading <https://upgrade.odoo.com/>`_ your database.
Even though we don't support older versions, you can always `upgrade from any version <https://upgrade.odoo.com/>`_.

View File

@ -1,9 +1,9 @@
.. _setup/update:
=============================
Updating an Odoo installation
=============================
==============
Bugfix updates
==============
Introduction
============
@ -147,4 +147,4 @@ Docker
------
Please refer to our `Docker image documentation <https://hub.docker.com/_/odoo/>`_ for
specific update instructions.
specific update instructions.

View File

@ -1,7 +1,7 @@
:nosearch:
=======
Odoo sh
Odoo.sh
=======

View File

@ -167,7 +167,7 @@ In the above commands, the argument:
* ``--stop-after-init`` will immediately shutdown the server instance after it completed the operations you asked.
More options are available and detailed in the
:doc:`CLI documentation </developer/reference/cmdline>`.
:doc:`CLI documentation </developer/misc/other/cmdline>`.
You can find in the logs (*~/logs/odoo.log*) the addons path used by Odoo.sh to run your server.
Look for "*odoo: addons paths*":

View File

@ -42,7 +42,7 @@ instance will be held temporarily unavailable for maintenance reason.
This method is equivalent to perform an upgrade of the module through the Apps menu,
or through the :code:`-u` switch of
:doc:`the command line </developer/reference/cmdline>`.
:doc:`the command line </developer/misc/other/cmdline>`.
In the case the changes in the commit prevent the server to restart,
or if the modules update fails,

View File

@ -79,7 +79,7 @@ Import your database
====================
You can import your database in your Odoo.sh project as long as it is in a :doc:`supported version
</services/support/supported_versions>` of Odoo.
</administration/maintain/supported_versions>` of Odoo.
Push your modules in production
-------------------------------

View File

@ -1,11 +1,18 @@
:nosearch:
:show-content:
:hide-page-toc:
:show-toc:
============
Applications
============
=========
User Docs
=========
Discover our user guides and configuration tutorials per application.
.. toctree::
:maxdepth: 2
applications/finance
applications/sales

View File

@ -1,9 +1,25 @@
:nosearch:
:show-content:
:hide-page-toc:
:show-toc:
========================
Accounting and Invoicing
========================
**Odoo Invoicing** is a standalone invoicing app to create invoices, send them to your customers,
and manage payments.
**Odoo Accounting** is a full featured accounting app. Accountant productivity is at the core of its
development with features such as AI-powered invoice recognition, synchronization with your bank
accounts, smart matching suggestions, etc.
.. seealso::
- `Odoo Tutorials: Invoicing <https://www.odoo.com/slides/invoicing-18>`_
- `Odoo Tutorials: Accounting <https://www.odoo.com/slides/accounting-19>`_
- :doc:`Accounting Cheat Sheet <accounting/getting_started/memento>`
.. toctree::
:titlesonly:
@ -15,155 +31,3 @@ Accounting and Invoicing
accounting/reporting
accounting/others
accounting/fiscal_localizations
**Odoo Invoicing** is a standalone invoicing app that allows you to :doc:`issue invoices
<accounting/receivables/customer_invoices/overview>`, send them to your customers, and manage
payments, including :doc:`online payments
<accounting/receivables/customer_payments/online_payment>`. It works as a "lighter" version of Odoo
Accounting, and you can upgrade it to Odoo Accounting if you need more advanced accounting features.
**Odoo Accounting** is a complete and strong accounting app. The automation of processes is at the
core of its development with its perfect integration with all Odoo apps and with features such as
:doc:`AI-powered invoice recognition <accounting/payables/supplier_bills/ocr>`,
:doc:`synchronization with your bank accounts <accounting/bank/feeds/bank_synchronization>`, and
:doc:`automatic suggestions for a simplified reconciliation process
<accounting/bank/reconciliation/reconciliation_models>`.
.. seealso::
- `Odoo Invoicing: product page <https://www.odoo.com/app/invoicing>`_
- `Odoo Accounting: product page <https://www.odoo.com/app/accounting>`_
Double-entry bookkeeping
========================
Odoo automatically creates all the behind-the-scenes journal entries
for each of your accounting transactions: customer invoices, point of
sale order, expenses, inventory moves, etc.
Odoo uses the rules of double-entry bookkeeping system: all journal
entries are automatically balanced (sum of debits = sum of credits).
.. seealso::
- :doc:`Understand Odoo's accounting transactions per document
<accounting/getting_started/memento>`
Accrual and Cash Basis Methods
==============================
Odoo supports both accrual and cash basis reporting. This allows you to
report income / expense at the time transactions occur (i.e., accrual basis), or when
payment is made or received (i.e., cash basis).
Multi-companies
===============
Odoo allows one to manage several companies within the same database. Each
company has its own chart of accounts and rules. You can get
consolidation reports following your consolidation rules.
Users can access several companies but always work in one company at a
time.
Multi-currencies
================
Every transaction is recorded in the default currency of the
company. For transactions occurring in another currency, Odoo stores
both the value in the currency of the company and the value in the
currency of the transaction. Odoo can generate currencies gains and
losses after the reconciliation of the journal items.
Currency rates are updated once a day using a yahoo.com online
web-service.
International Standards
=======================
Odoo accounting supports more than 50 countries. The Odoo core
accounting implements accounting standards that are common to all
countries. Specific modules exist per country for the
specificities of the country like the chart of accounts, taxes, or
bank interfaces.
In particular, Odoo's core accounting engine supports:
* Anglo-Saxon Accounting (U.S., U.K.,, and other English-speaking
countries including Ireland, Canada, Australia, and New Zealand)
where costs of good sold are reported when products are
sold/delivered.
* European accounting where expenses are accounted at the supplier
bill.
Odoo has modules to comply with IFRS rules.
Accounts Receivable and Payable
===============================
By default, Odoo uses a single account for all account
receivable entries and one for all accounts payable entries. You can
create separate accounts per customers/suppliers, but you don't need
to.
As transactions are associated to customers or suppliers, you get
reports to perform analysis per customer/supplier such as the customer
statement, revenues per customers, aged receivable/payables, ...
Wide range of financial reports
===============================
In Odoo, you can generate financial reports in real time. Odoo's
reports range from basic accounting reports to advanced management
reports. Odoo's reports include:
* Performance reports (such as Profit and Loss, Budget Variance)
* Position reports (such as Balance Sheet, Aged Payables, Aged
Receivables)
* Cash reports (such as Bank Summary)
* Detail reports (such as Trial Balance and General Ledger)
* Management reports (such as Budgets, Executive Summary)
Odoo's report engine allows you to customize your own report based on
your own formulae.
Import bank feeds automatically
===============================
Bank reconciliation is a process that matches your bank statement
lines, as supplied by the bank, to your accounting transactions in the
general ledger. Odoo makes bank reconciliation easy by frequently
importing bank statement lines from your bank directly into your Odoo
account. This means you can have a daily view of your cashflow without
having to log into your online banking or wait for your paper bank
statements.
Odoo speeds up bank reconciliation by matching most of your imported
bank statement lines to your accounting transactions. Odoo also
remembers how you've treated other bank statement lines and provides
suggested general ledger transactions.
Calculate the tax you owe your tax authority
============================================
Odoo totals all your accounting transactions for your tax period and
uses these totals to calculate your tax obligation. You can then check
your sales tax by running Odoo's Tax Report.
Inventory Valuation
===================
Odoo support both periodic (manual) and perpetual (automated)
inventory valuations. The available methods are standard price,
average price, LIFO (for countries allowing it) and FIFO.
.. seealso::
- :doc:`View impact of the valuation method on your transactions
<../inventory_and_mrp/inventory/management/reporting/inventory_valuation_config>`
Easy retained earnings
======================
Retained earnings are the portion of income retained by your
business. Odoo automatically calculates your current year earnings in
real time so no year-end journal or rollover is required. This is
calculated by reporting the profit and loss balance to your balance
sheet report automatically.

View File

@ -2,44 +2,44 @@
France
======
FEC
FEC
===
If you have installed the French Accounting, you will be able to download the FEC.
For this, go in :menuselection:`Accounting --> Reporting --> France --> FEC`.
For this, go in :menuselection:`Accounting --> Reporting --> France --> FEC`.
.. tip::
If you do not see the submenu **FEC**, go in **Apps** and search for the module
called **France-FEC** and verify if it is well installed.
called **France-FEC** and verify if it is well installed.
French Accounting Reports
=========================
If you have installed the French Accounting, you will have access to some accounting reports specific to France:
If you have installed the French Accounting, you will have access to some accounting reports specific to France:
- Bilan comptable
- Compte de résultats
- Plan de Taxes France
- Plan de Taxes France
Get the VAT anti-fraud certification with Odoo
==============================================
As of January 1st 2018, a new anti-fraud legislation comes into effect
in France and DOM-TOM. This new legislation stipulates certain criteria
concerning the inalterability, security, storage and archiving of sales data.
These legal requirements are implemented in Odoo, version 9 onward,
As of January 1st 2018, a new anti-fraud legislation comes into effect
in France and DOM-TOM. This new legislation stipulates certain criteria
concerning the inalterability, security, storage and archiving of sales data.
These legal requirements are implemented in Odoo, version 9 onward,
through a module and a certificate of conformity to download.
Is my company required to use an anti-fraud software?
-----------------------------------------------------
Your company is required to use an anti-fraud cash register software like
Your company is required to use an anti-fraud cash register software like
Odoo (CGI art. 286, I. 3° bis) if:
* You are taxable (not VAT exempt) in France or any DOM-TOM,
* Some of your customers are private individuals (B2C).
This rule applies to any company size. Auto-entrepreneurs are exempted from
This rule applies to any company size. Auto-entrepreneurs are exempted from
VAT and therefore are not affected.
Get certified with Odoo
@ -47,13 +47,12 @@ Get certified with Odoo
Getting compliant with Odoo is very easy.
Your company is requested by the tax administration to deliver a certificate
Your company is requested by the tax administration to deliver a certificate
of conformity testifying that your software complies with the anti-fraud
legislation. This certificate is granted by Odoo SA to Odoo Enterprise users
legislation. This certificate is granted by Odoo SA to Odoo Enterprise users
`here <https://www.odoo.com/my/contract/french-certification/>`_.
If you use Odoo Community, you should
:doc:`upgrade to Odoo Enterprise </administration/enterprise>`
or contact your Odoo service provider.
If you use Odoo Community, you should :doc:`upgrade to Odoo Enterprise
</administration/maintain/enterprise>` or contact your Odoo service provider.
In case of non-conformity, your company risks a fine of €7,500.
@ -89,52 +88,52 @@ Anti-fraud features
The anti-fraud module introduces the following features:
* **Inalterability**: deactivation of all the ways to cancel or modify
* **Inalterability**: deactivation of all the ways to cancel or modify
key data of POS orders, invoices and journal entries;
* **Security**: chaining algorithm to verify the inalterability;
* **Storage**: automatic sales closings with computation of both period
* **Storage**: automatic sales closings with computation of both period
and cumulative totals (daily, monthly, annually).
Inalterability
~~~~~~~~~~~~~~
All the possible ways to cancel and modify key data of paid POS orders,
confirmed invoices and journal entries are deactivated,
if the company is located in France or in any DOM-TOM.
All the possible ways to cancel and modify key data of paid POS orders,
confirmed invoices and journal entries are deactivated,
if the company is located in France or in any DOM-TOM.
.. note:: If you run a multi-companies environment, only the documents of
.. note:: If you run a multi-companies environment, only the documents of
such companies are impacted.
Security
~~~~~~~~
To ensure the inalterability, every order or journal entry is encrypted
upon validation.
This number (or hash) is calculated from the key data of the document as
To ensure the inalterability, every order or journal entry is encrypted
upon validation.
This number (or hash) is calculated from the key data of the document as
well as from the hash of the precedent documents.
The module introduces an interface to test the data inalterability.
If any information is modified on a document after its validation,
the test will fail. The algorithm recomputes all the hashes and compares them
against the initial ones. In case of failure, the system points out the first
The module introduces an interface to test the data inalterability.
If any information is modified on a document after its validation,
the test will fail. The algorithm recomputes all the hashes and compares them
against the initial ones. In case of failure, the system points out the first
corrupted document recorded in the system.
Users with *Manager* access rights can launch the inalterability check.
For POS orders, go to
:menuselection:`Point of Sales --> Reporting --> French Statements`.
For invoices or journal entries,
Users with *Manager* access rights can launch the inalterability check.
For POS orders, go to
:menuselection:`Point of Sales --> Reporting --> French Statements`.
For invoices or journal entries,
go to :menuselection:`Invoicing/Accounting --> Reporting --> French Statements`.
Storage
~~~~~~~
The system also processes automatic sales closings on a daily, monthly
The system also processes automatic sales closings on a daily, monthly
and annual basis.
Such closings distinctly compute the sales total of the period as well as
the cumulative grand totals from the very first sales entry recorded
Such closings distinctly compute the sales total of the period as well as
the cumulative grand totals from the very first sales entry recorded
in the system.
Closings can be found in the *French Statements* menu of Point of Sale,
Closings can be found in the *French Statements* menu of Point of Sale,
Invoicing and Accounting apps.
.. note::
@ -142,15 +141,15 @@ Invoicing and Accounting apps.
* For multi-companies environments, such closings are performed by company.
* POS orders are posted as journal entries at the closing of the POS session.
Closing a POS session can be done anytime.
To prompt users to do it on a daily basis, the module prevents from resuming
a session opened more than 24 hours ago.
* POS orders are posted as journal entries at the closing of the POS session.
Closing a POS session can be done anytime.
To prompt users to do it on a daily basis, the module prevents from resuming
a session opened more than 24 hours ago.
Such a session must be closed before selling again.
* A periods total is computed from all the journal entries posted after the
previous closing of the same type, regardless of their posting date.
If you record a new sales transaction for a period already closed,
* A periods total is computed from all the journal entries posted after the
previous closing of the same type, regardless of their posting date.
If you record a new sales transaction for a period already closed,
it will be counted in the very next closing.
.. tip:: For test & audit purposes such closings can be manually generated in the
@ -161,14 +160,14 @@ Invoicing and Accounting apps.
Responsibilities
----------------
Do not uninstall the module! If you do so, the hashes will be reset and none
Do not uninstall the module! If you do so, the hashes will be reset and none
of your past data will be longer guaranteed as being inalterable.
Users remain responsible for their Odoo instance and must use it with
due diligence. It is not permitted to modify the source code which guarantees
Users remain responsible for their Odoo instance and must use it with
due diligence. It is not permitted to modify the source code which guarantees
the inalterability of data.
Odoo absolves itself of all and any responsibility in case of changes
Odoo absolves itself of all and any responsibility in case of changes
in the modules functions caused by 3rd party applications not certified by Odoo.

View File

@ -7,6 +7,7 @@ Getting Started
.. toctree::
:titlesonly:
getting_started/main_concept
getting_started/memento
getting_started/initial_configuration
getting_started/process_overview

View File

@ -0,0 +1,138 @@
========================
Main accounting concepts
========================
Double-entry bookkeeping
========================
Odoo automatically creates all the behind-the-scenes journal entries
for each of your accounting transactions: customer invoices, point of
sale order, expenses, inventory moves, etc.
Odoo uses the rules of double-entry bookkeeping system: all journal
entries are automatically balanced (sum of debits = sum of credits).
.. seealso::
- :doc:`Understand Odoo's accounting transactions per document
<memento>`
Accrual and Cash Basis Methods
==============================
Odoo supports both accrual and cash basis reporting. This allows you to
report income / expense at the time transactions occur (i.e., accrual basis), or when
payment is made or received (i.e., cash basis).
Multi-companies
===============
Odoo allows one to manage several companies within the same database. Each
company has its own chart of accounts and rules. You can get
consolidation reports following your consolidation rules.
Users can access several companies but always work in one company at a
time.
Multi-currencies
================
Every transaction is recorded in the default currency of the
company. For transactions occurring in another currency, Odoo stores
both the value in the currency of the company and the value in the
currency of the transaction. Odoo can generate currencies gains and
losses after the reconciliation of the journal items.
Currency rates are updated once a day using a yahoo.com online
web-service.
International Standards
=======================
Odoo accounting supports more than 50 countries. The Odoo core
accounting implements accounting standards that are common to all
countries. Specific modules exist per country for the
specificities of the country like the chart of accounts, taxes, or
bank interfaces.
In particular, Odoo's core accounting engine supports:
* Anglo-Saxon Accounting (U.S., U.K.,, and other English-speaking
countries including Ireland, Canada, Australia, and New Zealand)
where costs of good sold are reported when products are
sold/delivered.
* European accounting where expenses are accounted at the supplier
bill.
Odoo has modules to comply with IFRS rules.
Accounts Receivable and Payable
===============================
By default, Odoo uses a single account for all account
receivable entries and one for all accounts payable entries. You can
create separate accounts per customers/suppliers, but you don't need
to.
As transactions are associated to customers or suppliers, you get
reports to perform analysis per customer/supplier such as the customer
statement, revenues per customers, aged receivable/payables, ...
Wide range of financial reports
===============================
In Odoo, you can generate financial reports in real time. Odoo's
reports range from basic accounting reports to advanced management
reports. Odoo's reports include:
* Performance reports (such as Profit and Loss, Budget Variance)
* Position reports (such as Balance Sheet, Aged Payables, Aged
Receivables)
* Cash reports (such as Bank Summary)
* Detail reports (such as Trial Balance and General Ledger)
* Management reports (such as Budgets, Executive Summary)
Odoo's report engine allows you to customize your own report based on
your own formulae.
Import bank feeds automatically
===============================
Bank reconciliation is a process that matches your bank statement
lines, as supplied by the bank, to your accounting transactions in the
general ledger. Odoo makes bank reconciliation easy by frequently
importing bank statement lines from your bank directly into your Odoo
account. This means you can have a daily view of your cashflow without
having to log into your online banking or wait for your paper bank
statements.
Odoo speeds up bank reconciliation by matching most of your imported
bank statement lines to your accounting transactions. Odoo also
remembers how you've treated other bank statement lines and provides
suggested general ledger transactions.
Calculate the tax you owe your tax authority
============================================
Odoo totals all your accounting transactions for your tax period and
uses these totals to calculate your tax obligation. You can then check
your sales tax by running Odoo's Tax Report.
Inventory Valuation
===================
Odoo support both periodic (manual) and perpetual (automated)
inventory valuations. The available methods are standard price,
average price, LIFO (for countries allowing it) and FIFO.
.. seealso::
- :doc:`View impact of the valuation method on your transactions
</applications/inventory_and_mrp/inventory/management/reporting/inventory_valuation_config>`
Easy retained earnings
======================
Retained earnings are the portion of income retained by your
business. Odoo automatically calculates your current year earnings in
real time so no year-end journal or rollover is required. This is
calculated by reporting the profit and loss balance to your balance
sheet report automatically.

View File

@ -2,9 +2,9 @@
:custom-css: accounting.css
:custom-js: accounts.js,chart-of-accounts.js,entries.js,misc.js,reconciliation.js
==============================================
Accounting Memento For Entrepreneurs (US GAAP)
==============================================
======================
Accounting cheat sheet
======================
.. h:div:: intro-list

View File

@ -1,6 +1,6 @@
=================================
Overview of the invoicing process
=================================
===================
Invoicing processes
===================
Depending on your business and the application you use, there are
different ways to automate the customer invoice creation in Odoo.

View File

@ -1,184 +1,15 @@
:show-content:
=======
General
=======
=============
Miscellaneous
=============
.. toctree::
general/users
general/export_import_data
general/multi_companies
general/auth
general/apps_modules
general/export_import_data
general/payment_acquirers
general/voip
general/calendars
general/in_app_purchase
general/unsplash
**Odoo** is a suite of open source business apps that cover all your company needs: :doc:`CRM
<sales/crm>`, :doc:`eCommerce <websites/ecommerce>`, :doc:`accounting <finance/accounting>`,
:doc:`inventory <inventory_and_mrp/inventory>`, :doc:`point of sale <sales/point_of_sale>`,
:doc:`project management <services/project>`, etc. Its unique value proposition is to be at the same
time *very easy* to use and *fully integrated*.
This section of the documentation covers all functional aspects that aren't app-specific. You can
find, for example, information about:
- :doc:`general/users` and :doc:`general/users/access_rights`, to configure each user correctly.
- :doc:`general/export_import_data`, to transfer data from and to other environments than Odoo or
update data.
- :doc:`general/payment_acquirers`, to allow your customers to pay with their favorite payment
method.
- :doc:`general/auth/google`, as an authentication method.
.. important::
- | **Installing or uninstalling apps, managing users, etc., is up to you.**
| As the administrator of your database, you are responsible for its usage, as you know best
how your organization works. This includes the installation or uninstallation of :ref:`apps
<general/apps-modules>` as well as the number of :doc:`users <general/users>` currently in
use.
- | **Odoo apps have dependencies.**
| Installing some apps and features with dependencies may also install additional apps and
modules that are technically required, even if you won't actively use them.
- | **Always test app installation/removal on a duplicate of your database.**
| This way, you can know what app dependencies may be required or what data may be erased.
.. seealso::
- :ref:`Online Database management: Duplicate a database <duplicate_online>`
- :ref:`On-premises Database management: Duplicate a database <duplicate_premise>`
- `Submit a Support Ticket <https://www.odoo.com/help>`_
.. _general/apps-modules:
Apps and modules
================
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*.
.. _general/uninstall:
Uninstall apps and modules
--------------------------
Go to :menuselection:`Apps`, click on the *dropdown menu* of the app you want to uninstall, then on
*Uninstall*.
.. image:: general/uninstall.png
:align: center
Some apps have dependencies, meaning that one app requires another. Therefore, uninstalling one app
may uninstall multiple apps and modules. Odoo warns you which dependant apps and modules are
affected by it.
.. image:: general/uninstall_deps.png
:align: center
To complete the uninstallation, click on *Confirm*.
.. danger::
Uninstalling an app also uninstalls all its dependencies and permanently erases their data.
.. _developer-mode:
Activate the developer mode (debug mode)
========================================
The developer mode (or debug mode) gives you access to extra and advanced tools.
Through the Settings
--------------------
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 odoos debug icon in a chromes 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)`
and make sure that **Push Notifications** is checked.
general/developer_mode

View File

@ -0,0 +1,76 @@
================
Apps and modules
================
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, click on
*Filters* and select *Extra*.
.. image:: 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.
- | **Installing or uninstalling apps and managing users is up to you.**
| As the administrator of your database, you are responsible for its usage, as you know best
how your organization works.
- | **Odoo apps have dependencies.**
| Installing some apps and features with dependencies may also install additional apps and
modules that are technically required, even if you won't actively use them.
- | **Test app installation/removal on a duplicate of your database.**
| This way, you can know what app dependencies may be required or what data may be erased.
.. _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
</administration/maintain/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*.
.. _general/uninstall:
Uninstall apps and modules
==========================
Go to :menuselection:`Apps`, click on the *dropdown menu* of the app you want to uninstall, then on
*Uninstall*.
.. image:: uninstall.png
:align: center
Some apps have dependencies, meaning that one app requires another. Therefore, uninstalling one app
may uninstall multiple apps and modules. Odoo warns you which dependant apps and modules are
affected by it.
.. image:: uninstall_deps.png
:align: center
To complete the uninstallation, click on *Confirm*.
.. danger::
Uninstalling an app also uninstalls all its dependencies and permanently erases their data.

View File

@ -8,7 +8,6 @@ Authentication
:titlesonly:
auth/google
auth/google_spreadsheets
auth/azure
auth/ldap
auth/2fa

View File

@ -1,6 +1,6 @@
=======================================
How to allow users to sign in with LDAP
=======================================
=================
Sign in with LDAP
=================
- Install the LDAP module in General Settings.

View File

@ -0,0 +1,57 @@
.. _developer-mode:
===========================
Developer Mode (debug mode)
===========================
The developer mode (or debug mode) gives you access to extra and advanced tools.
Activate through the Settings
=============================
Go to :menuselection:`Settings --> Activate the developer mode`.
.. image:: 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.
Activate 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:: monkey.png
:align: center
:alt: View of odoos debug icon in a chromes toolbar
Activate through the URL
========================
In the URL add ``?debug=1`` or ``?debug=true`` after *web*.
.. image:: 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:: button_location.png
:align: center
:alt: Overview of a console page and the debug icon being shown in Odoo

View File

@ -68,4 +68,4 @@ Offering my own services
I am more than welcome to offer my own IAP services through Odoo Apps! It is the perfect opportunity
to get recurring revenue for an ongoing service use rather than — and possibly instead of — a sole
initial purchase. Please, find more information at: :doc:`In-App Purchase
</developer/webservices/iap>`.
</developer/misc/api/iap>`.

View File

@ -1,161 +1,20 @@
:show-content:
:nosearch:
:hide-page-toc:
:show-toc:
==============
Users settings
==============
.. toctree::
:titlesonly:
users/language
users/access_rights
=================
Users & Companies
=================
Odoo defines a *user* as someone who has access to a database to perform daily tasks. You can add as
many users as you need and, in order to restrict the type of information each user can access, rules
can be applied. Users and access rights can be added and changed at any point.
.. seealso::
- :doc:`users/language`
- :doc:`users/access_rights`
.. toctree::
:titlesonly:
.. _users/add-individual:
users/manage_users
users/language
users/access_rights
users/companies
Add individual users
====================
Go to :menuselection:`Settings --> Manage Users` and click on *Create*.
.. image:: users/manage-users.png
:align: center
:height: 280
:alt: View of the settings page emphasizing the manage users field in Odoo
| Fill in the form with the needed information. Under the tab
:doc:`Access Rights <users/access_rights>` choose the group within each application the user can
have access to.
| The list of applications shown is based on the applications installed on the database.
.. image:: users/new_user.png
:align: center
:alt: View of a users form emphasizing the access rights tab in Odoo
When you are done editing the page and have *Saved* it, an invitation email is automatically sent to
the user. The user must click on it to accept the invitation and create a login.
.. image:: users/invitation-email.png
:align: center
:alt: View of a users form with a notification that the invitation email has been sent in Odoo
.. note::
Remember that subscription prices follow the number of users. Refer to our
`pricing page <https://www.odoo.com/pricing>`_
for more information.
With the :ref:`developer mode <developer-mode>` activated, *User Types* can be selected.
.. image:: users/user-type.png
:align: center
:height: 300
:alt: View of a users form in developer mode emphasizing the user type field in Odoo
The *Portal* and *Public* options do not allow you to choose access rights. Members have specific
ones (such as record rules and restricted menus) and usually do not belong to the usual Odoo
groups.
.. _users/deactivate:
Deactivate Users
================
Go to :menuselection:`Settings --> Users & Companies --> Users`, open the user you want to
deactivate, click on *Action*, and then on *Archive*.
.. danger::
**Never** deactivate the main user (*admin*).
.. _users/passwords-management:
Passwords management
====================
.. _users/reset-password:
Reset passwords
---------------
.. _users/reset-password-login:
Enable password resets from login page
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
It is possible to enable password resets directly from the login page.
To do so, go to :menuselection:`Settings --> Permissions`, activate **Password Reset** and *Save*.
.. image:: users/password-reset-login.png
:align: center
:alt: Enabling Password Reset in Odoo Settings
.. _users/reset-password-email:
Send reset instructions to users
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Go to :menuselection:`Settings --> Users & Companies --> Users`, select the user out of the list and
click on *Send Password Reset Instructions* on its user form. An email is automatically sent to
them.
.. note::
The *Send Password Reset Instructions* button only appears if the Odoo invitation email has
already been confirmed by the user.
This email contains all the instructions needed to reset the password, along with a link redirecting
the user to an Odoo login page.
.. image:: users/password-email.png
:align: center
:alt: Example of an email with a password reset link for an Odoo account
.. _users/change-password:
Change users passwords
-----------------------
Go to :menuselection:`Settings --> Users & Companies --> Users` and select a user to access its
form. Click on the *Action* button and select *Change Password*.
.. image:: users/change-password.png
:align: center
:alt: Change another user's password on Odoo
Enter a new password and confirm by clicking on *Change Password*.
.. note::
This operation only modifies the password of the users locally and does not affect their odoo.com
account. If you want to change the odoo.com password, you can :ref:`send the password reset
instructions <users/reset-password-email>`.
Click on *Change Password* one more time. You are then redirected to an Odoo login page where you
can reaccess your database using your new password.
.. _users/multi-companies:
Multi Companies
===============
The *Multi Companies* field allows you to set to which of the multiple companies database you hold
the user can have access.
.. note::
Note that if not handled correctly, it may be the source of a lot of inconsistent multi-company
behaviors. Therefore, a good knowledge of Odoo is required. For technical explanations refer
to :doc:`this </developer/howtos/company>` documentation.
.. image:: users/multi-companies.png
:align: center
:height: 300
:alt: View of a users form emphasizing the multi companies field in Odoo
.. seealso::
- :doc:`multi_companies`
- :doc:`../general`

View File

@ -1,6 +1,6 @@
===============
Multi Companies
===============
=========
Companies
=========
A centralized management environment allows you to select multiple companies simultaneously and set
their specific warehouses, customers, equipment, and contacts. It provides you the ability to
@ -14,7 +14,7 @@ Go to :menuselection:`Settings --> Manage Companies` and fill in the form with y
information. If a *Parent Company* is selected, records are shared between the two companies (as
long as both environments are active).
.. image:: multi_companies/create_js_store_us.png
.. image:: companies/create_js_store_us.png
:align: center
:alt: Overview of a new company's form in Odoo
@ -23,7 +23,7 @@ long as both environments are active).
companies, and easily identify them by the browser tabs. Set your favicons files size to 16x16
or 32x32 pixels. JPG, PNG, GIF, and ICO are extensions accepted.
.. image:: multi_companies/favicon.png
.. image:: companies/favicon.png
:align: center
:height: 200
:alt: View of a web browser and the favicon for a specific company chosen in Odoo
@ -33,7 +33,7 @@ grayed company is the one which environment is in use. To switch environments, c
companys name. In the example below, the user has access to three companies, two are activated, and
the environment in use is of *JS Store US*.
.. image:: multi_companies/multi_companies_menu_dashboard.png
.. image:: companies/multi_companies_menu_dashboard.png
:align: center
:alt: View of the companies menu through the main dashboard in Odoo
@ -43,17 +43,17 @@ company only. To do so, on their forms, choose between:
- *A blank field*: the record is shared within all companies.
- *Adding a company*: the record is visible to users logged in to that specific company.
.. image:: multi_companies/product_form_company.png
.. image:: companies/product_form_company.png
:align: center
:alt: View of a product's form emphasizing the company field in Odoo Sales
Employees' access
=================
Once companies are created, manage your employees' :doc:`Access Rights <users/access_rights>` for
*Multi Companies*.
Once companies are created, manage your employees' :doc:`Access Rights <access_rights>`
for *Multi Companies*.
.. image:: multi_companies/access_rights_multi_companies.png
.. image:: companies/access_rights_multi_companies.png
:align: center
:alt: View of an user form emphasizing the multi companies field under the access rights tabs
in Odoo
@ -75,7 +75,7 @@ Documents format
To set documents' formats according to each company, *activate* and *select* the respective one and,
under *Settings*, click on *Configure Document Layout*.
.. image:: multi_companies/document_layout.png
.. image:: companies/document_layout.png
:align: center
:alt: View of the settings page emphasizing the document layout field in Odoo
@ -84,18 +84,20 @@ Inter-Company Transactions
First, make sure each one of your companies is properly set in relation to:
- :doc:`Chart of Accounts <../finance/accounting/getting_started/initial_configuration/chart_of_accounts>`
- :doc:`Taxes <../finance/accounting/taxation/taxes/default_taxes>`
- :doc:`Fiscal Positions <../finance/accounting/taxation/taxes/fiscal_positions>`
- :doc:`Journals <../finance/accounting/bank/setup/bank_accounts>`
- :doc:`Fiscal Localizations <../finance/accounting/fiscal_localizations/overview/fiscal_localization_packages>`
- :doc:`Pricelists <../sales/sales/products_prices/prices/pricing>`
- :doc:`Chart of Accounts
<../../finance/accounting/getting_started/initial_configuration/chart_of_accounts>`
- :doc:`Taxes <../../finance/accounting/taxation/taxes/default_taxes>`
- :doc:`Fiscal Positions <../../finance/accounting/taxation/taxes/fiscal_positions>`
- :doc:`Journals <../../finance/accounting/bank/setup/bank_accounts>`
- :doc:`Fiscal Localizations
<../../finance/accounting/fiscal_localizations/overview/fiscal_localization_packages>`
- :doc:`Pricelists <../../sales/sales/products_prices/prices/pricing>`
Now, activate the *Inter-Company Transactions* option under *Settings*. With the respective company
*activated* and *selected*, choose if you would like operations between companies to be synchronized
at an invoice/bills level or at a sales/purchase orders level.
.. image:: multi_companies/inter_company_transactions.png
.. image:: companies/inter_company_transactions.png
:align: center
:alt: View of the settings page emphasizing the inter company transaction field in Odoo
@ -105,7 +107,7 @@ at an invoice/bills level or at a sales/purchase orders level.
*Example:* an invoice posted on JS Store Belgium, for JS Store US, automatically creates a vendor
bill on the JS Store US, from the JS Store Belgium.
.. image:: multi_companies/invoice_inter_company.png
.. image:: companies/invoice_inter_company.png
:align: center
:alt: View of an invoice for JS Store US created on JS Store Belgium in Odoo
@ -117,7 +119,7 @@ at an invoice/bills level or at a sales/purchase orders level.
on JS Store Belgium is automatically created (and confirmed if the *Automatic Validation* feature
was enabled).
.. image:: multi_companies/purchase_order_inter_company.png
.. image:: companies/purchase_order_inter_company.png
:align: center
:alt: View of the purchase created on JS Store US from JS Store Belgium in Odoo
@ -129,5 +131,4 @@ at an invoice/bills level or at a sales/purchase orders level.
.. seealso::
- :doc:`Multi-company Guidelines </developer/howtos/company>`
- :doc:`../finance/accounting/others/multicurrencies/how_it_works`
- :doc:`../../finance/accounting/others/multicurrencies/how_it_works`

View File

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 23 KiB

View File

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 42 KiB

View File

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 21 KiB

View File

@ -0,0 +1,152 @@
============
Manage users
============
Odoo defines a **user** as someone who has access to a database to perform daily tasks. You can add
as many users as you need and, in order to restrict the type of information each user can access,
rules can be applied. Users and access rights can be added and changed at any point.
.. seealso::
- :doc:`language`
- :doc:`access_rights`
.. _users/add-individual:
Add individual users
====================
Go to :menuselection:`Settings --> Manage Users` and click on *Create*.
.. image:: manage_users/manage-users.png
:align: center
:height: 280
:alt: View of the settings page emphasizing the manage users field in Odoo
| Fill in the form with the needed information. Under the tab
:doc:`Access Rights <access_rights>` choose the group within each application the user can
have access to.
| The list of applications shown is based on the applications installed on the database.
.. image:: manage_users/new_user.png
:align: center
:alt: View of a users form emphasizing the access rights tab in Odoo
When you are done editing the page and have *Saved* it, an invitation email is automatically sent to
the user. The user must click on it to accept the invitation and create a login.
.. image:: manage_users/invitation-email.png
:align: center
:alt: View of a users form with a notification that the invitation email has been sent in Odoo
.. note::
Remember that subscription prices follow the number of users. Refer to our
`pricing page <https://www.odoo.com/pricing>`_
for more information.
With the :ref:`developer mode <developer-mode>` activated, *User Types* can be selected.
.. image:: manage_users/user-type.png
:align: center
:height: 300
:alt: View of a users form in developer mode emphasizing the user type field in Odoo
The *Portal* and *Public* options do not allow you to choose access rights. Members have specific
ones (such as record rules and restricted menus) and usually do not belong to the usual Odoo
groups.
.. _users/deactivate:
Deactivate users
================
Go to :menuselection:`Settings --> Users & Companies --> Users`, open the user you want to
deactivate, click on *Action*, and then on *Archive*.
.. danger::
**Never** deactivate the main user (*admin*).
.. _users/passwords-management:
Passwords management
====================
.. _users/reset-password:
Reset passwords
---------------
.. _users/reset-password-login:
Enable password resets from login page
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
It is possible to enable password resets directly from the login page.
To do so, go to :menuselection:`Settings --> Permissions`, activate **Password Reset** and *Save*.
.. image:: manage_users/password-reset-login.png
:align: center
:alt: Enabling Password Reset in Odoo Settings
.. _users/reset-password-email:
Send reset instructions to users
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Go to :menuselection:`Settings --> Users & Companies --> Users`, select the user out of the list and
click on *Send Password Reset Instructions* on its user form. An email is automatically sent to
them.
.. note::
The *Send Password Reset Instructions* button only appears if the Odoo invitation email has
already been confirmed by the user.
This email contains all the instructions needed to reset the password, along with a link redirecting
the user to an Odoo login page.
.. image:: manage_users/password-email.png
:align: center
:alt: Example of an email with a password reset link for an Odoo account
.. _users/change-password:
Change users passwords
-----------------------
Go to :menuselection:`Settings --> Users & Companies --> Users` and select a user to access its
form. Click on the *Action* button and select *Change Password*.
.. image:: manage_users/change-password.png
:align: center
:alt: Change another user's password on Odoo
Enter a new password and confirm by clicking on *Change Password*.
.. note::
This operation only modifies the password of the users locally and does not affect their odoo.com
account. If you want to change the odoo.com password, you can :ref:`send the password reset
instructions <users/reset-password-email>`.
Click on *Change Password* one more time. You are then redirected to an Odoo login page where you
can reaccess your database using your new password.
.. _users/multi-companies:
Multi Companies
===============
The *Multi Companies* field allows you to set to which of the multiple companies database you hold
the user can have access.
.. note::
Note that if not handled correctly, it may be the source of a lot of inconsistent multi-company
behaviors. Therefore, a good knowledge of Odoo is required. For technical explanations refer
to :doc:`this </developer/howtos/company>` documentation.
.. image:: manage_users/multi-companies.png
:align: center
:height: 300
:alt: View of a users form emphasizing the multi companies field in Odoo
.. seealso::
- :doc:`companies`

View File

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 18 KiB

View File

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 24 KiB

View File

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 22 KiB

View File

Before

Width:  |  Height:  |  Size: 29 KiB

After

Width:  |  Height:  |  Size: 29 KiB

View File

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 39 KiB

View File

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 19 KiB

View File

Before

Width:  |  Height:  |  Size: 25 KiB

After

Width:  |  Height:  |  Size: 25 KiB

View File

Before

Width:  |  Height:  |  Size: 37 KiB

After

Width:  |  Height:  |  Size: 37 KiB

View File

@ -1,13 +1,24 @@
:nosearch:
:show-content:
:hide-page-toc:
:show-toc:
=========
Inventory
=========
**Odoo Inventory** is both an inventory application and a warehouse management system, with an
advanced barcode scanner app. Learn how to manage lead times, automate replenishments, and configure
advanced routes like drop-shipping, cross-docks, etc.
.. seealso::
- `Odoo Tutorials: Inventory <https://www.odoo.com/slides/inventory-24>`_
- `Odoo Tutorials: Barcode Scanner <https://www.odoo.com/slides/barcode-30>`_
.. toctree::
:titlesonly:
inventory/management
inventory/shipping
inventory/routes
inventory/barcode
inventory/barcode

View File

@ -1,9 +1,21 @@
:nosearch:
:show-content:
:hide-page-toc:
:show-toc:
=============
Manufacturing
=============
**Odoo Manufacturing** helps you schedule, plan and process manufacturing orders. With the work
center control panel, put tablets on the shop floor to control all your work orders in real-time and
allow workers to trigger maintenance operations, feedback loops, quality issues, etc.
.. seealso::
- `Odoo Tutorials: MRP <https://www.odoo.com/slides/mrp-29>`_
- `Odoo Tutorials: Barcode Scanner <https://www.odoo.com/slides/barcode-30>`_
- :doc:`IoT Boxes (MES) </applications/productivity/iot>`
.. toctree::
:titlesonly:

View File

@ -1,9 +1,18 @@
:nosearch:
:show-content:
:hide-page-toc:
:show-toc:
========
Purchase
========
**Odoo Purchase** helps you keep track of purchase agreements, quotations, and purchase orders.
Learn how to keep track of purchase tender, automate replenishments and follow up on your orders.
.. seealso::
- `Odoo Tutorials: Purchase <https://www.odoo.com/slides/purchase-23>`_
.. toctree::
:titlesonly:

View File

@ -9,4 +9,4 @@ Marketing
marketing/marketing_automation
marketing/sms_marketing
marketing/survey
marketing/surveys

View File

@ -1,9 +1,15 @@
:nosearch:
:show-content:
:hide-page-toc:
:show-toc:
====================
Marketing Automation
====================
.. seealso::
- `Odoo Tutorials: Marketing <https://www.odoo.com/slides/marketing-27>`_
.. toctree::
:titlesonly:

View File

@ -1,10 +1,16 @@
:nosearch:
:show-content:
:hide-page-toc:
:show-toc:
=============
SMS Marketing
=============
.. seealso::
- `Odoo Tutorials: Marketing <https://www.odoo.com/slides/marketing-27>`_
.. toctree::
:titlesonly:
sms_marketing/pricing
sms_marketing/pricing

View File

@ -1,10 +0,0 @@
:nosearch:
======
Survey
======
.. toctree::
:titlesonly:
survey/overview

View File

@ -0,0 +1,16 @@
:nosearch:
:show-content:
:hide-page-toc:
:show-toc:
=======
Surveys
=======
.. seealso::
- `Odoo Tutorials: Surveys <https://www.odoo.com/slides/surveys-62>`_
.. toctree::
:titlesonly:
surveys/overview

Some files were not shown because too many files have changed in this diff Show More