NextERP/documentation
5
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[FIX] *: RST cleanup

Browse Source 
RST cleanup to comply with the RST guidelines. This is required so we
can use "make test", as there are currently hundreds of errors. For now,
it is unusable because of the oldest code in this repo.

closes odoo/documentation#3567

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
This commit is contained in:
Jonathan Castillo (jcs)
2023-02-13 15:50:13 +00:00
parent 1591e1f087
commit 643834ced1
59 changed files with 834 additions and 836 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/administration/install/deploy.rst
+1
View File
@@ -516,6 +516,7 @@ security-related topics:
Blocking Brute Force Attacks
----------------------------
For internet-facing deployments, brute force attacks on user passwords are very common, and this
threat should not be neglected for Odoo servers. Odoo emits a log entry whenever a login attempt
is performed, and reports the result: success or failure, along with the target login and source IP.
content/administration/install/email_gateway.rst
+5 -1
View File
@@ -4,19 +4,22 @@ Email gateway
The Odoo mail gateway allows you to inject directly all the received emails in Odoo.
Its principle is straightforward: your SMTP server executes the "mailgate" script for every new incoming email.
Its principle is straightforward: your SMTP server executes the "mailgate" script for every new
incoming email.
The script takes care of connecting to your Odoo database through XML-RPC, and send the emails via
the `MailThread.message_process()` feature.
Prerequisites
-------------
- Administrator access to the Odoo database.
- Your own mail server such as Postfix or Exim.
- Technical knowledge on how to configure an email server.
For Postfix
-----------
In you alias config (:file:`/etc/aliases`):
.. code-block:: text
@@ -33,6 +36,7 @@ In you alias config (:file:`/etc/aliases`):
For Exim
--------
.. code-block:: text
*: |/odoo-directory/addons/mail/static/scripts/odoo-mailgate.py -d <database-name> -u <userid> -p <password>
content/administration/install/install.rst
+33 -32
View File
@@ -105,13 +105,13 @@ Linux
-----
Debian/Ubuntu
'''''''''''''
~~~~~~~~~~~~~
Odoo {CURRENT_MAJOR_VERSION} 'deb' package currently supports `Debian Buster`_, `Ubuntu 18.04`_ or
above.
Prepare
^^^^^^^
*******
Odoo needs a `PostgreSQL`_ server to run properly. The default configuration for
the Odoo 'deb' package is to use the PostgreSQL server on the same host as your
@@ -127,7 +127,7 @@ Odoo instance. Execute the following command in order to install the PostgreSQL
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**:
@@ -143,7 +143,7 @@ You can then use the usual `apt-get upgrade` command to keep your installation u
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_>`_.
@@ -179,12 +179,13 @@ and automatically start the server.
$ sudo pip3 install num2words
Fedora
''''''
~~~~~~
Odoo {CURRENT_MAJOR_VERSION} 'rpm' package supports Fedora 30.
Prepare
^^^^^^^
*******
Odoo needs a `PostgreSQL`_ server to run properly. Make sure that the `sudo` command is available
and well configured and, only then, execute the following command in order to install the PostgreSQL
server:
@@ -202,7 +203,7 @@ server:
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
@@ -216,7 +217,7 @@ commands:
$ 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_>`_.
@@ -254,12 +255,12 @@ 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:
@@ -275,7 +276,7 @@ Enterprise Edition:
.. _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
@@ -310,10 +311,10 @@ on contributing to Odoo source code, choose SSH.
.. _setup/install/source/windows/prepare:
Prepare
'''''''
~~~~~~~
Python
^^^^^^
******
Odoo requires Python 3.6 or later to run. Visit `Python's download page <https://www.python.org/downloads/windows/>`_
to download and install the latest version of Python 3 on your machine.
@@ -335,7 +336,7 @@ sure that **pip** is checked.
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).
@@ -356,7 +357,7 @@ create a new PostgreSQL user:
`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>`_.
@@ -396,7 +397,7 @@ needed:
(typically: `C:\\Users\\<user>\\AppData\\Roaming\\npm\\`).
Running Odoo
''''''''''''
~~~~~~~~~~~~
Once all dependencies are set up, Odoo can be launched by running `odoo-bin`, the
command-line interface of the server. It is located at the root of the Odoo Community directory.
@@ -444,12 +445,12 @@ 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:
@@ -465,7 +466,7 @@ Enterprise Edition:
.. _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
@@ -500,10 +501,10 @@ on contributing to Odoo source code, choose SSH.
.. _setup/install/source/linux/prepare:
Prepare
'''''''
~~~~~~~
Python
^^^^^^
******
Odoo requires Python 3.6 or later to run. Use your package manager to download and install Python 3
on your machine if it is not already done.
@@ -522,7 +523,7 @@ on your machine if it is not already done.
$ 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).
@@ -545,7 +546,7 @@ create a new PostgreSQL user:
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`
@@ -590,7 +591,7 @@ needed:
$ sudo npm install -g rtlcss
Running Odoo
''''''''''''
~~~~~~~~~~~~
Once all dependencies are set up, Odoo can be launched by running `odoo-bin`, the
command-line interface of the server. It is located at the root of the Odoo Community directory.
@@ -639,12 +640,12 @@ 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:
@@ -660,7 +661,7 @@ Enterprise Edition:
.. _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
@@ -695,10 +696,10 @@ on contributing to Odoo source code, choose SSH.
.. _setup/install/source/mac_os/prepare:
Prepare
'''''''
~~~~~~~
Python
^^^^^^
******
Odoo requires Python 3.6 or later to run. Use your preferred package manager (homebrew_, macports_)
to download and install Python 3 on your machine if it is not already done.
@@ -717,7 +718,7 @@ to download and install Python 3 on your machine if it is not already done.
$ 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).
@@ -739,7 +740,7 @@ create a new PostgreSQL user:
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.
@@ -783,7 +784,7 @@ needed:
$ sudo npm install -g rtlcss
Running Odoo
''''''''''''
~~~~~~~~~~~~
Once all dependencies are set up, Odoo can be launched by running `odoo-bin`, the
command-line interface of the server. It is located at the root of the Odoo Community directory.
content/administration/maintain/on_premise.rst
+18 -26
View File
@@ -19,12 +19,12 @@ If you are unable to register your database, you will likely encounter this
message:
.. image:: on_premise/error_message_sub_code.png
:align: center
:alt: Something went wrong while registering your database,
you can try again or contact Odoo Help
:align: center
:alt: Something went wrong while registering your database, you can try again or contact Odoo
Help
Solutions
'''''''''
~~~~~~~~~
* Do you have a valid Enterprise subscription?
@@ -42,15 +42,13 @@ Solutions
<https://accounts.odoo.com/my/subscription>`__ with the button "Unlink database"
.. image:: on_premise/unlink_single_db.png
:align: center
:align: center
A confirmation message will appear; make sure this is the correct database as
it will be deactivated shortly:
.. image:: on_premise/unlink_confirm_enterprise_edition.png
:align: center
:align: center
* Do you have the updated version of Odoo 9?
@@ -63,8 +61,7 @@ Solutions
specifying which database is problematic:
.. image:: on_premise/unlink_db_name_collision.png
:align: center
:align: center
In this case, you need to change the UUID on your test databases to solve this
issue. You will find more information about this in :ref:`this section <duplicate_premise>`.
@@ -85,8 +82,6 @@ Solutions
* Once you activated your database, you must keep these ports open, as the
Update notification runs once a week.
Error message due to too many users
-----------------------------------
@@ -94,16 +89,15 @@ If you have more users in your local database than provisionned in your
Odoo Enterprise subscription, you may encounter this message:
.. image:: on_premise/add_more_users.png
:align: center
:alt: This database will expire in X days, you
have more users than your subscription allows
:align: center
:alt: This database will expire in X days, you have more users than your subscription allows
When the message appears you have 30 days before the expiration.
The countdown is updated everyday.
Solutions
'''''''''
~~~~~~~~~
- **Add more users** on your subscription: follow the link and Validate
the upsell quotation and pay for the extra users.
@@ -123,15 +117,14 @@ If your database reaches its expiration date before your renew your subscription
you will encounter this message:
.. image:: on_premise/database_expired.png
:align: center
:alt: This database has expired.
:align: center
:alt: This database has expired.
This **blocking** message appears after a non-blocking message that lasts 30 days.
If you fail to take action before the end of the countdown, the database is expired.
Solutions
'''''''''
~~~~~~~~~
* Renew your subscription: follow the link and renew your subscription - note that
if you wish to pay by Wire Transfer, your subscription will effectively be renewed
@@ -142,7 +135,6 @@ Solutions
None of those solutions worked for you? Please contact our
`Support <https://www.odoo.com/help>`__
.. _force_ping:
.. _duplicate_premise:
@@ -155,8 +147,7 @@ server (<odoo-server>/web/database/manager). In this page, you can easily
duplicate your database (among other things).
.. image:: on_premise/db_manager.gif
:align: center
:align: center
When you duplicate a local database, it is **strongly** advised to change
the duplicated database's uuid (Unniversally Unique Identifier), since this
@@ -164,8 +155,9 @@ uuid is how your database identifies itself with our servers. Having two
databases with the same uuid could result in invoicing problems or registration
problems down the line.
.. note:: From July 2016 onward, Odoo 9 now automatically change the uuid of a
duplicated database; a manual operation is no longer required.
.. note::
From July 2016 onward, Odoo 9 now automatically change the uuid of a duplicated database; a
manual operation is no longer required.
The database uuid is currently accessible from the menu :menuselection:`Settings --> Technical -->
System Parameters`, we advise you to use a `uuid generator <https://www.uuidtools.com>`_ or to
@@ -173,4 +165,4 @@ use the unix command ``uuidgen`` to generate a new uuid. You can then simply rep
other record by clicking on it and using the edit button.
.. image:: on_premise/db_uuid.png
:align: center
:align: center
content/administration/maintain/update.rst
+2
View File
@@ -104,6 +104,7 @@ and you're all set.
Source Install (Tarball)
------------------------
If you have originally installed Odoo with the "tarball" version (source code archive), you have
to replace the installation directory with a newer version. First download the latest tarball
from Odoo.com. They are updated daily and include the latest security fixes (see step #1)
@@ -123,6 +124,7 @@ Finally, restart the Odoo service or reboot the machine, and you are all set.
Source Install (Github)
-----------------------
If you have originally installed Odoo with a full Github clone of the official repositories, the
update procedure requires you to pull the latest source code via git.
Change into the directory for each repository (the main Odoo repository, and the Enterprise