pengyuthon/odoo_source
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[IMP] doc: Enterprise-compatible installation instructions

Browse Source 
Before this revision, the installation instructions where
Community-centric, which led some customers to believe
that they had to install first Community then Enterprise.

This commit makes the instruction compatible for both editions.
This commit is contained in:
Damien Bouvy
2016-05-17 10:21:11 +02:00
committed by Martin Trigaux
parent 610d462740
commit a5277bc106
2 changed files with 150 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/setup/enterprise.rst
+3 -8
View File
@@ -1,3 +1,5 @@
.. _setup/enterprise:
============================
From Community to Enterprise
============================
@@ -58,14 +60,7 @@ have your own favourite. You may need to adapt sections to your usual workflow.
* Shutdown your server
* Backup your community database
* Update the ``--addons-path`` parameter of your launch command (``init.d``, custom script,
configuration file, etc.). The Enterprise addons folder should be included" **before** the community modules.
For example:
.. code-block:: console
$ --addons-path=~/src/custom_modules,~/src/enterprise,~/src/odoo/addons
* Update the ``--addons-path`` parameter of your launch command (see :ref:`setup/install/source`)
* Update the web module by using
.. code-block:: console
doc/setup/install.rst
+147 -28
View File
@@ -12,23 +12,23 @@ on the intended use case.
This documents attempts to describe most of the installation options.
:ref:`setup/install/demo`
the simplest "installation", only suitable for getting a quick feel for
The simplest "installation", only suitable for getting a quick feel for
Odoo or trying something out
:ref:`setup/install/saas`
trivial to start with and fully managed and migrated by Odoo S.A., can be
used to both test Odoo and use it for your business, but restricts the
flexibility of the system somewhat (check: no custom modules? what else?).
Trivial to start with and fully managed and migrated by Odoo S.A., can be
used to both test Odoo and use it for your business, prevents complex
customization (i.e. incompatible with custom modules or the Odoo Apps Store).
Can be used for both testing Odoo and long-term "production" use.
Can be used for both testing Odoo and long-term production use.
:ref:`setup/install/packaged`
simple to get started, allows more flexibility in hosting and deploying
Simple to get started, allows more flexibility in hosting and deploying
the system and greater control over where data is stored. The maintenance
burden is shifted to the user.
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`
harder to get started than :ref:`setup/install/packaged`, provides
Harder to get started than :ref:`setup/install/packaged`, provides
even greater flexibility: packaged installers don't generally allow
multiple running Odoo versions on the same system, and don't provide easy
source access to Odoo itself.
@@ -37,12 +37,39 @@ This documents attempts to describe most of the installation options.
deployment.
The source code can be obtained by downloading a tarball or using git.
Using git makes it easier to update, switch between multiple versions
(including the current development version) or contribute.
Using git is strongly advised, as it makes it easier to update, switch
between multiple versions (including the current development version)
or contribute.
`docker image <https://registry.hub.docker.com/_/odoo/>`_
if you usually use docker_ for development or deployment, an official
If you usually use docker_ for development or deployment, an official
docker_ base image is available, see the image's help document for more
information
information.
.. _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`).
If you wish to access the Enterprise installers/source code, you can:
* Go to the Download_ page and log in with your customer credentials
* Download the source on GitHub using git_
.. note:: If you do not have access to our Enterprise repository, you can request
it be e-mailing your sales representative or our online support with
your subscription number and GitHub username.
.. warning:: Enterprise deb and rpm packages do not have repositories, so automatic
update will not work. Reinstalling the latest package version will be needed
to update manually an installation.
.. _setup/install/demo:
@@ -73,19 +100,23 @@ Packaged installers
===================
Odoo provides packaged installers for Windows, deb-based distributions
(Debian, Ubuntu, …) and RPM-based distributions (Fedora, CentOS, RHEL, …).
(Debian, Ubuntu, …) and RPM-based distributions (Fedora, CentOS, RHEL, …) for
both the Community and Enterprise versions.
These packages automatically set up all dependencies, but may be difficult to
keep up-to-date.
These packages automatically set up all dependencies (for the Community version),
but may be difficult to keep up-to-date.
Official packages with all relevant dependency requirements are available on
https://nightly.odoo.com.
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 https://nightly.odoo.com/9.0/nightly/exe/odoo_9.0.latest.exe
* run the downloaded file
* Download the installer from our nightly_ server (Community only)
or the Windows installer from the Download_ page (any edition)
* Run the downloaded file
.. warning:: on Windows 8, you may see a warning titled "Windows protected
your PC". Click :guilabel:`More Info` then
@@ -111,7 +142,10 @@ To reload the configuration file, restart the Odoo service via
Deb
---
To install Odoo 9.0 on Debian-based distribution, execute the following
Community
'''''''''
To install Odoo 9.0 Community on Debian-based distribution, execute the following
commands as root:
.. code-block:: console
@@ -120,16 +154,39 @@ commands as root:
# echo "deb http://nightly.odoo.com/9.0/nightly/deb/ ./" >> /etc/apt/sources.list
# apt-get update && apt-get install odoo
This will automatically install all dependencies, install Odoo itself as a
daemon and automatically start it.
You can then use the usual ``apt-get upgrade`` command to keep your installation up-to-date.
Enterprise
''''''''''
For Odoo 9.0 Enterprise, get the package from the Download_ page. You can then
use ``gdebi``:
.. code-block:: console
# apt-get install postgresql -y
# gdebi <path_to_installation_package>
Or ``dpkg`` (handles less dependencies automatically):
.. code-block:: console
# apt-get install postgresql -y
# dpkg -i <path_to_installation_package> # this probably fails with missing dependencies
# apt-get install -f # should install the missing dependencies
# pdkg -i <path_to_installation_package>
This will install Odoo as a service, create the necessary PostgreSQL_ user
and automatically start the server.
.. danger:: to print PDF reports, you must install wkhtmltopdf_ yourself:
the version of wkhtmltopdf_ available in debian repositories does
not support headers and footers so it can not be installed
automatically. The recommended version is 0.12.1 and is available on
`the wkhtmltopdf download page`_, in the archive section. As there
is no official release for Debian Jessie, you can find ours on
http://nightly.odoo.com/extra/.
is no official release for Debian Jessie, you can find ours on the
extra_ section of our nightly server.
Configuration
'''''''''''''
@@ -160,6 +217,11 @@ RPM
For other RHEL-based distribution, see the EPEL_ documentation.
Community
'''''''''
Execute the following commands to install Odoo 9.0 Community on your server:
.. code-block:: console
$ sudo yum install -y postgresql-server
@@ -171,6 +233,23 @@ RPM
$ sudo systemctl enable odoo
$ sudo systemctl start odoo
Enterprise
''''''''''
To install Odoo 9.0 Enterprise, execute these commands:
.. code-block:: console
$ sudo yum install -y postgresql-server
$ sudo postgresql-setup initdb
$ sudo systemctl enable postgresql
$ sudo systemctl start postgresql
$ sudo yum-config-manager --add-repo=https://nightly.odoo.com/9.0/nightly/rpm/odoo.repo
$ sudo yum install -y odoo
$ sudo systemctl enable odoo
$ sudo systemctl start odoo
.. danger:: to print PDF reports, you must install wkhtmltopdf_ yourself:
the version of wkhtmltopdf_ available in Fedora/CentOS
repositories does not support headers and footers so it can not
@@ -210,18 +289,21 @@ edit a configuration file.
Finally it provides greater control over the system's set up, and allows more
easily keeping (and running) multiple versions of Odoo side-by-side.
Community
---------
There are two way to get the odoo source source zip or git.
* Odoo zip can be downloaded from
https://nightly.odoo.com/9.0/nightly/src/odoo_9.0.latest.zip, the zip file
then needs to be uncompressed to use its content
* Odoo zip can be downloaded from our nightly_ server or our Download_ page,
the zip file then needs to be uncompressed to use its content
* git allows simpler update and easier switching between differents versions
* git allows simpler update and easier switching between different versions
of Odoo. It also simplifies maintaining non-module patches and
contributions. The primary drawback of git is that it is significantly
larger than a tarball as it contains the entire history of the Odoo project.
The git repository is https://github.com/odoo/odoo.git.
The git repository is https://github.com/odoo/odoo.git for the Community
version.
Downloading it requires a `git client <http://git-scm.com/download/>`_
(which may be available via your distribution on linux) and can be performed
@@ -231,6 +313,33 @@ There are two way to get the odoo source source zip or git.
$ git clone https://github.com/odoo/odoo.git
Enterprise
----------
If you have access to the Enterprise repository (see :ref:`setup/install/editions`
if you wish to get access), you can use this command to fetch the addons:
.. code-block:: console
$ git clone https://github.com/odoo/enterprise.git
If you use git_, you must modify the :option:`--addons-path <odoo.py --addons-path>`
parameter of your launch command (``init.d``, custom script, configuration file,
etc.). The Enterprise addons folder should be included **before** the default
addons folder.
For example:
.. code-block:: console
$ odoo.py --addons-path=~/src/custom_modules,~/src/enterprise,~/src/odoo/addons
.. warning:: The Enterprise git repository **does not contain the full Odoo
source code**. You need to clone both the Community and Enterprise repository to
have a working Odoo installation. The Download_ page contains the entire
source code but is not updateable as easily.
Installing dependencies
-----------------------
@@ -378,6 +487,12 @@ Running Odoo
Once all dependencies are set up, Odoo can be launched by running ``odoo.py``.
.. warning:: For the Enterprise edition, you must specify the :file:`enterprise`
addons folder when starting your server. You can do so by providing the path
to your :file:`enterprise` folder in the ``addons-path`` parameter. Please
note that the :file:`enterprise` folder must come before the default
:file:`addons` folder in the list for the addons to be loaded correctly.
:ref:`Configuration <reference/cmdline>` can be provided either through
:ref:`command-line arguments <reference/cmdline>` or through a
:ref:`configuration file <reference/cmdline/config>`.
@@ -415,6 +530,7 @@ default db to serve on localhost:8069
.. _demo: https://demo.odoo.com
.. _docker: https://www.docker.com
.. _Download: https://www.odoo.com/page/download
.. _EPEL: https://fedoraproject.org/wiki/EPEL
.. _PostgreSQL: http://www.postgresql.org
.. _the official installer:
@@ -437,3 +553,6 @@ default db to serve on localhost:8069
.. _pywin32: http://sourceforge.net/projects/pywin32/files/pywin32/
.. _the repository: https://github.com/odoo/odoo
.. _git: http://git-scm.com
.. _Editions: https://www.odoo.com/pricing#pricing_table_features
.. _nightly: https://nightly.odoo.com/9.0/nightly/
.. _extra: https://nightly.odoo.com/extra/