Compare commits
192 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| dba4ba5f39 | |||
| d9620d54e7 | |||
| 6594686062 | |||
| 5f29b23c70 | |||
| 9a31ed8f67 | |||
| afdd438818 | |||
| ef2443f2fa | |||
| ec10063ab9 | |||
| 69364e7ddb | |||
| bc257a8f5e | |||
| 0ccf35c29a | |||
| 2b076ce94f | |||
| d30cb941c5 | |||
| e528bbcfb5 | |||
| 76cfe25774 | |||
| 5ae6578b83 | |||
| 6c2e3e099e | |||
| 4e070ab14c | |||
| 4bd0353e2f | |||
| 2c9ce286d7 | |||
| 64784c41ed | |||
| f8f784c0b0 | |||
| be1653cc51 | |||
| 16418c020b | |||
| bf061f6d56 | |||
| cc8c33c848 | |||
| b4ef20a970 | |||
| 7548209ed1 | |||
| bfe6f805a8 | |||
| ebd932134d | |||
| f63e7e77d1 | |||
| b152653337 | |||
| 8467404116 | |||
| 2fafbc1b15 | |||
| 197dc14e78 | |||
| 8752e14dee | |||
| a5ab764c04 | |||
| 1e520cbbfc | |||
| 46643653bf | |||
| 3355500414 | |||
| 94e033c5e8 | |||
| 245dd60bb4 | |||
| 7faf5ff926 | |||
| 8831e33e53 | |||
| 65ece5951e | |||
| 3687dc5d1e | |||
| 819d1d7332 | |||
| c84ac0f7e4 | |||
| b423c066f9 | |||
| e55138742f | |||
| 5583691ae2 | |||
| 5b59088a71 | |||
| ce9e496873 | |||
| c34e7eea30 | |||
| d8a669e6fc | |||
| 889ff02027 | |||
| d4f3830eba | |||
| bba648dc66 | |||
| 99511bb2d7 | |||
| db02edc371 | |||
| d59bc40f4a | |||
| 192d9349c1 | |||
| 0421e03141 | |||
| c38dbf59ce | |||
| cafa11ac70 | |||
| 207bfd6684 | |||
| 3a915ce2d1 | |||
| e33ff19702 | |||
| 0fcc6fc9d8 | |||
| a040ad6797 | |||
| ecd044ba15 | |||
| 7c2bcdb980 | |||
| c3eb3f015e | |||
| cffb0b341a | |||
| 1f81173389 | |||
| 23a40f9748 | |||
| ec1dc7b632 | |||
| 1faf5486a7 | |||
| 015f456d80 | |||
| 28da20b840 | |||
| 457008fab7 | |||
| b30f28a3c4 | |||
| 251438d569 | |||
| 1d3375f1a8 | |||
| 7c3106e95c | |||
| c8750ae032 | |||
| 525d05e068 | |||
| 08f8a3d0c0 | |||
| 4c92915aba | |||
| e95ff9c5ed | |||
| 8b201ca924 | |||
| f6d3c5628d | |||
| 5469c2fb2c | |||
| a8cfd6c6c5 | |||
| b1b48759ba | |||
| dc7679a20b | |||
| 2ec074d5a0 | |||
| 9db11c78c9 | |||
| fffaca7384 | |||
| ddb5523d03 | |||
| 10e0a48ac0 | |||
| 49baf6b4d7 | |||
| 193e22492c | |||
| 2591ddc6d2 | |||
| 400b3f52b7 | |||
| 2fb77cf3ff | |||
| 9493bbf4f4 | |||
| 8c036a0321 | |||
| 2b6f89f26e | |||
| 6940f68cb5 | |||
| 4c6947da4f | |||
| 675f7bc899 | |||
| b33ce0a6ca | |||
| d409bc0639 | |||
| 451f1ccee7 | |||
| 7efbf490f6 | |||
| 79f8baadd3 | |||
| a1e7024fa0 | |||
| c9b6795179 | |||
| 40afc9d9f0 | |||
| bfec9a58f9 | |||
| becf7a207d | |||
| 0a4e0610c6 | |||
| e96bc804d3 | |||
| 2f4c713be1 | |||
| 4483a86907 | |||
| eb0304c958 | |||
| 3ae10515b9 | |||
| f3bf048221 | |||
| 1758c674e6 | |||
| 4ca0d019c7 | |||
| fa267e5cfc | |||
| dee28c59a1 | |||
| 76e05ccfb8 | |||
| ead1b9a533 | |||
| 05d99f94d6 | |||
| ba635bdc02 | |||
| 6b616c1bd0 | |||
| 74e7da5694 | |||
| 90b848eb45 | |||
| e1adedc2e5 | |||
| 88f00fe611 | |||
| e11f010783 | |||
| 4d0f63e3eb | |||
| 6dd282f6e1 | |||
| 86cefde583 | |||
| 10612f0ba7 | |||
| 131f48bc38 | |||
| 78ffc619ea | |||
| 8a160c3437 | |||
| cdd5fc8049 | |||
| d9bd94ed3c | |||
| 4b1a61a7aa | |||
| 647b6d924d | |||
| 5c3a4e60e2 | |||
| d66de0d1f2 | |||
| 7f3b2a1edd | |||
| 806761eec5 | |||
| b96c1338c9 | |||
| 80f24e5533 | |||
| 1f9cd600cc | |||
| defd620d5e | |||
| c135e49668 | |||
| 46c21826fc | |||
| 2ddac026f1 | |||
| ee0083cdc7 | |||
| d0c2cb17bc | |||
| e9d06b7881 | |||
| b88c9ef6a9 | |||
| 8ad392222b | |||
| 87ab494b42 | |||
| ba72b396a4 | |||
| dc49cd9e7b | |||
| 326de4b39e | |||
| 83eaee0196 | |||
| 88e7e8d6db | |||
| 9e77998bc1 | |||
| c1d09cb79d | |||
| 769f5d9728 | |||
| 2d9ad82bd6 | |||
| 9e49550239 | |||
| bea76554f9 | |||
| 2ded74bbd6 | |||
| 106f9fa99a | |||
| b97c0bd230 | |||
| e76e1f41b6 | |||
| e09beafe99 | |||
| 903e80a756 | |||
| 5cc85f00c5 | |||
| aecd62eb9a | |||
| 337e9c8df0 | |||
| b5274bdd95 |
@@ -2,59 +2,14 @@
|
||||
host = https://www.transifex.com
|
||||
type = PO
|
||||
|
||||
[odoo-14-doc.accounting]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/accounting.po
|
||||
source_file = locale/sources/accounting.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.applications]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/applications.po
|
||||
source_file = locale/sources/applications.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.contributing]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/contributing.po
|
||||
source_file = locale/sources/contributing.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.crm]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/crm.po
|
||||
source_file = locale/sources/crm.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.db_management]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/db_management.po
|
||||
source_file = locale/sources/db_management.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.discuss]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/discuss.po
|
||||
source_file = locale/sources/discuss.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.ecommerce]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/ecommerce.po
|
||||
source_file = locale/sources/ecommerce.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.email_marketing]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/email_marketing.po
|
||||
source_file = locale/sources/email_marketing.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.expense]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/expense.po
|
||||
source_file = locale/sources/expense.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.events]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/events.po
|
||||
source_file = locale/sources/events.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.fsm]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/fsm.po
|
||||
source_file = locale/sources/fsm.pot
|
||||
[odoo-14-doc.finance]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/finance.po
|
||||
source_file = locale/sources/finance.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.general]
|
||||
@@ -62,84 +17,24 @@ file_filter = locale/<lang>/LC_MESSAGES/general.po
|
||||
source_file = locale/sources/general.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.getting_started]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/getting_started.po
|
||||
source_file = locale/sources/getting_started.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.helpdesk]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/helpdesk.po
|
||||
source_file = locale/sources/helpdesk.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.index]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/index.po
|
||||
source_file = locale/sources/index.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.inventory]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/inventory.po
|
||||
source_file = locale/sources/inventory.pot
|
||||
[odoo-14-doc.inventory_and_mrp]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/inventory_and_mrp.po
|
||||
source_file = locale/sources/inventory_and_mrp.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.iot]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/iot.po
|
||||
source_file = locale/sources/iot.pot
|
||||
[odoo-14-doc.marketing]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/marketing.po
|
||||
source_file = locale/sources/marketing.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.livechat]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/livechat.po
|
||||
source_file = locale/sources/livechat.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.mobile]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/mobile.po
|
||||
source_file = locale/sources/mobile.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.marketing_automation]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/marketing_automation.po
|
||||
source_file = locale/sources/marketing_automation.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.manufacturing]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/manufacturing.po
|
||||
source_file = locale/sources/manufacturing.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.planning]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/planning.po
|
||||
source_file = locale/sources/planning.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.point_of_sale]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/point_of_sale.po
|
||||
source_file = locale/sources/point_of_sale.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.portal]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/portal.po
|
||||
source_file = locale/sources/portal.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.practical]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/practical.po
|
||||
source_file = locale/sources/practical.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.project]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/project.po
|
||||
source_file = locale/sources/project.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.purchase]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/purchase.po
|
||||
source_file = locale/sources/purchase.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.quality]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/quality.po
|
||||
source_file = locale/sources/quality.pot
|
||||
[odoo-14-doc.productivity]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/productivity.po
|
||||
source_file = locale/sources/productivity.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.sales]
|
||||
@@ -147,42 +42,22 @@ file_filter = locale/<lang>/LC_MESSAGES/sales.po
|
||||
source_file = locale/sources/sales.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.sign]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/sign.po
|
||||
source_file = locale/sources/sign.pot
|
||||
[odoo-14-doc.services]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/services.po
|
||||
source_file = locale/sources/services.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.sms_marketing]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/sms_marketing.po
|
||||
source_file = locale/sources/sms_marketing.pot
|
||||
[odoo-14-doc.theme]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/sphinx.po
|
||||
source_file = locale/sources/sphinx.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.social_marketing]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/social_marketing.po
|
||||
source_file = locale/sources/social_marketing.pot
|
||||
[odoo-14-doc.user_settings]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/settings.po
|
||||
source_file = locale/sources/settings.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.studio]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/studio.po
|
||||
source_file = locale/sources/studio.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.support]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/support.po
|
||||
source_file = locale/sources/support.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.survey]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/survey.po
|
||||
source_file = locale/sources/survey.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.timesheets]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/timesheets.po
|
||||
source_file = locale/sources/timesheets.pot
|
||||
source_lang = en
|
||||
|
||||
[odoo-14-doc.website]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/website.po
|
||||
source_file = locale/sources/website.pot
|
||||
source_lang = en
|
||||
[odoo-14-doc.websites]
|
||||
file_filter = locale/<lang>/LC_MESSAGES/websites.po
|
||||
source_file = locale/sources/websites.pot
|
||||
source_lang = en
|
||||
@@ -1,8 +1,12 @@
|
||||
# Makefile for Sphinx documentation
|
||||
|
||||
# Pass WORKERS=auto for parallel build
|
||||
# Pass WORKERS=1 for single-worker build
|
||||
ifndef WORKERS
|
||||
WORKERS = 1
|
||||
WORKERS = auto
|
||||
endif
|
||||
|
||||
ifndef BUILD_DIR
|
||||
BUILD_DIR = _build
|
||||
endif
|
||||
|
||||
SPHINX_BUILD = sphinx-build
|
||||
@@ -13,11 +17,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)/14.0
|
||||
HTML_BUILD_DIR := $(HTML_BUILD_DIR)/master
|
||||
endif
|
||||
ifneq ($(CURRENT_LANG),en)
|
||||
HTML_BUILD_DIR := $(HTML_BUILD_DIR)/$(CURRENT_LANG)
|
||||
@@ -37,10 +41,9 @@ help:
|
||||
clean:
|
||||
@echo "Cleaning build files..."
|
||||
rm -rf $(BUILD_DIR)/*
|
||||
rm extensions/odoo_theme/static/style.css
|
||||
@echo "Cleaning finished."
|
||||
|
||||
html: extensions/odoo_theme/static/style.css
|
||||
html: $(BUILD_DIR)/html/_static/style.css
|
||||
@echo "Starting build..."
|
||||
$(SPHINX_BUILD) -c $(CONFIG_DIR) -b html $(SPHINXOPTS) $(SOURCE_DIR) $(HTML_BUILD_DIR)
|
||||
@echo "Build finished."
|
||||
@@ -55,24 +58,22 @@ latexpdf:
|
||||
cp $(BUILD_DIR)/latex/*.pdf $(BUILD_DIR)/html/
|
||||
@echo "Build finished."
|
||||
|
||||
l10n:
|
||||
gettext:
|
||||
@echo "Generating translatable files..."
|
||||
$(SPHINX_BUILD) -c $(CONFIG_DIR) -b gettext $(SOURCE_DIR) $(BUILD_DIR)/gettext
|
||||
$(SPHINX_BUILD) -c $(CONFIG_DIR) -b gettext $(SOURCE_DIR) locale/sources
|
||||
@echo "Generation finished."
|
||||
@echo "Localizing translation strings..."
|
||||
sphinx-intl update -p $(BUILD_DIR)/gettext -l $(L10N_LANGUAGES)
|
||||
@echo "Localization finished."
|
||||
|
||||
extensions/odoo_theme/static/style.css: extensions/odoo_theme/static/style.scss extensions/odoo_theme/static/scss/*.scss
|
||||
$(BUILD_DIR)/html/_static/style.css: extensions/odoo_theme/static/style.scss extensions/odoo_theme/static/scss/*.scss
|
||||
@echo "Compiling stylesheets..."
|
||||
pysassc $(subst .css,.scss,$@) $@
|
||||
mkdir -p $(BUILD_DIR)/html/_static
|
||||
pysassc extensions/odoo_theme/static/style.scss $(BUILD_DIR)/html/_static/style.css
|
||||
@echo "Compilation finished."
|
||||
|
||||
#=== Development and debugging rules ===#
|
||||
|
||||
fast: SPHINXOPTS += -A collapse_menu=True -j auto
|
||||
fast: SPHINXOPTS += -A collapse_menu=True
|
||||
fast: html
|
||||
|
||||
static: extensions/odoo_theme/static/style.css
|
||||
cp -r extensions/odoo_theme/static/* _build/html/_static/
|
||||
cp -r static/* _build/html/_static/
|
||||
static: $(BUILD_DIR)/static/style.css
|
||||
cp -r extensions/odoo_theme/static/* $(BUILD_DIR)/html/_static/
|
||||
cp -r static/* $(BUILD_DIR)/html/_static/
|
||||
|
||||
@@ -4,11 +4,11 @@
|
||||
|
||||
### Requirements
|
||||
|
||||
- [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)
|
||||
- [Git](https://www.odoo.com/documentation/master/contributing/documentation.html#install-git)
|
||||
- [Python 3.6, 3.7, or 3.8](https://www.odoo.com/documentation/master/contributing/documentation.html#python)
|
||||
- Python dependencies listed in the file [`requirements.txt`](https://github.com/odoo/documentation/tree/master/requirements.txt).
|
||||
- [Make](https://www.odoo.com/documentation/master/contributing/documentation.html#make)
|
||||
- A local copy of the [odoo/odoo repository in master](https://github.com/odoo/odoo/tree/master) (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/14.0/contributing/documentation/introduction_guide.html#preview-your-changes)
|
||||
3. See [this guide](https://www.odoo.com/documentation/master/contributing/documentation.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/14.0/contributing/documentation/introduction_guide.html).
|
||||
[Introduction Guide](https://www.odoo.com/documentation/master/contributing/documentation.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.
|
||||
|
||||
@@ -5,6 +5,7 @@ from pathlib import Path
|
||||
|
||||
from pygments.lexers import JsonLexer, XmlLexer
|
||||
from sphinx.util import logging
|
||||
import sphinx
|
||||
|
||||
_logger = logging.getLogger(__name__)
|
||||
|
||||
@@ -18,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 = '14.0'
|
||||
version = release = 'master'
|
||||
|
||||
# The minimal Sphinx version required to build the documentation.
|
||||
needs_sphinx = '3.0.0'
|
||||
@@ -59,6 +60,11 @@ 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"
|
||||
@@ -128,7 +134,14 @@ intersphinx_mapping = {
|
||||
github_user = 'odoo'
|
||||
github_project = 'documentation'
|
||||
|
||||
locale_dirs = ['locale/']
|
||||
locale_dirs = ['../locale/']
|
||||
templates_path = ['../extensions']
|
||||
|
||||
# custom docname_to_domain to divide 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]
|
||||
|
||||
supported_languages = {
|
||||
'de': 'Deutsch',
|
||||
'en': 'English',
|
||||
|
||||
@@ -1,14 +1,21 @@
|
||||
==============
|
||||
Administration
|
||||
==============
|
||||
: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>`
|
||||
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
|
||||
administration/install
|
||||
administration/deployment
|
||||
administration/update
|
||||
administration/db_upgrade
|
||||
administration/maintain
|
||||
administration/odoo_sh
|
||||
administration/db_management
|
||||
administration/enterprise
|
||||
|
||||
@@ -1,10 +0,0 @@
|
||||
===================
|
||||
Database Management
|
||||
===================
|
||||
|
||||
|
||||
.. toctree::
|
||||
|
||||
db_management/db_online
|
||||
db_management/db_premise
|
||||
db_management/hosting_changes
|
||||
@@ -1,233 +0,0 @@
|
||||
|
||||
.. _db_online:
|
||||
|
||||
==========================
|
||||
Online Database management
|
||||
==========================
|
||||
|
||||
To manage your databases, access the `database management page
|
||||
<https://www.odoo.com/my/databases>`__ (you will have to sign in). Then click
|
||||
on the `Manage Your Databases <https://www.odoo.com/my/databases/manage>`__
|
||||
button.
|
||||
|
||||
.. image:: media/databases.png
|
||||
:align: center
|
||||
|
||||
Make sure you are connected as the administrator of the database you
|
||||
want to manage - many operations depends on 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>`__
|
||||
|
Before Width: | Height: | Size: 9.2 KiB |
|
Before Width: | Height: | Size: 10 KiB |
|
Before Width: | Height: | Size: 7.3 KiB |
|
Before Width: | Height: | Size: 3.4 KiB |
|
Before Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 19 KiB |
|
Before Width: | Height: | Size: 44 KiB |
|
Before Width: | Height: | Size: 11 KiB |
|
Before Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 28 KiB |
|
Before Width: | Height: | Size: 35 KiB |
|
Before Width: | Height: | Size: 35 KiB |
@@ -1,10 +0,0 @@
|
||||
==========
|
||||
Deployment
|
||||
==========
|
||||
|
||||
|
||||
.. toctree::
|
||||
|
||||
deployment/deploy
|
||||
deployment/cdn
|
||||
deployment/email_gateway
|
||||
@@ -1,756 +1,12 @@
|
||||
:nosearch:
|
||||
|
||||
.. _setup/install:
|
||||
=======
|
||||
Install
|
||||
=======
|
||||
|
||||
===============
|
||||
Installing Odoo
|
||||
===============
|
||||
.. toctree::
|
||||
|
||||
There are multiple ways to install Odoo, or not install it at all, depending
|
||||
on the intended use case.
|
||||
|
||||
This documents attempts to describe most of the installation options.
|
||||
|
||||
:ref:`setup/install/online`
|
||||
The easiest way to use Odoo in production or to try it.
|
||||
|
||||
:ref:`setup/install/packaged`
|
||||
Suitable for testing Odoo, developing modules and can be used for
|
||||
long-term production use with additional deployment and maintenance work.
|
||||
|
||||
:ref:`setup/install/source`
|
||||
Provides greater flexibility: e.g. allow multiple running Odoo versions on
|
||||
the same system. Good for developing modules, can be used as base for
|
||||
production deployment.
|
||||
|
||||
:ref:`setup/install/docker`
|
||||
If you usually use docker_ for development or deployment, an official
|
||||
docker_ base image is available.
|
||||
|
||||
|
||||
.. _setup/install/editions:
|
||||
|
||||
Editions
|
||||
========
|
||||
|
||||
There are two different Editions_ of Odoo: the Community and Enterprise versions.
|
||||
Using the Enterprise version is possible on our SaaS_ and accessing the code is
|
||||
restricted to Enterprise customers and partners. The Community version is freely
|
||||
available to anyone.
|
||||
|
||||
If you already use the Community version and wish to upgrade to Enterprise, please
|
||||
refer to :ref:`setup/enterprise` (except for :ref:`setup/install/source`).
|
||||
|
||||
|
||||
.. _setup/install/online:
|
||||
|
||||
Online
|
||||
======
|
||||
|
||||
Demo
|
||||
----
|
||||
|
||||
To simply get a quick idea of Odoo, demo_ instances are available. They are
|
||||
shared instances which only live for a few hours, and can be used to browse
|
||||
around and try things out with no commitment.
|
||||
|
||||
Demo_ instances require no local installation, just a web browser.
|
||||
|
||||
SaaS
|
||||
----
|
||||
|
||||
Trivial to start with, fully managed and migrated by Odoo S.A., Odoo's SaaS_
|
||||
provides private instances and starts out free. It can be used to discover and
|
||||
test Odoo and do non-code customizations (i.e. incompatible with custom modules
|
||||
or the Odoo Apps Store) without having to install it locally.
|
||||
|
||||
Can be used for both testing Odoo and long-term production use.
|
||||
|
||||
Like demo_ instances, SaaS_ instances require no local installation, a web
|
||||
browser is sufficient.
|
||||
|
||||
|
||||
.. _setup/install/packaged:
|
||||
|
||||
Packaged installers
|
||||
===================
|
||||
|
||||
Odoo provides packaged installers for Windows, deb-based distributions
|
||||
(Debian, Ubuntu, …) and RPM-based distributions (Fedora, CentOS, RHEL, …) for
|
||||
both the Community and Enterprise versions.
|
||||
|
||||
These packages automatically set up all dependencies (for the Community version),
|
||||
but may be difficult to keep up-to-date.
|
||||
|
||||
Official Community packages with all relevant dependency requirements are
|
||||
available on our nightly_ server. Both Communtiy and Enterprise packages can
|
||||
be downloaded from our download_ page (you must to be logged in as a paying
|
||||
customer or partner to download the Enterprise packages).
|
||||
|
||||
Windows
|
||||
-------
|
||||
|
||||
#. Download the installer from our nightly_ server (Community only) or the Windows installer from
|
||||
the download_ page (any edition).
|
||||
#. Execute the downloaded file.
|
||||
|
||||
.. warning:: | On Windows 8 and later you may see a warning titled "Windows protected your PC".
|
||||
| Click on **More Info** and then on **Run anyway**.
|
||||
|
||||
#. Accept the UAC_ prompt.
|
||||
#. Go through the various installation steps.
|
||||
|
||||
Odoo will automatically be started at the end of the installation.
|
||||
|
||||
Linux
|
||||
-----
|
||||
|
||||
Debian/Ubuntu
|
||||
'''''''''''''
|
||||
|
||||
Odoo 14.0 'deb' package currently supports `Debian Buster`_, `Ubuntu 20.04`_ or above.
|
||||
|
||||
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
|
||||
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
|
||||
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
|
||||
details on the various versions.
|
||||
|
||||
Repository
|
||||
^^^^^^^^^^
|
||||
|
||||
Odoo S.A. provides a repository that can be used with Debian and Ubuntu distributions. It can be
|
||||
used to install *Odoo Community Edition* by executing the following commands:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ wget -O - https://nightly.odoo.com/odoo.key | sudo apt-key add -
|
||||
$ sudo sh -c 'echo "deb http://nightly.odoo.com/14.0/nightly/deb/ ./" >> /etc/apt/sources.list.d/odoo.list'
|
||||
$ sudo apt-get update && sudo apt-get install odoo
|
||||
|
||||
You can then use the usual `apt-get upgrade` command to keep your installation up-to-date.
|
||||
|
||||
At this moment, there is no nightly repository for the Enterprise Edition.
|
||||
|
||||
Deb Package
|
||||
^^^^^^^^^^^
|
||||
|
||||
Instead of using the repository as described above, the 'deb' packages for both the *Community* and
|
||||
*Enterprise* editions can be downloaded from the `official download page <download_>`_.
|
||||
|
||||
Next, execute the following commands:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo apt-get install <path_to_installation_package>
|
||||
|
||||
This will install Odoo as a service, create the necessary PostgreSQL_ user
|
||||
and automatically start the server.
|
||||
|
||||
.. note:: The recommended `postgresql-server` package will be installed by the Debian Odoo package.
|
||||
The `--no-install-recommends` argument of the `apt-get` tool should be used if you plan
|
||||
to install the Postgresql server on another machine.
|
||||
|
||||
Fedora
|
||||
''''''
|
||||
|
||||
Odoo 14.0 'rpm' package supports Fedora 32.
|
||||
|
||||
.. warning:: The Odoo 14.0 rpm package does not support Fedora 33 or above.
|
||||
|
||||
Prepare
|
||||
^^^^^^^
|
||||
Odoo needs a `PostgreSQL`_ server to run properly. Make sure that the `sudo` command is available
|
||||
and well configured and, only then, execute the following command in order to install the PostgreSQL
|
||||
server:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo dnf install -y postgresql-server
|
||||
$ sudo postgresql-setup --initdb --unit postgresql
|
||||
$ sudo systemctl enable postgresql
|
||||
$ sudo systemctl start postgresql
|
||||
|
||||
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
|
||||
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
|
||||
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
|
||||
details on the various versions.
|
||||
|
||||
Repository
|
||||
^^^^^^^^^^
|
||||
|
||||
Odoo S.A. provides a repository that can be used with the Fedora distributions.
|
||||
It can be used to install *Odoo Community Edition* by executing the following
|
||||
commands:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo dnf config-manager --add-repo=https://nightly.odoo.com/14.0/nightly/rpm/odoo.repo
|
||||
$ sudo dnf install -y odoo
|
||||
$ sudo systemctl enable odoo
|
||||
$ sudo systemctl start odoo
|
||||
|
||||
RPM package
|
||||
^^^^^^^^^^^
|
||||
|
||||
Instead of using the repository as described above, the 'rpm' packages for both the *Community* and
|
||||
*Enterprise* editions can be downloaded from the `official download page <download_>`_.
|
||||
|
||||
Once downloaded, the package can be installed using the 'dnf' package manager:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo dnf localinstall odoo_14.0.latest.noarch.rpm
|
||||
$ sudo systemctl enable odoo
|
||||
$ sudo systemctl start odoo
|
||||
|
||||
|
||||
.. _setup/install/source:
|
||||
|
||||
Source Install
|
||||
==============
|
||||
|
||||
The source "installation" is really about not installing Odoo, and running it directly from source
|
||||
instead.
|
||||
|
||||
This can be more convenient for module developers as the Odoo source is more easily accessible
|
||||
than using packaged installation (for information or to build this documentation and have it
|
||||
available offline).
|
||||
|
||||
It also makes starting and stopping Odoo more flexible and explicit than the services set up by the
|
||||
packaged installations, and allows overriding settings using
|
||||
:ref:`command-line parameters <reference/cmdline>` without needing to edit a configuration file.
|
||||
|
||||
Finally it provides greater control over the system's set up, and allows to more easily keep
|
||||
(and run) multiple versions of Odoo side-by-side.
|
||||
|
||||
Windows
|
||||
-------
|
||||
|
||||
Fetch the sources
|
||||
'''''''''''''''''
|
||||
|
||||
There are two ways to obtain the source code of Odoo: as a zip **archive** or through **git**.
|
||||
|
||||
Archive
|
||||
^^^^^^^
|
||||
|
||||
Community Edition:
|
||||
|
||||
* `Official download page <download_>`_
|
||||
* `GitHub repository <community-repository_>`_
|
||||
* `Nightly server <nightly_>`_
|
||||
|
||||
Enterprise Edition:
|
||||
|
||||
* `Official download page <download_>`_
|
||||
* `GitHub repository <enterprise-repository_>`_
|
||||
|
||||
Git
|
||||
^^^
|
||||
|
||||
The following requires git_ to be installed on your machine and that you have basic knowledge of
|
||||
git commands.
|
||||
|
||||
Community Edition:
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> git clone https://github.com/odoo/odoo.git
|
||||
|
||||
|
||||
Enterprise Edition: (see :ref:`setup/install/editions` to get access)
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> git clone https://github.com/odoo/enterprise.git
|
||||
|
||||
.. note:: **The Enterprise git repository does not contain the full Odoo source code**. It is only
|
||||
a collection of extra add-ons. The main server code is in the Community version. Running
|
||||
the Enterprise version actually means running the server from the Community version with
|
||||
the addons-path option set to the folder with the Enterprise version. You need to clone
|
||||
both the Community and Enterprise repository to have a working Odoo Enterprise
|
||||
installation.
|
||||
|
||||
Prepare
|
||||
'''''''
|
||||
|
||||
Python
|
||||
^^^^^^
|
||||
|
||||
Odoo requires Python 3.6 or later to run. Visit `Python's download page <https://www.python.org/downloads/windows/>`_
|
||||
to download and install the latest version of Python 3 on your machine.
|
||||
|
||||
During installation, check **Add Python 3 to PATH**, then click **Customize Installation** and make
|
||||
sure that **pip** is checked.
|
||||
|
||||
.. note:: If Python 3 is already installed, make sure that the version is 3.6 or above, as previous
|
||||
versions are not compatible with Odoo.
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> python --version
|
||||
|
||||
Verify also that pip_ is installed for this version.
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> pip --version
|
||||
|
||||
PostgreSQL
|
||||
^^^^^^^^^^
|
||||
|
||||
Odoo uses PostgreSQL as database management system. `Download and install PostgreSQL <https://www.postgresql.org/download/windows/>`_
|
||||
(supported version: 10.0 and later).
|
||||
|
||||
By default, the only user is `postgres` but Odoo forbids connecting as `postgres`, so you need to
|
||||
create a new PostgreSQL user:
|
||||
|
||||
#. Add PostgreSQL's `bin` directory (by default: `C:\\Program Files\\PostgreSQL\\<version>\\bin`) to
|
||||
your `PATH`.
|
||||
#. Create a postgres user with a password using the pg admin gui:
|
||||
|
||||
1. Open **pgAdmin**.
|
||||
2. Double-click the server to create a connection.
|
||||
3. Select :menuselection:`Object --> Create --> Login/Group Role`.
|
||||
4. Enter the username in the **Role Name** field (e.g. `odoo`).
|
||||
5. Open the **Definition** tab and enter the password (e.g. ``odoo``), then click **Save**.
|
||||
6. Open the **Privileges** tab and switch **Can login?** to `Yes` and **Create database?** to
|
||||
`Yes`.
|
||||
|
||||
Dependencies
|
||||
^^^^^^^^^^^^
|
||||
|
||||
Before installing the dependencies, you must download and install the
|
||||
`Build Tools for Visual Studio <https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2019>`_.
|
||||
When prompted, select **C++ build tools** in the **Workloads** tab and install them.
|
||||
|
||||
Odoo dependencies are listed in the `requirements.txt` file located at the root of the Odoo
|
||||
community directory.
|
||||
|
||||
.. tip:: It can be preferable to not mix python modules packages between different instances of Odoo
|
||||
or with your system. You can use virtualenv_ to create isolated Python environments.
|
||||
|
||||
Navigate to the path of your Odoo Community installation (`CommunityPath`) and run **pip**
|
||||
on the requirements file in a terminal **with Administrator privileges**:
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> cd \CommunityPath
|
||||
C:\> pip install setuptools wheel
|
||||
C:\> pip install -r requirements.txt
|
||||
|
||||
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
|
||||
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
|
||||
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
|
||||
details on the various versions.
|
||||
|
||||
For languages with right-to-left interface (such as Arabic or Hebrew), the package `rtlcss` is
|
||||
needed:
|
||||
|
||||
#. Download and install `nodejs <https://nodejs.org/en/download/>`_.
|
||||
#. Install `rtlcss`:
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> npm install -g rtlcss
|
||||
|
||||
#. Edit the System Environment's variable `PATH` to add the folder where `rtlcss.cmd` is located
|
||||
(typically: `C:\\Users\\<user>\\AppData\\Roaming\\npm\\`).
|
||||
|
||||
Running Odoo
|
||||
''''''''''''
|
||||
|
||||
Once all dependencies are set up, Odoo can be launched by running `odoo-bin`, the
|
||||
command-line interface of the server. It is located at the root of the Odoo Community directory.
|
||||
|
||||
To configure the server, you can either specify :ref:`command-line arguments <reference/cmdline/server>` or a
|
||||
:ref:`configuration file <reference/cmdline/config>`.
|
||||
|
||||
.. tip:: For the Enterprise edition, you must add the path to the `enterprise` addons to the
|
||||
`addons-path` argument. Note that it must come before the other paths in `addons-path` for
|
||||
addons to be loaded correctly.
|
||||
|
||||
Common necessary configurations are:
|
||||
|
||||
* PostgreSQL user and password.
|
||||
* Custom addon paths beyond the defaults, to load your own modules.
|
||||
|
||||
A typical way to run the server would be:
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> cd CommunityPath/
|
||||
C:\> python odoo-bin -r dbuser -w dbpassword --addons-path=addons -d mydb
|
||||
|
||||
Where `CommunityPath` is the path of the Odoo Community installation, `dbuser` is the
|
||||
PostgreSQL login, `dbpassword` is the PostgreSQL password
|
||||
and `mydb` is the default database to serve on `localhost:8069`. You can add other
|
||||
directory paths separated by a comma to ``addons`` at the end of the addons-path option.
|
||||
|
||||
Linux
|
||||
-----
|
||||
|
||||
Fetch the sources
|
||||
'''''''''''''''''
|
||||
|
||||
There are two ways to obtain the source code of Odoo: as a zip **archive** or through **git**.
|
||||
|
||||
Archive
|
||||
^^^^^^^
|
||||
|
||||
Community Edition:
|
||||
|
||||
* `Official download page <download_>`_
|
||||
* `GitHub repository <community-repository_>`_
|
||||
* `Nightly server <nightly_>`_
|
||||
|
||||
Enterprise Edition:
|
||||
|
||||
* `Official download page <download_>`_
|
||||
* `GitHub repository <enterprise-repository_>`_
|
||||
|
||||
Git
|
||||
^^^
|
||||
|
||||
The following requires git_ to be installed on your machine and that you have basic knowledge of
|
||||
git commands.
|
||||
|
||||
Community Edition:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ git clone https://github.com/odoo/odoo.git
|
||||
|
||||
|
||||
Enterprise Edition: (see :ref:`setup/install/editions` to get access)
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ git clone https://github.com/odoo/enterprise.git
|
||||
|
||||
.. note:: **The Enterprise git repository does not contain the full Odoo source code**. It is only
|
||||
a collection of extra add-ons. The main server code is in the Community version. Running
|
||||
the Enterprise version actually means running the server from the Community version with
|
||||
the addons-path option set to the folder with the Enterprise version. You need to clone
|
||||
both the Community and Enterprise repository to have a working Odoo Enterprise
|
||||
installation.
|
||||
|
||||
Prepare
|
||||
'''''''
|
||||
|
||||
Python
|
||||
^^^^^^
|
||||
|
||||
Odoo requires Python 3.6 or later to run. Use your package manager to download and install Python 3
|
||||
on your machine if it is not already done.
|
||||
|
||||
.. note:: If Python 3 is already installed, make sure that the version is 3.6 or above, as previous
|
||||
versions are not compatible with Odoo.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ python3 --version
|
||||
|
||||
Verify also that pip_ is installed for this version.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ pip3 --version
|
||||
|
||||
PostgreSQL
|
||||
^^^^^^^^^^
|
||||
|
||||
Odoo uses PostgreSQL as database management system. Use your package manager to download and install
|
||||
PostgreSQL (supported version: 10.0 and later).
|
||||
|
||||
On Debian/Unbuntu, it can be achieved by executing the following:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo apt install postgresql postgresql-client
|
||||
|
||||
By default, the only user is `postgres` but Odoo forbids connecting as `postgres`, so you need to
|
||||
create a new PostgreSQL user:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo -u postgres createuser -s $USER
|
||||
$ createdb $USER
|
||||
|
||||
.. note:: Because your PostgreSQL user has the same name as your Unix login, you will be able to
|
||||
connect to the database without password.
|
||||
|
||||
Dependencies
|
||||
^^^^^^^^^^^^
|
||||
|
||||
For libraries using native code, it is necessary to install development tools and native
|
||||
dependencies before the Python dependencies of Odoo. They are available in `-dev` or `-devel`
|
||||
packages for Python, PostgreSQL, libxml2, libxslt1, libevent, libsasl2 and libldap2.
|
||||
|
||||
On Debian/Unbuntu, the following command should install all the required libraries:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo apt install python3-dev libxml2-dev libxslt1-dev libldap2-dev libsasl2-dev \
|
||||
libtiff5-dev libjpeg8-dev libopenjp2-7-dev zlib1g-dev libfreetype6-dev \
|
||||
liblcms2-dev libwebp-dev libharfbuzz-dev libfribidi-dev libxcb1-dev libpq-dev
|
||||
|
||||
Odoo dependencies are listed in the `requirements.txt` file located at the root of the Odoo
|
||||
community directory.
|
||||
|
||||
.. tip:: It can be preferable to not mix python modules packages between different instances of Odoo
|
||||
or with your system. You can use virtualenv_ to create isolated Python environments.
|
||||
|
||||
Navigate to the path of your Odoo Community installation (`CommunityPath`) and run **pip**
|
||||
on the requirements file:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ cd /CommunityPath
|
||||
$ pip3 install setuptools wheel
|
||||
$ pip3 install -r requirements.txt
|
||||
|
||||
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
|
||||
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
|
||||
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
|
||||
details on the various versions.
|
||||
|
||||
For languages with right-to-left interface (such as Arabic or Hebrew), the package `rtlcss` is
|
||||
needed:
|
||||
|
||||
#. Download and install **nodejs** and **npm** with your package manager.
|
||||
#. Install `rtlcss`:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo npm install -g rtlcss
|
||||
|
||||
Running Odoo
|
||||
''''''''''''
|
||||
|
||||
Once all dependencies are set up, Odoo can be launched by running `odoo-bin`, the
|
||||
command-line interface of the server. It is located at the root of the Odoo Community directory.
|
||||
|
||||
To configure the server, you can either specify :ref:`command-line arguments <reference/cmdline/server>` or a
|
||||
:ref:`configuration file <reference/cmdline/config>`.
|
||||
|
||||
.. tip:: For the Enterprise edition, you must add the path to the `enterprise` addons to the
|
||||
`addons-path` argument. Note that it must come before the other paths in `addons-path` for
|
||||
addons to be loaded correctly.
|
||||
|
||||
Common necessary configurations are:
|
||||
|
||||
* PostgreSQL user and password. Odoo has no defaults beyond
|
||||
`psycopg2's defaults <http://initd.org/psycopg/docs/module.html>`_: connects over a UNIX socket on
|
||||
port `5432` with the current user and no password.
|
||||
* Custom addon paths beyond the defaults, to load your own modules.
|
||||
|
||||
A typical way to run the server would be:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ cd /CommunityPath
|
||||
$ python3 odoo-bin --addons-path=addons -d mydb
|
||||
|
||||
Where `CommunityPath` is the path of the Odoo Community installation
|
||||
and `mydb` is the default database to serve on `localhost:8069`. You can add other
|
||||
directory paths separated by a comma to ``addons`` at the end of the addons-path option.
|
||||
|
||||
Mac OS
|
||||
------
|
||||
|
||||
Fetch the sources
|
||||
'''''''''''''''''
|
||||
|
||||
There are two ways to obtain the source code of Odoo: as a zip **archive** or through **git**.
|
||||
|
||||
Archive
|
||||
^^^^^^^
|
||||
|
||||
Community Edition:
|
||||
|
||||
* `Official download page <download_>`_
|
||||
* `GitHub repository <community-repository_>`_
|
||||
* `Nightly server <nightly_>`_
|
||||
|
||||
Enterprise Edition:
|
||||
|
||||
* `Official download page <download_>`_
|
||||
* `GitHub repository <enterprise-repository_>`_
|
||||
|
||||
Git
|
||||
^^^
|
||||
|
||||
The following requires git_ to be installed on your machine and that you have basic knowledge of
|
||||
git commands.
|
||||
|
||||
Community Edition:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ git clone https://github.com/odoo/odoo.git
|
||||
|
||||
|
||||
Enterprise Edition: (see :ref:`setup/install/editions` to get access)
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ git clone https://github.com/odoo/enterprise.git
|
||||
|
||||
.. note:: **The Enterprise git repository does not contain the full Odoo source code**. It is only
|
||||
a collection of extra add-ons. The main server code is in the Community version. Running
|
||||
the Enterprise version actually means running the server from the Community version with
|
||||
the addons-path option set to the folder with the Enterprise version. You need to clone
|
||||
both the Community and Enterprise repository to have a working Odoo Enterprise
|
||||
installation.
|
||||
|
||||
Prepare
|
||||
'''''''
|
||||
|
||||
Python
|
||||
^^^^^^
|
||||
|
||||
Odoo requires Python 3.6 or later to run. Use your preferred package manager (homebrew_, macports_)
|
||||
to download and install Python 3 on your machine if it is not already done.
|
||||
|
||||
.. note:: If Python 3 is already installed, make sure that the version is 3.6 or above, as previous
|
||||
versions are not compatible with Odoo.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ python3 --version
|
||||
|
||||
Verify also that pip_ is installed for this version.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ pip3 --version
|
||||
|
||||
PostgreSQL
|
||||
^^^^^^^^^^
|
||||
|
||||
Odoo uses PostgreSQL as database management system. Use `postgres.app <https://postgresapp.com>`_
|
||||
to download and install PostgreSQL (supported version: 10.0 and later).
|
||||
|
||||
By default, the only user is `postgres` but Odoo forbids connecting as `postgres`, so you need to
|
||||
create a new PostgreSQL user:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo -u postgres createuser -s $USER
|
||||
$ createdb $USER
|
||||
|
||||
.. note:: Because your PostgreSQL user has the same name as your Unix login, you will be able to
|
||||
connect to the database without password.
|
||||
|
||||
Dependencies
|
||||
^^^^^^^^^^^^
|
||||
|
||||
Odoo dependencies are listed in the `requirements.txt` file located at the root of the Odoo
|
||||
community directory.
|
||||
|
||||
.. tip:: It can be preferable to not mix python modules packages between different instances of Odoo
|
||||
or with your system. You can use virtualenv_ to create isolated Python environments.
|
||||
|
||||
Navigate to the path of your Odoo Community installation (`CommunityPath`) and run **pip**
|
||||
on the requirements file:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ cd /CommunityPath
|
||||
$ pip3 install setuptools wheel
|
||||
$ pip3 install -r requirements.txt
|
||||
|
||||
.. warning:: Non-Python dependencies need to be installed with a package manager:
|
||||
|
||||
#. Download and install the **Command Line Tools**:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ xcode-select --install
|
||||
|
||||
#. Download and install the package manager of your choice (homebrew_, macports_).
|
||||
#. Install non-python dependencies.
|
||||
|
||||
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
|
||||
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
|
||||
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
|
||||
details on the various versions.
|
||||
|
||||
For languages with right-to-left interface (such as Arabic or Hebrew), the package `rtlcss` is
|
||||
needed:
|
||||
|
||||
#. Download and install **nodejs** with your preferred package manager (homebrew_, macports_).
|
||||
#. Install `rtlcss`:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo npm install -g rtlcss
|
||||
|
||||
Running Odoo
|
||||
''''''''''''
|
||||
|
||||
Once all dependencies are set up, Odoo can be launched by running `odoo-bin`, the
|
||||
command-line interface of the server. It is located at the root of the Odoo Community directory.
|
||||
|
||||
To configure the server, you can either specify :ref:`command-line arguments <reference/cmdline/server>` or a
|
||||
:ref:`configuration file <reference/cmdline/config>`.
|
||||
|
||||
.. tip:: For the Enterprise edition, you must add the path to the `enterprise` addons to the
|
||||
`addons-path` argument. Note that it must come before the other paths in `addons-path` for
|
||||
addons to be loaded correctly.
|
||||
|
||||
Common necessary configurations are:
|
||||
|
||||
* PostgreSQL user and password. Odoo has no defaults beyond
|
||||
`psycopg2's defaults <http://initd.org/psycopg/docs/module.html>`_: connects over a UNIX socket on
|
||||
port `5432` with the current user and no password.
|
||||
* Custom addon paths beyond the defaults, to load your own modules.
|
||||
|
||||
A typical way to run the server would be:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ cd /CommunityPath
|
||||
$ python3 odoo-bin --addons-path=addons -d mydb
|
||||
|
||||
Where `CommunityPath` is the path of the Odoo Community installation
|
||||
and `mydb` is the default database to serve on `localhost:8069`. You can add other
|
||||
directory paths separated by a comma to ``addons`` at the end of the addons-path option.
|
||||
|
||||
|
||||
.. _setup/install/docker:
|
||||
|
||||
Docker
|
||||
======
|
||||
|
||||
The full documentation on how to use Odoo with Docker can be found on the
|
||||
official Odoo `docker image <https://registry.hub.docker.com/_/odoo/>`_ page.
|
||||
|
||||
.. _Debian Buster: https://www.debian.org/releases/buster/
|
||||
.. _demo: https://demo.odoo.com
|
||||
.. _docker: https://www.docker.com
|
||||
.. _download: https://www.odoo.com/page/download
|
||||
.. _Ubuntu 20.04: http://releases.ubuntu.com/20.04/
|
||||
.. _EPEL: https://fedoraproject.org/wiki/EPEL
|
||||
.. _PostgreSQL: http://www.postgresql.org
|
||||
.. _the official installer:
|
||||
.. _install pip:
|
||||
https://pip.pypa.io/en/latest/installing.html#install-pip
|
||||
.. _Quilt: http://en.wikipedia.org/wiki/Quilt_(software)
|
||||
.. _saas: https://www.odoo.com/page/start
|
||||
.. _the wkhtmltopdf download page: https://github.com/wkhtmltopdf/wkhtmltopdf/releases/tag/0.12.5
|
||||
.. _UAC: http://en.wikipedia.org/wiki/User_Account_Control
|
||||
.. _wkhtmltopdf: http://wkhtmltopdf.org
|
||||
.. _pip: https://pip.pypa.io
|
||||
.. _macports: https://www.macports.org
|
||||
.. _homebrew: http://brew.sh
|
||||
.. _wheels: https://wheel.readthedocs.org/en/latest/
|
||||
.. _virtualenv: https://pypi.python.org/pypi/virtualenv
|
||||
.. _virtualenvwrapper: https://virtualenvwrapper.readthedocs.io/en/latest/
|
||||
.. _pywin32: http://sourceforge.net/projects/pywin32/files/pywin32/
|
||||
.. _community-repository: https://github.com/odoo/odoo
|
||||
.. _enterprise-repository: https://github.com/odoo/enterprise
|
||||
.. _git: https://git-scm.com/
|
||||
.. _Editions: https://www.odoo.com/pricing#pricing_table_features
|
||||
.. _nightly: https://nightly.odoo.com/
|
||||
.. _extra: https://nightly.odoo.com/extra/
|
||||
install/install
|
||||
install/deploy
|
||||
install/cdn
|
||||
install/email_gateway
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
|
||||
========================================
|
||||
Deploying with Content Delivery Networks
|
||||
========================================
|
||||
===========================================
|
||||
Setting up a Content Delivery Network (CDN)
|
||||
===========================================
|
||||
|
||||
.. _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,7 +1,6 @@
|
||||
|
||||
==============
|
||||
Deploying Odoo
|
||||
==============
|
||||
====================
|
||||
System configuration
|
||||
====================
|
||||
|
||||
This document describes basic steps to set up Odoo in production or on an
|
||||
internet-facing server. It follows :ref:`installation <setup/install>`, and is
|
||||
@@ -69,7 +68,7 @@ in ``/etc/odoo.conf`` set:
|
||||
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 paramater to prevent listing
|
||||
and to use the ``--no-database-list`` startup parameter to prevent listing
|
||||
your databases, and to block access to the database management screens.
|
||||
See also security_.
|
||||
|
||||
@@ -171,7 +170,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 choosed out of 'disable', 'allow', 'prefer', 'require', 'verify-ca'
|
||||
with value chosen out of 'disable', 'allow', 'prefer', 'require', 'verify-ca'
|
||||
or 'verify-full'
|
||||
|
||||
`PostgreSQL Doc <https://www.postgresql.org/docs/current/static/libpq-ssl.html>`_
|
||||
@@ -238,8 +237,8 @@ Configuration sample
|
||||
* Server with 4 CPU, 8 Thread
|
||||
* 60 concurrent users
|
||||
|
||||
* 60 users / 6 = 10 <- theorical number of worker needed
|
||||
* (4 * 2) + 1 = 9 <- theorical maximal number of worker
|
||||
* 60 users / 6 = 10 <- theoretical number of worker needed
|
||||
* (4 * 2) + 1 = 9 <- theoretical 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
|
||||
|
||||
@@ -386,7 +385,7 @@ notifications.
|
||||
|
||||
The solutions to support livechat/motifications in a WSGI application are:
|
||||
|
||||
* Deploy a threaded version of Odoo (instread of a process-based preforking
|
||||
* Deploy a threaded version of Odoo (instead 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.
|
||||
@@ -1,7 +1,6 @@
|
||||
|
||||
==================
|
||||
Odoo email gateway
|
||||
==================
|
||||
=============
|
||||
Email gateway
|
||||
=============
|
||||
|
||||
The Odoo mail gateway allows you to inject directly all the received emails in Odoo.
|
||||
|
||||
@@ -44,5 +43,5 @@ For Exim
|
||||
- `Exim <https://www.exim.org/docs.html>`_
|
||||
|
||||
.. tip::
|
||||
If you don't have access/manage your email server, use `inbound messages
|
||||
<https://www.odoo.com/documentation/user/14.0/discuss/advanced/email_servers.html#how-to-manage-outbound-messages>`_.
|
||||
If you don't have access/manage your email server, use :ref:`inbound messages
|
||||
<discuss/email_servers/inbound_messages>`.
|
||||
@@ -0,0 +1,782 @@
|
||||
|
||||
.. _setup/install:
|
||||
|
||||
===============
|
||||
Installing Odoo
|
||||
===============
|
||||
|
||||
There are multiple ways to install Odoo, or not install it at all, depending
|
||||
on the intended use case.
|
||||
|
||||
This documents attempts to describe most of the installation options.
|
||||
|
||||
:ref:`setup/install/online`
|
||||
The easiest way to use Odoo in production or to try it.
|
||||
|
||||
:ref:`setup/install/packaged`
|
||||
Suitable for testing Odoo, developing modules and can be used for
|
||||
long-term production use with additional deployment and maintenance work.
|
||||
|
||||
:ref:`setup/install/source`
|
||||
Provides greater flexibility: e.g. allow multiple running Odoo versions on
|
||||
the same system. Good for developing modules, can be used as base for
|
||||
production deployment.
|
||||
|
||||
:ref:`setup/install/docker`
|
||||
If you usually use docker_ for development or deployment, an official
|
||||
docker_ base image is available.
|
||||
|
||||
|
||||
.. _setup/install/editions:
|
||||
|
||||
Editions
|
||||
========
|
||||
|
||||
There are two different Editions_ of Odoo: the Community and Enterprise versions.
|
||||
Using the Enterprise version is possible on our SaaS_ and accessing the code is
|
||||
restricted to Enterprise customers and partners. The Community version is freely
|
||||
available to anyone.
|
||||
|
||||
If you already use the Community version and wish to upgrade to Enterprise, please
|
||||
refer to :ref:`setup/enterprise` (except for :ref:`setup/install/source`).
|
||||
|
||||
|
||||
.. _setup/install/online:
|
||||
|
||||
Online
|
||||
======
|
||||
|
||||
Demo
|
||||
----
|
||||
|
||||
To simply get a quick idea of Odoo, demo_ instances are available. They are
|
||||
shared instances which only live for a few hours, and can be used to browse
|
||||
around and try things out with no commitment.
|
||||
|
||||
Demo_ instances require no local installation, just a web browser.
|
||||
|
||||
SaaS
|
||||
----
|
||||
|
||||
Trivial to start with, fully managed and migrated by Odoo S.A., Odoo's SaaS_
|
||||
provides private instances and starts out free. It can be used to discover and
|
||||
test Odoo and do non-code customizations (i.e. incompatible with custom modules
|
||||
or the Odoo Apps Store) without having to install it locally.
|
||||
|
||||
Can be used for both testing Odoo and long-term production use.
|
||||
|
||||
Like demo_ instances, SaaS_ instances require no local installation, a web
|
||||
browser is sufficient.
|
||||
|
||||
|
||||
.. _setup/install/packaged:
|
||||
|
||||
Packaged installers
|
||||
===================
|
||||
|
||||
Odoo provides packaged installers for Windows, deb-based distributions
|
||||
(Debian, Ubuntu, …) and RPM-based distributions (Fedora, CentOS, RHEL, …) for
|
||||
both the Community and Enterprise versions.
|
||||
|
||||
These packages automatically set up all dependencies (for the Community version),
|
||||
but may be difficult to keep up-to-date.
|
||||
|
||||
Official Community packages with all relevant dependency requirements are
|
||||
available on our nightly_ server. Both Communtiy and Enterprise packages can
|
||||
be downloaded from our download_ page (you must to be logged in as a paying
|
||||
customer or partner to download the Enterprise packages).
|
||||
|
||||
Windows
|
||||
-------
|
||||
|
||||
#. Download the installer from our nightly_ server (Community only) or the Windows installer from
|
||||
the download_ page (any edition).
|
||||
#. Execute the downloaded file.
|
||||
|
||||
.. warning:: | On Windows 8 and later you may see a warning titled "Windows protected your PC".
|
||||
| Click on **More Info** and then on **Run anyway**.
|
||||
|
||||
#. Accept the UAC_ prompt.
|
||||
#. Go through the various installation steps.
|
||||
|
||||
Odoo will automatically be started at the end of the installation.
|
||||
|
||||
Linux
|
||||
-----
|
||||
|
||||
Debian/Ubuntu
|
||||
'''''''''''''
|
||||
|
||||
Odoo 13.0 'deb' package currently supports `Debian Buster`_, `Ubuntu 18.04`_ or above.
|
||||
|
||||
Prepare
|
||||
^^^^^^^
|
||||
|
||||
Odoo needs a `PostgreSQL`_ server to run properly. The default configuration for
|
||||
the Odoo 'deb' package is to use the PostgreSQL server on the same host as your
|
||||
Odoo instance. Execute the following command in order to install the PostgreSQL server:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo apt install postgresql -y
|
||||
|
||||
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
|
||||
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
|
||||
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
|
||||
details on the various versions.
|
||||
|
||||
Repository
|
||||
^^^^^^^^^^
|
||||
|
||||
Odoo S.A. provides a repository that can be used with Debian and Ubuntu distributions. It can be
|
||||
used to install *Odoo Community Edition* by executing the following commands **as root**:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# wget -O - https://nightly.odoo.com/odoo.key | apt-key add -
|
||||
# echo "deb http://nightly.odoo.com/13.0/nightly/deb/ ./" >> /etc/apt/sources.list.d/odoo.list
|
||||
# apt-get update && apt-get install odoo
|
||||
|
||||
You can then use the usual `apt-get upgrade` command to keep your installation up-to-date.
|
||||
|
||||
At this moment, there is no nightly repository for the Enterprise Edition.
|
||||
|
||||
Deb Package
|
||||
^^^^^^^^^^^
|
||||
|
||||
Instead of using the repository as described above, the 'deb' packages for both the *Community* and
|
||||
*Enterprise* editions can be downloaded from the `official download page <download_>`_.
|
||||
|
||||
Next, execute the following commands **as root**:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# dpkg -i <path_to_installation_package> # this probably fails with missing dependencies
|
||||
# apt-get install -f # should install the missing dependencies
|
||||
# dpkg -i <path_to_installation_package>
|
||||
|
||||
This will install Odoo as a service, create the necessary PostgreSQL_ user
|
||||
and automatically start the server.
|
||||
|
||||
.. warning:: The `python3-xlwt` Debian package does not exists in Debian Buster nor Ubuntu 18.04.
|
||||
This python module is needed to export into xls format.
|
||||
|
||||
If you need the feature, you can install it manually with:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo pip3 install xlwt
|
||||
|
||||
.. warning:: The `num2words` python package does not exists in Debian Buster nor Ubuntu 18.04.
|
||||
Textual amounts will not be rendered by Odoo and this could cause problems with the
|
||||
`l10n_mx_edi` module.
|
||||
|
||||
If you need this feature, you can install manually with:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo pip3 install num2words
|
||||
|
||||
Fedora
|
||||
''''''
|
||||
|
||||
Odoo 13.0 'rpm' package supports Fedora 30.
|
||||
|
||||
Prepare
|
||||
^^^^^^^
|
||||
Odoo needs a `PostgreSQL`_ server to run properly. Make sure that the `sudo` command is available
|
||||
and well configured and, only then, execute the following command in order to install the PostgreSQL
|
||||
server:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo dnf install -y postgresql-server
|
||||
$ sudo postgresql-setup --initdb --unit postgresql
|
||||
$ sudo systemctl enable postgresql
|
||||
$ sudo systemctl start postgresql
|
||||
|
||||
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
|
||||
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
|
||||
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
|
||||
details on the various versions.
|
||||
|
||||
Repository
|
||||
^^^^^^^^^^
|
||||
|
||||
Odoo S.A. provides a repository that can be used with the Fedora distributions.
|
||||
It can be used to install *Odoo Community Edition* by executing the following
|
||||
commands:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo dnf config-manager --add-repo=https://nightly.odoo.com/13.0/nightly/rpm/odoo.repo
|
||||
$ sudo dnf install -y odoo
|
||||
$ sudo systemctl enable odoo
|
||||
$ sudo systemctl start odoo
|
||||
|
||||
RPM package
|
||||
^^^^^^^^^^^
|
||||
|
||||
Instead of using the repository as described above, the 'rpm' packages for both the *Community* and
|
||||
*Enterprise* editions can be downloaded from the `official download page <download_>`_.
|
||||
|
||||
Once downloaded, the package can be installed using the 'dnf' package manager:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo dnf localinstall odoo_13.0.latest.noarch.rpm
|
||||
$ sudo systemctl enable odoo
|
||||
$ sudo systemctl start odoo
|
||||
|
||||
|
||||
.. _setup/install/source:
|
||||
|
||||
Source Install
|
||||
==============
|
||||
|
||||
The source "installation" is really about not installing Odoo, and running it directly from source
|
||||
instead.
|
||||
|
||||
This can be more convenient for module developers as the Odoo source is more easily accessible
|
||||
than using packaged installation (for information or to build this documentation and have it
|
||||
available offline).
|
||||
|
||||
It also makes starting and stopping Odoo more flexible and explicit than the services set up by the
|
||||
packaged installations, and allows overriding settings using
|
||||
:ref:`command-line parameters <reference/cmdline>` without needing to edit a configuration file.
|
||||
|
||||
Finally it provides greater control over the system's set up, and allows to more easily keep
|
||||
(and run) multiple versions of Odoo side-by-side.
|
||||
|
||||
Windows
|
||||
-------
|
||||
|
||||
Fetch the sources
|
||||
'''''''''''''''''
|
||||
|
||||
There are two ways to obtain the source code of Odoo: as a zip **archive** or through **git**.
|
||||
|
||||
Archive
|
||||
^^^^^^^
|
||||
|
||||
Community Edition:
|
||||
|
||||
* `Official download page <download_>`_
|
||||
* `GitHub repository <community-repository_>`_
|
||||
* `Nightly server <nightly_>`_
|
||||
|
||||
Enterprise Edition:
|
||||
|
||||
* `Official download page <download_>`_
|
||||
* `GitHub repository <enterprise-repository_>`_
|
||||
|
||||
Git
|
||||
^^^
|
||||
|
||||
The following requires git_ to be installed on your machine and that you have basic knowledge of
|
||||
git commands.
|
||||
|
||||
Community Edition:
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> git clone https://github.com/odoo/odoo.git
|
||||
|
||||
|
||||
Enterprise Edition: (see :ref:`setup/install/editions` to get access)
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> git clone https://github.com/odoo/enterprise.git
|
||||
|
||||
.. note:: **The Enterprise git repository does not contain the full Odoo source code**. It is only
|
||||
a collection of extra add-ons. The main server code is in the Community version. Running
|
||||
the Enterprise version actually means running the server from the Community version with
|
||||
the addons-path option set to the folder with the Enterprise version. You need to clone
|
||||
both the Community and Enterprise repository to have a working Odoo Enterprise
|
||||
installation.
|
||||
|
||||
Prepare
|
||||
'''''''
|
||||
|
||||
Python
|
||||
^^^^^^
|
||||
|
||||
Odoo requires Python 3.6 or later to run. Visit `Python's download page <https://www.python.org/downloads/windows/>`_
|
||||
to download and install the latest version of Python 3 on your machine.
|
||||
|
||||
During installation, check **Add Python 3 to PATH**, then click **Customize Installation** and make
|
||||
sure that **pip** is checked.
|
||||
|
||||
.. note:: If Python 3 is already installed, make sure that the version is 3.6 or above, as previous
|
||||
versions are not compatible with Odoo.
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> python --version
|
||||
|
||||
Verify also that pip_ is installed for this version.
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> pip --version
|
||||
|
||||
PostgreSQL
|
||||
^^^^^^^^^^
|
||||
|
||||
Odoo uses PostgreSQL as database management system. `Download and install PostgreSQL <https://www.postgresql.org/download/windows/>`_
|
||||
(supported version: 10.0 and later).
|
||||
|
||||
By default, the only user is `postgres` but Odoo forbids connecting as `postgres`, so you need to
|
||||
create a new PostgreSQL user:
|
||||
|
||||
#. Add PostgreSQL's `bin` directory (by default: `C:\\Program Files\\PostgreSQL\\<version>\\bin`) to
|
||||
your `PATH`.
|
||||
#. Create a postgres user with a password using the pg admin gui:
|
||||
|
||||
1. Open **pgAdmin**.
|
||||
2. Double-click the server to create a connection.
|
||||
3. Select :menuselection:`Object --> Create --> Login/Group Role`.
|
||||
4. Enter the username in the **Role Name** field (e.g. `odoo`).
|
||||
5. Open the **Definition** tab and enter the password (e.g. ``odoo``), then click **Save**.
|
||||
6. Open the **Privileges** tab and switch **Can login?** to `Yes` and **Create database?** to
|
||||
`Yes`.
|
||||
|
||||
Dependencies
|
||||
^^^^^^^^^^^^
|
||||
|
||||
Before installing the dependencies, you must download and install the
|
||||
`Build Tools for Visual Studio <https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2019>`_.
|
||||
When prompted, select **C++ build tools** in the **Workloads** tab and install them.
|
||||
|
||||
Odoo dependencies are listed in the `requirements.txt` file located at the root of the Odoo
|
||||
community directory.
|
||||
|
||||
.. tip:: It can be preferable to not mix python modules packages between different instances of Odoo
|
||||
or with your system. You can use virtualenv_ to create isolated Python environments.
|
||||
|
||||
Navigate to the path of your Odoo Community installation (`CommunityPath`) and run **pip**
|
||||
on the requirements file in a terminal **with Administrator privileges**:
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> cd \CommunityPath
|
||||
C:\> pip install setuptools wheel
|
||||
C:\> pip install -r requirements.txt
|
||||
|
||||
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
|
||||
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
|
||||
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
|
||||
details on the various versions.
|
||||
|
||||
For languages with right-to-left interface (such as Arabic or Hebrew), the package `rtlcss` is
|
||||
needed:
|
||||
|
||||
#. Download and install `nodejs <https://nodejs.org/en/download/>`_.
|
||||
#. Install `rtlcss`:
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> npm install -g rtlcss
|
||||
|
||||
#. Edit the System Environment's variable `PATH` to add the folder where `rtlcss.cmd` is located
|
||||
(typically: `C:\\Users\\<user>\\AppData\\Roaming\\npm\\`).
|
||||
|
||||
Running Odoo
|
||||
''''''''''''
|
||||
|
||||
Once all dependencies are set up, Odoo can be launched by running `odoo-bin`, the
|
||||
command-line interface of the server. It is located at the root of the Odoo Community directory.
|
||||
|
||||
To configure the server, you can either specify :ref:`command-line arguments <reference/cmdline/server>` or a
|
||||
:ref:`configuration file <reference/cmdline/config>`.
|
||||
|
||||
.. tip:: For the Enterprise edition, you must add the path to the `enterprise` addons to the
|
||||
`addons-path` argument. Note that it must come before the other paths in `addons-path` for
|
||||
addons to be loaded correctly.
|
||||
|
||||
Common necessary configurations are:
|
||||
|
||||
* PostgreSQL user and password.
|
||||
* Custom addon paths beyond the defaults, to load your own modules.
|
||||
|
||||
A typical way to run the server would be:
|
||||
|
||||
.. code-block:: doscon
|
||||
|
||||
C:\> cd CommunityPath/
|
||||
C:\> python odoo-bin -r dbuser -w dbpassword --addons-path=addons -d mydb
|
||||
|
||||
Where `CommunityPath` is the path of the Odoo Community installation, `dbuser` is the
|
||||
PostgreSQL login, `dbpassword` is the PostgreSQL password
|
||||
and `mydb` is the default database to serve on `localhost:8069`. You can add other
|
||||
directory paths separated by a comma to ``addons`` at the end of the addons-path option.
|
||||
|
||||
Linux
|
||||
-----
|
||||
|
||||
Fetch the sources
|
||||
'''''''''''''''''
|
||||
|
||||
There are two ways to obtain the source code of Odoo: as a zip **archive** or through **git**.
|
||||
|
||||
Archive
|
||||
^^^^^^^
|
||||
|
||||
Community Edition:
|
||||
|
||||
* `Official download page <download_>`_
|
||||
* `GitHub repository <community-repository_>`_
|
||||
* `Nightly server <nightly_>`_
|
||||
|
||||
Enterprise Edition:
|
||||
|
||||
* `Official download page <download_>`_
|
||||
* `GitHub repository <enterprise-repository_>`_
|
||||
|
||||
Git
|
||||
^^^
|
||||
|
||||
The following requires git_ to be installed on your machine and that you have basic knowledge of
|
||||
git commands.
|
||||
|
||||
Community Edition:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ git clone https://github.com/odoo/odoo.git
|
||||
|
||||
|
||||
Enterprise Edition: (see :ref:`setup/install/editions` to get access)
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ git clone https://github.com/odoo/enterprise.git
|
||||
|
||||
.. note:: **The Enterprise git repository does not contain the full Odoo source code**. It is only
|
||||
a collection of extra add-ons. The main server code is in the Community version. Running
|
||||
the Enterprise version actually means running the server from the Community version with
|
||||
the addons-path option set to the folder with the Enterprise version. You need to clone
|
||||
both the Community and Enterprise repository to have a working Odoo Enterprise
|
||||
installation.
|
||||
|
||||
Prepare
|
||||
'''''''
|
||||
|
||||
Python
|
||||
^^^^^^
|
||||
|
||||
Odoo requires Python 3.6 or later to run. Use your package manager to download and install Python 3
|
||||
on your machine if it is not already done.
|
||||
|
||||
.. note:: If Python 3 is already installed, make sure that the version is 3.6 or above, as previous
|
||||
versions are not compatible with Odoo.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ python3 --version
|
||||
|
||||
Verify also that pip_ is installed for this version.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ pip3 --version
|
||||
|
||||
PostgreSQL
|
||||
^^^^^^^^^^
|
||||
|
||||
Odoo uses PostgreSQL as database management system. Use your package manager to download and install
|
||||
PostgreSQL (supported version: 10.0 and later).
|
||||
|
||||
On Debian/Unbuntu, it can be achieved by executing the following:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo apt install postgresql postgresql-client
|
||||
|
||||
By default, the only user is `postgres` but Odoo forbids connecting as `postgres`, so you need to
|
||||
create a new PostgreSQL user:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo -u postgres createuser -s $USER
|
||||
$ createdb $USER
|
||||
|
||||
.. note:: Because your PostgreSQL user has the same name as your Unix login, you will be able to
|
||||
connect to the database without password.
|
||||
|
||||
Dependencies
|
||||
^^^^^^^^^^^^
|
||||
|
||||
For libraries using native code, it is necessary to install development tools and native
|
||||
dependencies before the Python dependencies of Odoo. They are available in `-dev` or `-devel`
|
||||
packages for Python, PostgreSQL, libxml2, libxslt1, libevent, libsasl2 and libldap2.
|
||||
|
||||
On Debian/Unbuntu, the following command should install all the required libraries:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo apt install python3-dev libxml2-dev libxslt1-dev libldap2-dev libsasl2-dev \
|
||||
libtiff5-dev libjpeg8-dev libopenjp2-7-dev zlib1g-dev libfreetype6-dev \
|
||||
liblcms2-dev libwebp-dev libharfbuzz-dev libfribidi-dev libxcb1-dev libpq-dev
|
||||
|
||||
Odoo dependencies are listed in the `requirements.txt` file located at the root of the Odoo
|
||||
community directory.
|
||||
|
||||
.. tip:: It can be preferable to not mix python modules packages between different instances of Odoo
|
||||
or with your system. You can use virtualenv_ to create isolated Python environments.
|
||||
|
||||
Navigate to the path of your Odoo Community installation (`CommunityPath`) and run **pip**
|
||||
on the requirements file:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ cd /CommunityPath
|
||||
$ pip3 install setuptools wheel
|
||||
$ pip3 install -r requirements.txt
|
||||
|
||||
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
|
||||
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
|
||||
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
|
||||
details on the various versions.
|
||||
|
||||
For languages with right-to-left interface (such as Arabic or Hebrew), the package `rtlcss` is
|
||||
needed:
|
||||
|
||||
#. Download and install **nodejs** and **npm** with your package manager.
|
||||
#. Install `rtlcss`:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo npm install -g rtlcss
|
||||
|
||||
Running Odoo
|
||||
''''''''''''
|
||||
|
||||
Once all dependencies are set up, Odoo can be launched by running `odoo-bin`, the
|
||||
command-line interface of the server. It is located at the root of the Odoo Community directory.
|
||||
|
||||
To configure the server, you can either specify :ref:`command-line arguments <reference/cmdline/server>` or a
|
||||
:ref:`configuration file <reference/cmdline/config>`.
|
||||
|
||||
.. tip:: For the Enterprise edition, you must add the path to the `enterprise` addons to the
|
||||
`addons-path` argument. Note that it must come before the other paths in `addons-path` for
|
||||
addons to be loaded correctly.
|
||||
|
||||
Common necessary configurations are:
|
||||
|
||||
* PostgreSQL user and password. Odoo has no defaults beyond
|
||||
`psycopg2's defaults <http://initd.org/psycopg/docs/module.html>`_: connects over a UNIX socket on
|
||||
port `5432` with the current user and no password.
|
||||
* Custom addon paths beyond the defaults, to load your own modules.
|
||||
|
||||
A typical way to run the server would be:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ cd /CommunityPath
|
||||
$ python3 odoo-bin --addons-path=addons -d mydb
|
||||
|
||||
Where `CommunityPath` is the path of the Odoo Community installation
|
||||
and `mydb` is the default database to serve on `localhost:8069`. You can add other
|
||||
directory paths separated by a comma to ``addons`` at the end of the addons-path option.
|
||||
|
||||
Mac OS
|
||||
------
|
||||
|
||||
Fetch the sources
|
||||
'''''''''''''''''
|
||||
|
||||
There are two ways to obtain the source code of Odoo: as a zip **archive** or through **git**.
|
||||
|
||||
Archive
|
||||
^^^^^^^
|
||||
|
||||
Community Edition:
|
||||
|
||||
* `Official download page <download_>`_
|
||||
* `GitHub repository <community-repository_>`_
|
||||
* `Nightly server <nightly_>`_
|
||||
|
||||
Enterprise Edition:
|
||||
|
||||
* `Official download page <download_>`_
|
||||
* `GitHub repository <enterprise-repository_>`_
|
||||
|
||||
Git
|
||||
^^^
|
||||
|
||||
The following requires git_ to be installed on your machine and that you have basic knowledge of
|
||||
git commands.
|
||||
|
||||
Community Edition:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ git clone https://github.com/odoo/odoo.git
|
||||
|
||||
|
||||
Enterprise Edition: (see :ref:`setup/install/editions` to get access)
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ git clone https://github.com/odoo/enterprise.git
|
||||
|
||||
.. note:: **The Enterprise git repository does not contain the full Odoo source code**. It is only
|
||||
a collection of extra add-ons. The main server code is in the Community version. Running
|
||||
the Enterprise version actually means running the server from the Community version with
|
||||
the addons-path option set to the folder with the Enterprise version. You need to clone
|
||||
both the Community and Enterprise repository to have a working Odoo Enterprise
|
||||
installation.
|
||||
|
||||
Prepare
|
||||
'''''''
|
||||
|
||||
Python
|
||||
^^^^^^
|
||||
|
||||
Odoo requires Python 3.6 or later to run. Use your preferred package manager (homebrew_, macports_)
|
||||
to download and install Python 3 on your machine if it is not already done.
|
||||
|
||||
.. note:: If Python 3 is already installed, make sure that the version is 3.6 or above, as previous
|
||||
versions are not compatible with Odoo.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ python3 --version
|
||||
|
||||
Verify also that pip_ is installed for this version.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ pip3 --version
|
||||
|
||||
PostgreSQL
|
||||
^^^^^^^^^^
|
||||
|
||||
Odoo uses PostgreSQL as database management system. Use `postgres.app <https://postgresapp.com>`_
|
||||
to download and install PostgreSQL (supported version: 10.0 and later).
|
||||
|
||||
By default, the only user is `postgres` but Odoo forbids connecting as `postgres`, so you need to
|
||||
create a new PostgreSQL user:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo -u postgres createuser -s $USER
|
||||
$ createdb $USER
|
||||
|
||||
.. note:: Because your PostgreSQL user has the same name as your Unix login, you will be able to
|
||||
connect to the database without password.
|
||||
|
||||
Dependencies
|
||||
^^^^^^^^^^^^
|
||||
|
||||
Odoo dependencies are listed in the `requirements.txt` file located at the root of the Odoo
|
||||
community directory.
|
||||
|
||||
.. tip:: It can be preferable to not mix python modules packages between different instances of Odoo
|
||||
or with your system. You can use virtualenv_ to create isolated Python environments.
|
||||
|
||||
Navigate to the path of your Odoo Community installation (`CommunityPath`) and run **pip**
|
||||
on the requirements file:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ cd /CommunityPath
|
||||
$ pip3 install setuptools wheel
|
||||
$ pip3 install -r requirements.txt
|
||||
|
||||
.. warning:: Non-Python dependencies need to be installed with a package manager:
|
||||
|
||||
#. Download and install the **Command Line Tools**:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ xcode-select --install
|
||||
|
||||
#. Download and install the package manager of your choice (homebrew_, macports_).
|
||||
#. Install non-python dependencies.
|
||||
|
||||
.. warning:: `wkhtmltopdf` is not installed through **pip** and must be installed manually in
|
||||
version `0.12.5 <the wkhtmltopdf download page_>`_ for it to support headers and
|
||||
footers. See our `wiki <https://github.com/odoo/odoo/wiki/Wkhtmltopdf>`_ for more
|
||||
details on the various versions.
|
||||
|
||||
For languages with right-to-left interface (such as Arabic or Hebrew), the package `rtlcss` is
|
||||
needed:
|
||||
|
||||
#. Download and install **nodejs** with your preferred package manager (homebrew_, macports_).
|
||||
#. Install `rtlcss`:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ sudo npm install -g rtlcss
|
||||
|
||||
Running Odoo
|
||||
''''''''''''
|
||||
|
||||
Once all dependencies are set up, Odoo can be launched by running `odoo-bin`, the
|
||||
command-line interface of the server. It is located at the root of the Odoo Community directory.
|
||||
|
||||
To configure the server, you can either specify :ref:`command-line arguments <reference/cmdline/server>` or a
|
||||
:ref:`configuration file <reference/cmdline/config>`.
|
||||
|
||||
.. tip:: For the Enterprise edition, you must add the path to the `enterprise` addons to the
|
||||
`addons-path` argument. Note that it must come before the other paths in `addons-path` for
|
||||
addons to be loaded correctly.
|
||||
|
||||
Common necessary configurations are:
|
||||
|
||||
* PostgreSQL user and password. Odoo has no defaults beyond
|
||||
`psycopg2's defaults <http://initd.org/psycopg/docs/module.html>`_: connects over a UNIX socket on
|
||||
port `5432` with the current user and no password.
|
||||
* Custom addon paths beyond the defaults, to load your own modules.
|
||||
|
||||
A typical way to run the server would be:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ cd /CommunityPath
|
||||
$ python3 odoo-bin --addons-path=addons -d mydb
|
||||
|
||||
Where `CommunityPath` is the path of the Odoo Community installation
|
||||
and `mydb` is the default database to serve on `localhost:8069`. You can add other
|
||||
directory paths separated by a comma to ``addons`` at the end of the addons-path option.
|
||||
|
||||
|
||||
.. _setup/install/docker:
|
||||
|
||||
Docker
|
||||
======
|
||||
|
||||
The full documentation on how to use Odoo with Docker can be found on the
|
||||
official Odoo `docker image <https://registry.hub.docker.com/_/odoo/>`_ page.
|
||||
|
||||
.. _Debian Buster: https://www.debian.org/releases/buster/
|
||||
.. _demo: https://demo.odoo.com
|
||||
.. _docker: https://www.docker.com
|
||||
.. _download: https://www.odoo.com/page/download
|
||||
.. _Ubuntu 18.04: http://releases.ubuntu.com/18.04/
|
||||
.. _EPEL: https://fedoraproject.org/wiki/EPEL
|
||||
.. _PostgreSQL: http://www.postgresql.org
|
||||
.. _the official installer:
|
||||
.. _install pip:
|
||||
https://pip.pypa.io/en/latest/installing.html#install-pip
|
||||
.. _Quilt: http://en.wikipedia.org/wiki/Quilt_(software)
|
||||
.. _saas: https://www.odoo.com/page/start
|
||||
.. _the wkhtmltopdf download page: https://github.com/wkhtmltopdf/wkhtmltopdf/releases/tag/0.12.5
|
||||
.. _UAC: http://en.wikipedia.org/wiki/User_Account_Control
|
||||
.. _wkhtmltopdf: http://wkhtmltopdf.org
|
||||
.. _pip: https://pip.pypa.io
|
||||
.. _macports: https://www.macports.org
|
||||
.. _homebrew: http://brew.sh
|
||||
.. _wheels: https://wheel.readthedocs.org/en/latest/
|
||||
.. _virtualenv: https://pypi.python.org/pypi/virtualenv
|
||||
.. _virtualenvwrapper: https://virtualenvwrapper.readthedocs.io/en/latest/
|
||||
.. _pywin32: http://sourceforge.net/projects/pywin32/files/pywin32/
|
||||
.. _community-repository: https://github.com/odoo/odoo
|
||||
.. _enterprise-repository: https://github.com/odoo/enterprise
|
||||
.. _git: https://git-scm.com/
|
||||
.. _Editions: https://www.odoo.com/pricing#pricing_table_features
|
||||
.. _nightly: https://nightly.odoo.com/
|
||||
.. _extra: https://nightly.odoo.com/extra/
|
||||
@@ -0,0 +1,14 @@
|
||||
:nosearch:
|
||||
|
||||
========
|
||||
Maintain
|
||||
========
|
||||
|
||||
.. toctree::
|
||||
|
||||
maintain/update
|
||||
maintain/db_upgrade
|
||||
maintain/enterprise
|
||||
maintain/hosting_changes
|
||||
maintain/db_premise
|
||||
maintain/supported_versions
|
||||
@@ -6,9 +6,9 @@
|
||||
|
||||
.. _db-upgrade:
|
||||
|
||||
=======
|
||||
Upgrade
|
||||
=======
|
||||
================
|
||||
Versions upgrade
|
||||
================
|
||||
|
||||
.. _db-upgrade/overview:
|
||||
|
||||
@@ -20,8 +20,7 @@ Overview
|
||||
The upgrade process
|
||||
-------------------
|
||||
|
||||
This documentation is for our *On-Premise* (self-hosted) and *Odoo.sh* customers. If you are hosted
|
||||
Online, please check our :ref:`instruction page for our Online (SaaS) customers <upgrade_button>`.
|
||||
This documentation is for our *On-Premise* (self-hosted) and *Odoo.sh* customers.
|
||||
|
||||
.. _db-upgrade/definition:
|
||||
|
||||
@@ -109,8 +108,7 @@ The upgrade process varies depending on where your database is hosted.
|
||||
Online (SaaS)
|
||||
-------------
|
||||
|
||||
If you are hosted Online, please check our :ref:`instruction page for our Online (SaaS) customers
|
||||
<upgrade_button>`.
|
||||
If you are hosted Online, please check your `database manager <https://www.odoo.com/my/databases>`_.
|
||||
|
||||
.. _db-upgrade/odoo-sh:
|
||||
|
||||
@@ -118,7 +116,7 @@ Odoo.sh
|
||||
-------
|
||||
|
||||
If you are Odoo.sh hosted, check our :doc:`specific instructions to be able to upgrade
|
||||
<odoo_sh/advanced/upgrade_your_database>`.
|
||||
<../odoo_sh/advanced/upgrade_your_database>`.
|
||||
|
||||
.. _db-upgrade/on-premise:
|
||||
|
||||
@@ -351,7 +349,7 @@ for the production request.
|
||||
Upgrade of the custom modules
|
||||
-----------------------------
|
||||
|
||||
As stated in our :doc:`../legal/terms/enterprise`, section :ref:`charges_standard`, this optional
|
||||
As stated in our :doc:`/legal/terms/enterprise`, section :ref:`charges_standard`, this optional
|
||||
service is subject to additional fees.
|
||||
|
||||
If you have a custom code, you can choose to have it upgraded by our services, by one of our
|
||||
@@ -376,7 +374,7 @@ Switching the hosting types (Self-hosted vs Online vs Odoo.sh)
|
||||
An upgrade does not cover a change of `Hosting types <https://www.odoo.com/page/hosting-types>`_.
|
||||
|
||||
Open the following link to get :doc:`more information about how to change your hosting type
|
||||
<db_management/hosting_changes>`.
|
||||
<hosting_changes>`.
|
||||
|
||||
.. note:: |assistance-contact|
|
||||
|
||||
@@ -412,4 +410,4 @@ This is a factor to take into consideration before upgrading. If you are on an o
|
||||
suggest you to prefer the most recent version to benefit from a longer support (before having to
|
||||
upgrade again).
|
||||
|
||||
You can get more information about our :doc:`supported versions <../services/support/supported_versions>`.
|
||||
You can get more information about our :doc:`supported versions <supported_versions>`.
|
||||
@@ -1,9 +1,9 @@
|
||||
|
||||
.. _setup/enterprise:
|
||||
|
||||
============================
|
||||
From Community to Enterprise
|
||||
============================
|
||||
===============================
|
||||
Upgrade Community to Enterprise
|
||||
===============================
|
||||
|
||||
Depending on your current installation, there are multiple ways to upgrade
|
||||
your community version.
|
||||
|
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,9 +1,9 @@
|
||||
|
||||
.. _db_management/hosting_changes:
|
||||
|
||||
===============
|
||||
Hosting Changes
|
||||
===============
|
||||
=======================
|
||||
Change hosting solution
|
||||
=======================
|
||||
|
||||
You may want to move your Odoo database from one hosting solution to another.
|
||||
Depending on the platforms, you have to do it by yourself or contact our support team first.
|
||||
@@ -59,4 +59,3 @@ From Odoo.sh to on-premises
|
||||
1. Grab a :ref:`backup of your Odoo.sh production database <odoo_sh_branches_backups>`.
|
||||
2. Restore it from the database manager on your local server.
|
||||
|
||||
|
||||
|
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 |
|
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 |
|
Before Width: | Height: | Size: 89 KiB After Width: | Height: | Size: 89 KiB |
|
Before Width: | Height: | Size: 17 KiB After Width: | Height: | Size: 17 KiB |
|
Before Width: | Height: | Size: 6.9 KiB After Width: | Height: | Size: 6.9 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 |
@@ -82,4 +82,4 @@ OpenERP 7.0, 6.1, 6.0 and 5.0 is not supported anymore, on any platform.
|
||||
|
||||
TinyERP 4.0, 3.0, 2.0 and 1.0 is not supported anymore, on any platform.
|
||||
|
||||
You should consider `upgrading <https://upgrade.odoo.com/>`_ your database.
|
||||
Even though we don't support older versions, you can always `upgrade from any version <https://upgrade.odoo.com/>`_.
|
||||
@@ -1,9 +1,9 @@
|
||||
|
||||
.. _setup/update:
|
||||
|
||||
=============================
|
||||
Updating an Odoo installation
|
||||
=============================
|
||||
==============
|
||||
Bugfix updates
|
||||
==============
|
||||
|
||||
Introduction
|
||||
============
|
||||
@@ -147,4 +147,4 @@ Docker
|
||||
------
|
||||
|
||||
Please refer to our `Docker image documentation <https://hub.docker.com/_/odoo/>`_ for
|
||||
specific update instructions.
|
||||
specific update instructions.
|
||||
@@ -1,5 +1,7 @@
|
||||
:nosearch:
|
||||
|
||||
=======
|
||||
Odoo sh
|
||||
Odoo.sh
|
||||
=======
|
||||
|
||||
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
: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
|
||||
`CLI documentation <https://www.odoo.com/documentation/14.0/reference/cmdline.html>`_.
|
||||
:doc:`CLI documentation </developer/misc/other/cmdline>`.
|
||||
|
||||
You can find in the logs (*~/logs/odoo.log*) the addons path used by Odoo.sh to run your server.
|
||||
Look for "*odoo: addons paths*":
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
: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
|
||||
`the command line <https://www.odoo.com/documentation/14.0/reference/cmdline.html>`_.
|
||||
:doc:`the command line </developer/misc/other/cmdline>`.
|
||||
|
||||
In the case the changes in the commit prevent the server to restart,
|
||||
or if the modules update fails,
|
||||
@@ -318,15 +318,15 @@ Staging builds duplicate the production build and the production build only inst
|
||||
**Test suite**
|
||||
|
||||
For development branches, you can choose to enable or disable the test suite. It's enabled by default.
|
||||
When the test suite is enabled, you can restrict them by specifying test tags `test tags
|
||||
<https://www.odoo.com/documentation/12.0/reference/testing.html#test-selection>`_.
|
||||
When the test suite is enabled, you can restrict them by specifying test tags :ref:`test tags
|
||||
<developer/reference/testing/selection>`.
|
||||
|
||||
**Odoo Version**
|
||||
|
||||
For development branches only, you can change the version of Odoo, should you want to test upgraded code or develop
|
||||
features while your production database is in the process of being upgraded to a newer version.
|
||||
|
||||
In addition, for each version you have two options regarding the code update.
|
||||
In addition, for each version you have two options regarding the code update.
|
||||
|
||||
* You can choose to benefit from the latest bug, security and performance fixes automatically. The
|
||||
sources of your Odoo server will be updated weekly. This is the 'Latest' option.
|
||||
|
||||
@@ -78,7 +78,8 @@ 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 this is an Odoo 10.0, 11.0 or above 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.
|
||||
|
||||
Push your modules in production
|
||||
-------------------------------
|
||||
@@ -108,8 +109,7 @@ Access the URL :file:`/web/database/manager` of your on-premise database and dow
|
||||
.. Warning::
|
||||
|
||||
If you cannot access the database manager, it may have been disabled by your system administrator.
|
||||
See the `database manager security documentation
|
||||
<https://www.odoo.com/documentation/14.0/setup/deploy.html#database-manager-security>`_.
|
||||
See the :ref:`database manager security documentation <db_manager_security>`.
|
||||
|
||||
You will need the master password of your database server. If you do not have it, contact your system administrator.
|
||||
|
||||
@@ -152,7 +152,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`
|
||||
(:doc:`Developer mode <../../../../applications/general/developer_mode/activate>` must be activated).
|
||||
(:ref:`Developer mode <developer-mode>` 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.
|
||||
|
||||
@@ -88,8 +88,7 @@ From the Odoo.sh editor, in a terminal:
|
||||
|
||||
$ odoo-bin scaffold my_module ~/src/user/
|
||||
|
||||
Or, from your computer, if you have an `installation of Odoo
|
||||
<https://www.odoo.com/documentation/14.0/setup/install.html#source-install>`_:
|
||||
Or, from your computer, if you have an :ref:`installation of Odoo <setup/install/source>`:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
@@ -150,7 +149,7 @@ Manually
|
||||
--------
|
||||
|
||||
If you want to create your module structure manually,
|
||||
you can follow `Build an Odoo module <https://www.odoo.com/documentation/14.0/howtos/backend.html>`_ to understand
|
||||
you can follow :doc:`Build an Odoo module </developer/howtos/backend>` to understand
|
||||
the structure of a module and the content of each file.
|
||||
|
||||
Push the development branch
|
||||
@@ -264,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 :doc:`Developer mode <../../../applications/general/developer_mode/activate>`
|
||||
* Activate the :ref:`developer mode <developer-mode>`
|
||||
* in the apps menu, click the *Update Apps List* button,
|
||||
* in the dialog that appears, click the *Update* button.
|
||||
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
:nosearch:
|
||||
|
||||
=================
|
||||
Overview
|
||||
|
||||
@@ -1,9 +1,18 @@
|
||||
============
|
||||
Applications
|
||||
============
|
||||
:nosearch:
|
||||
:show-content:
|
||||
:hide-page-toc:
|
||||
:show-toc:
|
||||
|
||||
|
||||
=========
|
||||
User Docs
|
||||
=========
|
||||
|
||||
Discover our user guides and configuration tutorials per application.
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
applications/finance
|
||||
applications/sales
|
||||
@@ -12,5 +21,4 @@ Applications
|
||||
applications/marketing
|
||||
applications/services
|
||||
applications/productivity
|
||||
applications/settings
|
||||
applications/general
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
:nosearch:
|
||||
|
||||
=======
|
||||
Finance
|
||||
=======
|
||||
@@ -6,5 +8,6 @@ Finance
|
||||
.. toctree::
|
||||
|
||||
finance/accounting
|
||||
finance/expense/expense
|
||||
finance/sign
|
||||
finance/expenses
|
||||
finance/documents
|
||||
finance/sign
|
||||
@@ -1,16 +1,33 @@
|
||||
:nosearch:
|
||||
:show-content:
|
||||
:hide-page-toc:
|
||||
:show-toc:
|
||||
|
||||
========================
|
||||
Invoicing and Accounting
|
||||
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:
|
||||
|
||||
accounting/overview
|
||||
accounting/getting_started
|
||||
accounting/receivables
|
||||
accounting/payables
|
||||
accounting/bank
|
||||
accounting/taxation
|
||||
accounting/reporting
|
||||
accounting/others
|
||||
accounting/fiscal_localizations
|
||||
accounting/fiscal_localizations
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
:nosearch:
|
||||
|
||||
===========
|
||||
Bank & Cash
|
||||
===========
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
:nosearch:
|
||||
|
||||
==========
|
||||
Bank Feeds
|
||||
==========
|
||||
@@ -8,4 +10,4 @@ Bank Feeds
|
||||
feeds/bank_statements
|
||||
feeds/bank_synchronization
|
||||
feeds/ponto
|
||||
feeds/saltedge
|
||||
feeds/saltedge
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
:nosearch:
|
||||
|
||||
=============
|
||||
Miscellaneous
|
||||
=============
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
:nosearch:
|
||||
|
||||
===================
|
||||
Bank Reconciliation
|
||||
===================
|
||||
|
||||
@@ -101,8 +101,5 @@ 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,3 +1,5 @@
|
||||
:nosearch:
|
||||
|
||||
=====
|
||||
Setup
|
||||
=====
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
:nosearch:
|
||||
|
||||
====================
|
||||
Fiscal Localizations
|
||||
====================
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
:nosearch:
|
||||
|
||||
=============
|
||||
Localizations
|
||||
=============
|
||||
|
||||
@@ -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 :doc:`developer mode
|
||||
<../../../../../applications/general/developer_mode>` can be used:
|
||||
number in the AFIP POS, the next button that is visible under :ref:`developer mode <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 transation is created.
|
||||
folio when the first transaction is created.
|
||||
|
||||
|
||||
|
||||
@@ -377,7 +377,10 @@ 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
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
@@ -468,12 +471,12 @@ credit and debit notes, they are set automatically by Odoo:
|
||||
Invoice PDF Report
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
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:
|
||||
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:
|
||||
|
||||
.. image:: media/Chile22.png
|
||||
:align: center
|
||||
:alt: Barcode and fiscal elements in the invice report.
|
||||
:alt: Barcode and fiscal elements in the invoice report.
|
||||
|
||||
|
||||
Commercial Validation
|
||||
|
||||
@@ -36,8 +36,8 @@ Configuration
|
||||
Install the Colombian localization modules
|
||||
------------------------------------------
|
||||
|
||||
For this, go in Apps and search for Colombia. Then click Install for
|
||||
the first two 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.
|
||||
|
||||
.. image:: media/colombia02.png
|
||||
:align: center
|
||||
@@ -142,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 :doc:`Developer mode <../../../../../applications/general/developer_mode>`: :menuselection:`Accounting -->
|
||||
accessed using the :ref:`developer mode <developer-mode>`: :menuselection:`Accounting -->
|
||||
Settings --> Configuration Setting --> Journals`.
|
||||
|
||||
.. image:: media/colombia09.png
|
||||
|
||||
@@ -51,30 +51,27 @@ 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
|
||||
`here <https://www.odoo.com/my/contract/french-certification/>`_.
|
||||
If you use Odoo Community, you should
|
||||
`upgrade to Odoo Enterprise <https://www.odoo.com/documentation/14.0/setup/enterprise.html>`_
|
||||
or contact your Odoo service provider.
|
||||
If you use Odoo Community, you should :doc:`upgrade to Odoo Enterprise
|
||||
</administration/maintain/enterprise>` or contact your Odoo service provider.
|
||||
|
||||
In case of non-conformity, your company risks a fine of €7,500.
|
||||
|
||||
To get the certification just follow the following steps:
|
||||
|
||||
* Install the anti-fraud module fitting your Odoo environment from the
|
||||
*Apps* menu:
|
||||
* 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: *l10n_fr_pos_cert*: France - VAT Anti-Fraud Certification for Point of Sale (CGI 286 I-3 bis)
|
||||
* in any other case: *l10n_fr_certification*: France - VAT Anti-Fraud Certification (CGI 286 I-3 bis)
|
||||
|
||||
* 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,
|
||||
go to :menuselection:`Settings --> Users & Companies --> Companies`.
|
||||
* 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,
|
||||
go to :menuselection:`Settings --> Users & Companies --> Companies`.
|
||||
Select a country from the list; Do not create a new country.
|
||||
* Download the mandatory certificate of conformity delivered by Odoo SA `here <https://www.odoo.com/my/contract/french-certification/>`__.
|
||||
|
||||
.. note::
|
||||
* To install the module in any system created before
|
||||
December 18th 2017, you should update the modules list.
|
||||
To do so, activate the :doc:`Developer mode <../../../../../applications/general/developer_mode>`.
|
||||
To do so, activate the :ref:`developer mode <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.
|
||||
@@ -156,8 +153,8 @@ Invoicing and Accounting apps.
|
||||
it will be counted in the very next closing.
|
||||
|
||||
.. tip:: For test & audit purposes such closings can be manually generated in the
|
||||
:doc:`Developer mode <../../../../../applications/general/developer_mode>`. Then go to
|
||||
:menuselection:`Settings --> Technical --> Automation --> Scheduled Actions`.
|
||||
:ref:`developer mode <developer-mode>`. Then go to :menuselection:`Settings -->
|
||||
Technical --> Automation --> Scheduled Actions`.
|
||||
|
||||
|
||||
Responsibilities
|
||||
|
||||
@@ -31,7 +31,139 @@ 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.
|
||||
**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.
|
||||
|
||||
.. _germany/gobd:
|
||||
|
||||
|
||||
|
After Width: | Height: | Size: 3.6 KiB |
|
After Width: | Height: | Size: 7.1 KiB |
|
After Width: | Height: | Size: 3.6 KiB |
|
After Width: | Height: | Size: 6.4 KiB |
|
After Width: | Height: | Size: 2.4 KiB |
|
After Width: | Height: | Size: 13 KiB |
|
After Width: | Height: | Size: 11 KiB |
@@ -25,9 +25,10 @@ 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
|
||||
puo’ consultare la relativa :doc:`guida <../../../../productivity/discuss/advanced/email_servers>`.
|
||||
può 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.
|
||||
|
||||
@@ -36,13 +37,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 si che la Fatturazione
|
||||
Elettronica funzioni correttamente, questi cambi devono essere
|
||||
- Partita IVA e Codice Fiscale. Per far sì che la Fatturazione
|
||||
Elettronica funzioni correttamente, questi campi 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.
|
||||
|
||||
|
||||
|
Before Width: | Height: | Size: 27 KiB |
|
Before Width: | Height: | Size: 19 KiB |
|
Before Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 45 KiB |
|
Before Width: | Height: | Size: 198 KiB |
|
Before Width: | Height: | Size: 22 KiB |
|
Before Width: | Height: | Size: 44 KiB |
|
Before Width: | Height: | Size: 75 KiB |
|
Before Width: | Height: | Size: 62 KiB |
|
Before Width: | Height: | Size: 108 KiB |
|
Before Width: | Height: | Size: 42 KiB |
|
Before Width: | Height: | Size: 120 KiB |