[REF] install: move intro to main install page and split by install type
This PR moves the introduction about the different installation methods and editions found on the
install/install.rst page directly under the main install/ page. It creates three pages, one per
installation method documented on the install/install.rst page (Docker being documented on
docker.com and maintained by us), and moves the related content there. In addition, it fixes various
typos/grammar issues and improves the content according to the documentation guidelines. Various
references and links across the documentation had to be fixed accordingly.
task-3459070
closes odoo/documentation#5522
X-original-commit: b7d5d04229
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
This commit is contained in:
parent
83dcc39459
commit
c4c945e41c
@ -1,14 +1,49 @@
|
|||||||
:nosearch:
|
:show-content:
|
||||||
|
|
||||||
=======
|
=======
|
||||||
Install
|
Install
|
||||||
=======
|
=======
|
||||||
|
|
||||||
.. If you add content on this page, remove the redirect rule 'install -> install/install'
|
Depending on the intended use case, there are multiple ways to install Odoo - or not install it at
|
||||||
|
all.
|
||||||
|
|
||||||
|
- :doc:`Online <install/online>` is the easiest way to use Odoo in production or to try it.
|
||||||
|
|
||||||
|
- :doc:`Packaged installers <install/packages>` are suitable for testing Odoo and developing
|
||||||
|
modules. They can be used for long-term production with additional deployment and maintenance
|
||||||
|
work.
|
||||||
|
|
||||||
|
- :doc:`Source install <install/source>` provides greater flexibility, as it allows, for example,
|
||||||
|
running multiple Odoo versions on the same system. It is adequate to develop modules and can be
|
||||||
|
used as a base for production deployment.
|
||||||
|
|
||||||
|
- A `Docker <https://hub.docker.com/_/odoo/>`_ base image is available for development or
|
||||||
|
deployment.
|
||||||
|
|
||||||
|
.. _install/editions:
|
||||||
|
|
||||||
|
Editions
|
||||||
|
========
|
||||||
|
|
||||||
|
There are two different editions.
|
||||||
|
|
||||||
|
**Odoo Community** is the free and open-source version of the software, licensed under the `GNU
|
||||||
|
LGPLv3 <https://github.com/odoo/odoo/blob/master/LICENSE>`_. It is the core upon which Odoo
|
||||||
|
Enterprise is built.
|
||||||
|
|
||||||
|
**Odoo Enterprise** is the shared source version of the software, giving access to more
|
||||||
|
functionalities, including functional support, upgrades, and hosting. `Pricing
|
||||||
|
<https://www.odoo.com/pricing-plan>`_ starts from one app free.
|
||||||
|
|
||||||
|
.. tip::
|
||||||
|
:doc:`Switch from Community to Enterprise <maintain/enterprise>` at any time (except for the
|
||||||
|
source install).
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
|
||||||
install/install
|
install/online
|
||||||
install/deploy
|
install/packages
|
||||||
install/cdn
|
install/source
|
||||||
install/email_gateway
|
install/deploy
|
||||||
|
install/cdn
|
||||||
|
install/email_gateway
|
||||||
|
@ -3,7 +3,7 @@ System configuration
|
|||||||
====================
|
====================
|
||||||
|
|
||||||
This document describes basic steps to set up Odoo in production or on an
|
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
|
internet-facing server. It follows :doc:`installation <../install>`, and is
|
||||||
not generally necessary for a development systems that is not exposed on the
|
not generally necessary for a development systems that is not exposed on the
|
||||||
internet.
|
internet.
|
||||||
|
|
||||||
@ -123,7 +123,7 @@ Out of the box, Odoo connects to a local postgres over UNIX socket via port
|
|||||||
<reference/cmdline/server/database>` when your Postgres deployment is not
|
<reference/cmdline/server/database>` when your Postgres deployment is not
|
||||||
local and/or does not use the installation defaults.
|
local and/or does not use the installation defaults.
|
||||||
|
|
||||||
The :ref:`packaged installers <setup/install/packaged>` will automatically
|
The :doc:`packaged installers <packages>` will automatically
|
||||||
create a new user (``odoo``) and set it as the database user.
|
create a new user (``odoo``) and set it as the database user.
|
||||||
|
|
||||||
* The database management screens are protected by the ``admin_passwd``
|
* The database management screens are protected by the ``admin_passwd``
|
||||||
|
@ -1,876 +0,0 @@
|
|||||||
|
|
||||||
.. _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 `Odoo Online`_ 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.
|
|
||||||
|
|
||||||
Odoo Online
|
|
||||||
-----------
|
|
||||||
|
|
||||||
Trivial to start with, fully managed and migrated by Odoo S.A., `Odoo Online`_
|
|
||||||
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, `Odoo Online`_ 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 {CURRENT_MAJOR_VERSION} 'deb' package currently supports `Debian 11 (Bullseye)`_,
|
|
||||||
`Ubuntu 20.04 (Focal)`_ 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/{CURRENT_MAJOR_BRANCH}/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 {CURRENT_MAJOR_VERSION} 'rpm' package supports Fedora 34.
|
|
||||||
|
|
||||||
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/{CURRENT_MAJOR_BRANCH}/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_{CURRENT_MAJOR_BRANCH}.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.
|
|
||||||
|
|
||||||
It can be more convenient for module developers as the Odoo source is more easily accessible than
|
|
||||||
using packaged installation.
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
.. _setup/install/source/windows:
|
|
||||||
|
|
||||||
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_>`_
|
|
||||||
|
|
||||||
.. _setup/install/source/windows/git:
|
|
||||||
|
|
||||||
Git
|
|
||||||
***
|
|
||||||
|
|
||||||
The following requires `Git <git_>`_ to be installed on your machine and that you have basic
|
|
||||||
knowledge of Git commands. To clone a Git repository, you must choose between cloning with HTTPS or
|
|
||||||
SSH. If you do not know the difference between the two, the best option is most likely HTTPS. If you
|
|
||||||
are following the :doc:`Getting started </developer/tutorials/getting_started>` developer tutorial,
|
|
||||||
or plan on contributing to Odoo source code, choose SSH.
|
|
||||||
|
|
||||||
.. 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. See
|
|
||||||
:ref:`setup/install/editions` to get access to the Enterprise repository.
|
|
||||||
|
|
||||||
.. tabs::
|
|
||||||
|
|
||||||
.. tab:: Clone with HTTPS
|
|
||||||
|
|
||||||
.. code-block:: doscon
|
|
||||||
|
|
||||||
C:\> git clone https://github.com/odoo/odoo.git
|
|
||||||
C:\> git clone https://github.com/odoo/enterprise.git
|
|
||||||
|
|
||||||
.. tab:: Clone with SSH
|
|
||||||
|
|
||||||
.. code-block:: doscon
|
|
||||||
|
|
||||||
C:\> git clone git@github.com:odoo/odoo.git
|
|
||||||
C:\> git clone git@github.com:odoo/enterprise.git
|
|
||||||
|
|
||||||
.. _setup/install/source/windows/prepare:
|
|
||||||
|
|
||||||
Prepare
|
|
||||||
~~~~~~~
|
|
||||||
|
|
||||||
Python
|
|
||||||
******
|
|
||||||
|
|
||||||
Odoo requires Python 3.7 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.7 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\\`).
|
|
||||||
|
|
||||||
.. _setup/install/source/windows/running_odoo:
|
|
||||||
|
|
||||||
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 name of the PostgreSQL database.
|
|
||||||
|
|
||||||
After the server has started (the INFO log `odoo.modules.loading: Modules loaded.` is printed), open
|
|
||||||
http://localhost:8069 in your web browser and log in with the base administrator account: Use
|
|
||||||
`admin` for the :guilabel:`Email` and, again, `admin` for the :guilabel:`Password`. That's it, you
|
|
||||||
just logged into your own Odoo database!
|
|
||||||
|
|
||||||
.. tip::
|
|
||||||
- From there, you can create and manage new :doc:`users
|
|
||||||
</applications/general/users/manage_users>`.
|
|
||||||
- The user account you use to log into Odoo's web interface differs from the :option:`--db_user
|
|
||||||
<odoo-bin -r>` CLI argument.
|
|
||||||
|
|
||||||
.. seealso::
|
|
||||||
:doc:`The exhaustive list of CLI arguments for odoo-bin </developer/reference/cli>`.
|
|
||||||
|
|
||||||
.. _setup/install/source/linux:
|
|
||||||
|
|
||||||
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_>`_
|
|
||||||
|
|
||||||
.. _setup/install/source/linux/git:
|
|
||||||
|
|
||||||
Git
|
|
||||||
***
|
|
||||||
|
|
||||||
The following requires `Git <git_>`_ to be installed on your machine and that you have basic
|
|
||||||
knowledge of Git commands. To clone a Git repository, you must choose between cloning with HTTPS or
|
|
||||||
SSH. If you do not know the difference between the two, the best option is most likely HTTPS. If you
|
|
||||||
are following the :doc:`Getting started </developer/tutorials/getting_started>` developer tutorial,
|
|
||||||
or plan on contributing to Odoo source code, choose SSH.
|
|
||||||
|
|
||||||
.. 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. See
|
|
||||||
:ref:`setup/install/editions` to get access to the Enterprise repository.
|
|
||||||
|
|
||||||
.. tabs::
|
|
||||||
|
|
||||||
.. tab:: Clone with HTTPS
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
$ git clone https://github.com/odoo/odoo.git
|
|
||||||
$ git clone https://github.com/odoo/enterprise.git
|
|
||||||
|
|
||||||
.. tab:: Clone with SSH
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
$ git clone git@github.com:odoo/odoo.git
|
|
||||||
$ git clone git@github.com:odoo/enterprise.git
|
|
||||||
|
|
||||||
.. _setup/install/source/linux/prepare:
|
|
||||||
|
|
||||||
Prepare
|
|
||||||
~~~~~~~
|
|
||||||
|
|
||||||
Python
|
|
||||||
******
|
|
||||||
|
|
||||||
Odoo requires Python 3.7 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.7 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
|
|
||||||
|
|
||||||
.. _setup/install/source/linux/running_odoo:
|
|
||||||
|
|
||||||
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 name of the PostgreSQL database.
|
|
||||||
|
|
||||||
After the server has started (the INFO log `odoo.modules.loading: Modules loaded.` is printed), open
|
|
||||||
http://localhost:8069 in your web browser and log in with the base administrator account: Use
|
|
||||||
`admin` for the :guilabel:`Email` and, again, `admin` for the :guilabel:`Password`. That's it, you
|
|
||||||
just logged into your own Odoo database!
|
|
||||||
|
|
||||||
.. tip::
|
|
||||||
- From there, you can create and manage new :doc:`users
|
|
||||||
</applications/general/users/manage_users>`.
|
|
||||||
- The user account you use to log into Odoo's web interface differs from the :option:`--db_user
|
|
||||||
<odoo-bin -r>` CLI argument.
|
|
||||||
|
|
||||||
.. seealso::
|
|
||||||
:doc:`The exhaustive list of CLI arguments for odoo-bin </developer/reference/cli>`.
|
|
||||||
|
|
||||||
.. _setup/install/source/mac_os:
|
|
||||||
|
|
||||||
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_>`_
|
|
||||||
|
|
||||||
.. _setup/install/source/mac_os/git:
|
|
||||||
|
|
||||||
Git
|
|
||||||
***
|
|
||||||
|
|
||||||
The following requires `Git <git_>`_ to be installed on your machine and that you have basic
|
|
||||||
knowledge of Git commands. To clone a Git repository, you must choose between cloning with HTTPS or
|
|
||||||
SSH. If you do not know the difference between the two, the best option is most likely HTTPS. If you
|
|
||||||
are following the :doc:`Getting started </developer/tutorials/getting_started>` developer tutorial,
|
|
||||||
or plan on contributing to Odoo source code, choose SSH.
|
|
||||||
|
|
||||||
.. 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. See
|
|
||||||
:ref:`setup/install/editions` to get access to the Enterprise repository.
|
|
||||||
|
|
||||||
.. tabs::
|
|
||||||
|
|
||||||
.. tab:: Clone with HTTPS
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
$ git clone https://github.com/odoo/odoo.git
|
|
||||||
$ git clone https://github.com/odoo/enterprise.git
|
|
||||||
|
|
||||||
.. tab:: Clone with SSH
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
$ git clone git@github.com:odoo/odoo.git
|
|
||||||
$ git clone git@github.com:odoo/enterprise.git
|
|
||||||
|
|
||||||
.. _setup/install/source/mac_os/prepare:
|
|
||||||
|
|
||||||
Prepare
|
|
||||||
~~~~~~~
|
|
||||||
|
|
||||||
Python
|
|
||||||
******
|
|
||||||
|
|
||||||
Odoo requires Python 3.7 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.7 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).
|
|
||||||
|
|
||||||
.. tip::
|
|
||||||
To make the command line tools bundled with `postgres.app` available, make sure to setup your
|
|
||||||
`$PATH` variable by following the `Postgres.app CLI Tools Instructions
|
|
||||||
<https://postgresapp.com/documentation/cli-tools.html>`_.
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
.. _setup/install/source/mac_os/running_odoo:
|
|
||||||
|
|
||||||
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 name of the PostgreSQL database.
|
|
||||||
|
|
||||||
.. warning::
|
|
||||||
Some versions of python on Mac might lead to the following error message: `current limit exceeds
|
|
||||||
maximum limit`. In that case, add the following parameter `--limit-memory-hard 0` to avoid the
|
|
||||||
problem.
|
|
||||||
|
|
||||||
After the server has started (the INFO log `odoo.modules.loading: Modules loaded.` is printed), open
|
|
||||||
http://localhost:8069 in your web browser and log in with the base administrator account: Use
|
|
||||||
`admin` for the :guilabel:`Email` and, again, `admin` for the :guilabel:`Password`. That's it, you
|
|
||||||
just logged into your own Odoo database!
|
|
||||||
|
|
||||||
.. tip::
|
|
||||||
- From there, you can create and manage new :doc:`users
|
|
||||||
</applications/general/users/manage_users>`.
|
|
||||||
- The user account you use to log into Odoo's web interface differs from the :option:`--db_user
|
|
||||||
<odoo-bin -r>` CLI argument.
|
|
||||||
|
|
||||||
.. seealso::
|
|
||||||
:doc:`The exhaustive list of CLI arguments for odoo-bin </developer/reference/cli>`.
|
|
||||||
|
|
||||||
.. _setup/install/docker:
|
|
||||||
|
|
||||||
Docker
|
|
||||||
======
|
|
||||||
|
|
||||||
The full documentation on how to use Odoo with Docker can be found on the
|
|
||||||
official Odoo `docker image <https://hub.docker.com/_/odoo/>`_ page.
|
|
||||||
|
|
||||||
.. _Debian 11 (Bullseye): https://www.debian.org/releases/bullseye/
|
|
||||||
.. _demo: https://demo.odoo.com
|
|
||||||
.. _docker: https://www.docker.com
|
|
||||||
.. _download: https://www.odoo.com/page/download
|
|
||||||
.. _Ubuntu 20.04 (Focal): 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)
|
|
||||||
.. _Odoo Online: 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/
|
|
21
content/administration/install/online.rst
Normal file
21
content/administration/install/online.rst
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
======
|
||||||
|
Online
|
||||||
|
======
|
||||||
|
|
||||||
|
Online instances are accessed using any web browser and do not require a local installation.
|
||||||
|
|
||||||
|
Demo
|
||||||
|
----
|
||||||
|
|
||||||
|
To quickly try out Odoo, shared `demo <https://demo.odoo.com>`_ instances are available. No
|
||||||
|
registration is required, but each instance only lives for a few hours.
|
||||||
|
|
||||||
|
Odoo Online
|
||||||
|
-----------
|
||||||
|
|
||||||
|
`Odoo Online <https://www.odoo.com/trial>`_ provides private instances which are fully managed and
|
||||||
|
hosted by Odoo. It can be used for long-term production or to test Odoo thoroughly, including
|
||||||
|
customizations that don't require code.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
Odoo Online is incompatible with custom modules or the Odoo App Store.
|
162
content/administration/install/packages.rst
Normal file
162
content/administration/install/packages.rst
Normal file
@ -0,0 +1,162 @@
|
|||||||
|
===================
|
||||||
|
Packaged installers
|
||||||
|
===================
|
||||||
|
|
||||||
|
Odoo provides packaged installers for Debian-based Linux distributions (Debian, Ubuntu, etc.),
|
||||||
|
RPM-based Linux distributions (Fedora, CentOS, RHEL, etc.), and Windows for the Community and
|
||||||
|
Enterprise editions.
|
||||||
|
|
||||||
|
Official **Community** nightly packages with all relevant dependency requirements are available on
|
||||||
|
the `nightly server <https://nightly.odoo.com>`_.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
Nightly packages may be difficult to keep up to date.
|
||||||
|
|
||||||
|
Official **Community** and **Enterprise** packages can be downloaded from the `Odoo download page
|
||||||
|
<https://www.odoo.com/page/download>`_.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
It is required to be logged in as a paying customer or partner to download the Enterprise
|
||||||
|
packages.
|
||||||
|
|
||||||
|
.. _install/packages/linux:
|
||||||
|
|
||||||
|
Linux
|
||||||
|
=====
|
||||||
|
|
||||||
|
Prepare
|
||||||
|
-------
|
||||||
|
|
||||||
|
Odoo needs a `PostgreSQL <https://www.postgresql.org/>`_ server to run properly.
|
||||||
|
|
||||||
|
.. tabs::
|
||||||
|
|
||||||
|
.. group-tab:: Debian/Ubuntu
|
||||||
|
|
||||||
|
The default configuration for the Odoo 'deb' package is to use the PostgreSQL server on the
|
||||||
|
same host as the Odoo instance. Execute the following command to install the PostgreSQL
|
||||||
|
server:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ sudo apt install postgresql -y
|
||||||
|
|
||||||
|
.. group-tab:: Fedora
|
||||||
|
|
||||||
|
Make sure that the `sudo` command is available and well configured and, only then, execute the
|
||||||
|
following command 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
|
||||||
|
<https://github.com/wkhtmltopdf/wkhtmltopdf/releases/tag/0.12.5>`_ for it to support headers and
|
||||||
|
footers. Check out the `wkhtmltopdf 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 to install the **Community** edition by executing
|
||||||
|
the following commands:
|
||||||
|
|
||||||
|
.. tabs::
|
||||||
|
|
||||||
|
.. group-tab:: Debian/Ubuntu
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ wget -q -O - https://nightly.odoo.com/odoo.key | sudo gpg --dearmor -o /usr/share/keyrings/odoo-archive-keyring.gpg
|
||||||
|
$ echo 'deb [signed-by=/usr/share/keyrings/odoo-archive-keyring.gpg] https://nightly.odoo.com/{CURRENT_MAJOR_BRANCH}/nightly/deb/ ./' | sudo tee /etc/apt/sources.list.d/odoo.list
|
||||||
|
$ sudo apt-get update && sudo apt-get install odoo
|
||||||
|
|
||||||
|
Use the usual `apt-get upgrade` command to keep the installation up-to-date.
|
||||||
|
|
||||||
|
.. group-tab:: Fedora
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ sudo dnf config-manager --add-repo=https://nightly.odoo.com/{CURRENT_MAJOR_BRANCH}/nightly/rpm/odoo.repo
|
||||||
|
$ sudo dnf install -y odoo
|
||||||
|
$ sudo systemctl enable odoo
|
||||||
|
$ sudo systemctl start odoo
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
Currently, there is no nightly repository for the Enterprise edition.
|
||||||
|
|
||||||
|
Distribution package
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
Instead of using the repository, packages for both the **Community** and **Enterprise** editions can
|
||||||
|
be downloaded from the `Odoo download page <https://www.odoo.com/page/download>`_.
|
||||||
|
|
||||||
|
.. tabs::
|
||||||
|
|
||||||
|
.. group-tab:: Debian/Ubuntu
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
Odoo {CURRENT_MAJOR_VERSION} 'deb' package currently supports `Debian Buster
|
||||||
|
<https://www.debian.org/releases/buster/>`_ and `Ubuntu 18.04
|
||||||
|
<https://releases.ubuntu.com/18.04>`_ or above.
|
||||||
|
|
||||||
|
Once downloaded, execute the following commands **as root** to install Odoo as a service,
|
||||||
|
create the necessary PostgreSQL user, and automatically start the server:
|
||||||
|
|
||||||
|
.. 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>
|
||||||
|
|
||||||
|
.. warning::
|
||||||
|
- The `python3-xlwt` Debian package, needed to export into the XLS format, does not exist
|
||||||
|
in Debian Buster nor Ubuntu 18.04. If needed, install it manually with the following:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ sudo pip3 install xlwt
|
||||||
|
|
||||||
|
- The `num2words` Python package - needed to render textual amounts - does not exist in
|
||||||
|
Debian Buster nor Ubuntu 18.04, which could cause problems with the `l10n_mx_edi` module.
|
||||||
|
If needed, install it manually with the following:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ sudo pip3 install num2words
|
||||||
|
|
||||||
|
.. group-tab:: Fedora
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
Odoo {CURRENT_MAJOR_VERSION} 'rpm' package supports Fedora 36.
|
||||||
|
|
||||||
|
Once downloaded, the package can be installed using the 'dnf' package manager:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ sudo dnf localinstall odoo_{CURRENT_MAJOR_BRANCH}.latest.noarch.rpm
|
||||||
|
$ sudo systemctl enable odoo
|
||||||
|
$ sudo systemctl start odoo
|
||||||
|
|
||||||
|
.. _install/packages/windows:
|
||||||
|
|
||||||
|
Windows
|
||||||
|
=======
|
||||||
|
|
||||||
|
#. Download the installer from the `nightly server <https://nightly.odoo.com>`_ (Community only) or
|
||||||
|
the Windows installer from the `Odoo download page <https://www.odoo.com/page/download>`_ (any
|
||||||
|
edition.
|
||||||
|
#. Execute the downloaded file.
|
||||||
|
|
||||||
|
.. warning::
|
||||||
|
On Windows 8 and later, a warning titled *Windows protected your PC* may be displayed. Click
|
||||||
|
**More Info** and then **Run anyway** to proceed.
|
||||||
|
|
||||||
|
#. Accept the `UAC <https://en.wikipedia.org/wiki/User_Account_Control>`_ prompt.
|
||||||
|
#. Go through the installation steps.
|
||||||
|
|
||||||
|
Odoo launches automatically at the end of the installation.
|
483
content/administration/install/source.rst
Normal file
483
content/administration/install/source.rst
Normal file
@ -0,0 +1,483 @@
|
|||||||
|
======
|
||||||
|
Source
|
||||||
|
======
|
||||||
|
|
||||||
|
The source 'installation' is not about installing Odoo but running it directly from the source
|
||||||
|
instead.
|
||||||
|
|
||||||
|
Using the Odoo source can be more convenient for module developers as it is more easily accessible
|
||||||
|
than using packaged installers.
|
||||||
|
|
||||||
|
It makes starting and stopping Odoo more flexible and explicit than the services set up by the
|
||||||
|
packaged installers. Also, it 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 setup and allows to more easily keep (and
|
||||||
|
run) multiple versions of Odoo side-by-side.
|
||||||
|
|
||||||
|
Fetch the sources
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
There are two ways to obtain the source code of Odoo: as a ZIP **archive** or through **Git**.
|
||||||
|
|
||||||
|
Archive
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
Community edition:
|
||||||
|
|
||||||
|
- `Odoo download page <https://www.odoo.com/page/download>`_
|
||||||
|
- `GitHub Community repository <https://github.com/odoo/odoo>`_
|
||||||
|
- `Nightly server <https://nightly.odoo.com>`_
|
||||||
|
|
||||||
|
Enterprise edition:
|
||||||
|
|
||||||
|
- `Odoo download page <https://www.odoo.com/page/download>`_
|
||||||
|
- `GitHub Enterprise repository <https://github.com/odoo/enterprise>`_
|
||||||
|
|
||||||
|
.. _install/source/git:
|
||||||
|
|
||||||
|
Git
|
||||||
|
~~~
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
It is required to have `Git <https://git-scm.com/>`_ installed, and it is recommended to have a
|
||||||
|
basic knowledge of Git commands to proceed.
|
||||||
|
|
||||||
|
To clone a Git repository, choose between cloning with HTTPS or SSH. In most cases, the best option
|
||||||
|
is HTTPS. However, choose SSH to contribute to Odoo source code or when following the :doc:`Getting
|
||||||
|
Started developer tutorial </developer/tutorials/getting_started>`.
|
||||||
|
|
||||||
|
.. tabs::
|
||||||
|
|
||||||
|
.. group-tab:: Linux
|
||||||
|
|
||||||
|
.. tabs::
|
||||||
|
|
||||||
|
.. tab:: Clone with HTTPS
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ git clone https://github.com/odoo/odoo.git
|
||||||
|
$ git clone https://github.com/odoo/enterprise.git
|
||||||
|
|
||||||
|
.. tab:: Clone with SSH
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ git clone git@github.com:odoo/odoo.git
|
||||||
|
$ git clone git@github.com:odoo/enterprise.git
|
||||||
|
|
||||||
|
.. group-tab:: Windows
|
||||||
|
|
||||||
|
.. tabs::
|
||||||
|
|
||||||
|
.. tab:: Clone with HTTPS
|
||||||
|
|
||||||
|
.. code-block:: doscon
|
||||||
|
|
||||||
|
C:\> git clone https://github.com/odoo/odoo.git
|
||||||
|
C:\> git clone https://github.com/odoo/enterprise.git
|
||||||
|
|
||||||
|
.. tab:: Clone with SSH
|
||||||
|
|
||||||
|
.. code-block:: doscon
|
||||||
|
|
||||||
|
C:\> git clone git@github.com:odoo/odoo.git
|
||||||
|
C:\> git clone git@github.com:odoo/enterprise.git
|
||||||
|
|
||||||
|
.. group-tab:: Mac OS
|
||||||
|
|
||||||
|
.. tabs::
|
||||||
|
|
||||||
|
.. tab:: Clone with HTTPS
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ git clone https://github.com/odoo/odoo.git
|
||||||
|
$ git clone https://github.com/odoo/enterprise.git
|
||||||
|
|
||||||
|
.. tab:: Clone with SSH
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ git clone git@github.com:odoo/odoo.git
|
||||||
|
$ git clone git@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 edition. Running the
|
||||||
|
Enterprise version means running the server from the Community version with the `addons-path`
|
||||||
|
option set to the folder with the Enterprise edition. It is required to clone both the Community
|
||||||
|
and Enterprise repositories to have a working Odoo Enterprise installation.
|
||||||
|
|
||||||
|
.. _install/source/prepare:
|
||||||
|
|
||||||
|
Prepare
|
||||||
|
-------
|
||||||
|
|
||||||
|
Python
|
||||||
|
~~~~~~
|
||||||
|
|
||||||
|
Odoo requires **Python 3.7** or later to run.
|
||||||
|
|
||||||
|
.. tabs::
|
||||||
|
|
||||||
|
.. group-tab:: Linux
|
||||||
|
|
||||||
|
Use a package manager to download and install Python 3 if needed.
|
||||||
|
|
||||||
|
.. group-tab:: Windows
|
||||||
|
|
||||||
|
`Download the latest version of Python 3 <https://www.python.org/downloads/windows/>`_ and
|
||||||
|
install it.
|
||||||
|
|
||||||
|
During installation, check **Add Python 3 to PATH**, then click **Customize Installation** and
|
||||||
|
make sure that **pip** is checked.
|
||||||
|
|
||||||
|
.. group-tab:: Mac OS
|
||||||
|
|
||||||
|
Use a package manager (`Homebrew <https://brew.sh/>`_, `MacPorts <https://www.macports.org>`_)
|
||||||
|
to download and install Python 3 if needed.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
If Python 3 is already installed, make sure that the version is 3.7 or above, as previous
|
||||||
|
versions are not compatible with Odoo.
|
||||||
|
|
||||||
|
.. tabs::
|
||||||
|
|
||||||
|
.. group-tab:: Linux
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ python3 --version
|
||||||
|
|
||||||
|
.. group-tab:: Windows
|
||||||
|
|
||||||
|
.. code-block:: doscon
|
||||||
|
|
||||||
|
C:\> python --version
|
||||||
|
|
||||||
|
.. group-tab:: Mac OS
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ python3 --version
|
||||||
|
|
||||||
|
Verify that `pip <https://pip.pypa.io>`_ is also installed for this version.
|
||||||
|
|
||||||
|
.. tabs::
|
||||||
|
|
||||||
|
.. group-tab:: Linux
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ pip3 --version
|
||||||
|
|
||||||
|
.. group-tab:: Windows
|
||||||
|
|
||||||
|
.. code-block:: doscon
|
||||||
|
|
||||||
|
C:\> pip --version
|
||||||
|
|
||||||
|
.. group-tab:: Mac OS
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ pip3 --version
|
||||||
|
|
||||||
|
PostgreSQL
|
||||||
|
~~~~~~~~~~
|
||||||
|
|
||||||
|
Odoo uses PostgreSQL as its database management system.
|
||||||
|
|
||||||
|
.. tabs::
|
||||||
|
|
||||||
|
.. group-tab:: Linux
|
||||||
|
|
||||||
|
Use a package manager to download and install PostgreSQL (supported versions: 12.0 or above).
|
||||||
|
It can be achieved by executing the following:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ sudo apt install postgresql postgresql-client
|
||||||
|
|
||||||
|
.. group-tab:: Windows
|
||||||
|
|
||||||
|
`Download PostgreSQL <https://www.postgresql.org/download/windows>`_ (supported versions: 12.0
|
||||||
|
or above) and install it.
|
||||||
|
|
||||||
|
.. group-tab:: Mac OS
|
||||||
|
|
||||||
|
Use `Postgres.app <https://postgresapp.com>`_ to download and install PostgreSQL (supported
|
||||||
|
version: 12.0 or above).
|
||||||
|
|
||||||
|
.. tip::
|
||||||
|
To make the command line tools bundled with Postgres.app available, make sure to set up the
|
||||||
|
`$PATH` variable by following the `Postgres.app CLI tools instructions
|
||||||
|
<https://postgresapp.com/documentation/cli-tools.html>`_.
|
||||||
|
|
||||||
|
By default, the only user is `postgres`. As Odoo forbids connecting as `postgres`, create a new
|
||||||
|
PostgreSQL user.
|
||||||
|
|
||||||
|
.. tabs::
|
||||||
|
|
||||||
|
.. group-tab:: Linux
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ sudo -u postgres createuser -s $USER
|
||||||
|
$ createdb $USER
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
Because the PostgreSQL user has the same name as the Unix login, it is possible to connect
|
||||||
|
to the database without a password.
|
||||||
|
|
||||||
|
.. group-tab:: Windows
|
||||||
|
|
||||||
|
#. Add PostgreSQL's `bin` directory (by default:
|
||||||
|
:file:`C:\\Program Files\\PostgreSQL\\<version>\\bin`) to the `PATH`.
|
||||||
|
#. Create a postgres user with a password using the pg admin gui:
|
||||||
|
|
||||||
|
#. Open **pgAdmin**.
|
||||||
|
#. Double-click the server to create a connection.
|
||||||
|
#. Select :menuselection:`Object --> Create --> Login/Group Role`.
|
||||||
|
#. Enter the username in the **Role Name** field (e.g., `odoo`).
|
||||||
|
#. Open the **Definition** tab, enter a password (e.g., `odoo`), and click **Save**.
|
||||||
|
#. Open the **Privileges** tab and switch **Can login?** to `Yes` and **Create database?**
|
||||||
|
to `Yes`.
|
||||||
|
|
||||||
|
.. group-tab:: Mac OS
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ sudo -u postgres createuser -s $USER
|
||||||
|
$ createdb $USER
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
Because the PostgreSQL user has the same name as the Unix login, it is possible to connect
|
||||||
|
to the database without a password.
|
||||||
|
|
||||||
|
.. _install/dependencies:
|
||||||
|
|
||||||
|
Dependencies
|
||||||
|
~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. tabs::
|
||||||
|
|
||||||
|
.. group-tab:: Linux
|
||||||
|
|
||||||
|
Using **distribution packages** is the preferred way of installing dependencies.
|
||||||
|
Alternatively, install the Python dependencies with **pip**.
|
||||||
|
|
||||||
|
.. tabs::
|
||||||
|
|
||||||
|
.. tab:: Debian/Ubuntu
|
||||||
|
|
||||||
|
For Debian-based systems, the packages are listed in the `debian/control
|
||||||
|
<{GITHUB_PATH}/debian/control>`_ file of the Odoo sources.
|
||||||
|
|
||||||
|
On Debian/Ubuntu, the following commands should install the required packages:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ cd /CommunityPath
|
||||||
|
$ sed -n -e '/^Depends:/,/^Pre/ s/ python3-\(.*\),/python3-\1/p' debian/control | sudo xargs apt-get install -y
|
||||||
|
|
||||||
|
.. tab:: Install with pip
|
||||||
|
|
||||||
|
As some of the Python packages need a compilation step, they require system libraries to
|
||||||
|
be installed.
|
||||||
|
|
||||||
|
On Debian/Ubuntu, the following command should install these required libraries:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ sudo apt install python3-pip libldap2-dev libpq-dev libsasl2-dev
|
||||||
|
|
||||||
|
Odoo dependencies are listed in the :file:`requirements.txt` file located at the root of
|
||||||
|
the Odoo Community directory.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
The Python packages in :file:`requirements.txt` are based on their stable/LTS
|
||||||
|
Debian/Ubuntu corresponding version at the moment of the Odoo release. For example,
|
||||||
|
for Odoo 15.0, the `python3-babel` package version is 2.8.0 in Debian Bullseye and
|
||||||
|
2.6.0 in Ubuntu Focal. The lowest version is then chosen in the
|
||||||
|
:file:`requirements.txt`.
|
||||||
|
|
||||||
|
.. tip::
|
||||||
|
It can be preferable not to mix Python module packages between different instances of
|
||||||
|
Odoo or with the system. However, it is possible to use `virtualenv
|
||||||
|
<https://pypi.org/project/virtualenv/>`_ to create isolated Python environments.
|
||||||
|
|
||||||
|
Navigate to the path of the Odoo Community installation (:file:`CommunityPath`) and run
|
||||||
|
**pip** on the requirements file to install the requirements for the current user.
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ cd /CommunityPath
|
||||||
|
$ pip install -r requirements.txt
|
||||||
|
|
||||||
|
.. group-tab:: Windows
|
||||||
|
|
||||||
|
Before installing the dependencies, download and install the `Build Tools for Visual
|
||||||
|
Studio <https://visualstudio.microsoft.com/downloads/>`_. Select **C++ build tools** in the
|
||||||
|
**Workloads** tab and install them when prompted.
|
||||||
|
|
||||||
|
Odoo dependencies are listed in the `requirements.txt` file located at the root of the Odoo
|
||||||
|
Community directory.
|
||||||
|
|
||||||
|
.. tip::
|
||||||
|
It can be preferable not to mix Python module packages between different instances of
|
||||||
|
Odoo or with the system. However, it is possible to use `virtualenv
|
||||||
|
<https://pypi.org/project/virtualenv/>`_ to create isolated Python environments.
|
||||||
|
|
||||||
|
Navigate to the path of the 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
|
||||||
|
|
||||||
|
.. group-tab:: Mac OS
|
||||||
|
|
||||||
|
Odoo dependencies are listed in the `requirements.txt` file located at the root of the Odoo
|
||||||
|
Community directory.
|
||||||
|
|
||||||
|
.. tip::
|
||||||
|
It can be preferable not to mix Python module packages between different instances of
|
||||||
|
Odoo or with the system. However, it is possible to use `virtualenv
|
||||||
|
<https://pypi.org/project/virtualenv/>`_ to create isolated Python environments.
|
||||||
|
|
||||||
|
Navigate to the path of the 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 must be installed with a package manager (`Homebrew
|
||||||
|
<https://brew.sh/>`_, `MacPorts <https://www.macports.org>`_).
|
||||||
|
|
||||||
|
#. Download and install the **Command Line Tools**:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ xcode-select --install
|
||||||
|
|
||||||
|
#. Use the package manager to install non-Python dependencies.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
For languages using a **right-to-left interface** (such as Arabic or Hebrew), the `rtlcss`
|
||||||
|
package is required.
|
||||||
|
|
||||||
|
.. tabs::
|
||||||
|
|
||||||
|
.. group-tab:: Linux
|
||||||
|
|
||||||
|
#. Download and install **nodejs** and **npm** with a package manager.
|
||||||
|
#. Install `rtlcss`:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ sudo npm install -g rtlcss
|
||||||
|
|
||||||
|
.. group-tab:: Windows
|
||||||
|
|
||||||
|
#. 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: :file:`C:\\Users\\<user>\\AppData\\Roaming\\npm\\`).
|
||||||
|
|
||||||
|
.. group-tab:: Mac OS
|
||||||
|
|
||||||
|
#. Download and install **nodejs** with a package manager (`Homebrew <https://brew.sh/>`_,
|
||||||
|
`MacPorts <https://www.macports.org>`_).
|
||||||
|
#. Install `rtlcss`:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ sudo npm install -g rtlcss
|
||||||
|
|
||||||
|
.. warning::
|
||||||
|
`wkhtmltopdf` is not installed through **pip** and must be installed manually in `version 0.12.5
|
||||||
|
<https://github.com/wkhtmltopdf/wkhtmltopdf/releases/tag/0.12.5>`_ for it to support headers and
|
||||||
|
footers. Check out the `wkhtmltopdf wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for
|
||||||
|
more details on the various versions.
|
||||||
|
|
||||||
|
.. _install/source/running_odoo:
|
||||||
|
|
||||||
|
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, either specify :ref:`command-line arguments <reference/cmdline/server>` or
|
||||||
|
a :ref:`configuration file <reference/cmdline/config>`.
|
||||||
|
|
||||||
|
.. tip::
|
||||||
|
For the Enterprise edition, add the path to the `enterprise` add-ons to the `addons-path`
|
||||||
|
argument. Note that it must come before the other paths in `addons-path` for add-ons to be loaded
|
||||||
|
correctly.
|
||||||
|
|
||||||
|
Common necessary configurations are:
|
||||||
|
|
||||||
|
- PostgreSQL user and password.
|
||||||
|
- Custom addon paths beyond the defaults to load custom modules.
|
||||||
|
|
||||||
|
A typical way to run the server would be:
|
||||||
|
|
||||||
|
.. tabs::
|
||||||
|
|
||||||
|
.. group-tab:: Linux
|
||||||
|
|
||||||
|
.. 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 name
|
||||||
|
of the PostgreSQL database.
|
||||||
|
|
||||||
|
.. group-tab:: Windows
|
||||||
|
|
||||||
|
.. 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 name of the
|
||||||
|
PostgreSQL database.
|
||||||
|
|
||||||
|
.. group-tab:: Mac OS
|
||||||
|
|
||||||
|
.. 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 name
|
||||||
|
of the PostgreSQL database.
|
||||||
|
|
||||||
|
After the server has started (the INFO log `odoo.modules.loading: Modules loaded.` is printed), open
|
||||||
|
http://localhost:8069 in a web browser and log into the Odoo database with the base administrator
|
||||||
|
account: use `admin` as the email and, again, `admin` as the password.
|
||||||
|
|
||||||
|
.. tip::
|
||||||
|
- From there, create and manage new :doc:`users <../../applications/general/users/manage_users>`.
|
||||||
|
- The user account used to log into Odoo's web interface differs from the :option:`--db_user
|
||||||
|
<odoo-bin -r>` CLI argument.
|
||||||
|
|
||||||
|
.. seealso::
|
||||||
|
:doc:`The list of CLI arguments for odoo-bin </developer/reference/cli>`
|
@ -61,7 +61,7 @@ have your own favourite. You may need to adapt sections to your usual workflow.
|
|||||||
|
|
||||||
* Shutdown your server
|
* Shutdown your server
|
||||||
* Backup your community database
|
* Backup your community database
|
||||||
* Update the ``--addons-path`` parameter of your launch command (see :ref:`setup/install/source`)
|
* Update the ``--addons-path`` parameter of your launch command (see :doc:`../install/source`)
|
||||||
* Install the web_enterprise module by using
|
* Install the web_enterprise module by using
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
@ -46,7 +46,7 @@ Updating Odoo is accomplished by simply reinstalling the latest version of your
|
|||||||
Edition on top of your current installation. This will preserve your data without any alteration,
|
Edition on top of your current installation. This will preserve your data without any alteration,
|
||||||
as long as you do not uninstall PostgreSQL (the database engine that comes with Odoo).
|
as long as you do not uninstall PostgreSQL (the database engine that comes with Odoo).
|
||||||
|
|
||||||
The main reference for updating is logically our :ref:`installation guide <setup/install>`,
|
The main reference for updating is logically our :doc:`installation guide <../install>`,
|
||||||
which explains the common installation methods.
|
which explains the common installation methods.
|
||||||
|
|
||||||
Updating is also most appropriately accomplished by the person who deployed Odoo initially,
|
Updating is also most appropriately accomplished by the person who deployed Odoo initially,
|
||||||
|
@ -85,7 +85,7 @@ From the Odoo.sh editor, in a terminal:
|
|||||||
|
|
||||||
$ odoo-bin scaffold my_module ~/src/user/
|
$ odoo-bin scaffold my_module ~/src/user/
|
||||||
|
|
||||||
Or, from your computer, if you have an :ref:`installation of Odoo <setup/install/source>`:
|
Or, from your computer, if you have an :doc:`installation of Odoo <../../install/source>`:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
|
@ -220,7 +220,7 @@ Proxy. Copy the token and save it in a safe place for later use.
|
|||||||
|
|
||||||
.. seealso::
|
.. seealso::
|
||||||
- `Odoo: Download Odoo <https://www.odoo.com/page/download>`_
|
- `Odoo: Download Odoo <https://www.odoo.com/page/download>`_
|
||||||
- :doc:`/administration/install/install`
|
- :doc:`../../../administration/install`
|
||||||
|
|
||||||
.. _egypt/e-invoicing-usb-configuration:
|
.. _egypt/e-invoicing-usb-configuration:
|
||||||
|
|
||||||
|
@ -37,8 +37,8 @@ and then push them to GitHub. Skip this section and go to
|
|||||||
affecting the main codebase. Skip this step if you work at Odoo.
|
affecting the main codebase. Skip this step if you work at Odoo.
|
||||||
#. .. include:: install_git.rst
|
#. .. include:: install_git.rst
|
||||||
#. .. include:: configure_git_authorship.rst
|
#. .. include:: configure_git_authorship.rst
|
||||||
#. :ref:`Install Odoo from the sources <setup/install/source>`. Make sure to fetch the sources
|
#. :doc:`Install Odoo from the sources <../administration/install/source>`. Make sure to fetch the
|
||||||
through Git with SSH.
|
sources through Git with SSH.
|
||||||
#. Configure Git to push changes to your fork(s) rather than to the main codebase. If you work at
|
#. Configure Git to push changes to your fork(s) rather than to the main codebase. If you work at
|
||||||
Odoo, configure Git to push changes to the shared forks created on the account **odoo-dev**.
|
Odoo, configure Git to push changes to the shared forks created on the account **odoo-dev**.
|
||||||
|
|
||||||
|
@ -12,8 +12,9 @@ In this chapter, you will learn:
|
|||||||
Install
|
Install
|
||||||
=======
|
=======
|
||||||
|
|
||||||
There are multiple ways to :doc:`install Odoo <../../../administration/install/install>`, depending on the intended use case. This documentation
|
There are multiple ways to :doc:`install Odoo <../../../administration/install>`, depending on the
|
||||||
assumes you use the :ref:`source install <setup/install/source>` (running Odoo from the source code), which is best suited
|
intended use case. This documentation assumes you use the :doc:`source install
|
||||||
|
<../../../administration/install/source>` (running Odoo from the source code), which is best suited
|
||||||
for Odoo designers and developers.
|
for Odoo designers and developers.
|
||||||
|
|
||||||
Databases
|
Databases
|
||||||
@ -181,9 +182,9 @@ Running Odoo
|
|||||||
Once all dependencies are set up, Odoo can be launched by running `odoo-bin`, the command-line
|
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.
|
interface of the server. It is located at the root of the Odoo Community directory.
|
||||||
|
|
||||||
- :ref:`Windows <setup/install/source/windows/running_odoo>`
|
- :ref:`Windows <install/source/running_odoo>`
|
||||||
- :ref:`Linux <setup/install/source/linux/running_odoo>`
|
- :ref:`Linux <install/source/running_odoo>`
|
||||||
- :ref:`Mac OS <setup/install/source/mac_os/running_odoo>`
|
- :ref:`Mac OS <install/source/running_odoo>`
|
||||||
- `Docker <https://hub.docker.com/_/odoo/>`_
|
- `Docker <https://hub.docker.com/_/odoo/>`_
|
||||||
|
|
||||||
To configure the server, you can specify command-line arguments or a configuration file. The first
|
To configure the server, you can specify command-line arguments or a configuration file. The first
|
||||||
|
@ -12,10 +12,10 @@ environment <reference/cmdline/shell>`, :ref:`scaffold an Odoo module <reference
|
|||||||
|
|
||||||
.. important::
|
.. important::
|
||||||
The command to use to call the CLI depends on how you installed Odoo. In the examples below, we
|
The command to use to call the CLI depends on how you installed Odoo. In the examples below, we
|
||||||
assume that you are :ref:`running Odoo from source <setup/install/source>` with the
|
assume that you are :doc:`running Odoo from source <../../administration/install/source>` with
|
||||||
:file:`odoo-bin` file. If you installed Odoo :ref:`from a distribution package
|
the :file:`odoo-bin` file. If you installed Odoo :doc:`from a distribution package
|
||||||
<setup/install/packaged>` or :ref:`with Docker <setup/install/docker>`, you must adapt the
|
<../../administration/install/packages>` or with `Docker <https://hub.docker.com/_/odoo/>`_, you
|
||||||
command.
|
must adapt the command.
|
||||||
|
|
||||||
.. tabs::
|
.. tabs::
|
||||||
|
|
||||||
|
@ -11,7 +11,7 @@ Building a Module
|
|||||||
This tutorial is outdated. We recommend reading :doc:`getting_started` instead.
|
This tutorial is outdated. We recommend reading :doc:`getting_started` instead.
|
||||||
|
|
||||||
.. warning::
|
.. warning::
|
||||||
This tutorial requires :ref:`having installed Odoo <setup/install>`
|
This tutorial requires :doc:`having installed Odoo <../../administration/install>`
|
||||||
|
|
||||||
Start/Stop the Odoo server
|
Start/Stop the Odoo server
|
||||||
==========================
|
==========================
|
||||||
@ -970,8 +970,8 @@ Gantt
|
|||||||
-----
|
-----
|
||||||
|
|
||||||
.. warning::
|
.. warning::
|
||||||
The gantt view requires the web_gantt module which is present in :ref:`the enterprise edition
|
The gantt view requires the web_gantt module which is present in the enterprise edition
|
||||||
<setup/install/editions>` version.
|
<install/editions>` version.
|
||||||
|
|
||||||
Horizontal bar charts typically used to show project planning and advancement,
|
Horizontal bar charts typically used to show project planning and advancement,
|
||||||
their root element is ``<gantt>``.
|
their root element is ``<gantt>``.
|
||||||
|
@ -24,7 +24,7 @@ or extend existing business systems of Odoo, see :doc:`backend`.
|
|||||||
* jQuery_
|
* jQuery_
|
||||||
* `Underscore.js`_
|
* `Underscore.js`_
|
||||||
|
|
||||||
It also requires :ref:`an installed Odoo <setup/install>`, and Git_.
|
It also requires :doc:`an installed Odoo <../../administration/install>`, and Git_.
|
||||||
|
|
||||||
A Simple Module
|
A Simple Module
|
||||||
===============
|
===============
|
||||||
|
@ -11,7 +11,7 @@ Building a Website
|
|||||||
|
|
||||||
* This guide assumes `basic knowledge of Python
|
* This guide assumes `basic knowledge of Python
|
||||||
<http://docs.python.org/2/tutorial/>`_
|
<http://docs.python.org/2/tutorial/>`_
|
||||||
* This guide assumes :ref:`an installed Odoo <setup/install>`
|
* This guide assumes :doc:`an installed Odoo <../../administration/install>`
|
||||||
|
|
||||||
Creating a basic module
|
Creating a basic module
|
||||||
=======================
|
=======================
|
||||||
|
@ -1,3 +1,7 @@
|
|||||||
|
# administration/install
|
||||||
|
|
||||||
|
administration/install/install.rst administration/install.rst
|
||||||
|
|
||||||
# applications/finance
|
# applications/finance
|
||||||
|
|
||||||
applications/finance/accounting/bank/interbank.rst applications/finance/accounting/payments/internal_transfers.rst # bank/interbank -> payments/internal_transfers
|
applications/finance/accounting/bank/interbank.rst applications/finance/accounting/payments/internal_transfers.rst # bank/interbank -> payments/internal_transfers
|
||||||
|
Loading…
Reference in New Issue
Block a user