Compare commits
2 Commits
15.0-pos-h
...
14.0-crm-l
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
da36d9c8b7 | ||
|
|
4851e8e80b |
1
.gitignore
vendored
@@ -4,6 +4,7 @@
|
||||
|
||||
# Sphinx build files
|
||||
_build/
|
||||
extensions/odoo_theme/static/style.css
|
||||
|
||||
# Dependencies
|
||||
odoo
|
||||
|
||||
@@ -47,11 +47,6 @@ file_filter = locale/<lang>/LC_MESSAGES/services.po
|
||||
source_file = locale/sources/services.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.theme]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/sphinx.po
|
||||
source_file = locale/sources/sphinx.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.user_settings]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/settings.po
|
||||
source_file = locale/sources/settings.pot
|
||||
@@ -60,4 +55,4 @@ source_lang = en
|
||||
[odoo-14-doc.websites]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/websites.po
|
||||
source_file = locale/sources/websites.pot
|
||||
source_lang = en
|
||||
source_lang = en
|
||||
|
||||
27
Makefile
@@ -1,18 +1,10 @@
|
||||
# Makefile for Sphinx documentation
|
||||
|
||||
# Pass WORKERS=1 for single-worker build
|
||||
# Pass WORKERS=auto for parallel build
|
||||
ifndef WORKERS
|
||||
WORKERS = auto
|
||||
endif
|
||||
|
||||
ifndef BUILD_DIR
|
||||
BUILD_DIR = _build
|
||||
endif
|
||||
|
||||
ifndef CURRENT_LANG
|
||||
CURRENT_LANG = en
|
||||
endif
|
||||
|
||||
SPHINX_BUILD = sphinx-build
|
||||
CONFIG_DIR = .
|
||||
SPHINXOPTS = -D project_root=$(ROOT) -D canonical_version=$(CANONICAL_VERSION) \
|
||||
@@ -21,10 +13,11 @@ SPHINXOPTS = -D project_root=$(ROOT) -D canonical_version=$(CANONICAL_VERSIO
|
||||
-A google_analytics_key=$(GOOGLE_ANALYTICS_KEY) \
|
||||
-j $(WORKERS)
|
||||
SOURCE_DIR = content
|
||||
BUILD_DIR = _build
|
||||
|
||||
HTML_BUILD_DIR = $(BUILD_DIR)/html
|
||||
ifdef VERSIONS
|
||||
HTML_BUILD_DIR := $(HTML_BUILD_DIR)/15.0
|
||||
HTML_BUILD_DIR := $(HTML_BUILD_DIR)/14.0
|
||||
endif
|
||||
ifneq ($(CURRENT_LANG),en)
|
||||
HTML_BUILD_DIR := $(HTML_BUILD_DIR)/$(CURRENT_LANG)
|
||||
@@ -44,9 +37,10 @@ help:
|
||||
clean:
|
||||
@echo "Cleaning build files..."
|
||||
rm -rf $(BUILD_DIR)/*
|
||||
rm extensions/odoo_theme/static/style.css
|
||||
@echo "Cleaning finished."
|
||||
|
||||
html: $(HTML_BUILD_DIR)/_static/style.css
|
||||
html: extensions/odoo_theme/static/style.css
|
||||
@echo "Starting build..."
|
||||
$(SPHINX_BUILD) -c $(CONFIG_DIR) -b html $(SPHINXOPTS) $(SOURCE_DIR) $(HTML_BUILD_DIR)
|
||||
@echo "Build finished."
|
||||
@@ -66,10 +60,9 @@ gettext:
|
||||
$(SPHINX_BUILD) -c $(CONFIG_DIR) -b gettext $(SOURCE_DIR) locale/sources
|
||||
@echo "Generation finished."
|
||||
|
||||
$(HTML_BUILD_DIR)/_static/style.css: extensions/odoo_theme/static/style.scss extensions/odoo_theme/static/scss/*.scss
|
||||
extensions/odoo_theme/static/style.css: extensions/odoo_theme/static/style.scss extensions/odoo_theme/static/scss/*.scss
|
||||
@echo "Compiling stylesheets..."
|
||||
mkdir -p $(HTML_BUILD_DIR)/_static
|
||||
pysassc extensions/odoo_theme/static/style.scss $(HTML_BUILD_DIR)/_static/style.css
|
||||
pysassc $(subst .css,.scss,$@) $@
|
||||
@echo "Compilation finished."
|
||||
|
||||
#=== Development and debugging rules ===#
|
||||
@@ -77,6 +70,6 @@ $(HTML_BUILD_DIR)/_static/style.css: extensions/odoo_theme/static/style.scss ext
|
||||
fast: SPHINXOPTS += -A collapse_menu=True
|
||||
fast: html
|
||||
|
||||
static: $(HTML_BUILD_DIR)/static/style.css
|
||||
cp -r extensions/odoo_theme/static/* $(HTML_BUILD_DIR)/_static/
|
||||
cp -r static/* $(HTML_BUILD_DIR)/_static/
|
||||
static: extensions/odoo_theme/static/style.css
|
||||
cp -r extensions/odoo_theme/static/* _build/html/_static/
|
||||
cp -r static/* _build/html/_static/
|
||||
|
||||
14
README.md
@@ -4,11 +4,11 @@
|
||||
|
||||
### Requirements
|
||||
|
||||
- [Git](https://www.odoo.com/documentation/15.0/contributing/documentation.html#install-git)
|
||||
- [Python 3.6, 3.7, or 3.8](https://www.odoo.com/documentation/15.0/contributing/documentation.html#python)
|
||||
- Python dependencies listed in the file [`requirements.txt`](https://github.com/odoo/documentation/tree/15.0/requirements.txt).
|
||||
- [Make](https://www.odoo.com/documentation/15.0/contributing/documentation.html#make)
|
||||
- A local copy of the [odoo/odoo repository in 15.0](https://github.com/odoo/odoo/tree/15.0) (Optional)
|
||||
- [Git](https://www.odoo.com/documentation/14.0/contributing/documentation/introduction_guide.html#install-git)
|
||||
- [Python 3.6, 3.7, or 3.8](https://www.odoo.com/documentation/14.0/contributing/documentation/introduction_guide.html#python)
|
||||
- Python dependencies listed in the file [`requirements.txt`](https://github.com/odoo/documentation/tree/14.0/requirements.txt).
|
||||
- [Make](https://www.odoo.com/documentation/14.0/contributing/documentation/introduction_guide.html#make)
|
||||
- A local copy of the [odoo/odoo repository in 14.0](https://github.com/odoo/odoo/tree/14.0) (Optional)
|
||||
|
||||
### Instructions
|
||||
|
||||
@@ -23,7 +23,7 @@
|
||||
|
||||
2. Open the file `documentation/_build/html/index.html` in your web browser to display the render.
|
||||
|
||||
3. See [this guide](https://www.odoo.com/documentation/15.0/contributing/documentation.html#preview-your-changes)
|
||||
3. See [this guide](https://www.odoo.com/documentation/14.0/contributing/documentation/introduction_guide.html#preview-your-changes)
|
||||
for more detailed instructions.
|
||||
|
||||
Optional: to fully build the developer documentation with inline docstrings for documented Python
|
||||
@@ -34,7 +34,7 @@ be shown.
|
||||
## Contribute to the documentation
|
||||
|
||||
For contributions to the content of the documentation, please refer to the
|
||||
[Introduction Guide](https://www.odoo.com/documentation/15.0/contributing/documentation.html).
|
||||
[Introduction Guide](https://www.odoo.com/documentation/14.0/contributing/documentation/introduction_guide.html).
|
||||
|
||||
To **report a content issue**, **request new content** or **ask a question**, use the
|
||||
[repository's issue tracker](https://github.com/odoo/documentation-user/issues) as usual.
|
||||
|
||||
21
conf.py
@@ -19,7 +19,7 @@ copyright = 'Odoo S.A.'
|
||||
# `version` if the version info for the project being documented, acts as replacement for |version|,
|
||||
# also used in various other places throughout the built documents.
|
||||
# `release` is the full version, including alpha/beta/rc tags. Acts as replacement for |release|.
|
||||
version = release = '15.0'
|
||||
version = release = '14.0'
|
||||
|
||||
# The minimal Sphinx version required to build the documentation.
|
||||
needs_sphinx = '3.0.0'
|
||||
@@ -60,30 +60,24 @@ sys.path.insert(0, str(extension_dir.absolute()))
|
||||
# Search for the directory of odoo sources to know whether autodoc should be used on the dev doc
|
||||
odoo_dir = Path('odoo')
|
||||
odoo_dir_in_path = False
|
||||
if not odoo_dir.is_dir():
|
||||
parent_odoo_dir = Path('../odoo')
|
||||
if parent_odoo_dir.is_dir():
|
||||
_logger.info('Using parent dir to find odoo sources')
|
||||
odoo_dir = parent_odoo_dir
|
||||
if not odoo_dir.is_dir():
|
||||
_logger.warning(
|
||||
f"Could not find Odoo sources directory at {odoo_dir.absolute()}.\n"
|
||||
f"The 'Developer' documentation will be built but autodoc directives will be skipped.\n"
|
||||
f"In order to fully build the 'Developer' documentation, clone the repository with "
|
||||
f"`git clone https://github.com/odoo/odoo` or create a symbolic link."
|
||||
f"`git clone https://github.com/odoo/odoo` or create a symbolink link."
|
||||
)
|
||||
else:
|
||||
sys.path.insert(0, str(odoo_dir.absolute()))
|
||||
from odoo import release as odoo_release # Don't collide with Sphinx's 'release' config option
|
||||
odoo_version = odoo_release.version.replace('~', '-') \
|
||||
if 'alpha' not in odoo_release.version else 'master'
|
||||
odoo_version = odoo_release.version if 'alpha' not in odoo_release.version else 'master'
|
||||
if release != odoo_version:
|
||||
_logger.warning(
|
||||
f"Found Odoo sources directory but with version '{odoo_version}' incompatible with "
|
||||
f"documentation version '{version}'.\n"
|
||||
f"The 'Developer' documentation will be built but autodoc directives will be skipped.\n"
|
||||
f"In order to fully build the 'Developer' documentation, checkout the matching branch "
|
||||
f"with `cd odoo && git checkout {version}`."
|
||||
f"In order to fully build the 'Developer' documentation, checkout the matching branch"
|
||||
f" with `cd odoo && git checkout {version}`."
|
||||
)
|
||||
else:
|
||||
_logger.info(f"Found Odoo sources directory matching documentation version {release}.")
|
||||
@@ -136,9 +130,8 @@ github_user = 'odoo'
|
||||
github_project = 'documentation'
|
||||
|
||||
locale_dirs = ['../locale/']
|
||||
templates_path = ['../extensions']
|
||||
|
||||
# custom docname_to_domain to divide the translations of applications in subdirectories
|
||||
# custom docname_to_domain to devide the translations of applications in subdirectories
|
||||
sphinx.transforms.i18n.docname_to_domain = (
|
||||
sphinx.util.i18n.docname_to_domain
|
||||
) = lambda docname, compact: docname.split('/')[1 if docname.startswith('applications/') else 0]
|
||||
@@ -291,7 +284,7 @@ def _generate_alternate_urls(app, pagename, templatename, context, doctree):
|
||||
for _alternate_version in sorted(_alternate_versions, reverse=True)
|
||||
if _alternate_version != version and (
|
||||
_alternate_version != 'master' or pagename.startswith('developer')
|
||||
) and not _alternate_version.startswith('saas')
|
||||
)
|
||||
]
|
||||
|
||||
def _localize():
|
||||
|
||||
@@ -1,21 +1,14 @@
|
||||
:nosearch:
|
||||
:show-content:
|
||||
:hide-page-toc:
|
||||
:show-toc:
|
||||
|
||||
====================
|
||||
Install and Maintain
|
||||
====================
|
||||
|
||||
These guides provide instructions on how to install, maintain and upgrade Odoo databases.
|
||||
|
||||
.. seealso::
|
||||
:doc:`History of Versions <administration/maintain/supported_versions>`
|
||||
==============
|
||||
Administration
|
||||
==============
|
||||
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
|
||||
administration/install
|
||||
administration/maintain
|
||||
administration/deployment
|
||||
administration/update
|
||||
administration/db_upgrade
|
||||
administration/odoo_sh
|
||||
administration/db_management
|
||||
administration/enterprise
|
||||
|
||||
10
content/administration/db_management.rst
Normal file
@@ -0,0 +1,10 @@
|
||||
===================
|
||||
Database Management
|
||||
===================
|
||||
|
||||
|
||||
.. toctree::
|
||||
|
||||
db_management/db_online
|
||||
db_management/db_premise
|
||||
db_management/hosting_changes
|
||||
233
content/administration/db_management/db_online.rst
Normal file
@@ -0,0 +1,233 @@
|
||||
|
||||
.. _db_online:
|
||||
|
||||
==========================
|
||||
Online Database management
|
||||
==========================
|
||||
|
||||
To manage your databases, access the `database management page
|
||||
<https://www.odoo.com/my/databases>`__ (you will have to sign in). Then click
|
||||
on the `Manage Your Databases <https://www.odoo.com/my/databases/manage>`__
|
||||
button.
|
||||
|
||||
.. image:: media/databases.png
|
||||
:align: center
|
||||
|
||||
Make sure you are connected as the administrator of the database you
|
||||
want to manage - many operations depends on indentifying you remotely to that
|
||||
database.
|
||||
|
||||
Several actions are available:
|
||||
|
||||
.. image:: media/db_buttons.png
|
||||
:align: center
|
||||
|
||||
* :ref:`Upgrade <upgrade_button>`
|
||||
Upgrade your database to the latest Odoo version to enjoy cutting-edge
|
||||
features
|
||||
* :ref:`Duplicate <duplicate_online>`
|
||||
Make an exact copy of your database, if you want
|
||||
to try out new apps or new flows without compromising
|
||||
your daily operations
|
||||
* :ref:`Rename <rename_online_database>`
|
||||
Rename your database (and its URL)
|
||||
* **Backup**
|
||||
Download an instant backup of your database; note that we
|
||||
back up databases daily according to our Odoo Cloud SLA
|
||||
* :ref:`Domains <custom_domain>`
|
||||
Configure custom domains to access your
|
||||
database via another URL
|
||||
* :ref:`Delete <delete_online_database>`
|
||||
Delete a database instantly
|
||||
* Contact Support
|
||||
Access our `support page <https://www.odoo.com/help>`__
|
||||
with the correct database already selected
|
||||
|
||||
.. _upgrade_button:
|
||||
|
||||
Upgrade
|
||||
=======
|
||||
|
||||
.. warning:: Upgrading your database to a newer version of Odoo is a complex operation
|
||||
that require time and caution. It is extremely important that you
|
||||
fully test the process before upgrading your production database.
|
||||
|
||||
Odoo releases new versions regularly (at least once a year), and upgrading your
|
||||
database to enjoy new Odoo features is part of the Odoo Online experience.
|
||||
|
||||
The upgrade process can take some time, especially if you use multiple apps or
|
||||
apps that manage sensitive data (e.g. Accounting, Inventory, etc.). In general,
|
||||
the 'smaller' the database, the quickest the upgrade. A single-user
|
||||
database that uses only CRM will be processed faster than a multi-company,
|
||||
multi-user database that uses Accounting, Sales, Purchase and Manufacturing.
|
||||
|
||||
Unfortunately, it is impossible to give time estimates for every upgrade request,
|
||||
since Odoo.com will test manually every database upgrade at least once and will
|
||||
need to correct/adapt changes made to the standard Odoo Apps (e.g. through Studio
|
||||
or through a Success Pack) on a case-by-case basis. This can make the process
|
||||
slower, since requests are treated in the order they arrive. This is especially
|
||||
true in the months following the release of a new major version, which can lengthen
|
||||
the upgrade delay significantly.
|
||||
|
||||
The upgrade process is quite simple from your point of view:
|
||||
|
||||
1. You request a test upgrade
|
||||
2. Once all tests have been validated **by you**, you upgrade your actual database
|
||||
|
||||
The process to request a test or a production (*actual*) upgrade is the same.
|
||||
|
||||
First, make sure to be connected to the database you want to upgrade and access the
|
||||
`database management page <https://www.odoo.com/my/databases>`__.
|
||||
|
||||
.. note:: You have to have an active session with access to the Settings app
|
||||
in the database you want to upgrade for the button to be visible.
|
||||
|
||||
On the line of the database you want to upgrade, click
|
||||
on the "Cog" menu. If an newer version of Odoo is available, you will see an 'Upgrade'
|
||||
button.
|
||||
|
||||
.. image:: media/upgrade1.png
|
||||
:align: center
|
||||
|
||||
You have the possibility to choose the target version of the upgrade. By default,
|
||||
we select the highest available version available for your database; if you were
|
||||
already in the process of testing an upgrade, we will automatically select the
|
||||
version you were already testing (even if we released a more recent version during
|
||||
your tests).
|
||||
|
||||
.. image:: media/upgrade_test.png
|
||||
:align: center
|
||||
|
||||
By clicking on the "Test upgrade" button, an upgrade request will be generated.
|
||||
Only one request can be made at time for each database; if a request has already
|
||||
been made, you will see an 'Upgrade Queued' note instead and asking another
|
||||
request will not be possible.
|
||||
|
||||
A test upgrade will create a copy of your database, upgrade it and make it
|
||||
available to you automatically once successful. If this is the first test you
|
||||
request for this particular database, a manual testing phase will be done by
|
||||
Odoo.com - this could take time (up to several weeks). Subsequent requests
|
||||
will not go through that manual testing step and will usually be made
|
||||
available in a few hours. Once the test database is available, you should
|
||||
receive an e-mail with the URL of the test database.
|
||||
|
||||
**Testing your database is the most important step of the upgrade process!**
|
||||
Even though we test all upgrades manually, we do not know your work processes.
|
||||
A change in standard worfklows of Odoo in new versions might require you to
|
||||
change internal processes, or some of the customizations you made through Odoo
|
||||
Studio might not work properly. *It is up to you to make sure that everything
|
||||
works as it should!* You can report issues with your test database through our
|
||||
`Support page <https://www.odoo.com/help>`__.
|
||||
|
||||
Make sure to do one last test of your upgrade right before the final upgrade
|
||||
(e.g. the day before) to ensure everything will run smoothly. Downgrading is
|
||||
not possible and post-poning an upgrade is always easier than being prevented
|
||||
to work by an upgrade issue after the fact!
|
||||
|
||||
Once you are ready and you have validated all your tests, you can click
|
||||
again on the Upgrade button and confirm by clicking on Upgrade (the button
|
||||
with the little rocket!) to switch your production database to the new version.
|
||||
Your database will then be taken offline within the next 10 minutes and will be
|
||||
upgraded automatically; you receive a confirmation
|
||||
e-mail once the process is completed.
|
||||
|
||||
.. image:: media/upgrade_prod.png
|
||||
:align: center
|
||||
|
||||
.. warning::
|
||||
Your database will be taken offline during the upgrade (usually between 30min up to several hours
|
||||
for big databases), so make sure to plan your migration during non-business hours.
|
||||
|
||||
.. _duplicate_online:
|
||||
|
||||
Duplicating a database
|
||||
======================
|
||||
|
||||
.. note:: Database duplication, renaming, custom DNS, etc. is not available
|
||||
for trial databases on our Online platform. Paid Databases and "One App
|
||||
Free" database can duplicate without problem.
|
||||
|
||||
|
||||
In the line of the database you want to duplicate, you will have a few
|
||||
buttons. To duplicate your database, just click **Duplicate**. You will
|
||||
have to give a name to your duplicate, then click **Duplicate Database**.
|
||||
|
||||
.. image:: media/db_duplicate.png
|
||||
:align: center
|
||||
|
||||
.. danger:: If you do not check the "For testing purposes" checkbox when
|
||||
duplicating a database, all external communication will remain active:
|
||||
|
||||
* Emails are sent
|
||||
|
||||
* Payments are processed (in the e-commerce or Subscriptions apps, for
|
||||
example)
|
||||
|
||||
* Delivery orders (shipping providers) are sent
|
||||
|
||||
* Etc.
|
||||
|
||||
Make sure to check the checkbox "For testing purposes" if you want these
|
||||
behaviours to be disabled.
|
||||
|
||||
After a few seconds, you will be logged in your duplicated database.
|
||||
Notice that the url uses the name you chose for your duplicated
|
||||
database.
|
||||
|
||||
.. note::
|
||||
Duplicate databases expire automatically after 15 days.
|
||||
|
||||
.. image:: media/dup_expires.png
|
||||
:align: center
|
||||
|
||||
.. _rename_online_database:
|
||||
|
||||
Rename a Database
|
||||
===================
|
||||
|
||||
To rename your database, make sure you are connected to the database you want
|
||||
to rename, access the `database management page <https://www.odoo.com/my/databases>`__
|
||||
and click **Rename**. You will have to give a new name to your database,
|
||||
then click **Rename Database**.
|
||||
|
||||
.. image:: media/rename.png
|
||||
:align: center
|
||||
|
||||
.. _delete_online_database:
|
||||
|
||||
Deleting a Database
|
||||
===================
|
||||
|
||||
You can only delete databases of which you are the administrator.
|
||||
|
||||
.. danger:: When you delete your database all the data will be permanently lost.
|
||||
The deletion is instant and for all the Users. We advise you to do an
|
||||
instant backup of your database before deleting it, since the last automated
|
||||
daily backup may be several hours old at that point.
|
||||
|
||||
|
||||
From the `database management page <https://www.odoo.com/my/databases>`__,
|
||||
on the line of the database you want to delete, click on the "Delete" button.
|
||||
|
||||
.. image:: media/delete_button.png
|
||||
:align: center
|
||||
|
||||
|
||||
Read carefully the warning message that will appear and proceed only if you
|
||||
fully understand the implications of deleting a database:
|
||||
|
||||
.. image:: media/delete_warning.png
|
||||
:align: center
|
||||
|
||||
After a few seconds, the database will be deleted and the page will
|
||||
reload automatically.
|
||||
|
||||
.. note::
|
||||
* If you need to re-use this database name, it will be immediately available.
|
||||
|
||||
* It is not possible to delete a database if it is expired or linked
|
||||
to a Subscription. In these cases contact
|
||||
`Odoo Support <https://www.odoo.com/help>`__
|
||||
|
||||
* If you want to delete your Account, please contact
|
||||
`Odoo Support <https://www.odoo.com/help>`__
|
||||
@@ -1,9 +1,9 @@
|
||||
|
||||
.. _db_management/hosting_changes:
|
||||
|
||||
=======================
|
||||
Change hosting solution
|
||||
=======================
|
||||
===============
|
||||
Hosting Changes
|
||||
===============
|
||||
|
||||
You may want to move your Odoo database from one hosting solution to another.
|
||||
Depending on the platforms, you have to do it by yourself or contact our support team first.
|
||||
@@ -59,3 +59,4 @@ From Odoo.sh to on-premises
|
||||
1. Grab a :ref:`backup of your Odoo.sh production database <odoo_sh_branches_backups>`.
|
||||
2. Restore it from the database manager on your local server.
|
||||
|
||||
|
||||
|
Before Width: | Height: | Size: 9.5 KiB After Width: | Height: | Size: 9.5 KiB |
|
Before Width: | Height: | Size: 4.6 KiB After Width: | Height: | Size: 4.6 KiB |
BIN
content/administration/db_management/media/databases.png
Normal file
|
After Width: | Height: | Size: 9.2 KiB |
BIN
content/administration/db_management/media/db_buttons.png
Normal file
|
After Width: | Height: | Size: 10 KiB |
BIN
content/administration/db_management/media/db_duplicate.png
Normal file
|
After Width: | Height: | Size: 7.3 KiB |
|
Before Width: | Height: | Size: 89 KiB After Width: | Height: | Size: 89 KiB |
|
Before Width: | Height: | Size: 17 KiB After Width: | Height: | Size: 17 KiB |
BIN
content/administration/db_management/media/delete_button.png
Normal file
|
After Width: | Height: | Size: 3.4 KiB |
BIN
content/administration/db_management/media/delete_warning.png
Normal file
|
After Width: | Height: | Size: 15 KiB |
BIN
content/administration/db_management/media/dependencies.png
Normal file
|
After Width: | Height: | Size: 19 KiB |
BIN
content/administration/db_management/media/dup_expires.png
Normal file
|
After Width: | Height: | Size: 44 KiB |
|
Before Width: | Height: | Size: 6.9 KiB After Width: | Height: | Size: 6.9 KiB |
BIN
content/administration/db_management/media/rename.png
Normal file
|
After Width: | Height: | Size: 11 KiB |
BIN
content/administration/db_management/media/test_upgrade.png
Normal file
|
After Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
BIN
content/administration/db_management/media/upgrade1.png
Normal file
|
After Width: | Height: | Size: 28 KiB |
BIN
content/administration/db_management/media/upgrade_prod.png
Normal file
|
After Width: | Height: | Size: 35 KiB |
BIN
content/administration/db_management/media/upgrade_test.png
Normal file
|
After Width: | Height: | Size: 35 KiB |
@@ -6,9 +6,9 @@
|
||||
|
||||
.. _db-upgrade:
|
||||
|
||||
================
|
||||
Versions upgrade
|
||||
================
|
||||
=======
|
||||
Upgrade
|
||||
=======
|
||||
|
||||
.. _db-upgrade/overview:
|
||||
|
||||
@@ -20,7 +20,8 @@ Overview
|
||||
The upgrade process
|
||||
-------------------
|
||||
|
||||
This documentation is for our *On-Premise* (self-hosted) and *Odoo.sh* customers.
|
||||
This documentation is for our *On-Premise* (self-hosted) and *Odoo.sh* customers. If you are hosted
|
||||
Online, please check our :ref:`instruction page for our Online (SaaS) customers <upgrade_button>`.
|
||||
|
||||
.. _db-upgrade/definition:
|
||||
|
||||
@@ -108,7 +109,8 @@ The upgrade process varies depending on where your database is hosted.
|
||||
Online (SaaS)
|
||||
-------------
|
||||
|
||||
If you are hosted Online, please check your `database manager <https://www.odoo.com/my/databases>`_.
|
||||
If you are hosted Online, please check our :ref:`instruction page for our Online (SaaS) customers
|
||||
<upgrade_button>`.
|
||||
|
||||
.. _db-upgrade/odoo-sh:
|
||||
|
||||
@@ -116,7 +118,7 @@ Odoo.sh
|
||||
-------
|
||||
|
||||
If you are Odoo.sh hosted, check our :doc:`specific instructions to be able to upgrade
|
||||
<../odoo_sh/advanced/upgrade_your_database>`.
|
||||
<odoo_sh/advanced/upgrade_your_database>`.
|
||||
|
||||
.. _db-upgrade/on-premise:
|
||||
|
||||
@@ -128,7 +130,7 @@ There are two possibilities:
|
||||
#. Via the interface of our `website form <https://upgrade.odoo.com>`_
|
||||
#. | For technically-advanced users and partners, via the following command line (to be used on the
|
||||
machine where your database is hosted):
|
||||
| ``python <(curl -s https://upgrade.odoo.com/upgrade) test -d <your db name> -t 14.0``
|
||||
| ``python <(curl -s beta.upgrade.odoo.com/upgrade) test -d <your db name> -t 14.0``
|
||||
|
||||
What does it do?
|
||||
~~~~~~~~~~~~~~~~
|
||||
@@ -190,8 +192,8 @@ Test guidance
|
||||
|
||||
Every business and organization has its own operational needs and will have to test its specific
|
||||
Odoo instance respectively. However, we recommend you look at `the test scenario
|
||||
<https://docs.google.com/document/d/1ypNs7JKPOsjNbKpdiKFH7Al6g6whZ9jr7f7duAQ5E1w/>`_ we created, a
|
||||
high-level idea of what you should test and look out for.
|
||||
<https://drive.google.com/open?id=1Lm4JqbsHBirB1wMi14UChoz_YHLjx5ec>`_ we created, a high-level idea
|
||||
of what you should test and look out for.
|
||||
|
||||
.. todo:: change link "test scenario" once the related doc is published
|
||||
|
||||
@@ -349,7 +351,7 @@ for the production request.
|
||||
Upgrade of the custom modules
|
||||
-----------------------------
|
||||
|
||||
As stated in our :doc:`/legal/terms/enterprise`, section :ref:`charges_standard`, this optional
|
||||
As stated in our :doc:`../legal/terms/enterprise`, section :ref:`charges_standard`, this optional
|
||||
service is subject to additional fees.
|
||||
|
||||
If you have a custom code, you can choose to have it upgraded by our services, by one of our
|
||||
@@ -374,7 +376,7 @@ Switching the hosting types (Self-hosted vs Online vs Odoo.sh)
|
||||
An upgrade does not cover a change of `Hosting types <https://www.odoo.com/page/hosting-types>`_.
|
||||
|
||||
Open the following link to get :doc:`more information about how to change your hosting type
|
||||
<hosting_changes>`.
|
||||
<db_management/hosting_changes>`.
|
||||
|
||||
.. note:: |assistance-contact|
|
||||
|
||||
@@ -410,4 +412,4 @@ This is a factor to take into consideration before upgrading. If you are on an o
|
||||
suggest you to prefer the most recent version to benefit from a longer support (before having to
|
||||
upgrade again).
|
||||
|
||||
You can get more information about our :doc:`supported versions <supported_versions>`.
|
||||
You can get more information about our :doc:`supported versions <../services/support/supported_versions>`.
|
||||
10
content/administration/deployment.rst
Normal file
@@ -0,0 +1,10 @@
|
||||
==========
|
||||
Deployment
|
||||
==========
|
||||
|
||||
|
||||
.. toctree::
|
||||
|
||||
deployment/deploy
|
||||
deployment/cdn
|
||||
deployment/email_gateway
|
||||
@@ -1,6 +1,7 @@
|
||||
===========================================
|
||||
Setting up a Content Delivery Network (CDN)
|
||||
===========================================
|
||||
|
||||
========================================
|
||||
Deploying with Content Delivery Networks
|
||||
========================================
|
||||
|
||||
.. _reference/cdn/keycdn:
|
||||
|
||||
|
Before Width: | Height: | Size: 41 KiB After Width: | Height: | Size: 41 KiB |
|
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 10 KiB |
|
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 28 KiB |
|
Before Width: | Height: | Size: 9.8 KiB After Width: | Height: | Size: 9.8 KiB |
|
Before Width: | Height: | Size: 33 KiB After Width: | Height: | Size: 33 KiB |
|
Before Width: | Height: | Size: 6.3 KiB After Width: | Height: | Size: 6.3 KiB |
|
Before Width: | Height: | Size: 7.2 KiB After Width: | Height: | Size: 7.2 KiB |
@@ -1,6 +1,7 @@
|
||||
====================
|
||||
System configuration
|
||||
====================
|
||||
|
||||
==============
|
||||
Deploying Odoo
|
||||
==============
|
||||
|
||||
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
|
||||
@@ -9,6 +10,7 @@ internet.
|
||||
|
||||
.. warning:: If you are setting up a public server, be sure to check our :ref:`security` recommandations!
|
||||
|
||||
|
||||
.. _db_filter:
|
||||
|
||||
dbfilter
|
||||
@@ -63,15 +65,15 @@ in ``/etc/odoo.conf`` set:
|
||||
dbfilter = ^%d$
|
||||
|
||||
.. note::
|
||||
|
||||
Setting a proper :option:`--db-filter <odoo-bin --db-filter>` is an important part
|
||||
of securing your deployment.
|
||||
Once it is correctly working and only matching a single database per hostname, it
|
||||
is strongly recommended to block access to the database manager screens,
|
||||
and to use the ``--no-database-list`` startup parameter to prevent listing
|
||||
and to use the ``--no-database-list`` startup paramater to prevent listing
|
||||
your databases, and to block access to the database management screens.
|
||||
See also security_.
|
||||
|
||||
|
||||
PostgreSQL
|
||||
==========
|
||||
|
||||
@@ -169,7 +171,7 @@ SSL Between Odoo and PostgreSQL
|
||||
|
||||
Since Odoo 11.0, you can enforce ssl connection between Odoo and PostgreSQL.
|
||||
in Odoo the db_sslmode control the ssl security of the connection
|
||||
with value chosen out of 'disable', 'allow', 'prefer', 'require', 'verify-ca'
|
||||
with value choosed out of 'disable', 'allow', 'prefer', 'require', 'verify-ca'
|
||||
or 'verify-full'
|
||||
|
||||
`PostgreSQL Doc <https://www.postgresql.org/docs/current/static/libpq-ssl.html>`_
|
||||
@@ -195,6 +197,7 @@ be better monitored and resource-restricted.
|
||||
|
||||
.. warning:: multiprocessing mode currently isn't available on Windows
|
||||
|
||||
|
||||
Worker number calculation
|
||||
-------------------------
|
||||
|
||||
@@ -227,14 +230,16 @@ like nginx or apache. When doing so, you'll need to forward some more http Heade
|
||||
to Odoo, and activate the proxy_mode in Odoo configuration to have Odoo read those
|
||||
headers.
|
||||
|
||||
|
||||
|
||||
Configuration sample
|
||||
--------------------
|
||||
|
||||
* Server with 4 CPU, 8 Thread
|
||||
* 60 concurrent users
|
||||
|
||||
* 60 users / 6 = 10 <- theoretical number of worker needed
|
||||
* (4 * 2) + 1 = 9 <- theoretical maximal number of worker
|
||||
* 60 users / 6 = 10 <- theorical number of worker needed
|
||||
* (4 * 2) + 1 = 9 <- theorical maximal number of worker
|
||||
* We'll use 8 workers + 1 for cron. We'll also use a monitoring system to measure cpu load, and check if it's between 7 and 7.5 .
|
||||
* RAM = 9 * ((0.8*150) + (0.2*1024)) ~= 3Go RAM for Odoo
|
||||
|
||||
@@ -285,59 +290,59 @@ in ``/etc/nginx/sites-enabled/odoo.conf`` set:
|
||||
|
||||
#odoo server
|
||||
upstream odoo {
|
||||
server 127.0.0.1:8069;
|
||||
server 127.0.0.1:8069;
|
||||
}
|
||||
upstream odoochat {
|
||||
server 127.0.0.1:8072;
|
||||
server 127.0.0.1:8072;
|
||||
}
|
||||
|
||||
# http -> https
|
||||
server {
|
||||
listen 80;
|
||||
server_name odoo.mycompany.com;
|
||||
rewrite ^(.*) https://$host$1 permanent;
|
||||
listen 80;
|
||||
server_name odoo.mycompany.com;
|
||||
rewrite ^(.*) https://$host$1 permanent;
|
||||
}
|
||||
|
||||
server {
|
||||
listen 443;
|
||||
server_name odoo.mycompany.com;
|
||||
proxy_read_timeout 720s;
|
||||
proxy_connect_timeout 720s;
|
||||
proxy_send_timeout 720s;
|
||||
listen 443;
|
||||
server_name odoo.mycompany.com;
|
||||
proxy_read_timeout 720s;
|
||||
proxy_connect_timeout 720s;
|
||||
proxy_send_timeout 720s;
|
||||
|
||||
# Add Headers for odoo proxy mode
|
||||
proxy_set_header X-Forwarded-Host $host;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
# Add Headers for odoo proxy mode
|
||||
proxy_set_header X-Forwarded-Host $host;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
|
||||
# SSL parameters
|
||||
ssl on;
|
||||
ssl_certificate /etc/ssl/nginx/server.crt;
|
||||
ssl_certificate_key /etc/ssl/nginx/server.key;
|
||||
ssl_session_timeout 30m;
|
||||
ssl_protocols TLSv1.2;
|
||||
ssl_ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384;
|
||||
ssl_prefer_server_ciphers off;
|
||||
# SSL parameters
|
||||
ssl on;
|
||||
ssl_certificate /etc/ssl/nginx/server.crt;
|
||||
ssl_certificate_key /etc/ssl/nginx/server.key;
|
||||
ssl_session_timeout 30m;
|
||||
ssl_protocols TLSv1.2;
|
||||
ssl_ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384;
|
||||
ssl_prefer_server_ciphers off;
|
||||
|
||||
# log
|
||||
access_log /var/log/nginx/odoo.access.log;
|
||||
error_log /var/log/nginx/odoo.error.log;
|
||||
# log
|
||||
access_log /var/log/nginx/odoo.access.log;
|
||||
error_log /var/log/nginx/odoo.error.log;
|
||||
|
||||
# Redirect longpoll requests to odoo longpolling port
|
||||
location /longpolling {
|
||||
proxy_pass http://odoochat;
|
||||
}
|
||||
# Redirect longpoll requests to odoo longpolling port
|
||||
location /longpolling {
|
||||
proxy_pass http://odoochat;
|
||||
}
|
||||
|
||||
# Redirect requests to odoo backend server
|
||||
location / {
|
||||
proxy_redirect off;
|
||||
proxy_pass http://odoo;
|
||||
}
|
||||
# Redirect requests to odoo backend server
|
||||
location / {
|
||||
proxy_redirect off;
|
||||
proxy_pass http://odoo;
|
||||
}
|
||||
|
||||
# common gzip
|
||||
gzip_types text/css text/scss text/plain text/xml application/xml application/json application/javascript;
|
||||
gzip on;
|
||||
# common gzip
|
||||
gzip_types text/css text/scss text/plain text/xml application/xml application/json application/javascript;
|
||||
gzip on;
|
||||
}
|
||||
|
||||
Odoo as a WSGI Application
|
||||
@@ -381,7 +386,7 @@ notifications.
|
||||
|
||||
The solutions to support livechat/motifications in a WSGI application are:
|
||||
|
||||
* Deploy a threaded version of Odoo (instead of a process-based preforking
|
||||
* Deploy a threaded version of Odoo (instread of a process-based preforking
|
||||
one) and redirect only requests to URLs starting with ``/longpolling/`` to
|
||||
that Odoo, this is the simplest and the longpolling URL can double up as
|
||||
the cron instance.
|
||||
@@ -554,6 +559,9 @@ Here is what it could look like for blocking the IP for 15 minutes when
|
||||
findtime = 60 ; within 1 min /!\ Should be adjusted with the TZ offset
|
||||
logpath = /var/log/odoo.log ; set the actual odoo log path here
|
||||
|
||||
|
||||
|
||||
|
||||
.. _db_manager_security:
|
||||
|
||||
Database Manager Security
|
||||
@@ -616,10 +624,12 @@ Here are the supported browsers:
|
||||
.. warning:: Please make sure your browser is up-to-date and still supported by
|
||||
its publisher before filing a bug report.
|
||||
|
||||
|
||||
.. note::
|
||||
|
||||
Since Odoo 13.0, ES6 is supported. Therefore, IE support is dropped.
|
||||
|
||||
|
||||
.. [#different-machines]
|
||||
to have multiple Odoo installations use the same PostgreSQL database,
|
||||
or to provide more computing resources to both software.
|
||||
@@ -1,6 +1,7 @@
|
||||
=============
|
||||
Email gateway
|
||||
=============
|
||||
|
||||
==================
|
||||
Odoo email gateway
|
||||
==================
|
||||
|
||||
The Odoo mail gateway allows you to inject directly all the received emails in Odoo.
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
|
||||
.. _setup/enterprise:
|
||||
|
||||
===============================
|
||||
Upgrade Community to Enterprise
|
||||
===============================
|
||||
============================
|
||||
From Community to Enterprise
|
||||
============================
|
||||
|
||||
Depending on your current installation, there are multiple ways to upgrade
|
||||
your community version.
|
||||
|
Before Width: | Height: | Size: 6.9 KiB After Width: | Height: | Size: 6.9 KiB |
|
Before Width: | Height: | Size: 22 KiB After Width: | Height: | Size: 22 KiB |
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 27 KiB After Width: | Height: | Size: 27 KiB |
@@ -1,12 +1,756 @@
|
||||
:nosearch:
|
||||
|
||||
=======
|
||||
Install
|
||||
=======
|
||||
.. _setup/install:
|
||||
|
||||
.. toctree::
|
||||
===============
|
||||
Installing Odoo
|
||||
===============
|
||||
|
||||
install/install
|
||||
install/deploy
|
||||
install/cdn
|
||||
install/email_gateway
|
||||
There are multiple ways to install Odoo, or not install it at all, depending
|
||||
on the intended use case.
|
||||
|
||||
This documents attempts to describe most of the installation options.
|
||||
|
||||
:ref:`setup/install/online`
|
||||
The easiest way to use Odoo in production or to try it.
|
||||
|
||||
:ref:`setup/install/packaged`
|
||||
Suitable for testing Odoo, developing modules and can be used for
|
||||
long-term production use with additional deployment and maintenance work.
|
||||
|
||||
:ref:`setup/install/source`
|
||||
Provides greater flexibility: e.g. allow multiple running Odoo versions on
|
||||
the same system. Good for developing modules, can be used as base for
|
||||
production deployment.
|
||||
|
||||
:ref:`setup/install/docker`
|
||||
If you usually use docker_ for development or deployment, an official
|
||||
docker_ base image is available.
|
||||
|
||||
|
||||
.. _setup/install/editions:
|
||||
|
||||
Editions
|
||||
========
|
||||
|
||||
There are two different Editions_ of Odoo: the Community and Enterprise versions.
|
||||
Using the Enterprise version is possible on our SaaS_ and accessing the code is
|
||||
restricted to Enterprise customers and partners. The Community version is freely
|
||||
available to anyone.
|
||||
|
||||
If you already use the Community version and wish to upgrade to Enterprise, please
|
||||
refer to :ref:`setup/enterprise` (except for :ref:`setup/install/source`).
|
||||
|
||||
|
||||
.. _setup/install/online:
|
||||
|
||||
Online
|
||||
======
|
||||
|
||||
Demo
|
||||
----
|
||||
|
||||
To simply get a quick idea of Odoo, demo_ instances are available. They are
|
||||
shared instances which only live for a few hours, and can be used to browse
|
||||
around and try things out with no commitment.
|
||||
|
||||
Demo_ instances require no local installation, just a web browser.
|
||||
|
||||
SaaS
|
||||
----
|
||||
|
||||
Trivial to start with, fully managed and migrated by Odoo S.A., Odoo's SaaS_
|
||||
provides private instances and starts out free. It can be used to discover and
|
||||
test Odoo and do non-code customizations (i.e. incompatible with custom modules
|
||||
or the Odoo Apps Store) without having to install it locally.
|
||||
|
||||
Can be used for both testing Odoo and long-term production use.
|
||||
|
||||
Like demo_ instances, SaaS_ instances require no local installation, a web
|
||||
browser is sufficient.
|
||||
|
||||
|
||||
.. _setup/install/packaged:
|
||||
|
||||
Packaged installers
|
||||
===================
|
||||
|
||||
Odoo provides packaged installers for Windows, deb-based distributions
|
||||
(Debian, Ubuntu, …) and RPM-based distributions (Fedora, CentOS, RHEL, …) for
|
||||
both the Community and Enterprise versions.
|
||||
|
||||
These packages automatically set up all dependencies (for the Community version),
|
||||
but may be difficult to keep up-to-date.
|
||||
|
||||
Official Community packages with all relevant dependency requirements are
|
||||
available on our nightly_ server. Both Communtiy and Enterprise packages can
|
||||
be downloaded from our download_ page (you must to be logged in as a paying
|
||||
customer or partner to download the Enterprise packages).
|
||||
|
||||
Windows
|
||||
-------
|
||||
|
||||
#. Download the installer from our nightly_ server (Community only) or the Windows installer from
|
||||
the download_ page (any edition).
|
||||
#. Execute the downloaded file.
|
||||
|
||||
.. warning:: | On Windows 8 and later you may see a warning titled "Windows protected your PC".
|
||||
| Click on **More Info** and then on **Run anyway**.
|
||||
|
||||
#. Accept the UAC_ prompt.
|
||||
#. Go through the various installation steps.
|
||||
|
||||
Odoo will automatically be started at the end of the installation.
|
||||
|
||||
Linux
|
||||
-----
|
||||
|
||||
Debian/Ubuntu
|
||||
'''''''''''''
|
||||
|
||||
Odoo 14.0 'deb' package currently supports `Debian Buster`_, `Ubuntu 20.04`_ or above.
|
||||
|
||||
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
|
||||
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
|
||||
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
|
||||
details on the various versions.
|
||||
|
||||
Repository
|
||||
^^^^^^^^^^
|
||||
|
||||
Odoo S.A. provides a repository that can be used with Debian and Ubuntu distributions. It can be
|
||||
used to install *Odoo Community Edition* by executing the following commands:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ wget -O - https://nightly.odoo.com/odoo.key | sudo apt-key add -
|
||||
$ sudo sh -c 'echo "deb http://nightly.odoo.com/14.0/nightly/deb/ ./" >> /etc/apt/sources.list.d/odoo.list'
|
||||
$ sudo apt-get update && sudo apt-get install odoo
|
||||
|
||||
You can then use the usual `apt-get upgrade` command to keep your installation up-to-date.
|
||||
|
||||
At this moment, there is no nightly repository for the Enterprise Edition.
|
||||
|
||||
Deb Package
|
||||
^^^^^^^^^^^
|
||||
|
||||
Instead of using the repository as described above, the 'deb' packages for both the *Community* and
|
||||
*Enterprise* editions can be downloaded from the `official download page <download_>`_.
|
||||
|
||||
Next, execute the following commands:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo apt-get install <path_to_installation_package>
|
||||
|
||||
This will install Odoo as a service, create the necessary PostgreSQL_ user
|
||||
and automatically start the server.
|
||||
|
||||
.. note:: The recommended `postgresql-server` package will be installed by the Debian Odoo package.
|
||||
The `--no-install-recommends` argument of the `apt-get` tool should be used if you plan
|
||||
to install the Postgresql server on another machine.
|
||||
|
||||
Fedora
|
||||
''''''
|
||||
|
||||
Odoo 14.0 'rpm' package supports Fedora 32.
|
||||
|
||||
.. warning:: The Odoo 14.0 rpm package does not support Fedora 33 or above.
|
||||
|
||||
Prepare
|
||||
^^^^^^^
|
||||
Odoo needs a `PostgreSQL`_ server to run properly. Make sure that the `sudo` command is available
|
||||
and well configured and, only then, execute the following command in order to install the PostgreSQL
|
||||
server:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo dnf install -y postgresql-server
|
||||
$ sudo postgresql-setup --initdb --unit postgresql
|
||||
$ sudo systemctl enable postgresql
|
||||
$ sudo systemctl start postgresql
|
||||
|
||||
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
|
||||
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
|
||||
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
|
||||
details on the various versions.
|
||||
|
||||
Repository
|
||||
^^^^^^^^^^
|
||||
|
||||
Odoo S.A. provides a repository that can be used with the Fedora distributions.
|
||||
It can be used to install *Odoo Community Edition* by executing the following
|
||||
commands:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo dnf config-manager --add-repo=https://nightly.odoo.com/14.0/nightly/rpm/odoo.repo
|
||||
$ sudo dnf install -y odoo
|
||||
$ sudo systemctl enable odoo
|
||||
$ sudo systemctl start odoo
|
||||
|
||||
RPM package
|
||||
^^^^^^^^^^^
|
||||
|
||||
Instead of using the repository as described above, the 'rpm' packages for both the *Community* and
|
||||
*Enterprise* editions can be downloaded from the `official download page <download_>`_.
|
||||
|
||||
Once downloaded, the package can be installed using the 'dnf' package manager:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo dnf localinstall odoo_14.0.latest.noarch.rpm
|
||||
$ sudo systemctl enable odoo
|
||||
$ sudo systemctl start odoo
|
||||
|
||||
|
||||
.. _setup/install/source:
|
||||
|
||||
Source Install
|
||||
==============
|
||||
|
||||
The source "installation" is really about not installing Odoo, and running it directly from source
|
||||
instead.
|
||||
|
||||
This can be more convenient for module developers as the Odoo source is more easily accessible
|
||||
than using packaged installation (for information or to build this documentation and have it
|
||||
available offline).
|
||||
|
||||
It also makes starting and stopping Odoo more flexible and explicit than the services set up by the
|
||||
packaged installations, and allows overriding settings using
|
||||
:ref:`command-line parameters <reference/cmdline>` without needing to edit a configuration file.
|
||||
|
||||
Finally it provides greater control over the system's set up, and allows to more easily keep
|
||||
(and run) multiple versions of Odoo side-by-side.
|
||||
|
||||
Windows
|
||||
-------
|
||||
|
||||
Fetch the sources
|
||||
'''''''''''''''''
|
||||
|
||||
There are two ways to obtain the source code of Odoo: as a zip **archive** or through **git**.
|
||||
|
||||
Archive
|
||||
^^^^^^^
|
||||
|
||||
Community Edition:
|
||||
|
||||
* `Official download page <download_>`_
|
||||
* `GitHub repository <community-repository_>`_
|
||||
* `Nightly server <nightly_>`_
|
||||
|
||||
Enterprise Edition:
|
||||
|
||||
* `Official download page <download_>`_
|
||||
* `GitHub repository <enterprise-repository_>`_
|
||||
|
||||
Git
|
||||
^^^
|
||||
|
||||
The following requires git_ to be installed on your machine and that you have basic knowledge of
|
||||
git commands.
|
||||
|
||||
Community Edition:
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> git clone https://github.com/odoo/odoo.git
|
||||
|
||||
|
||||
Enterprise Edition: (see :ref:`setup/install/editions` to get access)
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> git clone https://github.com/odoo/enterprise.git
|
||||
|
||||
.. note:: **The Enterprise git repository does not contain the full Odoo source code**. It is only
|
||||
a collection of extra add-ons. The main server code is in the Community version. Running
|
||||
the Enterprise version actually means running the server from the Community version with
|
||||
the addons-path option set to the folder with the Enterprise version. You need to clone
|
||||
both the Community and Enterprise repository to have a working Odoo Enterprise
|
||||
installation.
|
||||
|
||||
Prepare
|
||||
'''''''
|
||||
|
||||
Python
|
||||
^^^^^^
|
||||
|
||||
Odoo requires Python 3.6 or later to run. Visit `Python's download page <https://www.python.org/downloads/windows/>`_
|
||||
to download and install the latest version of Python 3 on your machine.
|
||||
|
||||
During installation, check **Add Python 3 to PATH**, then click **Customize Installation** and make
|
||||
sure that **pip** is checked.
|
||||
|
||||
.. note:: If Python 3 is already installed, make sure that the version is 3.6 or above, as previous
|
||||
versions are not compatible with Odoo.
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> python --version
|
||||
|
||||
Verify also that pip_ is installed for this version.
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> pip --version
|
||||
|
||||
PostgreSQL
|
||||
^^^^^^^^^^
|
||||
|
||||
Odoo uses PostgreSQL as database management system. `Download and install PostgreSQL <https://www.postgresql.org/download/windows/>`_
|
||||
(supported version: 10.0 and later).
|
||||
|
||||
By default, the only user is `postgres` but Odoo forbids connecting as `postgres`, so you need to
|
||||
create a new PostgreSQL user:
|
||||
|
||||
#. Add PostgreSQL's `bin` directory (by default: `C:\\Program Files\\PostgreSQL\\<version>\\bin`) to
|
||||
your `PATH`.
|
||||
#. Create a postgres user with a password using the pg admin gui:
|
||||
|
||||
1. Open **pgAdmin**.
|
||||
2. Double-click the server to create a connection.
|
||||
3. Select :menuselection:`Object --> Create --> Login/Group Role`.
|
||||
4. Enter the username in the **Role Name** field (e.g. `odoo`).
|
||||
5. Open the **Definition** tab and enter the password (e.g. ``odoo``), then click **Save**.
|
||||
6. Open the **Privileges** tab and switch **Can login?** to `Yes` and **Create database?** to
|
||||
`Yes`.
|
||||
|
||||
Dependencies
|
||||
^^^^^^^^^^^^
|
||||
|
||||
Before installing the dependencies, you must download and install the
|
||||
`Build Tools for Visual Studio <https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2019>`_.
|
||||
When prompted, select **C++ build tools** in the **Workloads** tab and install them.
|
||||
|
||||
Odoo dependencies are listed in the `requirements.txt` file located at the root of the Odoo
|
||||
community directory.
|
||||
|
||||
.. tip:: It can be preferable to not mix python modules packages between different instances of Odoo
|
||||
or with your system. You can use virtualenv_ to create isolated Python environments.
|
||||
|
||||
Navigate to the path of your Odoo Community installation (`CommunityPath`) and run **pip**
|
||||
on the requirements file in a terminal **with Administrator privileges**:
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> cd \CommunityPath
|
||||
C:\> pip install setuptools wheel
|
||||
C:\> pip install -r requirements.txt
|
||||
|
||||
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
|
||||
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
|
||||
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
|
||||
details on the various versions.
|
||||
|
||||
For languages with right-to-left interface (such as Arabic or Hebrew), the package `rtlcss` is
|
||||
needed:
|
||||
|
||||
#. Download and install `nodejs <https://nodejs.org/en/download/>`_.
|
||||
#. Install `rtlcss`:
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> npm install -g rtlcss
|
||||
|
||||
#. Edit the System Environment's variable `PATH` to add the folder where `rtlcss.cmd` is located
|
||||
(typically: `C:\\Users\\<user>\\AppData\\Roaming\\npm\\`).
|
||||
|
||||
Running Odoo
|
||||
''''''''''''
|
||||
|
||||
Once all dependencies are set up, Odoo can be launched by running `odoo-bin`, the
|
||||
command-line interface of the server. It is located at the root of the Odoo Community directory.
|
||||
|
||||
To configure the server, you can either specify :ref:`command-line arguments <reference/cmdline/server>` or a
|
||||
:ref:`configuration file <reference/cmdline/config>`.
|
||||
|
||||
.. tip:: For the Enterprise edition, you must add the path to the `enterprise` addons to the
|
||||
`addons-path` argument. Note that it must come before the other paths in `addons-path` for
|
||||
addons to be loaded correctly.
|
||||
|
||||
Common necessary configurations are:
|
||||
|
||||
* PostgreSQL user and password.
|
||||
* Custom addon paths beyond the defaults, to load your own modules.
|
||||
|
||||
A typical way to run the server would be:
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> cd CommunityPath/
|
||||
C:\> python odoo-bin -r dbuser -w dbpassword --addons-path=addons -d mydb
|
||||
|
||||
Where `CommunityPath` is the path of the Odoo Community installation, `dbuser` is the
|
||||
PostgreSQL login, `dbpassword` is the PostgreSQL password
|
||||
and `mydb` is the default database to serve on `localhost:8069`. You can add other
|
||||
directory paths separated by a comma to ``addons`` at the end of the addons-path option.
|
||||
|
||||
Linux
|
||||
-----
|
||||
|
||||
Fetch the sources
|
||||
'''''''''''''''''
|
||||
|
||||
There are two ways to obtain the source code of Odoo: as a zip **archive** or through **git**.
|
||||
|
||||
Archive
|
||||
^^^^^^^
|
||||
|
||||
Community Edition:
|
||||
|
||||
* `Official download page <download_>`_
|
||||
* `GitHub repository <community-repository_>`_
|
||||
* `Nightly server <nightly_>`_
|
||||
|
||||
Enterprise Edition:
|
||||
|
||||
* `Official download page <download_>`_
|
||||
* `GitHub repository <enterprise-repository_>`_
|
||||
|
||||
Git
|
||||
^^^
|
||||
|
||||
The following requires git_ to be installed on your machine and that you have basic knowledge of
|
||||
git commands.
|
||||
|
||||
Community Edition:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ git clone https://github.com/odoo/odoo.git
|
||||
|
||||
|
||||
Enterprise Edition: (see :ref:`setup/install/editions` to get access)
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ git clone https://github.com/odoo/enterprise.git
|
||||
|
||||
.. note:: **The Enterprise git repository does not contain the full Odoo source code**. It is only
|
||||
a collection of extra add-ons. The main server code is in the Community version. Running
|
||||
the Enterprise version actually means running the server from the Community version with
|
||||
the addons-path option set to the folder with the Enterprise version. You need to clone
|
||||
both the Community and Enterprise repository to have a working Odoo Enterprise
|
||||
installation.
|
||||
|
||||
Prepare
|
||||
'''''''
|
||||
|
||||
Python
|
||||
^^^^^^
|
||||
|
||||
Odoo requires Python 3.6 or later to run. Use your package manager to download and install Python 3
|
||||
on your machine if it is not already done.
|
||||
|
||||
.. note:: If Python 3 is already installed, make sure that the version is 3.6 or above, as previous
|
||||
versions are not compatible with Odoo.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ python3 --version
|
||||
|
||||
Verify also that pip_ is installed for this version.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ pip3 --version
|
||||
|
||||
PostgreSQL
|
||||
^^^^^^^^^^
|
||||
|
||||
Odoo uses PostgreSQL as database management system. Use your package manager to download and install
|
||||
PostgreSQL (supported version: 10.0 and later).
|
||||
|
||||
On Debian/Unbuntu, it can be achieved by executing the following:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo apt install postgresql postgresql-client
|
||||
|
||||
By default, the only user is `postgres` but Odoo forbids connecting as `postgres`, so you need to
|
||||
create a new PostgreSQL user:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo -u postgres createuser -s $USER
|
||||
$ createdb $USER
|
||||
|
||||
.. note:: Because your PostgreSQL user has the same name as your Unix login, you will be able to
|
||||
connect to the database without password.
|
||||
|
||||
Dependencies
|
||||
^^^^^^^^^^^^
|
||||
|
||||
For libraries using native code, it is necessary to install development tools and native
|
||||
dependencies before the Python dependencies of Odoo. They are available in `-dev` or `-devel`
|
||||
packages for Python, PostgreSQL, libxml2, libxslt1, libevent, libsasl2 and libldap2.
|
||||
|
||||
On Debian/Unbuntu, the following command should install all the required libraries:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo apt install python3-dev libxml2-dev libxslt1-dev libldap2-dev libsasl2-dev \
|
||||
libtiff5-dev libjpeg8-dev libopenjp2-7-dev zlib1g-dev libfreetype6-dev \
|
||||
liblcms2-dev libwebp-dev libharfbuzz-dev libfribidi-dev libxcb1-dev libpq-dev
|
||||
|
||||
Odoo dependencies are listed in the `requirements.txt` file located at the root of the Odoo
|
||||
community directory.
|
||||
|
||||
.. tip:: It can be preferable to not mix python modules packages between different instances of Odoo
|
||||
or with your system. You can use virtualenv_ to create isolated Python environments.
|
||||
|
||||
Navigate to the path of your Odoo Community installation (`CommunityPath`) and run **pip**
|
||||
on the requirements file:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ cd /CommunityPath
|
||||
$ pip3 install setuptools wheel
|
||||
$ pip3 install -r requirements.txt
|
||||
|
||||
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
|
||||
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
|
||||
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
|
||||
details on the various versions.
|
||||
|
||||
For languages with right-to-left interface (such as Arabic or Hebrew), the package `rtlcss` is
|
||||
needed:
|
||||
|
||||
#. Download and install **nodejs** and **npm** with your package manager.
|
||||
#. Install `rtlcss`:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo npm install -g rtlcss
|
||||
|
||||
Running Odoo
|
||||
''''''''''''
|
||||
|
||||
Once all dependencies are set up, Odoo can be launched by running `odoo-bin`, the
|
||||
command-line interface of the server. It is located at the root of the Odoo Community directory.
|
||||
|
||||
To configure the server, you can either specify :ref:`command-line arguments <reference/cmdline/server>` or a
|
||||
:ref:`configuration file <reference/cmdline/config>`.
|
||||
|
||||
.. tip:: For the Enterprise edition, you must add the path to the `enterprise` addons to the
|
||||
`addons-path` argument. Note that it must come before the other paths in `addons-path` for
|
||||
addons to be loaded correctly.
|
||||
|
||||
Common necessary configurations are:
|
||||
|
||||
* PostgreSQL user and password. Odoo has no defaults beyond
|
||||
`psycopg2's defaults <http://initd.org/psycopg/docs/module.html>`_: connects over a UNIX socket on
|
||||
port `5432` with the current user and no password.
|
||||
* Custom addon paths beyond the defaults, to load your own modules.
|
||||
|
||||
A typical way to run the server would be:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ cd /CommunityPath
|
||||
$ python3 odoo-bin --addons-path=addons -d mydb
|
||||
|
||||
Where `CommunityPath` is the path of the Odoo Community installation
|
||||
and `mydb` is the default database to serve on `localhost:8069`. You can add other
|
||||
directory paths separated by a comma to ``addons`` at the end of the addons-path option.
|
||||
|
||||
Mac OS
|
||||
------
|
||||
|
||||
Fetch the sources
|
||||
'''''''''''''''''
|
||||
|
||||
There are two ways to obtain the source code of Odoo: as a zip **archive** or through **git**.
|
||||
|
||||
Archive
|
||||
^^^^^^^
|
||||
|
||||
Community Edition:
|
||||
|
||||
* `Official download page <download_>`_
|
||||
* `GitHub repository <community-repository_>`_
|
||||
* `Nightly server <nightly_>`_
|
||||
|
||||
Enterprise Edition:
|
||||
|
||||
* `Official download page <download_>`_
|
||||
* `GitHub repository <enterprise-repository_>`_
|
||||
|
||||
Git
|
||||
^^^
|
||||
|
||||
The following requires git_ to be installed on your machine and that you have basic knowledge of
|
||||
git commands.
|
||||
|
||||
Community Edition:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ git clone https://github.com/odoo/odoo.git
|
||||
|
||||
|
||||
Enterprise Edition: (see :ref:`setup/install/editions` to get access)
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ git clone https://github.com/odoo/enterprise.git
|
||||
|
||||
.. note:: **The Enterprise git repository does not contain the full Odoo source code**. It is only
|
||||
a collection of extra add-ons. The main server code is in the Community version. Running
|
||||
the Enterprise version actually means running the server from the Community version with
|
||||
the addons-path option set to the folder with the Enterprise version. You need to clone
|
||||
both the Community and Enterprise repository to have a working Odoo Enterprise
|
||||
installation.
|
||||
|
||||
Prepare
|
||||
'''''''
|
||||
|
||||
Python
|
||||
^^^^^^
|
||||
|
||||
Odoo requires Python 3.6 or later to run. Use your preferred package manager (homebrew_, macports_)
|
||||
to download and install Python 3 on your machine if it is not already done.
|
||||
|
||||
.. note:: If Python 3 is already installed, make sure that the version is 3.6 or above, as previous
|
||||
versions are not compatible with Odoo.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ python3 --version
|
||||
|
||||
Verify also that pip_ is installed for this version.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ pip3 --version
|
||||
|
||||
PostgreSQL
|
||||
^^^^^^^^^^
|
||||
|
||||
Odoo uses PostgreSQL as database management system. Use `postgres.app <https://postgresapp.com>`_
|
||||
to download and install PostgreSQL (supported version: 10.0 and later).
|
||||
|
||||
By default, the only user is `postgres` but Odoo forbids connecting as `postgres`, so you need to
|
||||
create a new PostgreSQL user:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo -u postgres createuser -s $USER
|
||||
$ createdb $USER
|
||||
|
||||
.. note:: Because your PostgreSQL user has the same name as your Unix login, you will be able to
|
||||
connect to the database without password.
|
||||
|
||||
Dependencies
|
||||
^^^^^^^^^^^^
|
||||
|
||||
Odoo dependencies are listed in the `requirements.txt` file located at the root of the Odoo
|
||||
community directory.
|
||||
|
||||
.. tip:: It can be preferable to not mix python modules packages between different instances of Odoo
|
||||
or with your system. You can use virtualenv_ to create isolated Python environments.
|
||||
|
||||
Navigate to the path of your Odoo Community installation (`CommunityPath`) and run **pip**
|
||||
on the requirements file:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ cd /CommunityPath
|
||||
$ pip3 install setuptools wheel
|
||||
$ pip3 install -r requirements.txt
|
||||
|
||||
.. warning:: Non-Python dependencies need to be installed with a package manager:
|
||||
|
||||
#. Download and install the **Command Line Tools**:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ xcode-select --install
|
||||
|
||||
#. Download and install the package manager of your choice (homebrew_, macports_).
|
||||
#. Install non-python dependencies.
|
||||
|
||||
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
|
||||
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
|
||||
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
|
||||
details on the various versions.
|
||||
|
||||
For languages with right-to-left interface (such as Arabic or Hebrew), the package `rtlcss` is
|
||||
needed:
|
||||
|
||||
#. Download and install **nodejs** with your preferred package manager (homebrew_, macports_).
|
||||
#. Install `rtlcss`:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo npm install -g rtlcss
|
||||
|
||||
Running Odoo
|
||||
''''''''''''
|
||||
|
||||
Once all dependencies are set up, Odoo can be launched by running `odoo-bin`, the
|
||||
command-line interface of the server. It is located at the root of the Odoo Community directory.
|
||||
|
||||
To configure the server, you can either specify :ref:`command-line arguments <reference/cmdline/server>` or a
|
||||
:ref:`configuration file <reference/cmdline/config>`.
|
||||
|
||||
.. tip:: For the Enterprise edition, you must add the path to the `enterprise` addons to the
|
||||
`addons-path` argument. Note that it must come before the other paths in `addons-path` for
|
||||
addons to be loaded correctly.
|
||||
|
||||
Common necessary configurations are:
|
||||
|
||||
* PostgreSQL user and password. Odoo has no defaults beyond
|
||||
`psycopg2's defaults <http://initd.org/psycopg/docs/module.html>`_: connects over a UNIX socket on
|
||||
port `5432` with the current user and no password.
|
||||
* Custom addon paths beyond the defaults, to load your own modules.
|
||||
|
||||
A typical way to run the server would be:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ cd /CommunityPath
|
||||
$ python3 odoo-bin --addons-path=addons -d mydb
|
||||
|
||||
Where `CommunityPath` is the path of the Odoo Community installation
|
||||
and `mydb` is the default database to serve on `localhost:8069`. You can add other
|
||||
directory paths separated by a comma to ``addons`` at the end of the addons-path option.
|
||||
|
||||
|
||||
.. _setup/install/docker:
|
||||
|
||||
Docker
|
||||
======
|
||||
|
||||
The full documentation on how to use Odoo with Docker can be found on the
|
||||
official Odoo `docker image <https://registry.hub.docker.com/_/odoo/>`_ page.
|
||||
|
||||
.. _Debian Buster: https://www.debian.org/releases/buster/
|
||||
.. _demo: https://demo.odoo.com
|
||||
.. _docker: https://www.docker.com
|
||||
.. _download: https://www.odoo.com/page/download
|
||||
.. _Ubuntu 20.04: http://releases.ubuntu.com/20.04/
|
||||
.. _EPEL: https://fedoraproject.org/wiki/EPEL
|
||||
.. _PostgreSQL: http://www.postgresql.org
|
||||
.. _the official installer:
|
||||
.. _install pip:
|
||||
https://pip.pypa.io/en/latest/installing.html#install-pip
|
||||
.. _Quilt: http://en.wikipedia.org/wiki/Quilt_(software)
|
||||
.. _saas: https://www.odoo.com/page/start
|
||||
.. _the wkhtmltopdf download page: https://github.com/wkhtmltopdf/wkhtmltopdf/releases/tag/0.12.5
|
||||
.. _UAC: http://en.wikipedia.org/wiki/User_Account_Control
|
||||
.. _wkhtmltopdf: http://wkhtmltopdf.org
|
||||
.. _pip: https://pip.pypa.io
|
||||
.. _macports: https://www.macports.org
|
||||
.. _homebrew: http://brew.sh
|
||||
.. _wheels: https://wheel.readthedocs.org/en/latest/
|
||||
.. _virtualenv: https://pypi.python.org/pypi/virtualenv
|
||||
.. _virtualenvwrapper: https://virtualenvwrapper.readthedocs.io/en/latest/
|
||||
.. _pywin32: http://sourceforge.net/projects/pywin32/files/pywin32/
|
||||
.. _community-repository: https://github.com/odoo/odoo
|
||||
.. _enterprise-repository: https://github.com/odoo/enterprise
|
||||
.. _git: https://git-scm.com/
|
||||
.. _Editions: https://www.odoo.com/pricing#pricing_table_features
|
||||
.. _nightly: https://nightly.odoo.com/
|
||||
.. _extra: https://nightly.odoo.com/extra/
|
||||
|
||||
@@ -1,782 +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 our SaaS_ and accessing the code is
|
||||
restricted to Enterprise customers and partners. The Community version is freely
|
||||
available to anyone.
|
||||
|
||||
If you already use the Community version and wish to upgrade to Enterprise, please
|
||||
refer to :ref:`setup/enterprise` (except for :ref:`setup/install/source`).
|
||||
|
||||
|
||||
.. _setup/install/online:
|
||||
|
||||
Online
|
||||
======
|
||||
|
||||
Demo
|
||||
----
|
||||
|
||||
To simply get a quick idea of Odoo, demo_ instances are available. They are
|
||||
shared instances which only live for a few hours, and can be used to browse
|
||||
around and try things out with no commitment.
|
||||
|
||||
Demo_ instances require no local installation, just a web browser.
|
||||
|
||||
SaaS
|
||||
----
|
||||
|
||||
Trivial to start with, fully managed and migrated by Odoo S.A., Odoo's SaaS_
|
||||
provides private instances and starts out free. It can be used to discover and
|
||||
test Odoo and do non-code customizations (i.e. incompatible with custom modules
|
||||
or the Odoo Apps Store) without having to install it locally.
|
||||
|
||||
Can be used for both testing Odoo and long-term production use.
|
||||
|
||||
Like demo_ instances, SaaS_ instances require no local installation, a web
|
||||
browser is sufficient.
|
||||
|
||||
|
||||
.. _setup/install/packaged:
|
||||
|
||||
Packaged installers
|
||||
===================
|
||||
|
||||
Odoo provides packaged installers for Windows, deb-based distributions
|
||||
(Debian, Ubuntu, …) and RPM-based distributions (Fedora, CentOS, RHEL, …) for
|
||||
both the Community and Enterprise versions.
|
||||
|
||||
These packages automatically set up all dependencies (for the Community version),
|
||||
but may be difficult to keep up-to-date.
|
||||
|
||||
Official Community packages with all relevant dependency requirements are
|
||||
available on our nightly_ server. Both Communtiy and Enterprise packages can
|
||||
be downloaded from our download_ page (you must to be logged in as a paying
|
||||
customer or partner to download the Enterprise packages).
|
||||
|
||||
Windows
|
||||
-------
|
||||
|
||||
#. Download the installer from our nightly_ server (Community only) or the Windows installer from
|
||||
the download_ page (any edition).
|
||||
#. Execute the downloaded file.
|
||||
|
||||
.. warning:: | On Windows 8 and later you may see a warning titled "Windows protected your PC".
|
||||
| Click on **More Info** and then on **Run anyway**.
|
||||
|
||||
#. Accept the UAC_ prompt.
|
||||
#. Go through the various installation steps.
|
||||
|
||||
Odoo will automatically be started at the end of the installation.
|
||||
|
||||
Linux
|
||||
-----
|
||||
|
||||
Debian/Ubuntu
|
||||
'''''''''''''
|
||||
|
||||
Odoo 13.0 'deb' package currently supports `Debian Buster`_, `Ubuntu 18.04`_ or above.
|
||||
|
||||
Prepare
|
||||
^^^^^^^
|
||||
|
||||
Odoo needs a `PostgreSQL`_ server to run properly. The default configuration for
|
||||
the Odoo 'deb' package is to use the PostgreSQL server on the same host as your
|
||||
Odoo instance. Execute the following command in order to install the PostgreSQL server:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo apt install postgresql -y
|
||||
|
||||
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
|
||||
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
|
||||
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
|
||||
details on the various versions.
|
||||
|
||||
Repository
|
||||
^^^^^^^^^^
|
||||
|
||||
Odoo S.A. provides a repository that can be used with Debian and Ubuntu distributions. It can be
|
||||
used to install *Odoo Community Edition* by executing the following commands **as root**:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# wget -O - https://nightly.odoo.com/odoo.key | apt-key add -
|
||||
# echo "deb http://nightly.odoo.com/13.0/nightly/deb/ ./" >> /etc/apt/sources.list.d/odoo.list
|
||||
# apt-get update && apt-get install odoo
|
||||
|
||||
You can then use the usual `apt-get upgrade` command to keep your installation up-to-date.
|
||||
|
||||
At this moment, there is no nightly repository for the Enterprise Edition.
|
||||
|
||||
Deb Package
|
||||
^^^^^^^^^^^
|
||||
|
||||
Instead of using the repository as described above, the 'deb' packages for both the *Community* and
|
||||
*Enterprise* editions can be downloaded from the `official download page <download_>`_.
|
||||
|
||||
Next, execute the following commands **as root**:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# dpkg -i <path_to_installation_package> # this probably fails with missing dependencies
|
||||
# apt-get install -f # should install the missing dependencies
|
||||
# dpkg -i <path_to_installation_package>
|
||||
|
||||
This will install Odoo as a service, create the necessary PostgreSQL_ user
|
||||
and automatically start the server.
|
||||
|
||||
.. warning:: The `python3-xlwt` Debian package does not exists in Debian Buster nor Ubuntu 18.04.
|
||||
This python module is needed to export into xls format.
|
||||
|
||||
If you need the feature, you can install it manually with:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo pip3 install xlwt
|
||||
|
||||
.. warning:: The `num2words` python package does not exists in Debian Buster nor Ubuntu 18.04.
|
||||
Textual amounts will not be rendered by Odoo and this could cause problems with the
|
||||
`l10n_mx_edi` module.
|
||||
|
||||
If you need this feature, you can install manually with:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo pip3 install num2words
|
||||
|
||||
Fedora
|
||||
''''''
|
||||
|
||||
Odoo 13.0 'rpm' package supports Fedora 30.
|
||||
|
||||
Prepare
|
||||
^^^^^^^
|
||||
Odoo needs a `PostgreSQL`_ server to run properly. Make sure that the `sudo` command is available
|
||||
and well configured and, only then, execute the following command in order to install the PostgreSQL
|
||||
server:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo dnf install -y postgresql-server
|
||||
$ sudo postgresql-setup --initdb --unit postgresql
|
||||
$ sudo systemctl enable postgresql
|
||||
$ sudo systemctl start postgresql
|
||||
|
||||
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
|
||||
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
|
||||
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
|
||||
details on the various versions.
|
||||
|
||||
Repository
|
||||
^^^^^^^^^^
|
||||
|
||||
Odoo S.A. provides a repository that can be used with the Fedora distributions.
|
||||
It can be used to install *Odoo Community Edition* by executing the following
|
||||
commands:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo dnf config-manager --add-repo=https://nightly.odoo.com/13.0/nightly/rpm/odoo.repo
|
||||
$ sudo dnf install -y odoo
|
||||
$ sudo systemctl enable odoo
|
||||
$ sudo systemctl start odoo
|
||||
|
||||
RPM package
|
||||
^^^^^^^^^^^
|
||||
|
||||
Instead of using the repository as described above, the 'rpm' packages for both the *Community* and
|
||||
*Enterprise* editions can be downloaded from the `official download page <download_>`_.
|
||||
|
||||
Once downloaded, the package can be installed using the 'dnf' package manager:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo dnf localinstall odoo_13.0.latest.noarch.rpm
|
||||
$ sudo systemctl enable odoo
|
||||
$ sudo systemctl start odoo
|
||||
|
||||
|
||||
.. _setup/install/source:
|
||||
|
||||
Source Install
|
||||
==============
|
||||
|
||||
The source "installation" is really about not installing Odoo, and running it directly from source
|
||||
instead.
|
||||
|
||||
This can be more convenient for module developers as the Odoo source is more easily accessible
|
||||
than using packaged installation (for information or to build this documentation and have it
|
||||
available offline).
|
||||
|
||||
It also makes starting and stopping Odoo more flexible and explicit than the services set up by the
|
||||
packaged installations, and allows overriding settings using
|
||||
:ref:`command-line parameters <reference/cmdline>` without needing to edit a configuration file.
|
||||
|
||||
Finally it provides greater control over the system's set up, and allows to more easily keep
|
||||
(and run) multiple versions of Odoo side-by-side.
|
||||
|
||||
Windows
|
||||
-------
|
||||
|
||||
Fetch the sources
|
||||
'''''''''''''''''
|
||||
|
||||
There are two ways to obtain the source code of Odoo: as a zip **archive** or through **git**.
|
||||
|
||||
Archive
|
||||
^^^^^^^
|
||||
|
||||
Community Edition:
|
||||
|
||||
* `Official download page <download_>`_
|
||||
* `GitHub repository <community-repository_>`_
|
||||
* `Nightly server <nightly_>`_
|
||||
|
||||
Enterprise Edition:
|
||||
|
||||
* `Official download page <download_>`_
|
||||
* `GitHub repository <enterprise-repository_>`_
|
||||
|
||||
Git
|
||||
^^^
|
||||
|
||||
The following requires git_ to be installed on your machine and that you have basic knowledge of
|
||||
git commands.
|
||||
|
||||
Community Edition:
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> git clone https://github.com/odoo/odoo.git
|
||||
|
||||
|
||||
Enterprise Edition: (see :ref:`setup/install/editions` to get access)
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> git clone https://github.com/odoo/enterprise.git
|
||||
|
||||
.. note:: **The Enterprise git repository does not contain the full Odoo source code**. It is only
|
||||
a collection of extra add-ons. The main server code is in the Community version. Running
|
||||
the Enterprise version actually means running the server from the Community version with
|
||||
the addons-path option set to the folder with the Enterprise version. You need to clone
|
||||
both the Community and Enterprise repository to have a working Odoo Enterprise
|
||||
installation.
|
||||
|
||||
Prepare
|
||||
'''''''
|
||||
|
||||
Python
|
||||
^^^^^^
|
||||
|
||||
Odoo requires Python 3.6 or later to run. Visit `Python's download page <https://www.python.org/downloads/windows/>`_
|
||||
to download and install the latest version of Python 3 on your machine.
|
||||
|
||||
During installation, check **Add Python 3 to PATH**, then click **Customize Installation** and make
|
||||
sure that **pip** is checked.
|
||||
|
||||
.. note:: If Python 3 is already installed, make sure that the version is 3.6 or above, as previous
|
||||
versions are not compatible with Odoo.
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> python --version
|
||||
|
||||
Verify also that pip_ is installed for this version.
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> pip --version
|
||||
|
||||
PostgreSQL
|
||||
^^^^^^^^^^
|
||||
|
||||
Odoo uses PostgreSQL as database management system. `Download and install PostgreSQL <https://www.postgresql.org/download/windows/>`_
|
||||
(supported version: 10.0 and later).
|
||||
|
||||
By default, the only user is `postgres` but Odoo forbids connecting as `postgres`, so you need to
|
||||
create a new PostgreSQL user:
|
||||
|
||||
#. Add PostgreSQL's `bin` directory (by default: `C:\\Program Files\\PostgreSQL\\<version>\\bin`) to
|
||||
your `PATH`.
|
||||
#. Create a postgres user with a password using the pg admin gui:
|
||||
|
||||
1. Open **pgAdmin**.
|
||||
2. Double-click the server to create a connection.
|
||||
3. Select :menuselection:`Object --> Create --> Login/Group Role`.
|
||||
4. Enter the username in the **Role Name** field (e.g. `odoo`).
|
||||
5. Open the **Definition** tab and enter the password (e.g. ``odoo``), then click **Save**.
|
||||
6. Open the **Privileges** tab and switch **Can login?** to `Yes` and **Create database?** to
|
||||
`Yes`.
|
||||
|
||||
Dependencies
|
||||
^^^^^^^^^^^^
|
||||
|
||||
Before installing the dependencies, you must download and install the
|
||||
`Build Tools for Visual Studio <https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2019>`_.
|
||||
When prompted, select **C++ build tools** in the **Workloads** tab and install them.
|
||||
|
||||
Odoo dependencies are listed in the `requirements.txt` file located at the root of the Odoo
|
||||
community directory.
|
||||
|
||||
.. tip:: It can be preferable to not mix python modules packages between different instances of Odoo
|
||||
or with your system. You can use virtualenv_ to create isolated Python environments.
|
||||
|
||||
Navigate to the path of your Odoo Community installation (`CommunityPath`) and run **pip**
|
||||
on the requirements file in a terminal **with Administrator privileges**:
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> cd \CommunityPath
|
||||
C:\> pip install setuptools wheel
|
||||
C:\> pip install -r requirements.txt
|
||||
|
||||
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
|
||||
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
|
||||
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
|
||||
details on the various versions.
|
||||
|
||||
For languages with right-to-left interface (such as Arabic or Hebrew), the package `rtlcss` is
|
||||
needed:
|
||||
|
||||
#. Download and install `nodejs <https://nodejs.org/en/download/>`_.
|
||||
#. Install `rtlcss`:
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> npm install -g rtlcss
|
||||
|
||||
#. Edit the System Environment's variable `PATH` to add the folder where `rtlcss.cmd` is located
|
||||
(typically: `C:\\Users\\<user>\\AppData\\Roaming\\npm\\`).
|
||||
|
||||
Running Odoo
|
||||
''''''''''''
|
||||
|
||||
Once all dependencies are set up, Odoo can be launched by running `odoo-bin`, the
|
||||
command-line interface of the server. It is located at the root of the Odoo Community directory.
|
||||
|
||||
To configure the server, you can either specify :ref:`command-line arguments <reference/cmdline/server>` or a
|
||||
:ref:`configuration file <reference/cmdline/config>`.
|
||||
|
||||
.. tip:: For the Enterprise edition, you must add the path to the `enterprise` addons to the
|
||||
`addons-path` argument. Note that it must come before the other paths in `addons-path` for
|
||||
addons to be loaded correctly.
|
||||
|
||||
Common necessary configurations are:
|
||||
|
||||
* PostgreSQL user and password.
|
||||
* Custom addon paths beyond the defaults, to load your own modules.
|
||||
|
||||
A typical way to run the server would be:
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> cd CommunityPath/
|
||||
C:\> python odoo-bin -r dbuser -w dbpassword --addons-path=addons -d mydb
|
||||
|
||||
Where `CommunityPath` is the path of the Odoo Community installation, `dbuser` is the
|
||||
PostgreSQL login, `dbpassword` is the PostgreSQL password
|
||||
and `mydb` is the default database to serve on `localhost:8069`. You can add other
|
||||
directory paths separated by a comma to ``addons`` at the end of the addons-path option.
|
||||
|
||||
Linux
|
||||
-----
|
||||
|
||||
Fetch the sources
|
||||
'''''''''''''''''
|
||||
|
||||
There are two ways to obtain the source code of Odoo: as a zip **archive** or through **git**.
|
||||
|
||||
Archive
|
||||
^^^^^^^
|
||||
|
||||
Community Edition:
|
||||
|
||||
* `Official download page <download_>`_
|
||||
* `GitHub repository <community-repository_>`_
|
||||
* `Nightly server <nightly_>`_
|
||||
|
||||
Enterprise Edition:
|
||||
|
||||
* `Official download page <download_>`_
|
||||
* `GitHub repository <enterprise-repository_>`_
|
||||
|
||||
Git
|
||||
^^^
|
||||
|
||||
The following requires git_ to be installed on your machine and that you have basic knowledge of
|
||||
git commands.
|
||||
|
||||
Community Edition:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ git clone https://github.com/odoo/odoo.git
|
||||
|
||||
|
||||
Enterprise Edition: (see :ref:`setup/install/editions` to get access)
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ git clone https://github.com/odoo/enterprise.git
|
||||
|
||||
.. note:: **The Enterprise git repository does not contain the full Odoo source code**. It is only
|
||||
a collection of extra add-ons. The main server code is in the Community version. Running
|
||||
the Enterprise version actually means running the server from the Community version with
|
||||
the addons-path option set to the folder with the Enterprise version. You need to clone
|
||||
both the Community and Enterprise repository to have a working Odoo Enterprise
|
||||
installation.
|
||||
|
||||
Prepare
|
||||
'''''''
|
||||
|
||||
Python
|
||||
^^^^^^
|
||||
|
||||
Odoo requires Python 3.6 or later to run. Use your package manager to download and install Python 3
|
||||
on your machine if it is not already done.
|
||||
|
||||
.. note:: If Python 3 is already installed, make sure that the version is 3.6 or above, as previous
|
||||
versions are not compatible with Odoo.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ python3 --version
|
||||
|
||||
Verify also that pip_ is installed for this version.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ pip3 --version
|
||||
|
||||
PostgreSQL
|
||||
^^^^^^^^^^
|
||||
|
||||
Odoo uses PostgreSQL as database management system. Use your package manager to download and install
|
||||
PostgreSQL (supported version: 10.0 and later).
|
||||
|
||||
On Debian/Unbuntu, it can be achieved by executing the following:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo apt install postgresql postgresql-client
|
||||
|
||||
By default, the only user is `postgres` but Odoo forbids connecting as `postgres`, so you need to
|
||||
create a new PostgreSQL user:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo -u postgres createuser -s $USER
|
||||
$ createdb $USER
|
||||
|
||||
.. note:: Because your PostgreSQL user has the same name as your Unix login, you will be able to
|
||||
connect to the database without password.
|
||||
|
||||
Dependencies
|
||||
^^^^^^^^^^^^
|
||||
|
||||
For libraries using native code, it is necessary to install development tools and native
|
||||
dependencies before the Python dependencies of Odoo. They are available in `-dev` or `-devel`
|
||||
packages for Python, PostgreSQL, libxml2, libxslt1, libevent, libsasl2 and libldap2.
|
||||
|
||||
On Debian/Unbuntu, the following command should install all the required libraries:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo apt install python3-dev libxml2-dev libxslt1-dev libldap2-dev libsasl2-dev \
|
||||
libtiff5-dev libjpeg8-dev libopenjp2-7-dev zlib1g-dev libfreetype6-dev \
|
||||
liblcms2-dev libwebp-dev libharfbuzz-dev libfribidi-dev libxcb1-dev libpq-dev
|
||||
|
||||
Odoo dependencies are listed in the `requirements.txt` file located at the root of the Odoo
|
||||
community directory.
|
||||
|
||||
.. tip:: It can be preferable to not mix python modules packages between different instances of Odoo
|
||||
or with your system. You can use virtualenv_ to create isolated Python environments.
|
||||
|
||||
Navigate to the path of your Odoo Community installation (`CommunityPath`) and run **pip**
|
||||
on the requirements file:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ cd /CommunityPath
|
||||
$ pip3 install setuptools wheel
|
||||
$ pip3 install -r requirements.txt
|
||||
|
||||
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
|
||||
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
|
||||
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
|
||||
details on the various versions.
|
||||
|
||||
For languages with right-to-left interface (such as Arabic or Hebrew), the package `rtlcss` is
|
||||
needed:
|
||||
|
||||
#. Download and install **nodejs** and **npm** with your package manager.
|
||||
#. Install `rtlcss`:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo npm install -g rtlcss
|
||||
|
||||
Running Odoo
|
||||
''''''''''''
|
||||
|
||||
Once all dependencies are set up, Odoo can be launched by running `odoo-bin`, the
|
||||
command-line interface of the server. It is located at the root of the Odoo Community directory.
|
||||
|
||||
To configure the server, you can either specify :ref:`command-line arguments <reference/cmdline/server>` or a
|
||||
:ref:`configuration file <reference/cmdline/config>`.
|
||||
|
||||
.. tip:: For the Enterprise edition, you must add the path to the `enterprise` addons to the
|
||||
`addons-path` argument. Note that it must come before the other paths in `addons-path` for
|
||||
addons to be loaded correctly.
|
||||
|
||||
Common necessary configurations are:
|
||||
|
||||
* PostgreSQL user and password. Odoo has no defaults beyond
|
||||
`psycopg2's defaults <http://initd.org/psycopg/docs/module.html>`_: connects over a UNIX socket on
|
||||
port `5432` with the current user and no password.
|
||||
* Custom addon paths beyond the defaults, to load your own modules.
|
||||
|
||||
A typical way to run the server would be:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ cd /CommunityPath
|
||||
$ python3 odoo-bin --addons-path=addons -d mydb
|
||||
|
||||
Where `CommunityPath` is the path of the Odoo Community installation
|
||||
and `mydb` is the default database to serve on `localhost:8069`. You can add other
|
||||
directory paths separated by a comma to ``addons`` at the end of the addons-path option.
|
||||
|
||||
Mac OS
|
||||
------
|
||||
|
||||
Fetch the sources
|
||||
'''''''''''''''''
|
||||
|
||||
There are two ways to obtain the source code of Odoo: as a zip **archive** or through **git**.
|
||||
|
||||
Archive
|
||||
^^^^^^^
|
||||
|
||||
Community Edition:
|
||||
|
||||
* `Official download page <download_>`_
|
||||
* `GitHub repository <community-repository_>`_
|
||||
* `Nightly server <nightly_>`_
|
||||
|
||||
Enterprise Edition:
|
||||
|
||||
* `Official download page <download_>`_
|
||||
* `GitHub repository <enterprise-repository_>`_
|
||||
|
||||
Git
|
||||
^^^
|
||||
|
||||
The following requires git_ to be installed on your machine and that you have basic knowledge of
|
||||
git commands.
|
||||
|
||||
Community Edition:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ git clone https://github.com/odoo/odoo.git
|
||||
|
||||
|
||||
Enterprise Edition: (see :ref:`setup/install/editions` to get access)
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ git clone https://github.com/odoo/enterprise.git
|
||||
|
||||
.. note:: **The Enterprise git repository does not contain the full Odoo source code**. It is only
|
||||
a collection of extra add-ons. The main server code is in the Community version. Running
|
||||
the Enterprise version actually means running the server from the Community version with
|
||||
the addons-path option set to the folder with the Enterprise version. You need to clone
|
||||
both the Community and Enterprise repository to have a working Odoo Enterprise
|
||||
installation.
|
||||
|
||||
Prepare
|
||||
'''''''
|
||||
|
||||
Python
|
||||
^^^^^^
|
||||
|
||||
Odoo requires Python 3.6 or later to run. Use your preferred package manager (homebrew_, macports_)
|
||||
to download and install Python 3 on your machine if it is not already done.
|
||||
|
||||
.. note:: If Python 3 is already installed, make sure that the version is 3.6 or above, as previous
|
||||
versions are not compatible with Odoo.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ python3 --version
|
||||
|
||||
Verify also that pip_ is installed for this version.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ pip3 --version
|
||||
|
||||
PostgreSQL
|
||||
^^^^^^^^^^
|
||||
|
||||
Odoo uses PostgreSQL as database management system. Use `postgres.app <https://postgresapp.com>`_
|
||||
to download and install PostgreSQL (supported version: 10.0 and later).
|
||||
|
||||
By default, the only user is `postgres` but Odoo forbids connecting as `postgres`, so you need to
|
||||
create a new PostgreSQL user:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo -u postgres createuser -s $USER
|
||||
$ createdb $USER
|
||||
|
||||
.. note:: Because your PostgreSQL user has the same name as your Unix login, you will be able to
|
||||
connect to the database without password.
|
||||
|
||||
Dependencies
|
||||
^^^^^^^^^^^^
|
||||
|
||||
Odoo dependencies are listed in the `requirements.txt` file located at the root of the Odoo
|
||||
community directory.
|
||||
|
||||
.. tip:: It can be preferable to not mix python modules packages between different instances of Odoo
|
||||
or with your system. You can use virtualenv_ to create isolated Python environments.
|
||||
|
||||
Navigate to the path of your Odoo Community installation (`CommunityPath`) and run **pip**
|
||||
on the requirements file:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ cd /CommunityPath
|
||||
$ pip3 install setuptools wheel
|
||||
$ pip3 install -r requirements.txt
|
||||
|
||||
.. warning:: Non-Python dependencies need to be installed with a package manager:
|
||||
|
||||
#. Download and install the **Command Line Tools**:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ xcode-select --install
|
||||
|
||||
#. Download and install the package manager of your choice (homebrew_, macports_).
|
||||
#. Install non-python dependencies.
|
||||
|
||||
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
|
||||
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
|
||||
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
|
||||
details on the various versions.
|
||||
|
||||
For languages with right-to-left interface (such as Arabic or Hebrew), the package `rtlcss` is
|
||||
needed:
|
||||
|
||||
#. Download and install **nodejs** with your preferred package manager (homebrew_, macports_).
|
||||
#. Install `rtlcss`:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo npm install -g rtlcss
|
||||
|
||||
Running Odoo
|
||||
''''''''''''
|
||||
|
||||
Once all dependencies are set up, Odoo can be launched by running `odoo-bin`, the
|
||||
command-line interface of the server. It is located at the root of the Odoo Community directory.
|
||||
|
||||
To configure the server, you can either specify :ref:`command-line arguments <reference/cmdline/server>` or a
|
||||
:ref:`configuration file <reference/cmdline/config>`.
|
||||
|
||||
.. tip:: For the Enterprise edition, you must add the path to the `enterprise` addons to the
|
||||
`addons-path` argument. Note that it must come before the other paths in `addons-path` for
|
||||
addons to be loaded correctly.
|
||||
|
||||
Common necessary configurations are:
|
||||
|
||||
* PostgreSQL user and password. Odoo has no defaults beyond
|
||||
`psycopg2's defaults <http://initd.org/psycopg/docs/module.html>`_: connects over a UNIX socket on
|
||||
port `5432` with the current user and no password.
|
||||
* Custom addon paths beyond the defaults, to load your own modules.
|
||||
|
||||
A typical way to run the server would be:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ cd /CommunityPath
|
||||
$ python3 odoo-bin --addons-path=addons -d mydb
|
||||
|
||||
Where `CommunityPath` is the path of the Odoo Community installation
|
||||
and `mydb` is the default database to serve on `localhost:8069`. You can add other
|
||||
directory paths separated by a comma to ``addons`` at the end of the addons-path option.
|
||||
|
||||
|
||||
.. _setup/install/docker:
|
||||
|
||||
Docker
|
||||
======
|
||||
|
||||
The full documentation on how to use Odoo with Docker can be found on the
|
||||
official Odoo `docker image <https://registry.hub.docker.com/_/odoo/>`_ page.
|
||||
|
||||
.. _Debian Buster: https://www.debian.org/releases/buster/
|
||||
.. _demo: https://demo.odoo.com
|
||||
.. _docker: https://www.docker.com
|
||||
.. _download: https://www.odoo.com/page/download
|
||||
.. _Ubuntu 18.04: http://releases.ubuntu.com/18.04/
|
||||
.. _EPEL: https://fedoraproject.org/wiki/EPEL
|
||||
.. _PostgreSQL: http://www.postgresql.org
|
||||
.. _the official installer:
|
||||
.. _install pip:
|
||||
https://pip.pypa.io/en/latest/installing.html#install-pip
|
||||
.. _Quilt: http://en.wikipedia.org/wiki/Quilt_(software)
|
||||
.. _saas: https://www.odoo.com/page/start
|
||||
.. _the wkhtmltopdf download page: https://github.com/wkhtmltopdf/wkhtmltopdf/releases/tag/0.12.5
|
||||
.. _UAC: http://en.wikipedia.org/wiki/User_Account_Control
|
||||
.. _wkhtmltopdf: http://wkhtmltopdf.org
|
||||
.. _pip: https://pip.pypa.io
|
||||
.. _macports: https://www.macports.org
|
||||
.. _homebrew: http://brew.sh
|
||||
.. _wheels: https://wheel.readthedocs.org/en/latest/
|
||||
.. _virtualenv: https://pypi.python.org/pypi/virtualenv
|
||||
.. _virtualenvwrapper: https://virtualenvwrapper.readthedocs.io/en/latest/
|
||||
.. _pywin32: http://sourceforge.net/projects/pywin32/files/pywin32/
|
||||
.. _community-repository: https://github.com/odoo/odoo
|
||||
.. _enterprise-repository: https://github.com/odoo/enterprise
|
||||
.. _git: https://git-scm.com/
|
||||
.. _Editions: https://www.odoo.com/pricing#pricing_table_features
|
||||
.. _nightly: https://nightly.odoo.com/
|
||||
.. _extra: https://nightly.odoo.com/extra/
|
||||
@@ -1,14 +0,0 @@
|
||||
:nosearch:
|
||||
|
||||
========
|
||||
Maintain
|
||||
========
|
||||
|
||||
.. toctree::
|
||||
|
||||
maintain/update
|
||||
maintain/db_upgrade
|
||||
maintain/enterprise
|
||||
maintain/hosting_changes
|
||||
maintain/db_premise
|
||||
maintain/supported_versions
|
||||
@@ -1,88 +0,0 @@
|
||||
|
||||
.. _supported_versions:
|
||||
|
||||
==================
|
||||
Supported versions
|
||||
==================
|
||||
|
||||
|
||||
Odoo provides support and bug fixing **for the 3 last major versions** of Odoo.
|
||||
|
||||
Users hosted on **Odoo Online** may use intermediary versions (sometimes called *SaaS versions*) that are
|
||||
supported as well. These versions are not published for Odoo.sh or On-Premise
|
||||
installations.
|
||||
|
||||
|
||||
What's the support status of my Odoo?
|
||||
=====================================
|
||||
|
||||
This matrix shows the support status of every version.
|
||||
|
||||
**Major releases are in bold type.**
|
||||
|
||||
+-----------------+-------------+----------+-------------+----------------+------------------------+
|
||||
| | Odoo Online | Odoo.sh | On-Premise | Release date | End of support |
|
||||
+=================+=============+==========+=============+================+========================+
|
||||
| **Odoo 15.0** | |green| | |green| | |green| | October 2021 | October 2024 (planned) |
|
||||
+-----------------+-------------+----------+-------------+----------------+------------------------+
|
||||
| **Odoo 14.0** | |green| | |green| | |green| | October 2020 | October 2023 (planned) |
|
||||
+-----------------+-------------+----------+-------------+----------------+------------------------+
|
||||
| **Odoo 13.0** | |green| | |green| | |green| | October 2019 | October 2022 (planned) |
|
||||
+-----------------+-------------+----------+-------------+----------------+------------------------+
|
||||
| Odoo 12.saas~3 | |orange| | N/A | N/A | August 2019 | |
|
||||
+-----------------+-------------+----------+-------------+----------------+------------------------+
|
||||
| **Odoo 12.0** | |orange| | |orange| | |red| | October 2018 | October 2021 |
|
||||
+-----------------+-------------+----------+-------------+----------------+------------------------+
|
||||
| Odoo 11.saas~3 | |orange| | N/A | N/A | April 2018 | |
|
||||
+-----------------+-------------+----------+-------------+----------------+------------------------+
|
||||
| **Odoo 11.0** | |orange| | |orange| | |red| | October 2017 | October 2020 |
|
||||
+-----------------+-------------+----------+-------------+----------------+------------------------+
|
||||
| Odoo 10.saas~15 | |orange| | N/A | N/A | March 2017 | |
|
||||
+-----------------+-------------+----------+-------------+----------------+------------------------+
|
||||
| Odoo 10.saas~14 | |orange| | N/A | N/A | January 2017 | |
|
||||
+-----------------+-------------+----------+-------------+----------------+------------------------+
|
||||
| **Odoo 10.0** | |orange| | |orange| | |red| | October 2016 | October 2019 |
|
||||
+-----------------+-------------+----------+-------------+----------------+------------------------+
|
||||
| Odoo 9.saas~11 | |orange| | N/A | N/A | May 2016 | |
|
||||
+-----------------+-------------+----------+-------------+----------------+------------------------+
|
||||
| **Odoo 9.0** | |orange| | N/A | |red| | October 2015 | October 2018 |
|
||||
+-----------------+-------------+----------+-------------+----------------+------------------------+
|
||||
| Odoo 8.saas~6 | |orange| | N/A | N/A | February 2015 | |
|
||||
+-----------------+-------------+----------+-------------+----------------+------------------------+
|
||||
| **Odoo 8.0** | |orange| | N/A | |red| | September 2014 | October 2017 |
|
||||
+-----------------+-------------+----------+-------------+----------------+------------------------+
|
||||
|
||||
|
||||
.. note::
|
||||
|
||||
|green| Supported version
|
||||
|
||||
|red| End-of-support
|
||||
|
||||
N/A Never released for this platform
|
||||
|
||||
|orange| Some of our older customers may still run this version on our Odoo Online servers, we provide help only on blocking issues and advise you to upgrade.
|
||||
|
||||
🏁 Future version, not released yet
|
||||
|
||||
|
||||
.. This is an awful way to display colored circles but "Large Green Circle Emoji" was only released
|
||||
in 2019 (see https://unicode-table.com/en/1F7E2/). Let's wait a few more years...
|
||||
|
||||
.. |green| image:: data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMzIuMTkgMjMyLjE5Ij48Y2lyY2xlIGN4PSIxMTYuMDkiIGN5PSIxMTYuMDkiIHI9IjExNi4wOSIgc3R5bGU9ImZpbGw6IzAwYTcwMCIvPjwvc3ZnPg==
|
||||
:width: 15
|
||||
|
||||
.. |red| image:: data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMzIuMTkgMjMyLjE5Ij48Y2lyY2xlIGN4PSIxMTYuMDkiIGN5PSIxMTYuMDkiIHI9IjExNi4wOSIgc3R5bGU9ImZpbGw6I2QwMDAwMCIvPjwvc3ZnPg==
|
||||
:width: 15
|
||||
|
||||
.. |orange| image:: data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMzIuMTkgMjMyLjE5Ij48Y2lyY2xlIGN4PSIxMTYuMDkiIGN5PSIxMTYuMDkiIHI9IjExNi4wOSIgc3R5bGU9ImZpbGw6I2ZmYTcwMCIvPjwvc3ZnPg==
|
||||
:width: 15
|
||||
|
||||
I run an older version of Odoo/OpenERP/TinyERP
|
||||
==============================================
|
||||
|
||||
OpenERP 7.0, 6.1, 6.0 and 5.0 is not supported anymore, on any platform.
|
||||
|
||||
TinyERP 4.0, 3.0, 2.0 and 1.0 is not supported anymore, on any platform.
|
||||
|
||||
Even though we don't support older versions, you can always `upgrade from any version <https://upgrade.odoo.com/>`_.
|
||||
|
Before Width: | Height: | Size: 9.5 KiB After Width: | Height: | Size: 9.5 KiB |
|
Before Width: | Height: | Size: 2.8 KiB After Width: | Height: | Size: 2.8 KiB |
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 8.7 KiB After Width: | Height: | Size: 8.7 KiB |
|
Before Width: | Height: | Size: 2.9 KiB After Width: | Height: | Size: 2.9 KiB |
@@ -1,7 +1,5 @@
|
||||
:nosearch:
|
||||
|
||||
=======
|
||||
Odoo.sh
|
||||
Odoo sh
|
||||
=======
|
||||
|
||||
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
:nosearch:
|
||||
|
||||
=================
|
||||
Advanced
|
||||
|
||||
@@ -167,7 +167,7 @@ In the above commands, the argument:
|
||||
* ``--stop-after-init`` will immediately shutdown the server instance after it completed the operations you asked.
|
||||
|
||||
More options are available and detailed in the
|
||||
:doc:`CLI documentation </developer/misc/other/cmdline>`.
|
||||
:doc:`CLI documentation </developer/reference/cmdline>`.
|
||||
|
||||
You can find in the logs (*~/logs/odoo.log*) the addons path used by Odoo.sh to run your server.
|
||||
Look for "*odoo: addons paths*":
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
:nosearch:
|
||||
|
||||
=================
|
||||
Get started
|
||||
|
||||
@@ -42,7 +42,7 @@ instance will be held temporarily unavailable for maintenance reason.
|
||||
|
||||
This method is equivalent to perform an upgrade of the module through the Apps menu,
|
||||
or through the :code:`-u` switch of
|
||||
:doc:`the command line </developer/misc/other/cmdline>`.
|
||||
:doc:`the command line </developer/reference/cmdline>`.
|
||||
|
||||
In the case the changes in the commit prevent the server to restart,
|
||||
or if the modules update fails,
|
||||
|
||||
@@ -78,8 +78,7 @@ You can start using Odoo.sh. Your first build is about to be created. You will s
|
||||
Import your database
|
||||
====================
|
||||
|
||||
You can import your database in your Odoo.sh project as long as it is in a :doc:`supported version
|
||||
</administration/maintain/supported_versions>` of Odoo.
|
||||
You can import your database in your Odoo.sh project as long as this is an Odoo 10.0, 11.0 or above database.
|
||||
|
||||
Push your modules in production
|
||||
-------------------------------
|
||||
@@ -152,7 +151,7 @@ Check your outgoing email servers
|
||||
There is a default mail server provided with Odoo.sh.
|
||||
To use it, there must be no enabled outgoing mail server configured in your database in
|
||||
:menuselection:`Settings --> Technical --> Outgoing Mail Servers`
|
||||
(:ref:`Developer mode <developer-mode>` must be activated).
|
||||
(:doc:`Developer mode </applications/general/developer_mode/activate>` must be activated).
|
||||
|
||||
After the import of your database,
|
||||
all outgoing email servers are disabled so you use the Odoo.sh email server provided by default.
|
||||
|
||||
@@ -263,7 +263,7 @@ and on your production you would not like your module to be installed automatica
|
||||
|
||||
Your module may not appear directly in your apps to install either, you need to update your apps list first:
|
||||
|
||||
* Activate the :ref:`developer mode <developer-mode>`
|
||||
* activate the :doc:`Developer mode </applications/general/developer_mode/activate>`
|
||||
* in the apps menu, click the *Update Apps List* button,
|
||||
* in the dialog that appears, click the *Update* button.
|
||||
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
:nosearch:
|
||||
|
||||
=================
|
||||
Overview
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
|
||||
.. _setup/update:
|
||||
|
||||
==============
|
||||
Bugfix updates
|
||||
==============
|
||||
=============================
|
||||
Updating an Odoo installation
|
||||
=============================
|
||||
|
||||
Introduction
|
||||
============
|
||||
@@ -147,4 +147,4 @@ Docker
|
||||
------
|
||||
|
||||
Please refer to our `Docker image documentation <https://hub.docker.com/_/odoo/>`_ for
|
||||
specific update instructions.
|
||||
specific update instructions.
|
||||
@@ -1,18 +1,9 @@
|
||||
:nosearch:
|
||||
:show-content:
|
||||
:hide-page-toc:
|
||||
:show-toc:
|
||||
|
||||
|
||||
=========
|
||||
User Docs
|
||||
=========
|
||||
|
||||
Discover our user guides and configuration tutorials per application.
|
||||
============
|
||||
Applications
|
||||
============
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
applications/finance
|
||||
applications/sales
|
||||
@@ -21,4 +12,5 @@ Discover our user guides and configuration tutorials per application.
|
||||
applications/marketing
|
||||
applications/services
|
||||
applications/productivity
|
||||
applications/settings
|
||||
applications/general
|
||||
|
||||
@@ -1,5 +1,3 @@
|
||||
:nosearch:
|
||||
|
||||
=======
|
||||
Finance
|
||||
=======
|
||||
@@ -9,5 +7,4 @@ Finance
|
||||
|
||||
finance/accounting
|
||||
finance/expenses
|
||||
finance/documents
|
||||
finance/sign
|
||||
finance/sign
|
||||
|
||||
@@ -1,25 +1,9 @@
|
||||
:nosearch:
|
||||
:show-content:
|
||||
:hide-page-toc:
|
||||
:show-toc:
|
||||
|
||||
========================
|
||||
Accounting and Invoicing
|
||||
========================
|
||||
|
||||
**Odoo Invoicing** is a standalone invoicing app to create invoices, send them to your customers,
|
||||
and manage payments.
|
||||
|
||||
**Odoo Accounting** is a full featured accounting app. Accountant productivity is at the core of its
|
||||
development with features such as AI-powered invoice recognition, synchronization with your bank
|
||||
accounts, smart matching suggestions, etc.
|
||||
|
||||
.. seealso::
|
||||
- `Odoo Tutorials: Invoicing <https://www.odoo.com/slides/invoicing-18>`_
|
||||
- `Odoo Tutorials: Accounting <https://www.odoo.com/slides/accounting-19>`_
|
||||
- :doc:`Accounting Cheat Sheet <accounting/getting_started/memento>`
|
||||
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
|
||||
@@ -31,3 +15,155 @@ accounts, smart matching suggestions, etc.
|
||||
accounting/reporting
|
||||
accounting/others
|
||||
accounting/fiscal_localizations
|
||||
|
||||
**Odoo Invoicing** is a standalone invoicing app that allows you to :doc:`issue invoices
|
||||
<accounting/receivables/customer_invoices/overview>`, send them to your customers, and manage
|
||||
payments, including :doc:`online payments
|
||||
<accounting/receivables/customer_payments/online_payment>`. It works as a "lighter" version of Odoo
|
||||
Accounting, and you can upgrade it to Odoo Accounting if you need more advanced accounting features.
|
||||
|
||||
**Odoo Accounting** is a complete and strong accounting app. The automation of processes is at the
|
||||
core of its development with its perfect integration with all Odoo apps and with features such as
|
||||
:doc:`AI-powered invoice recognition <accounting/payables/supplier_bills/ocr>`,
|
||||
:doc:`synchronization with your bank accounts <accounting/bank/feeds/bank_synchronization>`, and
|
||||
:doc:`automatic suggestions for a simplified reconciliation process
|
||||
<accounting/bank/reconciliation/reconciliation_models>`.
|
||||
|
||||
.. seealso::
|
||||
- `Odoo Invoicing: product page <https://www.odoo.com/app/invoicing>`_
|
||||
- `Odoo Accounting: product page <https://www.odoo.com/app/accounting>`_
|
||||
|
||||
Double-entry bookkeeping
|
||||
========================
|
||||
|
||||
Odoo automatically creates all the behind-the-scenes journal entries
|
||||
for each of your accounting transactions: customer invoices, point of
|
||||
sale order, expenses, inventory moves, etc.
|
||||
|
||||
Odoo uses the rules of double-entry bookkeeping system: all journal
|
||||
entries are automatically balanced (sum of debits = sum of credits).
|
||||
|
||||
.. seealso::
|
||||
- :doc:`Understand Odoo's accounting transactions per document
|
||||
<accounting/getting_started/memento>`
|
||||
|
||||
Accrual and Cash Basis Methods
|
||||
==============================
|
||||
|
||||
Odoo supports both accrual and cash basis reporting. This allows you to
|
||||
report income / expense at the time transactions occur (i.e., accrual basis), or when
|
||||
payment is made or received (i.e., cash basis).
|
||||
|
||||
Multi-companies
|
||||
===============
|
||||
|
||||
Odoo allows one to manage several companies within the same database. Each
|
||||
company has its own chart of accounts and rules. You can get
|
||||
consolidation reports following your consolidation rules.
|
||||
|
||||
Users can access several companies but always work in one company at a
|
||||
time.
|
||||
|
||||
Multi-currencies
|
||||
================
|
||||
|
||||
Every transaction is recorded in the default currency of the
|
||||
company. For transactions occurring in another currency, Odoo stores
|
||||
both the value in the currency of the company and the value in the
|
||||
currency of the transaction. Odoo can generate currencies gains and
|
||||
losses after the reconciliation of the journal items.
|
||||
|
||||
Currency rates are updated once a day using a yahoo.com online
|
||||
web-service.
|
||||
|
||||
International Standards
|
||||
=======================
|
||||
|
||||
Odoo accounting supports more than 50 countries. The Odoo core
|
||||
accounting implements accounting standards that are common to all
|
||||
countries. Specific modules exist per country for the
|
||||
specificities of the country like the chart of accounts, taxes, or
|
||||
bank interfaces.
|
||||
|
||||
In particular, Odoo's core accounting engine supports:
|
||||
|
||||
* Anglo-Saxon Accounting (U.S., U.K.,, and other English-speaking
|
||||
countries including Ireland, Canada, Australia, and New Zealand)
|
||||
where costs of good sold are reported when products are
|
||||
sold/delivered.
|
||||
* European accounting where expenses are accounted at the supplier
|
||||
bill.
|
||||
|
||||
Odoo has modules to comply with IFRS rules.
|
||||
|
||||
Accounts Receivable and Payable
|
||||
===============================
|
||||
|
||||
By default, Odoo uses a single account for all account
|
||||
receivable entries and one for all accounts payable entries. You can
|
||||
create separate accounts per customers/suppliers, but you don't need
|
||||
to.
|
||||
|
||||
As transactions are associated to customers or suppliers, you get
|
||||
reports to perform analysis per customer/supplier such as the customer
|
||||
statement, revenues per customers, aged receivable/payables, ...
|
||||
|
||||
Wide range of financial reports
|
||||
===============================
|
||||
|
||||
In Odoo, you can generate financial reports in real time. Odoo's
|
||||
reports range from basic accounting reports to advanced management
|
||||
reports. Odoo's reports include:
|
||||
|
||||
* Performance reports (such as Profit and Loss, Budget Variance)
|
||||
* Position reports (such as Balance Sheet, Aged Payables, Aged
|
||||
Receivables)
|
||||
* Cash reports (such as Bank Summary)
|
||||
* Detail reports (such as Trial Balance and General Ledger)
|
||||
* Management reports (such as Budgets, Executive Summary)
|
||||
|
||||
Odoo's report engine allows you to customize your own report based on
|
||||
your own formulae.
|
||||
|
||||
Import bank feeds automatically
|
||||
===============================
|
||||
|
||||
Bank reconciliation is a process that matches your bank statement
|
||||
lines, as supplied by the bank, to your accounting transactions in the
|
||||
general ledger. Odoo makes bank reconciliation easy by frequently
|
||||
importing bank statement lines from your bank directly into your Odoo
|
||||
account. This means you can have a daily view of your cashflow without
|
||||
having to log into your online banking or wait for your paper bank
|
||||
statements.
|
||||
|
||||
Odoo speeds up bank reconciliation by matching most of your imported
|
||||
bank statement lines to your accounting transactions. Odoo also
|
||||
remembers how you've treated other bank statement lines and provides
|
||||
suggested general ledger transactions.
|
||||
|
||||
Calculate the tax you owe your tax authority
|
||||
============================================
|
||||
|
||||
Odoo totals all your accounting transactions for your tax period and
|
||||
uses these totals to calculate your tax obligation. You can then check
|
||||
your sales tax by running Odoo's Tax Report.
|
||||
|
||||
Inventory Valuation
|
||||
===================
|
||||
|
||||
Odoo support both periodic (manual) and perpetual (automated)
|
||||
inventory valuations. The available methods are standard price,
|
||||
average price, LIFO (for countries allowing it) and FIFO.
|
||||
|
||||
.. seealso::
|
||||
- :doc:`View impact of the valuation method on your transactions
|
||||
<../inventory_and_mrp/inventory/management/reporting/inventory_valuation_config>`
|
||||
|
||||
Easy retained earnings
|
||||
======================
|
||||
|
||||
Retained earnings are the portion of income retained by your
|
||||
business. Odoo automatically calculates your current year earnings in
|
||||
real time so no year-end journal or rollover is required. This is
|
||||
calculated by reporting the profit and loss balance to your balance
|
||||
sheet report automatically.
|
||||
|
||||
@@ -1,5 +1,3 @@
|
||||
:nosearch:
|
||||
|
||||
===========
|
||||
Bank & Cash
|
||||
===========
|
||||
|
||||
@@ -1,5 +1,3 @@
|
||||
:nosearch:
|
||||
|
||||
==========
|
||||
Bank Feeds
|
||||
==========
|
||||
@@ -10,4 +8,4 @@ Bank Feeds
|
||||
feeds/bank_statements
|
||||
feeds/bank_synchronization
|
||||
feeds/ponto
|
||||
feeds/saltedge
|
||||
feeds/saltedge
|
||||
@@ -1,5 +1,3 @@
|
||||
:nosearch:
|
||||
|
||||
=============
|
||||
Miscellaneous
|
||||
=============
|
||||
|
||||
@@ -1,5 +1,3 @@
|
||||
:nosearch:
|
||||
|
||||
===================
|
||||
Bank Reconciliation
|
||||
===================
|
||||
|
||||
@@ -101,5 +101,8 @@ right and validate all related payments :
|
||||
.. image:: media/use10.png
|
||||
:align: center
|
||||
|
||||
.. tip::
|
||||
Hit CTRL-Enter to reconcile all the balanced items in the sheet.
|
||||
|
||||
.. seealso::
|
||||
* :doc:`../feeds/bank_synchronization`
|
||||
@@ -1,5 +1,3 @@
|
||||
:nosearch:
|
||||
|
||||
=====
|
||||
Setup
|
||||
=====
|
||||
|
||||
@@ -1,5 +1,3 @@
|
||||
:nosearch:
|
||||
|
||||
====================
|
||||
Fiscal Localizations
|
||||
====================
|
||||
|
||||
@@ -1,5 +1,3 @@
|
||||
:nosearch:
|
||||
|
||||
=============
|
||||
Localizations
|
||||
=============
|
||||
@@ -15,7 +13,6 @@ Localizations
|
||||
localizations/france
|
||||
localizations/germany
|
||||
localizations/indonesia
|
||||
localizations/italy
|
||||
localizations/italy_IT
|
||||
localizations/mexico
|
||||
localizations/netherlands
|
||||
|
||||
@@ -275,8 +275,8 @@ with the same letter will share the same sequence. For example:
|
||||
Sequences
|
||||
~~~~~~~~~
|
||||
In case that you want to synchronize the next number in the sequence in Odoo based on the next
|
||||
number in the AFIP POS, the next button that is visible under :ref:`developer mode <developer-mode>`
|
||||
can be used:
|
||||
number in the AFIP POS, the next button that is visible under :doc:`developer mode
|
||||
</applications/general/developer_mode>` can be used:
|
||||
|
||||
.. image:: media/argentina_edi_05.png
|
||||
:align: center
|
||||
|
||||
@@ -346,7 +346,7 @@ for this document type, the invoice number takes the first folio in the sequence
|
||||
|
||||
.. important::
|
||||
In case you have used some folios in your previous system, make sure you set the next valid
|
||||
folio when the first transaction is created.
|
||||
folio when the first transation is created.
|
||||
|
||||
|
||||
|
||||
@@ -377,10 +377,7 @@ You can manually change the document type if needed.
|
||||
.. image:: media/Chile15.png
|
||||
:align: center
|
||||
:alt: Document type selection on invoices.
|
||||
|
||||
.. important::
|
||||
Documents type 33: Electronic Invoice must have at least one item with tax, otherwise the SII
|
||||
rejects the document validation.
|
||||
|
||||
|
||||
Validation and DTE Status
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
@@ -471,16 +468,13 @@ credit and debit notes, they are set automatically by Odoo:
|
||||
Invoice PDF Report
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Once the invoice is accepted and validated by the SII and the PDF is printed, it includes the
|
||||
fiscal elements that indicate that the document is fiscally valid:
|
||||
After the invoice is Accepted and valdiated by the SII and the PDF is printed it includes the
|
||||
fiscal elements that indicates out document is fiscally valid:
|
||||
|
||||
.. image:: media/Chile22.png
|
||||
:align: center
|
||||
:alt: Barcode and fiscal elements in the invoice report.
|
||||
:alt: Barcode and fiscal elements in the invice report.
|
||||
|
||||
.. important::
|
||||
If you are hosted in Odoo SH or On-Premise, you should manually install the ``pdf417gen``
|
||||
library. Use the following command to install it: ``pip install pdf417gen``.
|
||||
|
||||
Commercial Validation
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
@@ -491,7 +485,7 @@ Once the invoice has been sent to the customer:
|
||||
2. The customer must send a reception confirmation email.
|
||||
3. Subsequently, if all the commercial terms and invoice data are correct, they will send the
|
||||
Acceptance confirmation, otherwise they send a Claim.
|
||||
4. The field DTE acceptation status is updated automatically.
|
||||
4. The field DTE acceptation status is updated automatically.
|
||||
|
||||
.. image:: media/Chile23.png
|
||||
:align: center
|
||||
|
||||
@@ -19,7 +19,7 @@ requires the next modules:
|
||||
contains the default setup for: chart of accounts, taxes,
|
||||
retentions, identification document types
|
||||
#. **l10n_co_edi**: This module includes all the extra fields that are
|
||||
required for the Integration with Carvajal and generate the
|
||||
required for the Integration with Carvajal T&S and generate the
|
||||
electronic invoice, based on the DIAN legal requirements.
|
||||
|
||||
|
||||
@@ -36,19 +36,19 @@ Configuration
|
||||
Install the Colombian localization modules
|
||||
------------------------------------------
|
||||
|
||||
To :ref:`install <general/install>` the modules, go to :menuselection:`Apps`, remove the *Apps*
|
||||
filter and search for "Colombia". Then click on *Install* for the first two modules.
|
||||
For this, go in Apps and search for Colombia. Then click Install for
|
||||
the first two modules.
|
||||
|
||||
.. image:: media/colombia02.png
|
||||
:align: center
|
||||
|
||||
|
||||
Configure credentials for Carvajal web service
|
||||
----------------------------------------------
|
||||
Configure credentials for Carvajal T&S web service
|
||||
--------------------------------------------------
|
||||
|
||||
Once that the modules are installed, in order to be able to connect
|
||||
with Carvajal Web Service, it's necessary to configure the user
|
||||
and credentials, this information will be provided by Carvajal.
|
||||
with Carvajal T&S Web Service, it's necessary to configure the user
|
||||
and credentials, this information will be provided by Carvajal T&S.
|
||||
|
||||
Go to :menuselection:`Accounting --> Configuration --> Settings` and
|
||||
look for the *Colombian Electronic Invoice* section.
|
||||
@@ -56,20 +56,12 @@ look for the *Colombian Electronic Invoice* section.
|
||||
.. image:: media/colombia03.png
|
||||
:align: center
|
||||
|
||||
Using the Testing mode it is possible to connect with a Carvajal
|
||||
Using the Testing mode it is possible to connect with a Carvajal T&S
|
||||
testing environment. This allows users to test the complete workflow
|
||||
and integration with the CEN Financiero portal, which is accessible
|
||||
here:
|
||||
here: https://cenfinancierolab.cen.biz
|
||||
|
||||
CTS (Carvajal T&S)
|
||||
https://cenflab.cen.biz/site/
|
||||
|
||||
CSC (Carvajal Servicios de Comunicación)
|
||||
https://web-stage.facturacarvajal.com/
|
||||
|
||||
CSC is the default for new databases.
|
||||
|
||||
Once that Odoo and Carvajal are fully configured and ready for
|
||||
Once that Odoo and Carvajal T&S is fully configured and ready for
|
||||
production the testing environment can be disabled.
|
||||
|
||||
|
||||
@@ -150,7 +142,7 @@ Journals
|
||||
Once the DIAN has assigned the official sequence and prefix for the
|
||||
electronic invoice resolution, the Sales journals related to your
|
||||
invoice documents need to be updated in Odoo. The sequence can be
|
||||
accessed using the :ref:`developer mode <developer-mode>`: :menuselection:`Accounting -->
|
||||
accessed using the :doc:`Developer mode </applications/general/developer_mode>`: :menuselection:`Accounting -->
|
||||
Settings --> Configuration Setting --> Journals`.
|
||||
|
||||
.. image:: media/colombia09.png
|
||||
|
||||
@@ -18,7 +18,7 @@ requiere los siguientes Módulos:
|
||||
- Tipos de Documentos de Identificación
|
||||
|
||||
#. **l10n_co_edi**: Este módulo incluye todos los campos adicionales que son
|
||||
requeridos para la Integración entre Carvajal y la generación de la
|
||||
requeridos para la Integración entre Carvajal T&S y la generación de la
|
||||
Factura Electrónica, basado en los requisitos legales de la DIAN.
|
||||
|
||||
|
||||
@@ -42,12 +42,12 @@ Instalar a los primeros dos módulos:
|
||||
:align: center
|
||||
|
||||
|
||||
Configuración de las credenciales del Servicio Web de Carvajal
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Configuración de las credenciales del Servicio Web de Carvajal T&S
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
| Una vez que los módulos están instalados, para poderte conectar con el
|
||||
Servicio Web de Carvajal, es necesario configurar el Usuario y las
|
||||
Credenciales. Esta información será provista por Carvajal.
|
||||
Servicio Web de Carvajal T&S, es necesario configurar el Usuario y las
|
||||
Credenciales. Esta información será provista por Carvajal T&S.
|
||||
| Ve a :menuselection:`Facturación --> Configuración --> Configuración` y busca la sección
|
||||
**Facturación Electrónica Colombiana**
|
||||
|
||||
@@ -55,21 +55,14 @@ Configuración de las credenciales del Servicio Web de Carvajal
|
||||
:align: center
|
||||
|
||||
La funcionalidad de pruebas le permite conectarse e interactuar con el
|
||||
ambiente piloto de Carvajal, esto permite a los usuarios probar el
|
||||
ambiente piloto de Carvajal T&S, esto permite a los usuarios probar el
|
||||
flujo completo y la integración con el Portal Financiero CEN, al cual
|
||||
se accede a través de la siguiente liga:
|
||||
|
||||
CTS (Carvajal T&S)
|
||||
https://cenflab.cen.biz/site/
|
||||
|
||||
CSC (Carvajal Servicios de Comunicación)
|
||||
https://web-stage.facturacarvajal.com/
|
||||
|
||||
CSC es el predeterminado para nuevas bases de datos.
|
||||
se accede a través de la siguiente liga: `Cenfinanciero <https://cenfinancierolab.cen.biz>`_.
|
||||
|
||||
Una vez que el ambiente de producción está listo en Odoo y en Carvajal
|
||||
el ambiente de pruebas debe ser deshabilitado para poder enviar la
|
||||
información al ambiente de producción de Carvajal.
|
||||
T&S el ambiente de pruebas debe ser deshabilitado para poder enviar la
|
||||
información al ambiente de producción de Carvajal, para el cual es
|
||||
utilizada la siguiente URL: `Cenfinanciero <https://cenfinancierolab.cen.biz>`_.
|
||||
|
||||
|
||||
Configuración de Información para PDF
|
||||
|
||||
@@ -2,44 +2,44 @@
|
||||
France
|
||||
======
|
||||
|
||||
FEC
|
||||
FEC
|
||||
===
|
||||
|
||||
If you have installed the French Accounting, you will be able to download the FEC.
|
||||
For this, go in :menuselection:`Accounting --> Reporting --> France --> FEC`.
|
||||
For this, go in :menuselection:`Accounting --> Reporting --> France --> FEC`.
|
||||
|
||||
.. tip::
|
||||
If you do not see the submenu **FEC**, go in **Apps** and search for the module
|
||||
called **France-FEC** and verify if it is well installed.
|
||||
called **France-FEC** and verify if it is well installed.
|
||||
|
||||
French Accounting Reports
|
||||
=========================
|
||||
|
||||
If you have installed the French Accounting, you will have access to some accounting reports specific to France:
|
||||
If you have installed the French Accounting, you will have access to some accounting reports specific to France:
|
||||
|
||||
- Bilan comptable
|
||||
- Compte de résultats
|
||||
- Plan de Taxes France
|
||||
- Plan de Taxes France
|
||||
|
||||
Get the VAT anti-fraud certification with Odoo
|
||||
==============================================
|
||||
|
||||
As of January 1st 2018, a new anti-fraud legislation comes into effect
|
||||
in France and DOM-TOM. This new legislation stipulates certain criteria
|
||||
concerning the inalterability, security, storage and archiving of sales data.
|
||||
These legal requirements are implemented in Odoo, version 9 onward,
|
||||
As of January 1st 2018, a new anti-fraud legislation comes into effect
|
||||
in France and DOM-TOM. This new legislation stipulates certain criteria
|
||||
concerning the inalterability, security, storage and archiving of sales data.
|
||||
These legal requirements are implemented in Odoo, version 9 onward,
|
||||
through a module and a certificate of conformity to download.
|
||||
|
||||
Is my company required to use an anti-fraud software?
|
||||
-----------------------------------------------------
|
||||
|
||||
Your company is required to use an anti-fraud cash register software like
|
||||
Your company is required to use an anti-fraud cash register software like
|
||||
Odoo (CGI art. 286, I. 3° bis) if:
|
||||
|
||||
* You are taxable (not VAT exempt) in France or any DOM-TOM,
|
||||
* Some of your customers are private individuals (B2C).
|
||||
|
||||
This rule applies to any company size. Auto-entrepreneurs are exempted from
|
||||
This rule applies to any company size. Auto-entrepreneurs are exempted from
|
||||
VAT and therefore are not affected.
|
||||
|
||||
Get certified with Odoo
|
||||
@@ -47,20 +47,21 @@ Get certified with Odoo
|
||||
|
||||
Getting compliant with Odoo is very easy.
|
||||
|
||||
Your company is requested by the tax administration to deliver a certificate
|
||||
Your company is requested by the tax administration to deliver a certificate
|
||||
of conformity testifying that your software complies with the anti-fraud
|
||||
legislation. This certificate is granted by Odoo SA to Odoo Enterprise users
|
||||
legislation. This certificate is granted by Odoo SA to Odoo Enterprise users
|
||||
`here <https://www.odoo.com/my/contract/french-certification/>`_.
|
||||
If you use Odoo Community, you should :doc:`upgrade to Odoo Enterprise
|
||||
</administration/maintain/enterprise>` or contact your Odoo service provider.
|
||||
If you use Odoo Community, you should
|
||||
:doc:`upgrade to Odoo Enterprise </administration/enterprise>`
|
||||
or contact your Odoo service provider.
|
||||
|
||||
In case of non-conformity, your company risks a fine of €7,500.
|
||||
|
||||
To get the certification just follow the following steps:
|
||||
|
||||
* If you use **Odoo Point of Sale**, :ref:`install <general/install>` the **France - VAT Anti-Fraud
|
||||
Certification for Point of Sale (CGI 286 I-3 bis)** module by going to :menuselection:`Apps`,
|
||||
removing the *Apps* filter, then searching for *l10n_fr_pos_cert*, and installing the module.
|
||||
* If you use **Odoo Point of Sale**, install the **France - VAT Anti-Fraud Certification for Point
|
||||
of Sale (CGI 286 I-3 bis)** module by going to :menuselection:`Apps`, removing the *Apps* filter,
|
||||
then searching for *l10n_fr_pos_cert*, and installing the module.
|
||||
|
||||
* Make sure a country is set on your company, otherwise your entries won’t be
|
||||
encrypted for the inalterability check. To edit your company’s data,
|
||||
@@ -71,7 +72,7 @@ To get the certification just follow the following steps:
|
||||
.. note::
|
||||
* To install the module in any system created before
|
||||
December 18th 2017, you should update the modules list.
|
||||
To do so, activate the :ref:`developer mode <developer-mode>`.
|
||||
To do so, activate the :doc:`Developer mode </applications/general/developer_mode>`.
|
||||
Then go to the *Apps* menu and press *Update Modules List* in the top-menu.
|
||||
* In case you run Odoo on-premise, you need to update your installation
|
||||
and restart your server beforehand.
|
||||
@@ -88,52 +89,52 @@ Anti-fraud features
|
||||
|
||||
The anti-fraud module introduces the following features:
|
||||
|
||||
* **Inalterability**: deactivation of all the ways to cancel or modify
|
||||
* **Inalterability**: deactivation of all the ways to cancel or modify
|
||||
key data of POS orders, invoices and journal entries;
|
||||
* **Security**: chaining algorithm to verify the inalterability;
|
||||
* **Storage**: automatic sales closings with computation of both period
|
||||
* **Storage**: automatic sales closings with computation of both period
|
||||
and cumulative totals (daily, monthly, annually).
|
||||
|
||||
Inalterability
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
All the possible ways to cancel and modify key data of paid POS orders,
|
||||
confirmed invoices and journal entries are deactivated,
|
||||
if the company is located in France or in any DOM-TOM.
|
||||
All the possible ways to cancel and modify key data of paid POS orders,
|
||||
confirmed invoices and journal entries are deactivated,
|
||||
if the company is located in France or in any DOM-TOM.
|
||||
|
||||
.. note:: If you run a multi-companies environment, only the documents of
|
||||
.. note:: If you run a multi-companies environment, only the documents of
|
||||
such companies are impacted.
|
||||
|
||||
Security
|
||||
~~~~~~~~
|
||||
|
||||
To ensure the inalterability, every order or journal entry is encrypted
|
||||
upon validation.
|
||||
This number (or hash) is calculated from the key data of the document as
|
||||
To ensure the inalterability, every order or journal entry is encrypted
|
||||
upon validation.
|
||||
This number (or hash) is calculated from the key data of the document as
|
||||
well as from the hash of the precedent documents.
|
||||
|
||||
The module introduces an interface to test the data inalterability.
|
||||
If any information is modified on a document after its validation,
|
||||
the test will fail. The algorithm recomputes all the hashes and compares them
|
||||
against the initial ones. In case of failure, the system points out the first
|
||||
The module introduces an interface to test the data inalterability.
|
||||
If any information is modified on a document after its validation,
|
||||
the test will fail. The algorithm recomputes all the hashes and compares them
|
||||
against the initial ones. In case of failure, the system points out the first
|
||||
corrupted document recorded in the system.
|
||||
|
||||
Users with *Manager* access rights can launch the inalterability check.
|
||||
For POS orders, go to
|
||||
:menuselection:`Point of Sales --> Reporting --> French Statements`.
|
||||
For invoices or journal entries,
|
||||
Users with *Manager* access rights can launch the inalterability check.
|
||||
For POS orders, go to
|
||||
:menuselection:`Point of Sales --> Reporting --> French Statements`.
|
||||
For invoices or journal entries,
|
||||
go to :menuselection:`Invoicing/Accounting --> Reporting --> French Statements`.
|
||||
|
||||
Storage
|
||||
~~~~~~~
|
||||
|
||||
The system also processes automatic sales closings on a daily, monthly
|
||||
The system also processes automatic sales closings on a daily, monthly
|
||||
and annual basis.
|
||||
Such closings distinctly compute the sales total of the period as well as
|
||||
the cumulative grand totals from the very first sales entry recorded
|
||||
Such closings distinctly compute the sales total of the period as well as
|
||||
the cumulative grand totals from the very first sales entry recorded
|
||||
in the system.
|
||||
|
||||
Closings can be found in the *French Statements* menu of Point of Sale,
|
||||
Closings can be found in the *French Statements* menu of Point of Sale,
|
||||
Invoicing and Accounting apps.
|
||||
|
||||
.. note::
|
||||
@@ -141,33 +142,33 @@ Invoicing and Accounting apps.
|
||||
|
||||
* For multi-companies environments, such closings are performed by company.
|
||||
|
||||
* POS orders are posted as journal entries at the closing of the POS session.
|
||||
Closing a POS session can be done anytime.
|
||||
To prompt users to do it on a daily basis, the module prevents from resuming
|
||||
a session opened more than 24 hours ago.
|
||||
* POS orders are posted as journal entries at the closing of the POS session.
|
||||
Closing a POS session can be done anytime.
|
||||
To prompt users to do it on a daily basis, the module prevents from resuming
|
||||
a session opened more than 24 hours ago.
|
||||
Such a session must be closed before selling again.
|
||||
|
||||
* A period’s total is computed from all the journal entries posted after the
|
||||
previous closing of the same type, regardless of their posting date.
|
||||
If you record a new sales transaction for a period already closed,
|
||||
* A period’s total is computed from all the journal entries posted after the
|
||||
previous closing of the same type, regardless of their posting date.
|
||||
If you record a new sales transaction for a period already closed,
|
||||
it will be counted in the very next closing.
|
||||
|
||||
.. tip:: For test & audit purposes such closings can be manually generated in the
|
||||
:ref:`developer mode <developer-mode>`. Then go to :menuselection:`Settings -->
|
||||
Technical --> Automation --> Scheduled Actions`.
|
||||
:doc:`Developer mode </applications/general/developer_mode>`. Then go to
|
||||
:menuselection:`Settings --> Technical --> Automation --> Scheduled Actions`.
|
||||
|
||||
|
||||
Responsibilities
|
||||
----------------
|
||||
|
||||
Do not uninstall the module! If you do so, the hashes will be reset and none
|
||||
Do not uninstall the module! If you do so, the hashes will be reset and none
|
||||
of your past data will be longer guaranteed as being inalterable.
|
||||
|
||||
Users remain responsible for their Odoo instance and must use it with
|
||||
due diligence. It is not permitted to modify the source code which guarantees
|
||||
Users remain responsible for their Odoo instance and must use it with
|
||||
due diligence. It is not permitted to modify the source code which guarantees
|
||||
the inalterability of data.
|
||||
|
||||
Odoo absolves itself of all and any responsibility in case of changes
|
||||
|
||||
Odoo absolves itself of all and any responsibility in case of changes
|
||||
in the module’s functions caused by 3rd party applications not certified by Odoo.
|
||||
|
||||
|
||||
|
||||
@@ -31,139 +31,7 @@ Export from Odoo to Datev
|
||||
It is possible to export your accounting entries from Odoo to Datev. To be able to use this
|
||||
feature, the german accounting localization needs to be installed on your Odoo Enterprise database.
|
||||
Then you can go in :menuselection:`Accounting --> Reporting --> General Ledger` then click on the
|
||||
**Export Datev (csv)** button.
|
||||
|
||||
.. _germany/pos:
|
||||
|
||||
Point of Sale in Germany: Technical Security System
|
||||
===================================================
|
||||
|
||||
The **Kassensicherungsverordnung** (The Act on Protection against Manipulation of Digital Records)
|
||||
requires that electronic record-keeping systems - including the :doc:`point of sale
|
||||
<../../../../sales/point_of_sale>` systems - must be equipped with a **Technical Security System**
|
||||
(also called **TSS** or **TSE**).
|
||||
|
||||
Odoo offers a service that is compliant with the help of `fiskaly <https://fiskaly.com>`_, a
|
||||
*cloud-based solution*.
|
||||
|
||||
.. important::
|
||||
Since this solution is cloud-based, a working internet connection is required.
|
||||
|
||||
.. note::
|
||||
The only VAT rates allowed are given by fiskaly. You can check these rates by consulting:
|
||||
`fiskaly DSFinV-K API: VAT Definition
|
||||
<https://developer.fiskaly.com/api/dsfinvk/v0/#tag/VAT-Definition>`_.
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
|
||||
Modules installation
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
#. If your database was created before June 2021, :ref:`upgrade <general/upgrade>` your **Point of
|
||||
Sale** app (`point_of_sale`) and the **Restaurant** module (`pos_restaurant`).
|
||||
#. :ref:`Install <general/install>` the **Germany - Certification for Point of Sale**
|
||||
(`l10n_de_pos_cert`) and **Germany - Certification for Point of Sale of type restaurant**
|
||||
(`l10n_de_pos_res_cert`) modules.
|
||||
|
||||
.. tip::
|
||||
If these modules are not listed, :ref:`update the app list <general/install>`.
|
||||
|
||||
.. image:: germany/pos-upgrade.png
|
||||
:align: center
|
||||
:alt: Upgrading Odoo Point of Sale from the Apps dashboard
|
||||
|
||||
Register your company at the financial authority
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
To register your company, go to :menuselection:`Settings --> General Settings --> Companies -->
|
||||
Update Info`, fill out the following fields and *Save*.
|
||||
|
||||
- **Company name**
|
||||
- Valid **address**
|
||||
- **VAT** number
|
||||
- **St.-Nr** (Steuernummer): this number is assigned by the tax office to every taxable natural or
|
||||
legal person. (e.g., `2893081508152`)
|
||||
- **W-IdNr** (Wirtschafts-Identifikationsnummer): this number is used as a permanent
|
||||
identification number for economically active persons.
|
||||
|
||||
You can then **register your company through fiskaly** by opening the *fiskaly* tab and clicking on
|
||||
the *fiskaly Registration* button.
|
||||
|
||||
.. image:: germany/fiskaly-registration.png
|
||||
:align: center
|
||||
:alt: Button to register a company through fiskaly in Odoo
|
||||
|
||||
.. tip::
|
||||
If you do not see the *fiskaly Registration* button, make sure that you *saved* your company
|
||||
details and are not in *editing mode* anymore.
|
||||
|
||||
Once the registration has been finalized, new fields appear:
|
||||
|
||||
- **fiskaly organization ID** refers to the ID of your company at the fiskaly side.
|
||||
- **fiskaly API key** and **secret** are the credentials the system uses to access the services
|
||||
offered by fiskaly.
|
||||
|
||||
.. image:: germany/fiskaly-keys.png
|
||||
:align: center
|
||||
:alt: fiskaly keys as displayed on Odoo
|
||||
|
||||
.. note::
|
||||
It is possible to request new credentials if there is any issue with the current ones.
|
||||
|
||||
Create and link a Technical Security System to your PoS
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. image:: germany/create-tss.png
|
||||
:align: right
|
||||
:alt: Create TSS option from a point of sale
|
||||
|
||||
To use your point of sale in Germany, you first have to create a :abbr:`TSS (Technical Security
|
||||
System)` for it.
|
||||
|
||||
To do so, go to :menuselection:`Point of Sale --> Configuration --> Point of Sale`, open the point
|
||||
of sale you want to edit, then check the box next to **Create TSS** and *Save*.
|
||||
|
||||
.. image:: germany/tss-ids.png
|
||||
:align: right
|
||||
:alt: Example of TSS ID and Client ID from fiskaly in Odoo Point of Sale
|
||||
|
||||
Once the creation of the TSS is successful, you can find your **TSS ID** and **Client ID** under the
|
||||
*fiskaly API* section.
|
||||
|
||||
- **TSS ID** refers to the ID of your TSS at fiskaly's side.
|
||||
- **Client ID** refers to your PoS but at fiskaly's side.
|
||||
|
||||
DSFinV-K
|
||||
--------
|
||||
|
||||
.. image:: germany/dsfinv-k-export.png
|
||||
:align: right
|
||||
:alt: Menu to export DSFinV-K
|
||||
|
||||
Whenever you close a PoS session, the orders' details are sent to the :abbr:`DSFinV-K (Digitale
|
||||
Schnittstelle der Finanzverwaltung für Kassensysteme)` service of fiskaly.
|
||||
|
||||
In case of an audit, you can export the data sent to DSFinV-K by going to :menuselection:`Point of
|
||||
Sale --> Orders --> DSFinV-k exports`.
|
||||
|
||||
These fields are mandatory:
|
||||
|
||||
- **Name**
|
||||
- **Start Datetime** (export data with dates larger than or equal to the given start date)
|
||||
- **End Datetime** (export data with dates smaller than or equal to the given end date)
|
||||
|
||||
Leave the **Point of Sale** field blank if you want to export the data of all your points of sale.
|
||||
Specify a Point of Sale if you want to export this specific PoS' data only.
|
||||
|
||||
The creation of a DSFinV-K export triggers on export at fiskaly's side.
|
||||
|
||||
.. image:: germany/dsfinv-k-export-fields.png
|
||||
:align: center
|
||||
:alt: Pending DSFinV-K export on Odoo
|
||||
|
||||
As you can see, the **State** is *Pending*. This means that the export has been successfully
|
||||
triggered and is being processed. You have to click on *Refresh State* to check if it is ready.
|
||||
**Export Datev (csv)** button.
|
||||
|
||||
.. _germany/gobd:
|
||||
|
||||
|
||||
|
Before Width: | Height: | Size: 3.6 KiB |
|
Before Width: | Height: | Size: 7.1 KiB |
|
Before Width: | Height: | Size: 3.6 KiB |
|
Before Width: | Height: | Size: 6.4 KiB |
|
Before Width: | Height: | Size: 2.4 KiB |
|
Before Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 11 KiB |
@@ -1,79 +0,0 @@
|
||||
=====
|
||||
Italy
|
||||
=====
|
||||
|
||||
Allow the user to generate the EDI document for Italian invoicing.
|
||||
|
||||
This module allows the creation of the EDI documents and the communication with the SDICoop web
|
||||
service of FatturaPA to send or receive invoices and notifications.
|
||||
|
||||
.. warning::
|
||||
Once this module is installed, it's no longer possible to send invoices via :ref:`PEC mails
|
||||
<italy/pec>`.
|
||||
|
||||
SDICoop
|
||||
=======
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
|
||||
Setup the Codice Destinatario on FatturaPA
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
To receive invoices and notifications from third parties, you need to inform the FatturaPA service
|
||||
that Odoo is the allowed party to process files for you. To do so, you must setup Odoo's *Codice
|
||||
Destinatario* on the FatturaPA portal. The *Codice Destinatario* is ``K95IV18``.
|
||||
|
||||
#. Go to https://ivaservizi.agenziaentrate.gov.it/portale/ and authenticate.
|
||||
#. Go to section :menuselection:`Fatture e Corrispettivi`.
|
||||
#. Set the user as Legal Party for the VAT number you wish to configure the electronic adress.
|
||||
#. In :menuselection:`Servizi Disponibili --> Fatturazione Elettronica --> Registrazione
|
||||
dell’indirizzo telematico dove ricevere tutte le fatture elettroniche`, input Odoo's Codice
|
||||
Destinatario (**K95IV18**), then confirm.
|
||||
|
||||
Give Odoo permission to process files
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Since the files are transmitted through Odoo's server before being sent to SDICoop or received by
|
||||
your database, you need to authorize Odoo to process your files from your database.
|
||||
|
||||
To do this, go to :menuselection:`Accounting --> Settings --> Electronic Invoicing` and click on
|
||||
*Register*.
|
||||
|
||||
.. image:: italy/register.png
|
||||
:align: center
|
||||
:alt: Register button to allow Odoo to process invoices.
|
||||
|
||||
.. Note::
|
||||
All your files are encrypted upon reception in such a way that only you are able to decrypt them.
|
||||
|
||||
Enable FatturaPA on the Sales journal
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Open your sales journal. Under the *Advanced Settings* tab, in the **Electronic invoicing** field,
|
||||
check *FatturaPA* and *Save*.
|
||||
|
||||
.. image:: italy/journal.png
|
||||
:align: center
|
||||
:alt: FatturaPA feature in the sales journal's settings
|
||||
|
||||
Issue invoices
|
||||
--------------
|
||||
|
||||
Send an invoice the way you would do it normally. The EDI process proceeds automatically.
|
||||
|
||||
.. image:: italy/sending.png
|
||||
:align: center
|
||||
:alt: Asynchronous sending on a customer invoice
|
||||
|
||||
You can check the current status of your customer invoice under the **Electronic invoicing** field.
|
||||
|
||||
.. image:: italy/processing.png
|
||||
:align: center
|
||||
:alt: Electronic invoicing status (waiting for confirmation)
|
||||
|
||||
|
||||
Receive invoices
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
This process is ran automatically once a day.
|
||||
|
Before Width: | Height: | Size: 23 KiB |
|
Before Width: | Height: | Size: 24 KiB |
|
Before Width: | Height: | Size: 5.1 KiB |
|
Before Width: | Height: | Size: 28 KiB |
@@ -2,11 +2,6 @@
|
||||
Italy (IT)
|
||||
==========
|
||||
|
||||
.. _italy/pec:
|
||||
|
||||
PEC mail
|
||||
========
|
||||
|
||||
Questa guida spiegherà come utilizzare la fattura elettronica in Odoo e
|
||||
come configurare correttamente i dati aziendali, i contatti e la
|
||||
contabilità. Per testare la fattura elettronica i dati devono essere
|
||||
@@ -15,7 +10,7 @@ non riconoscerà l’interscambio di informazioni.
|
||||
|
||||
|
||||
Configurare le informazioni sulla tua Azienda
|
||||
---------------------------------------------
|
||||
=============================================
|
||||
|
||||
Il passo successivo è la configurazione delle informazioni necessarie al
|
||||
funzionamento della fatturazione elettronica. Si può accedere alla
|
||||
@@ -30,10 +25,9 @@ elettronica sono i seguenti:
|
||||
di posta elettronica certificata sono fornite dal tuo fornitore o dal
|
||||
Ministero. Lo stesso server deve essere configurato come server che
|
||||
gestisce tutta la corrispondenza mail in Odoo, per saperne di più si
|
||||
può consultare la relativa :doc:`guida
|
||||
</applications/productivity/discuss/advanced/email_servers>`.
|
||||
puo’ consultare la relativa :doc:`guida </applications/productivity/discuss/advanced/email_servers>`.
|
||||
|
||||
- Indirizzo PEC dell’Azienda, tale indirizzo deve essere lo stesso
|
||||
- Indirizzo PEC dell’ Azienda, tale indirizzo deve essere lo stesso
|
||||
registrato presso l’Agenzia delle Entrate per l’utilizzo dei servizi
|
||||
di fatturazione elettronica.
|
||||
|
||||
@@ -42,13 +36,13 @@ elettronica sono i seguenti:
|
||||
Entrate, ricorda che l’Agenzia delle Entrate potrebbe cambiare questo
|
||||
indirizzo in seguito, previa comunicazione.
|
||||
|
||||
- Partita IVA e Codice Fiscale. Per far sì che la Fatturazione
|
||||
Elettronica funzioni correttamente, questi campi devono essere
|
||||
- Partita IVA e Codice Fiscale. Per far si che la Fatturazione
|
||||
Elettronica funzioni correttamente, questi cambi devono essere
|
||||
compilati correttamente.
|
||||
|
||||
- Regime Fiscale. Il regime fiscale a cui è sottoposta l’Azienda deve
|
||||
essere selezionato scegliendo dalla lista precompilata fornita da
|
||||
Odoo. Chiedi al commercialista qual è il corretto regime fiscale!
|
||||
Odoo. Chiedi al commercialista qual’è il corretto regime fiscale!
|
||||
|
||||
- Numero di Iscrizione nel registro delle Imprese.
|
||||
|
||||
@@ -57,7 +51,7 @@ elettronica sono i seguenti:
|
||||
|
||||
|
||||
Configurare le impostazioni per la Fatturazione Elettronica
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
-----------------------------------------------------------
|
||||
|
||||
- Numero di iscrizione nel registro Imprese tenuto presso la Camera di
|
||||
Commercio.
|
||||
@@ -73,7 +67,7 @@ Configurare le impostazioni per la Fatturazione Elettronica
|
||||
|
||||
|
||||
Configurare il profilo dei clienti
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
----------------------------------
|
||||
|
||||
Per un corretto utilizzo dell’applicazione, il profilo di clienti e
|
||||
fornitori, nell’applicazione contatti, deve essere configurato con le
|
||||
@@ -90,7 +84,7 @@ fattura elettronica*.
|
||||
|
||||
|
||||
Il processo di fatturazione
|
||||
---------------------------
|
||||
===========================
|
||||
|
||||
Si può procedere ad emettere una fattura seguendo le indicazioni
|
||||
dell’applicazione. Il momento che determina il formale invio della
|
||||
|
||||
|
After Width: | Height: | Size: 27 KiB |
|
After Width: | Height: | Size: 19 KiB |
|
After Width: | Height: | Size: 15 KiB |
|
After Width: | Height: | Size: 45 KiB |
|
After Width: | Height: | Size: 198 KiB |