Compare commits

...

463 Commits

Author SHA1 Message Date
Demesmaeker 70e1dac884 [REM] sale_amazon: update not necessary anymore
task-2694222
2022-06-03 13:33:37 +02:00
Jonathan Castillo (jcs) 4837aa7eef [ADD] accounting/l10n: new egyptian localization and einvoicing section
task-id 2858349

closes odoo/documentation#2148

X-original-commit: a2cf3da864
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-02 16:54:39 +02:00
Tom Aarab (toaa) 75368f52e8 [IMP] accounting: add note about bank sync not available for trial db
Added a note to specify that bank synchronization is not available on trial databases

closes odoo/documentation#2138

X-original-commit: e4fc5f07ee
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Signed-off-by: Aarab Tom (toaa) <toaa@odoo.com>
2022-06-02 15:51:00 +02:00
Antoine Vandevenne (anv) 646fc412d0 [FIX] homepage: fix the link to the external API page
The page was moved from odoo.rst to external_api.rst with commit
0fc52188.

task-2870501

closes odoo/documentation#2143

X-original-commit: f6cd947d6b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-02 13:12:53 +02:00
Jonathan Castillo (jcs) 235bcf85f2 [IMP] maintain: add note in hosting changes (on-premise to online)
task-id 2869953

closes odoo/documentation#2129

X-original-commit: 4cd0500408
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-06-01 19:32:47 +02:00
Antoine Vandevenne (anv) e8e75d4175 [IMP] payment_acquirers: explain the different additional features
task-2862636

closes odoo/documentation#2121

X-original-commit: c820aa4951
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-01 14:16:04 +02:00
Horacio Tellez 869d8d1961 [IMP] general/payment_acquirers: authorize support refund from odoo
Add 'x' to make evident that Authorize.net supports refunds directly
from odoo.

Task - 2712287
Task (on payment) - 2678757

closes odoo/documentation#2091

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-01 12:13:59 +02:00
Julien Castiaux 0f2b82cb37 [IMP] install/deploy: serve static file/attachment
Odoo is compatible with X-Sendfile (apache) and X-Accel (nginx). They
are web server extension that can be used by the web application (Odoo)
to delegate serving local files to the web server (apache/nginx). We use
those extension to stream attachments. The documentation now explains
what is X-Sendfile/X-Accel and how to configure each web server.

Along those changes, the few sentences about serving static files have
been reworded and now include various configuration examples.

closes odoo/documentation#2083

Task: 2801675
Related: odoo/odoo#88134
Related: odoo/enterprise#26191
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-01 02:53:55 +02:00
Antoine Vandevenne (anv) 121be6a81e [ADD] payment_acquirers: add configuration steps for Flutterwave
task-2759117

closes odoo/documentation#1939

Related: odoo/odoo#85514
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-31 16:02:02 +02:00
william 978e4b3bac [FIX] conf: dynamic LaTeX releasename
closes odoo/documentation#2116

X-original-commit: 6d4f4f7d9b
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-05-30 18:43:53 +02:00
Demesmaeker e9943acebe [IMP] amazon: migrate to SPAPI
Starting July 2022, Amazon WMS API is deprecated and we need to use the Selling Partners API.

This brings changes in the authentication flow that are explained.

task-2466636

closes odoo/documentation#2107

X-original-commit: 2dd3a4ae74
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-30 16:45:56 +02:00
Michelle Vu (mivu) e7aac2eed3 [IMP] payment: update SIX screenshots
closes odoo/documentation#2101

X-original-commit: 6dc30adf15
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-27 13:46:17 +02:00
Michelle Vu (mivu) 8ffc93b3c1 [IMP] helpdesk: update flow and images for reinvoicing time
closes odoo/documentation#2097

X-original-commit: 00ec789d96
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-27 11:46:02 +02:00
Raphael Collet 3da237343f [IMP] developer: new API for flush() and invalidate()
closes odoo/documentation#1909

Signed-off-by: Raphael Collet <rco@odoo.com>
2022-05-25 21:34:53 +02:00
Michelle Vu (mivu) a0a4a2da98 [FW][IMP] calendar: update Google Calendar sync screenshots
Task ID: 2685658

closes odoo/documentation#2090

Forward-port-of: odoo/documentation#1982
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-25 12:46:11 +02:00
Valentin Chevalier f93aeec22f [IMP] payment_acquirers/stripe: support refund
Add a check to indicate that Stripe supports refunds.

closes odoo/documentation#2086

Related: odoo/odoo#92235
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-25 12:46:05 +02:00
Donatienne Pirlot 3d145e7759 [IMP] accounting: update the follow-up information
Task ID: 2735445

closes odoo/documentation#2081

X-original-commit: ffc23483ca
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Pirlot Donatienne (dopi) <dopi@odoo.com>
2022-05-24 17:08:56 +02:00
Michelle Vu (mivu) 7aae398cf7 [ADD] discuss: configure Twilio ICE servers
closes odoo/documentation#2074

X-original-commit: 47d1146c10
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-23 10:58:44 +02:00
Donatienne Pirlot 404b954a0e [IMP] accounting : update the list of fiscal localization packages
task id: 2858536

closes odoo/documentation#2053

X-original-commit: 6ca1fd83ec
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Signed-off-by: Pirlot Donatienne (dopi) <dopi@odoo.com>
2022-05-20 15:25:28 +02:00
Antoine Vandevenne (anv) 4887907ef7 [MOV] developer/api/odoo: rename odoo.rst into external_api.rst
The previous file name was not very relevant in regard to the content of
the page, and it conflicted with the `sys.path`.

closes odoo/documentation#2068

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-20 14:18:54 +02:00
Antoine Vandevenne (anv) 8722ea902e [MOV] content/*: move resource files into their related page's directory
Since odoo/documentation#903, the guideline for the location of new
resource (images, downloadable files, RST includes...) files is to place
those inside the directory of the RST page that references them.

For example, if `doc1.rst` has a reference to `image.png` and to
`download.zip`, the file structure should look like this:

├── parent_doc/
│     └── doc1/
│     │     └── image.png
│     │     └── download.zip
│     └── doc1.rst
│     └── doc2.rst
├── parent_doc.rst

Before this commit, most of the resource files were still located inside
'media' directories holding all the resource files referenced by RST
pages located at the same level as these directories. In the example
above, a single 'media' directory would hold all the resource files
referenced by both `doc1.rst` and `doc2.rst`. Doing so prevented us from
figuring out easily which resource file was referenced by which RST page
and, thus, lead to unused resource files piling up in the repository. It
also made it more complicated to define codeowners regex rules because a
team could not simply be assigned to `/some_page.*` but needed to be
assigned to both `/some_page\.rst` and to the location of 'media'.

In order to help new content writers figure out the guideline when
taking examples from other RST pages, this commit retroactively applies
the guideline to existing resource files and 'media' directories. The
left-over resource files that are not referenced by any RST page are
removed.

task-2497965

Part-of: odoo/documentation#2068
2022-05-20 14:18:54 +02:00
Martin Trigaux 3901e3b241 [FIX] odoo_theme: correctly consider baseurl
urlBase was only containing the domain name, not the /documentation/

closes odoo/documentation#2062

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-20 12:11:29 +02:00
Martin Trigaux a81e0623b0 [IMP] odoo_theme: introduce fallback URLs for the page switchers
When a user clicks on the link of an alternate page in the version or
language switcher, we now check if the page referenced by the target URL
exists or not. If not, we generate a series of fallback URLs from the
target URL and check whether the targeted resource exists or not, until
we read the root of the documentation. As soon as we find a valid URL,
we redirect the user to it.

This is inspired by the behaviour of docs.python.org's version and
language switchers.

task-2534669

closes odoo/documentation#2052

X-original-commit: 25e863a64c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 23:16:49 +02:00
Beshoy Nabeih d5d232bb50 [FIX] developer/frontend: typo in the user menu registry example
closes odoo/documentation#2039

X-original-commit: 6d30d81a76
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 18:06:18 +02:00
Altela Eleviansyah Pramardhika 5ddc402467 [FW][FIX] developer/howtos: Fixed typo from field to fields
closes odoo/documentation#2037

Forward-port-of: odoo/documentation#2023
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 18:06:15 +02:00
Tori (vpk) 79e3055ff4 [IMP] CRM: updated lead scoring with note about deprecation
Task ID: 2496900

closes odoo/documentation#2031

X-original-commit: fca684e802
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 16:40:26 +02:00
Tori (vpk) 55a8c391c4 [IMP] CRM: updating flow and screenshots of generating leads
closes odoo/documentation#2022

Task: 2540813
X-original-commit: 44129be225
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 12:28:30 +02:00
Jeremy Kersten eb28322572 [ADD] websites: add plausible.io Dashboard documentation
closes odoo/documentation#2007

Related: odoo/odoo#91058
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-18 20:33:37 +02:00
John Kirkwood (kij) ded1e69553 [IMP] developer: clarify options for many2one widget
Only `no_create` is required to hide both the 'Create "xxx"' and the
'Create and Edit...' dropdown menu options.

closes odoo/documentation#2016

X-original-commit: 599a137ffc
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-18 16:05:03 +02:00
Donatienne Pirlot 951e47708d [ADD] accounting: new doc about outstanding account
Task-id 2744131

closes odoo/documentation#2012

X-original-commit: 5de81c9e2d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-18 13:08:28 +02:00
Antoine Vandevenne (anv) 6191b57da3 [FIX] requirements.txt: pin Jinja2 < 3.1
The latest versions of Jinja2 are no longer compatible with the latest
version of Sphinx 3 (3.5.4).

task-2828982

closes odoo/documentation#2001

X-original-commit: 4c7e89d872
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-13 17:11:46 +02:00
Fabrice Henrion 9e902c7a7e [IMP] payment acquirers: a note in Authorize.net
closes odoo/documentation#1990

X-original-commit: df10f17c3e
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-05-12 17:34:41 +02:00
Laurent Desausoi (lade) 6073895598 [IMP] sale_management: remove price_unit from quotation template
Companion of [1].

[1]: https://github.com/odoo/odoo/pull/47186

opw-2824263

closes odoo/documentation#1980

X-original-commit: f6bf1183db
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Desausoi Laurent (lade) <lade@odoo.com>
2022-05-10 16:23:55 +02:00
Antoine Vandevenne (anv) 835d77f3cf [FIX] conf: allow building the documentation with Python 3.6.
Commit 3d358fdb introduced a new import of Odoo source files which
complain about the minimal Python version if the hack added by 57e1e314
is not executed early enough.

closes odoo/documentation#1973

X-original-commit: 557b261e01
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-09 16:04:54 +02:00
wan 889c9cf0f9 [REF] i18n/localization.rst: rework the entire localization tutorial
closes odoo/documentation#1969

X-original-commit: 9db567159d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: William André (wan) <wan@odoo.com>
Co-authored-by: William Andre <wan@odoo.com>
Co-authored-by: Ivan Yelizariev <iel@odoo.com>
2022-05-09 14:03:24 +02:00
wan 28fe18157e [ADD] extension: allow to build graphs using graphviz
X-original-commit: e00b5e35c7
Part-of: odoo/documentation#1969
2022-05-09 14:03:24 +02:00
wan 026d6a76be [ADD] extensions: new autofield directive
This new directive is generating documentation from Odoo fields. This
can be used to build documentation about business classes.
This will help developpers import/export data and build localization
modules for instance.

X-original-commit: 16afaf6fa7
Part-of: odoo/documentation#1969
2022-05-09 14:03:24 +02:00
wan f559ec5939 [ADD] conf: give relative and absolute path to odoo repo
Also add a condition on some directives to ignore them when we have no
relative/absolute path.

X-original-commit: a514c905c0
Part-of: odoo/documentation#1969
2022-05-09 14:03:23 +02:00
Demesmaeker d12773b496 [IMP] amazon: explain how to use a carrier
In case of an unsupported carrier or a self Delivery, Odoo won't block
the user to use the Amazon connector, but explanation were needed for
these cases.

task-2804907

closes odoo/documentation#1967

X-original-commit: 3231d20d92
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-09 14:03:13 +02:00
Tori (vpk) a7a0db9ca3 [IMP] CRM: update multiple sales teams doc
closes odoo/documentation#1964

Task: 2588786
X-original-commit: 98f306eca5
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-09 12:57:44 +02:00
Jeremy Kersten 8b5db69cae [IMP] odoo_theme: allow to add plausible script
export PLAUSIBLE_SCRIPT=https://plausible.io/js/script.js
export PLAUSIBLE_DOMAIN=yourdomain.com

closes odoo/documentation#1955

X-original-commit: 4c526eb02f
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Jérémy Kersten <jke@odoo.com>
2022-05-09 11:25:42 +02:00
Zachary Straub (ZST) 663157179f [ADD] accounting: avatax integration
closes odoo/documentation#1947

X-original-commit: 093aea15ec
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-09 08:25:01 +02:00
Jonathan Castillo (jcs) 35da831350 [IMP] install/maintain: add seealso links in domain names doc
closes odoo/documentation#1938

X-original-commit: d7da800674
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-05-06 15:32:00 +02:00
Altela Eleviansyah Pramardhika ee64b99c07 [FW][FIX] developer/howtos: missing parentheses in print statement
Added parentheses in a print function

closes odoo/documentation#1931

Forward-port-of: odoo/documentation#1923
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-05-06 13:30:21 +02:00
Victor Feyens 9a5c4e5a40 [FIX] developer/orm: fields_view_get is now deprecated
Since odoo/odoo#87522, the method fields_view_get is deprecated and
get_view should be used instead.
A deprecation notice will be included in fields_view_get docstring
to make sure users are aware that they shouldn't use it anymore.

closes odoo/documentation#1908

Related: odoo/odoo#90634
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-05-05 18:47:58 +02:00
Jonathan Castillo (jcs) 74840c9223 [IMP] contributing: modify titles and headings guidelines
The previous guidelines for titles and headings included an exception to
capitalize feature names as they are written in the apps. However, this
exception seems to have confused most writers as it isn't always clear
what should be considered as a feature name or what should be considered
as a noun or noun group. This commit removes this exception to make the
writing and reviewing processes easier while retaining good titles and
improving consistency across the documentation. It also changes the
titles of the Accounting section to provide a better example to other
writers.

task-id 2843109

closes odoo/documentation#1922

X-original-commit: 1997788e81
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-05-05 16:23:17 +02:00
Antoine Dupuis (andu) eee614be25 [FW][IMP] accounting: add a warning about invoices in USD in Mexico
Mexican companies very commonly issue invoices in USD, to be fulfiled
in MXN, at the official exchange rate defined by the Banco de Mexico
on the day of payment.

(Presumably, this is to insure against the volatility of the Mexican
peso.)

Odoo supports this workflow, but only if the payment is registered
directly on the invoice using the 'Register Payment' button.

If the payment is created separately, and then reconciled manually
with the invoice, a whole host of problems occur:
- the payment typically can't be reconciled fully with the invoice,
  (even though that can usually be solved by manually creating
  an exchange move)
- but more problematically, the amounts on the payment CFDI will
  be wrong, and even manually creating an exchange move won't solve
  that.

So, we absolutely need to warn users not to try to do that.

(We've been encountering lots of tickets lately in the tech-support
pipe because of users who tried this and then wonder why it doesn't
work.)

This is currently an issue in 14.0, 15.0 and master.

closes odoo/documentation#1917

Forward-port-of: odoo/documentation#1728
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-05 09:41:28 +02:00
Alexandre de Pape cee726d01d [FIX] sales: fix typo
critarias -> criteria

closes odoo/documentation#1906

X-original-commit: b2f4a9e818
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-03 03:57:17 +02:00
Antoine Vandevenne (anv) 7f2829f6c6 [ADD] .gitattributes: include RST files in language statistic on GitHub
closes odoo/documentation#1899

X-original-commit: 34d604ca89
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-29 11:01:52 +02:00
root f3a541ad73 [ADD] multi_website: add info to configure multiple domains
closes odoo/documentation#1898

X-original-commit: 324936c43e
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-29 11:01:50 +02:00
Loan (lse) ed4a7be19b [IMP] outlook mail_plugin: add solution for cookie issue
closes odoo/documentation#1885

X-original-commit: 3e25d94b0d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-28 14:59:55 +02:00
Adrien Milis f6b60c1010 [FIX] developer/rd-training: fix commands
Changed commands that were still referring to Odoo 14.0 to 15.0

closes odoo/documentation#1880

X-original-commit: b578f575d0
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-27 11:06:17 +02:00
MichaSi 7277af11d1 [FW][FIX] crm: fix typos and menuselection items
closes odoo/documentation#1874

Forward-port-of: odoo/documentation#1183
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-27 09:00:28 +02:00
Antoine Vandevenne (anv) e588d900c9 [FIX] developer/rdtraining: fix typos
closes odoo/documentation#1867

X-original-commit: f8f5ed93e1
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-26 11:01:52 +02:00
Dossogne Bertrand 9e71bb2a7b [FIX] developer: fix duplicate action availability
The duplicate action is not available for list views

closes odoo/documentation#1860

X-original-commit: ce1961ebaf
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-25 10:27:57 +02:00
Dossogne Bertrand 78f66a5298 [FIX] developer: fix duplicate availability
The duplicate action is not available for list views

closes odoo/documentation#1853

X-original-commit: 9cf425d886
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-22 18:09:05 +02:00
Touati Djamel (otd) 84ecfaa4a8 [FIX] inventory_and_mrp: documentation update
After this PR: https://github.com/odoo/odoo/pull/78199

The explanation of the `Security Lead Time for Purchase` field needs to be updated

opw-2766940

closes odoo/documentation#1841

X-original-commit: 9c242400b6
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Djamel Touati (otd) <otd@odoo.com>
2022-04-21 18:45:24 +02:00
Benoit Socias 27e9c1b2f2 [IMP] rdtraining: clarify transition sentence to view inheritance
The "View Inheritance" section is introduced by a sentence that can be
understood as "do this task then we'll be ready to go the next section"
instead of "in the next section we will see how to do this task".
This can confuse the reader into thinking that some knowledge was not
acquired in the previous parts.

This commit makes it clear that the task described in the transition
sentence will be achieved in the next part.

task-2822582

closes odoo/documentation#1831

X-original-commit: 5a39ba7d24
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Benoit Socias (bso) <bso@odoo.com>
2022-04-13 15:50:48 +02:00
Benoit Socias 1ae7cfa506 [IMP] rdtraining: add note about Settings requiring at least one app
At the point when the developer mode is introduced in the training, it is
confusing because the documentation page describes the option inside the
Settings page, but that page only appears if at least one application is
installed. (Otherwise, the Settings app shows the Users instead)

This commit adds a note so that the reader does not start looking for a
screen that cannot be reached at that point.

task-2822582

X-original-commit: 2ebb7fe802
Part-of: odoo/documentation#1831
2022-04-13 15:50:48 +02:00
Altela Eleviansyah Pramardhika dec529af18 [FW][FIX] developer/rdtraining: fix typo
Fixed `name = field.Char(required=True)` to
`name = fields.Char(required=True)`.

closes odoo/documentation#1822

Forward-port-of: odoo/documentation#1816
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-11 12:42:39 +02:00
Antoine Vandevenne (anv) 493d45d687 [IMP] odoo_theme: hide the "Edit on GitHub" button for pages in legal/
closes odoo/documentation#1815

X-original-commit: ff79ca3a6b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-08 15:52:36 +02:00
Christophe Simonis f997758e12 [FIX] supported_versions: correct naming of recent saas~x versions
Since 11.0, the naming scheme changed from `(x.)saas~y` to `saas~x.y`.

closes odoo/documentation#1809

X-original-commit: 30f55dfd72
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-04-06 17:39:51 +02:00
Antoine Vandevenne (anv) b4bbc63478 [ADD] last_build: add an orphan page informing on the last build date
closes odoo/documentation#1803

X-original-commit: 683840be18
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-05 17:17:37 +02:00
nouraellm 4e1cfeb606 [IMP] manufacturing: scrap location warning fw of #950
The destination location in manufacturing order shouldn't be a scrap location.
Otherwise, the user won't be able to complete manufacturing orders.

closes odoo/documentation#1794

X-original-commit: 7c5d18b84c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-05 10:53:55 +02:00
LoredanaLrpz fc268ae277 [IMP] pos: add tip usable decimal separator
task-id 2608735

closes odoo/documentation#1788

X-original-commit: ae76baa20e
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-31 10:37:06 +02:00
Ray Carnes 214fba8896 [IMP] inventory: add note about detailed operations in one_step.rst
User tripped up due to the creation of a second warehouse enabling
Storage Locations and changingthe workflow.

https://www.odoo.com/forum/help-1/inventory-receipt-in-second-warehouse-199962

closes odoo/documentation#1782

X-original-commit: bdf526af2c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-30 16:34:13 +02:00
Antoine Vandevenne (anv) 58be362009 [REF] general: move images in their respective page's folder
Codeowner regexes need images to be in the correct location, otherwise
some image files might not be assigned to a GitHub team when the regex
covering the parent folder is split into multiple codeowner rules.

closes odoo/documentation#1777

X-original-commit: 4e0a9b615f
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-30 14:19:56 +02:00
Donatienne Pirlot ba4f9d6354 [FIX] upgrade: small fixes
task-2684744

closes odoo/documentation#1769

X-original-commit: 6a316ca86e
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-29 12:00:14 +02:00
poma-odoo 4eb09d95f2 [IMP] developer/views: add and remove tags for position=attributes
The tags`add`, `remove` and `separator` are not included in the
documentation.

closes odoo/documentation#1741

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-29 11:59:50 +02:00
Jonathan Castillo (jcs) fa70e54d1a [FIX] redirects: add missing redirection for maintain/online.rst
closes odoo/documentation#1764

X-original-commit: 73a7ec6d6e
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-29 10:56:33 +02:00
Eric Macharia 1aa28868e4 [FIX] install/maintain: typo in deploy.rst
closes odoo/documentation#1759

X-original-commit: 5c5ef6e603
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-29 03:31:24 +02:00
Donatienne Pirlot cb825e247d [IMP] upgrade: update and improve the upgrade processes and information
task ID: 2684744

closes odoo/documentation#1749

X-original-commit: 825e0ede21
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-26 07:12:00 +01:00
Antoine Vandevenne (anv) c8a1814007 [IMP] supported_versions: flag saas-15.2 as supported
closes odoo/documentation#1745

X-original-commit: ba0e93e836
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-25 19:42:44 +01:00
Valentin Chevalier c57decd8b0 [IMP] payment_acquirers/stripe: split authorization and capture
Add documentation about the manual capture for Stripe

task-2781377

closes odoo/documentation#1642

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-23 13:39:50 +01:00
Thibault Francois e6d9a9dac2 [IMP] CLI: adapt cloc doc to new behavior
since https://github.com/odoo/odoo/pull/85854 cloc
also count stylesheet file and frontend file in
imported module

closes odoo/documentation#1734

X-original-commit: d2de65a15a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-22 12:00:48 +01:00
Jonathan Castillo (jcs) 8c1a7ae400 [ADD] accounting/l10n: new localization for luxembourg
task-id 2780977

closes odoo/documentation#1722

X-original-commit: 5a70ee1088
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-21 17:56:55 +01:00
Zachary Straub (ZST) 22e6fcc760 [ADD] general/digest_emails: add new digest emails docs
closes odoo/documentation#1731

X-original-commit: 5d8246c206
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-21 14:01:09 +01:00
Bruno Boi 0c0a7086ac [IMP] hooks: usePosition new API
closes odoo/documentation#1598

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-21 10:15:16 +01:00
0b11001111 cadf860b42 [IMP] developer: extend internationalization guide
In order for javascript translations to become active, the corresponding
addon needs to follow a certain naming scheme or register explicitly.
This commit updates the internationalization guide with a respective
hint.

Fixes odoo/documentation#1676

closes odoo/documentation#1727

X-original-commit: 112b6c1267
Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
2022-03-18 17:05:10 +01:00
Antoine Vandevenne (anv) 17b5636645 [FIX] odoo_theme: fix CSS issues and warnings
closes odoo/documentation#1717

X-original-commit: cb7a41b75b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-18 16:07:38 +01:00
Demesmaeker df991cb75d [IMP] stripe: add information for webhook creation
The events we are listening in the webhooks changed.

task-2766383

closes odoo/documentation#1605

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-18 12:26:33 +01:00
bve-odoo 279dc5a623 [FIX] dev/misc/cmdline: update url werkzeug
URL was pointing to a dead end.
Update from
http://werkzeug.pocoo.org/docs/contrib/fixers/#werkzeug.contrib.fixers.ProxyFix
to
https://werkzeug.palletsprojects.com/en/0.16.x/middleware/proxy_fix/#module-werkzeug.middleware.proxy_fix
new URL as we are using 0.16.1

closes odoo/documentation#1709

X-original-commit: 7ce175ff55
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-17 11:48:40 +01:00
Demesmaeker bad60e1fa8 [IMP] payment_acquirers: add tabs for Stripe
task-2782290

closes odoo/documentation#1702

X-original-commit: 88752379bb
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Morgane Demesmaeker <edm@odoo.com>
2022-03-16 15:09:51 +01:00
Antoine Vandevenne (anv) 7316152764 [IMP] developer/cli: mention the different ways of calling the CLI
All examples on the page suggest calling the CLI with "odoo-bin" while
it is recommended to call it with "odoo" when Odoo was installed from a
distribution package. It also failed to mention the location of
"odoo-bin" relative to the source files.

The chance is also taken to rename the somewhat unclear page title to
something more clear and generic.

closes odoo/documentation#1699

X-original-commit: c018a53686
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-14 11:28:56 +00:00
Antoine Vandevenne (anv) 7b9bb78801 [IMP] developer/api/extract_api: rework page to get rid of switchers
task-2787415

closes odoo/documentation#1692

X-original-commit: 85b7200944
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-11 14:44:47 +00:00
Antoine Vandevenne (anv) 4721c7291f [IMP] developer/api/odoo: rework page to use examples and content tabs
task-2787415

X-original-commit: 1afdec3784
Part-of: odoo/documentation#1692
2022-03-11 14:44:46 +00:00
Antoine Vandevenne (anv) 990ca4f7ca [REM] extensions: remove the 'switcher' extension
The 'sphinx-tabs' extension is better in every aspect:
- Synchronize selected tabs (group tabs feature).
- No need for extra `code-block` directive (code tabs feature).
- Better looking.
- No custom Python, JS, or CSS.

task-2787415

X-original-commit: 269173caac
Part-of: odoo/documentation#1692
2022-03-11 14:44:46 +00:00
Antoine Vandevenne (anv) 31df0a841a [IMP] contributing/documentation: document usage of code tabs
task-2787415

X-original-commit: 1e24b482b6
Part-of: odoo/documentation#1692
2022-03-11 14:44:46 +00:00
Demesmaeker 2a96d2c969 [IMP] payment_adyen: warn against partial capture
task-2784888

closes odoo/documentation#1652

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-11 12:47:35 +00:00
nle-odoo 8036fd51b5 [FIX] developer/mixins: mail.thread method names
In d46e358d3e88aea9f9289c4845c6c87ab9491c55 some mail.thread method
names were changed: it should be changed in documentation too.

closes odoo/documentation#1686

X-original-commit: b24560e224
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-10 14:59:46 +00:00
Jonathan Castillo (jcs) 9ecc73df71 [IMP] install/maintain: add use of :guilabel: in domain_names
+ fix two small typos.

closes odoo/documentation#1681

X-original-commit: 7e51c98636
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-10 14:38:15 +00:00
Elisabeth Dickinson 66d3bf35d0 [IMP] scss: content tabs refining
This commit removes unnecessary negative margins and makes code-blocks
inside content tabs lose their bottom margin and border.

closes odoo/documentation#1673

X-original-commit: ac28acee4a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-08 16:31:09 +00:00
Elisabeth Dickinson f0707ad049 [IMP] scss: make alert full width of parent
Before this commit, the alerts would all have different widths according
to their content, some stretching and getting pushed under the
"on this page" menu. This way all alerts are aligned.

X-original-commit: b76a566522
Part-of: odoo/documentation#1673
2022-03-08 16:31:09 +00:00
Carlos Valverde 9c56734a3a [IMP] documentation: content tabs design
This commit improves current css style added by default to the Odoo
Documentation's content tabs.

This design improvement has been made by following the current theme's
style, especially in terms of palette and borders.

Tabs are responsive and have been optimised in order to have a
cross-browser compatibility.

--
Task-2755240

closes odoo/documentation#1666

X-original-commit: 7250f88b8d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-08 10:16:45 +00:00
Ray Carnes f47c3db3bb [IMP] accounting: improve phrasing OCR
Add link to try the OCR service, cleanup copy.

closes odoo/documentation#1660

X-original-commit: b83df4f6d2
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-03-07 14:33:38 +00:00
Jonathan Castillo (jcs) 3c552336da [IMP] install/maintain: new improved doc about domain names
task-id 2680490

closes odoo/documentation#1651

X-original-commit: cda64e2678
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-03 17:54:35 +00:00
Laurent Stukkens ee52601986 [ADD] developper: add gantt dependency fields
task-2691454

closes odoo/documentation#1529

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-03-03 11:35:42 +00:00
Victor Feyens d4367c4d9a [FIX] developer/http: adapt to recent httppocalypse changes
See https://github.com/odoo/odoo/pull/78857

closes odoo/documentation#1640

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-02-28 15:25:48 +00:00
Jonathan Castillo (jcs) a75c78e9d4 [IMP] accounting: fix a typo in eu_distance_selling.rst
closes odoo/documentation#1638

X-original-commit: 3c0b7783b8
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-02-24 16:45:49 +00:00
Thibault Libioulle 617fc00c52 [IMP] general/payment_acquirers: add Stripe Connect documentation
This commit adds the user documentation about the modification done in
the payment onboarding and the new Stripe Connect capabilities.

task-2685160

closes odoo/documentation#1631

X-original-commit: ff55b18aa2
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-23 17:28:41 +00:00
Stanislas Sobieski 71c45a1525 [FW][REV] odoo_sh: revert commit 6c48f90
closes odoo/documentation#1623

Forward-port-of: odoo/documentation#1618
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-22 17:15:10 +00:00
Obay Abdelgadir cdf5c7eda4 [IMP] install: remove deprecated ssl instruction in deploy.rst
Backport of commit d227ab66b0 on #1448

closes odoo/documentation#1617

X-original-commit: a80f3c3899
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-22 13:44:14 +00:00
Stanislas Sobieski d530c8e566 [IMP] odoo_sh doc update
closes odoo/documentation#1610

X-original-commit: 6c48f90739
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-21 17:55:07 +00:00
Vincent Schippefilt b49da1df09 [ADD] orm/changelog: Add a changelog page for the ORM changes
Introduce changelog of the ORM by version, link to first change documented

closes odoo/documentation#1508

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-21 16:27:59 +00:00
Antoine Vandevenne (anv) 0e89b54be2 [FIX] conf: upper-case 'master' in the version switcher
closes odoo/documentation#1604

X-original-commit: a7f0651773
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-16 12:01:41 +00:00
Demesmaeker be8e8f0579 [ADD] general/payment_acquirers: add doc on Adyen manual capture
Add documentation about the manual capture for Adyen

closes odoo/documentation#1153

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-15 16:38:20 +00:00
Elisabeth Dickinson 1c2ea73923 [IMP] odoo_theme: switch admonitions' display type to inline-block
When placing an image before an admonition block and setting its
alignment to left or right, the admonition block would hide the image.
The reason for this is the use of "float" on the image. In order for
the image to reappear, we change the admonition's `display: block` to
`display: inline-block`.

task-2582954

closes odoo/documentation#1595

X-original-commit: c30f2735b8
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-15 08:50:29 +00:00
Mathieu Duckerts-Antoine 9f179bd49d [IMP] hooks: useAutofocus new API
Recently, the API of useAutofocus has been simplified (see https://github.com/odoo/odoo/commit/4308de6aab93630c2c24a2d1d2ffd2db4e1d4b6b).
Here we adapt its documentation.

closes odoo/documentation#1572

Signed-off-by: Mathieu Duckerts-Antoine <dam@odoo.com>
2022-02-11 16:06:42 +00:00
Antoine Vandevenne (anv) dce73864eb [IMP] conf: show all relevant versions in the version switcher
From now on, the master branch and the latest released SaaS branch are
always shown. SaaS branches are labeled "Odoo Online".

The list of the versions shown in the switcher is hard-coded to force
their ordering.

The class `dropdown-toggle` is always added to the version|language
switcher regardless of whether other versions|languages are available,
as a quick fix to a CSS issue that occurs when the class is missing.

closes odoo/documentation#1583

X-original-commit: 3febaffd75
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-11 15:19:39 +00:00
Jonathan Castillo (jcs) d8e4894f5b [IMP] install/maintain: add info about upgrading Odoo Online databases
closes odoo/documentation#1582

X-original-commit: 337b36320c
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-02-11 13:44:03 +00:00
Antoine Vandevenne (anv) e133c53f52 [IMP] supported_versions: emphasis short-term support of SaaS versions
X-original-commit: 31709ad082
Part-of: odoo/documentation#1582
2022-02-11 13:44:03 +00:00
Antoine Vandevenne (anv) 8d032bae61 [IMP] supported_versions: flag saas-15.1 as supported
X-original-commit: 696ab7de05
Part-of: odoo/documentation#1582
2022-02-11 13:44:03 +00:00
lejeune quentin d827ce586c [ADD] point_of_sale: Connect an Worldline Payment Terminal to your PoS
Documentation to explain how to configure a Worldline Payment terminal.

closes odoo/documentation#1573

X-original-commit: ae7868d8ed
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Co-authored-by: perazzo loredana <lrpz@odoo.com>
Co-authored-by: lejeune quentin <qle@odoo.com>
2022-02-10 16:00:39 +00:00
ren-odoo 53b921d934 [IMP] accounting/l10n: update webinar link in colombia.rst
The current webinar link is for another version, with this commit we're adding the newest webinar link.

closes odoo/documentation#1569

X-original-commit: 45726dded7
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-10 13:32:01 +00:00
Mathieu Duckerts-Antoine 2269ee51e8 [REF] notifications: removal of param messageIsHtml
closes odoo/documentation#1557

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-02-10 13:22:39 +00:00
Mathieu Duckerts-Antoine 484d245556 [IMP] hooks: document useAutofocus
Part-of: odoo/documentation#1557
2022-02-10 13:22:38 +00:00
StanvanHoorn 0754e169dc [FIX] install/maintain: update versions in "Installing Odoo"
closes odoo/documentation#1564

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-09 17:03:37 +00:00
Antoine Vandevenne (anv) 6172c98159 [ADD] developer/reference/frontend: add an icons library page
task-2704984

closes odoo/documentation#1462

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-08 14:26:42 +00:00
Antoine Vandevenne (anv) cf6ca0fbb2 [IMP] contributing/doc, install: add an extension for content tabs
In many places in the docs, we need to document several flows that
differ only by a few details. For example, the steps to install Odoo
from the sources are almost identical for Windows, Linux, and Mac OS.
In other places, we'd want to suggest a command in different
environments or programming languages, etc.

This commit thus adds an extension for content tabs (tabs within the
content) to help reduce content repetition in the documentation. As a
proof of concept, the "Packaged installers" and "Source install"
sections of the "Installing Odoo" page are reworked to present their
content within tabs whenever it helps clarify the instructions.

A new python dependency is added as of this commit: `sphinx-tabs`

task-2713983

closes odoo/documentation#1528

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Lucie Van Nieuwenhuyse (luvn) <luvn@odoo.com>
2022-02-07 16:44:01 +00:00
Jonathan Castillo (jcs) b71cf50f9e [FIX] redirections: duplicate rule + misplaced rules
- removes a duplicate rule:
  applications/finance/sign/overview/signature_validity.rst
  applications/finance/sign.rst
- moves two rules closer to their related redirections
- adds comments to these two rules
- updates redirection to "email_servers" with the new path (line 203)

closes odoo/documentation#1556

X-original-commit: 79a33520a1
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-02-07 16:11:59 +00:00
BVE f2179ad8a0 [ADD] email_communication: new documentation regarding general emailing
Creation of a new submenu under Applications/General for the Email communication.
Moved advanced of dicuss to this new submenu + adding of content regarding
frequently asked question in support.

Redirection has been done on other files pointing to Discuss/Advanced to match
the new folder email_communication.

Modified content in:
- Email servers: split and move configuration part under email_domain
- Email domain: covering information about SPF DKIM and DMARC configurations by JQU
- Email templates: (how to use the functions) by GOR
- Email common: answering frequently asked questions + common issues by ALA

closes odoo/documentation#1550

X-original-commit: ce8a02d46a
Signed-off-by: Vergote Baptiste (bve) <bve@odoo.com>
2022-02-07 12:11:43 +00:00
Jonathan Castillo (jcs) c40fbdbe0d [FW][FIX] accounting: fix module name to install in intrastat
closes odoo/documentation#1544

Forward-port-of: odoo/documentation#1539
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-02-04 18:15:10 +00:00
Antoine Vandevenne (anv) 1e7fe12478 [IMP] contributing/doc: add an entry for the example admonition
closes odoo/documentation#1538

X-original-commit: ddff8f6914
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-04 15:45:50 +00:00
Mathieu Germain 42bef26a5d [REF] mrp: documentation update
- Updated Pictures with latest version, deleted old ones
- Added Quality Control section
- Deleted Kit Routings section
- Adapted Terminology, specifically work orders vs routings

closes odoo/documentation#1535

X-original-commit: 6fb40b61c8
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Arnold Moyaux <arm@odoo.com>
2022-02-04 14:36:52 +00:00
Demesmaeker 8966e001c2 [IMP] integration_testing: add information about JS touring
Adding basic information about `How to make a test tour`.

task-2742841

closes odoo/documentation#1524

X-original-commit: dbd5a1e1bb
Signed-off-by: Morgane Demesmaeker <edm@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 15:55:41 +00:00
Niranjan Abhyankar ce9cc2f48b [FIX] developer/javascript_cheatsheet: fix a typo
closes odoo/documentation#1521

X-original-commit: d9e2ab6feb
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 13:46:10 +00:00
boan-odoo 64fd4bbd0a [IMP] rdtraining: add links from enterprise wiki
Select links and pieces of information from Odoo Enterprise wiki
were copied over at the end Chap. 2 of the functional training.

These would be useful to have during the tutorial instead of at
the end of it.

closes odoo/documentation#1515

X-original-commit: a9bc16bec8
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 13:38:02 +00:00
Antoine Vandevenne (anv) e4c963d7b6 [FIX] orm: remove autoattribute directive for BaseModel._sequence
The attribute was dropped with PR odoo/odoo#82727

closes odoo/documentation#1522

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 13:27:38 +00:00
Xavier (xpl) c0ac2a7e13 [ADD] Sign: section on Field Types
Task #: 2585411

closes odoo/documentation#1513

X-original-commit: 7ca24b13ef
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 07:30:36 +00:00
Antoine Vandevenne (anv) df35d8a093 [IMP] buckaroo: provide steps to set up a webhook
task-2692127

closes odoo/documentation#1481

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: <luvn@odoo.com>
2022-01-31 15:53:44 +00:00
Jonathan Castillo (jcs) 172d2e6e1b [FIX] redirects.txt: wrong path for outlook doc's redirection
These paths in redirects.txt miss the first folder level, starting from
/content/ .

closes odoo/documentation#1499

closes odoo/documentation#1507

X-original-commit: 4ac7ce7678
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-28 13:33:14 +00:00
Jonathan Castillo (jcs) 4e0c62ae03 [MOV] payment acquirers: from /general/ (misc. section) to /finance/
The "Payment Acquirers" category was moved to the /general/ folder
(Miscellaneous section) when the super-categories such as "Finance"
didn't exist yet. Now, it makes more sense to move this category to
"Finance".

task-id 2743227

X-original-commit: cbe6aad9e9
Part-of: odoo/documentation#1507
2022-01-28 13:33:13 +00:00
wan 0222285869 [ADD] extensions: add a custom example admonition
closes odoo/documentation#1506

X-original-commit: 434bb66492
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-28 11:20:03 +00:00
Jennafer 3d74c4584b [FW][FIX] rdtraining: use "deprecate" rather than "depreciate"
Fixed one typo - "depreciated" to "deprecated"

closes odoo/documentation#1496

Forward-port-of: odoo/documentation#1490
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-26 17:53:23 +00:00
“Chiara 41b6e71d1d [REM] Accounting: deprecated report removal
Task-id 2744389

closes odoo/documentation#1494

X-original-commit: b34e098551
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-26 17:49:45 +00:00
Antoine Vandevenne (anv) fd6589cf50 [IMP] paypal: clarify steps to properly configure PayPal
The "Enable IPN" step is also removed because this setting is overruled
by the payment request that Odoo sends to PayPal. Enabling IPN in PayPal
has no effect.

task-2744043

closes odoo/documentation#1489

X-original-commit: b97ca3f44d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-26 15:56:50 +00:00
Olivier Dony aa5e03bf89 [FIX] legal/terms: fixups for ES translation of enterprise
closes odoo/documentation#1486

X-original-commit: 69d1d32540
Signed-off-by: Olivier Dony <odo@odoo.com>
2022-01-26 02:22:48 +00:00
Ludvig Auvens d2b44d2c7d [IMP] Legal: spanish translation of enterprise.rst
Task-id: 2501357
X-original-commit: 89042fbe92
Part-of: odoo/documentation#1486
2022-01-26 02:22:47 +00:00
Valentin Chevalier adf0d83180 [IMP] payment_stripe: add PM supported by Odoo
Add payment methods supported by Odoo

This will inform users of Stripe which payment method we currently
support.

task-2685143

closes odoo/documentation#1483

X-original-commit: 587b2862df
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Valentin Chevalier <vcr@odoo.com>
2022-01-25 15:05:08 +00:00
“Chiara 5db4c36e43 [ADD] Accounting: new page about intrastat
Task-id 2721400

closes odoo/documentation#1478

X-original-commit: aa7a78331d
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-01-21 16:04:50 +00:00
Yajo 2c72491158 [FIX] discuss, cmdline: update for static outgoing mail addresses
This changed for Odoo 15.0 in odoo/odoo#61853 and the docs didn't
reflect that change.

MT-52 @moduon

closes odoo/documentation#1469

X-original-commit: 084fb777f9
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-13 12:09:21 +00:00
Stan 194f215662 [IMP] qweb: mention the two possible syntaxes for t-attf
closes odoo/documentation#1467

X-original-commit: cdb8d51131
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-12 09:56:04 +00:00
Demesmaeker 2e869a32e5 [ADD] general/payment_acquirers: add doc on Ogone Webhook Setup
task-2703230

closes odoo/documentation#1458

X-original-commit: dfdbf18afa
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-03 10:05:50 +00:00
Paolo (pgi) b8f59ad24f [IMP] accounting: add FEC import section to l10n/france
task-id 2573140

closes odoo/documentation#979

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-21 11:08:36 +00:00
luvi 331b7b6285 [ADD] developer: actionswiper doc added
This commit adds the developer documentation for a
component recently added to the web_enterprise module.
It also includes examples and a screenshot used in the
documentation.

closes odoo/documentation#1432

X-original-commit: 7763c22db4
Signed-off-by: Géry Debongnie <ged@odoo.com>
Signed-off-by: Luca Vitali <luvi@odoo.com>
2021-12-21 07:42:52 +00:00
Mark Fischer, Jr 9a5518bd2c [FIX] expenses: grammar and typos in expenses.rst
Backport to 13.0 of PR #1175

closes odoo/documentation#1443

X-original-commit: 7090a54670
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2021-12-17 16:31:36 +00:00
Christophe Monniez aa1c6b3f07 [IMP] install/setup: install dependencies from debian packages
This commit changes the way that Odoo python dependencies should be
installed.

Before this commit, the described way to install Odoo dependencies was
by using the `pip` utility.

Now, we explicitly recommend to use a Debian based system and install
Odoo dependencies from their packaging tool.

The main reasons are:
* Odoo productions instances are, most of the time, run on Debian based
  systems with those package already installed
* That way, a developer cannot mistakenly use a feature from a
  dependency that does not exists on those production environments
* Avoid mixes of python packages on the developer/user 's system

closes odoo/documentation#1364

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2021-12-17 12:28:55 +00:00
Julien Castiaux e410776f24 [FIX] developer/reference/javascript_reference
The "qweb key of the manifest" file was still mentionned even if it has
been replaced by the assets bundles.

See related task: 2352566

closes odoo/documentation#1434

X-original-commit: dc832e1cc8
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-17 11:37:39 +00:00
Jairo Llopis 4dc1223caf [IMP] developer/modules: deprecate 'active' and detail 'auto_install'
1. `active` is just a deprecated field that means exactly the same as
   `auto_install`.
2. `auto_install` can be a list.

See https://github.com/odoo/odoo/blob/6cb3140ea8f62a265b76ae494295f466ca6a00c4/odoo/modules/module.py#L348-L352

Original PR: https://github.com/odoo/documentation/pull/1109

closes odoo/documentation#1431

X-original-commit: 53cb375406
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-16 11:00:04 +00:00
poma-odoo c1e85cb5f0 [FW][FIX] developer/rdtraining: comply with the guidelines for report naming
The suggested folder structure does not comply with guidelines:
https://www.odoo.com/documentation/15.0/developer/misc/other/guidelines.html#file-naming

> Concerning printable reports which contain mainly data preparation and Qweb templates naming is
the following :

    addons/plant_nursery/
    |-- report/
    |   |-- plant_order_reports.xml (report actions, paperformat, ...)
    |   |-- plant_order_templates.xml (xml report templates)

closes odoo/documentation#1426

Forward-port-of: odoo/documentation#1350
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-16 09:43:11 +00:00
Ivan Yelizariev 2c4bfb12c2 [IMP] cmdline: add note about --dev=xml
closes odoo/documentation#1066

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-16 09:33:44 +00:00
Antoine Vandevenne (anv) 915f1805fd [IMP] developer/*: replace occurrences of "access rule" by "record rule"
Both the functional and technical name of the `ir.rule` model is "Record
Rule". This commit makes sure that all occurrences of "Access Rule" are
replaced by the correct name "Record Rule" as it was easily confused
with "Access Rights".

Original PR: https://github.com/odoo/documentation/pull/1118

closes odoo/documentation#1424

X-original-commit: a692dbdc9c
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-16 09:27:29 +00:00
TwioTech e5516517b4 [IMP] PoS: six payment method configuration
closes odoo/documentation#1420

X-original-commit: 87faaaf02c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: LoredanaLrpz <lrpz@odoo.com>
2021-12-15 11:48:57 +00:00
Adrien Minne 83a3eb5648 [FIX] rdtraining: fix wrong suggested folder for views
The training suggests to put the views in the data/ folder instead of the views/ folder

closes odoo/documentation#1418

X-original-commit: 9d45b861c0
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-15 08:53:05 +00:00
FrancoisGe 4335271352 [IMP] web: add tooltip on Dropdown
This commit adds the possibility to add a tooltip on a Dropdown.

closes odoo/documentation#1396

Signed-off-by: FrancoisGe <fge@odoo.com>
2021-12-15 08:12:01 +00:00
Samuel Degueldre 888fbb5c50 [IMP] web: adapt documentation to the removal of dropdown-item-selected
closes odoo/documentation#1404

Signed-off-by: Samuel Degueldre <sad@odoo.com>
2021-12-14 14:25:24 +00:00
Tymoteusz Motylewski dccdca0f41 [IMP] backend/testing: add link to unittest python library
closes odoo/documentation#1416

X-original-commit: a8fe35665b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-14 13:07:05 +00:00
Chris Parker 3ed9b8d435 [FIX] api/odoo: reflect the correct location of menu actions
closes odoo/documentation#1413

X-original-commit: beb92c9f18
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-14 12:08:40 +00:00
luxiaochuang 07f5559efe [FIX] howtos: remove useless <group/> tag from training example
closes odoo/documentation#1399

X-original-commit: cf1504258e
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-14 08:21:53 +00:00
Perman Atayev c858f1e095 [IMP] install/maintain: fix a typo
original commit 5098eaf93f
in PR https://github.com/odoo/documentation/pull/1345/

closes odoo/documentation#1408

X-original-commit: 806a96f8cb
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-12-13 18:11:05 +00:00
Xavier af7d5c277c [IMP] studio: fix a typo
Original commit: e1e644fc9a
in PR: #1330

closes odoo/documentation#1403

X-original-commit: a1db25d3ba
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-12-13 10:14:42 +00:00
Xavier Morel 90546aa2cd [FIX] orm: documentation of the reserved fields
- reset the `currentmodule` so the fields are not attributed to
  `odoo.fields`, also prefix the field names (for a similar reason)
- expand `active` with the documentation of the related methods

closes odoo/documentation#1352

Signed-off-by: Xavier Morel (xmo) <xmo@odoo.com>
2021-12-10 08:12:53 +00:00
Xavier Morel 55c0c63835 [IMP] orm: TransientModel autodocumentation
* remove the documentation for `_auto`, `abstract`, and `_transient`
  as that's redundant with `Model`
* add documentation for transients' dedicated attributes (and main
  method whose docstring explains what actually occurs)

Part-of: odoo/documentation#1352
2021-12-10 08:12:53 +00:00
Xavier Morel 28534dce88 [ADD] conf: intersphinx entry for pillow
Allows us to properly link to pillow's docs from docstrings using the
python domain.

Part-of: odoo/documentation#1352
2021-12-10 08:12:53 +00:00
mdb-odoo e6002983e6 [IMP] inventory: push/pull explanations
forward-port of e946f5fcfd
original commit (never merged) 427b14dcae

closes odoo/documentation#1393

X-original-commit: 71fe1e09ee
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2021-12-09 15:55:50 +00:00
jedgalbraith f99ac93e72 [IMP] sales: grammar fix
closes odoo/documentation#1389

X-original-commit: 4903a9fecc
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2021-12-09 15:33:58 +00:00
jedgalbraith fed107e9a6 [IMP] inventory: word mistake
closes odoo/documentation#1385

X-original-commit: 5d72b5028f
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2021-12-09 15:07:37 +00:00
Antoine Vandevenne (anv) 6b8372ccda [IMP] README: remove request for review instruction
closes odoo/documentation#1379

X-original-commit: 493ebbfa9a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-09 13:40:37 +00:00
Antoine Vandevenne (anv) b47ecb25a9 [REM] CODEOWNERS: rely on runbot's codeowners system
closes odoo/documentation#1374

X-original-commit: edddeb4826
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-09 12:23:54 +00:00
Moens Alexandre 881aecbe59 [IMP] hosting change: from PaaS to SaaS
Requesting a dump from the customers comming from the PaaS is useless
(since support has access to the odoo.sh projects) and counter
productive (since it only makes the migration outage longer while the
customer downloads the file, then uploads it, then we download it,
instead of just the support downloading it)

closes odoo/documentation#1368

X-original-commit: c3c054681c
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-12-08 13:54:03 +00:00
Morgane Demesmaeker 6fb8dd6b09 [IMP] general/payment_acquirers: rename and swap some headings
closes odoo/documentation#1363

X-original-commit: 8bfa68e930
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-08 10:30:08 +00:00
Antoine Vandevenne (anv) 32b506457a [FIX] conf.py: allow matching odoo sources with ~ in the version string 2021-12-03 13:47:07 +01:00
Demesmaeker 44a134850b [ADD] general/payment_acquirers: add doc on Stripe Webhook Setup
and ease the way to get the api keys

task-2574512

closes odoo/documentation#1346

X-original-commit: 92ad3e8658
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Morgane Demesmaeker <edm@odoo.com>
2021-12-03 08:41:44 +00:00
Rémy Baranx (bar) cf5b0d71ca [FIX] conf.py: check odoo_dir is a real Odoo sources dir
In `conf.py`, we try to find a Odoo sources folder among `odoo` and
`../odoo` directories without really checking that they really are
Odoo sources folders, leading to doc generation error if it's not the case.

So, to improve that, this commit checks that the selected Odoo sources folder
contains `odoo-bin`.

While we're at it, the logging is also improved to always display the
matching odoo sources' folder and version.

closes odoo/documentation#1341

X-original-commit: 57e1e31433
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne <anv@odoo.com>
2021-11-29 12:38:03 +00:00
lejeune quentin 7c1dc39d03 [FIX] point_of_sale: Update certificate import
With the new version of chrome 95 we need adapt the documentation

closes odoo/documentation#1320

X-original-commit: 0f1f90e486
Signed-off-by: Quentin Lejeune (qle) <qle@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-11-22 07:58:54 +00:00
Géry Debongnie 4233250b82 [IMP] developer: small rework of assets page (frontend)
This commit applies some remarks by Antoine.

closes odoo/documentation#1328

X-original-commit: 8c1003e363
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-11-19 13:35:18 +00:00
Bruno Boi 2d93b03dd0 [FIX] developer: effect service
closes odoo/documentation#1325

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-11-19 13:32:47 +00:00
luvi 24d0a9f71d [ADD] developer: scroller service added
This commit adds the documentation related to
the scroller service. This service is used for
the webclient to handle clicks on links and there
were no documentation related until now.

closes odoo/documentation#1326

X-original-commit: 1f84bab97d
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-19 12:36:54 +00:00
Zachary Straub (ZST) c48359e77c [IMP] finance: remove fiscal localization countries screenshots
closes odoo/documentation#1323

X-original-commit: 0653e3df58
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-11-17 11:26:23 +00:00
Antoine Dupuis (andu) 1086e0a9cf [IMP] accounting/taxcloud: how to set up default account for new taxes
New taxes generated by the TaxCloud integration are by default created without an income or an expense account specified. By default, the journal items corresponding to these taxes therefore end up in the default income account, which is usually the 'Sales' account, when they should in fact go to the 'Tax Payable' account. Because these taxes are automatically generated on-the-fly, the user is usually not able to manually specify the Tax Payable account before the journal items are posted, leading to incorrect accounting entries which then need to be manually repaired through the use of miscellaneous operations.

To solve this issue, our video on TaxCloud integration (https://www.youtube.com/watch?v=JE-NeRNIWeU&t=616s) tells us to create a User-Defined Default for the account field of the tax.repartition.line model. This sets the default account with which new taxes are created. However, this information is missing from the documentation.

This PR brings the documentation up-to-date by explaining how to create this User-Defined Default that specifies the correct Tax Payable account.

closes odoo/documentation#1322

X-original-commit: 35d773a82a
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-11-17 09:53:08 +00:00
Valentin Chevalier 9989c83fd9 [ADD] product_images: add a tutorial
This will help users to get automatically images for their products.

task-2558054

closes odoo/documentation#1316

X-original-commit: e062a7c816
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-11-15 15:25:40 +00:00
Géry Debongnie eb9cd7558c [IMP] developer: list content of browser object (js)
closes odoo/documentation#1312

X-original-commit: d761910466
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-15 09:39:13 +00:00
Bruno Boi d015bc03fa [IMP] developer: more info for usePosition JS hook
closes odoo/documentation#1309

X-original-commit: 43d838d826
Signed-off-by: Bruno Boi <boi@odoo.com>
2021-11-12 08:56:14 +00:00
Simon Genin (ges) 172c4490ef [ADD] developer: add js http service
closes odoo/documentation#1306

X-original-commit: bbc85e148e
Signed-off-by: Simon Genin (ges@odoo) <ges@odoo.com>
2021-11-09 18:20:14 +00:00
lejeune quentin e6db26a654 [ADD] point_of_sale: self-signed certificate for epos printers
Add documentation to explain how to use a ePos printer in HTTPS

closes odoo/documentation#1308

X-original-commit: f8f93ec288
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2021-11-09 17:14:16 +00:00
Géry Debongnie 81261e3c9d [IMP] developer: document formatters/parsers registries
and add entry for effects registry as well

closes odoo/documentation#1303

X-original-commit: 624131f712
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-08 16:22:51 +00:00
Géry Debongnie 7b4879a06c [IMP] developer: rewrite the page on assets
closes odoo/documentation#1302

X-original-commit: 8c79319011
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-08 16:22:48 +00:00
Géry Debongnie 3dd71a4817 [IMP] developer: add section on router service
closes odoo/documentation#1298

X-original-commit: 11171da6b1
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-05 14:23:57 +00:00
Géry Debongnie a826ed027d [IMP] developer: add missing links in js doc
and slightly improve effect registry page

closes odoo/documentation#1297

X-original-commit: d551193391
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-05 10:29:17 +00:00
Raf Geens 8db85a0caa [FIX] testing: Explain "new" tagging syntax
Syntax was added to explicitly specify a module, class or function with
`--test-tags`: https://github.com/odoo/odoo/commit/b729a11a121e53857063be00308904ed4d8dd2a0

The documentation was not updated to reflect this, leading to confusion
as people tried to reconcile the documentation with the actual behavior,
without necessarily having seen `odoo-bin --help` which is explicit
about it.

closes odoo/documentation#1282

X-original-commit: 77dd769b08
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Raf Geens <raf@odoo.com>
2021-11-05 08:57:39 +00:00
Géry Debongnie d16c2472f5 [IMP] developer: normalize reference in js doc
The preferred format for (frontend) references is now:
"frontend/filename/section", or something close to that.

closes odoo/documentation#1294

X-original-commit: 894165a949
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-04 13:51:11 +00:00
Michael (mcm) 3af790ba8e [IMP] developer: add doc for pager and usePager
closes odoo/documentation#1238

Signed-off-by: Michaël Mattiello <mcm@odoo.com>
2021-11-04 11:35:50 +00:00
Géry Debongnie 992fbc6ece [IMP] developer: rework section on debug mode
closes odoo/documentation#1290

X-original-commit: b48f0cbad8
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-03 20:35:04 +00:00
Géry Debongnie 772e0945a9 [IMP] developer: add sections on pyjs and domains
closes odoo/documentation#1289

X-original-commit: da4dae597e
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-03 19:53:41 +00:00
Géry Debongnie efb327479f [MOV] developer: move section on patching javascript
This commit is a move, but the content was also slightly
updated/reformatted.

closes odoo/documentation#1288

X-original-commit: f206233ebc
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-03 19:32:56 +00:00
Géry Debongnie aec3e2d9d9 [IMP] developer: add Dropdown documentation
joint work with Bruno (boi)

closes odoo/documentation#1287

X-original-commit: 91f97aff54
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-03 16:34:51 +00:00
Jonathan Castillo (jcs) 3e674f3178 [IMP] website: update a wrong link (godaddy)
task-id 2682327

closes odoo/documentation#1286

X-original-commit: edb747bca1
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2021-11-03 16:16:40 +00:00
Christophe Monniez 27fe4b06a5 [FIX] Makefile: call pysassc from python module
pysassc utility is called in the Makefile. On some system (e.g.: the latest
Dockerfile of the runbot) this utility cannot be found in the system's
paths.

As the pysassc utility is a wrapper for the python module, we can simply
call the python module by it's entrypoint.

Also, this commit fixes the requirements as the pysass package was
installed to incidentally install libsass.

closes odoo/documentation#1277

X-original-commit: cbd85f1f47
Signed-off-by: Christophe Monniez (moc) <moc@odoo.com>
2021-11-03 11:13:39 +00:00
Antoine Vandevenne (anv) 5327f9ece9 [FIX] requirements.txt: Let sphinx manage docutils version
As of sphinx 3.5.4, docutils >0.17 is no longer supported. To avoid
forcing the install of an unsupported version of docutils, we let
sphinx install the appropriate version through its dependencies.

closes odoo/documentation#1276

X-original-commit: 116d9b5181
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-11-03 10:45:20 +00:00
Simon Genin (ges) f0b550fa16 [IMP] js: js domain css customization
closes odoo/documentation#1272

X-original-commit: 05a0a49a20
Signed-off-by: Simon Genin (ges@odoo) <ges@odoo.com>
2021-11-03 09:31:04 +00:00
Simon Genin (ges) 85fc0b6063 [ADD] developer: effect service
closes odoo/documentation#1270

X-original-commit: d72c3fdd8b
Signed-off-by: Simon Genin (ges@odoo) <ges@odoo.com>
2021-11-03 09:16:54 +00:00
Géry Debongnie 54203049fa [IMP] developer: improve section on env
- add a link to services
- add a note that the env is quite powerful
- reformat the table with the list-table role, to make it easier to edit

closes odoo/documentation#1268

X-original-commit: 1e6c12be30
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-11-03 08:59:39 +00:00
Géry Debongnie 431839da7d [IMP] developer: reorder and improve notification service
closes odoo/documentation#1267

X-original-commit: 4082906776
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-11-03 08:40:48 +00:00
Géry Debongnie f0f9023062 [IMP] developer: add section on cookie service
and slightly improve notification information

closes odoo/documentation#1264

X-original-commit: b4fce0a13d
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-02 20:36:04 +00:00
Géry Debongnie 075894d56b [IMP] developer: add section on debug mode (js)
closes odoo/documentation#1263

X-original-commit: f564487e56
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-02 20:29:37 +00:00
Géry Debongnie edf4c45c3b [IMP] developer: use js domain for registry page
This commit update the registry documentation to use the js domain
directives instead of trying to format functions with code blocks.

I am not impressed with the way it looks, but in any cases, it is
certainly better to properly structure the documentation.

closes odoo/documentation#1262

X-original-commit: ce96d6c584
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-02 14:45:38 +00:00
Géry Debongnie 0c5ceef042 [FIX] developer: document assets key in manifest, remove old info
This commit adds a pretty important missing piece of information: the
assets key in the manifest. At the same time, we remove two keys that
are no longer in use.

closes odoo/documentation#1261

X-original-commit: a2a389688c
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-11-02 14:27:37 +00:00
Géry Debongnie 9bd739b36f [MOV] developer: move assets doc into frontend
Now that the reference is split into backend/frontend, it makes more
sense to have the assets page into the frontend section.

closes odoo/documentation#1260

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-02 14:00:09 +00:00
Géry Debongnie 2b2611e462 [IMP] developer: rename addons/js => backend/frontend
The terminology did not really make sense for a lot of these sub pages.
This change should have been done long ago, but was probably delayed
because some people in Odoo call the web client the "backend", which is
really misleading.

This commit also renames the title "Reference Guides" to "Reference",
since this section does not contain any guides anyway.

Part-of: odoo/documentation#1260
2021-11-02 14:00:09 +00:00
Martin Trigaux 0bdc750700 [FIX] conf: allow to build on python 3.6
Since odoo/odoo@794677fb6a Odoo requires python 3.7 min.
However, it still runs fine in 3.6 and this is the python version of
the build server.
Fake the version to be able to build the doc on the nightly server.

To be removed once the nightly server is migrated.

closes odoo/documentation#1259

X-original-commit: 4fb6c72d75
Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-11-02 13:45:43 +00:00
frln bbaa1856c5 [IMP] administration/install, *: make 3.7 the minimum version for Python
As of commit https://github.com/odoo/odoo/commit/794677fb Python 3.7 is
the minimum required version for Python when running Odoo 15.0.

This also applies to building the version 15.0 of the documentation.

closes odoo/documentation#1255

X-original-commit: 26042f541a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-11-02 13:33:55 +00:00
Géry Debongnie 7ea917988c [IMP] developer: add section on user menu registry (js)
closes odoo/documentation#1256

X-original-commit: a8172fa67a
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-11-02 11:18:39 +00:00
Géry Debongnie 71a5d15df4 [IMP] developer: add sections on service and systray registry
X-original-commit: a4a0f65c5d
Part-of: odoo/documentation#1256
2021-11-02 11:18:39 +00:00
Michael (mcm) 35e77b69bb [IMP] developer/views: update map doc
This commit updates the documentation of the map view.
There were missing map attributes, typos and wrong descriptions.

closes odoo/documentation#1232

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-10-29 14:48:01 +00:00
Géry Debongnie adf90f60c4 [IMP] developer: add information on bus (js)
and move the section on environment to the framework main documentation
page.

closes odoo/documentation#1237

X-original-commit: 05ab4a7b0a
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-10-29 13:41:36 +00:00
Simon Genin (ges) 334483cf78 [ADD] developer: notification service
closes odoo/documentation#1240

X-original-commit: 363e5446b5
Signed-off-by: Simon Genin (ges@odoo) <ges@odoo.com>
2021-10-29 12:55:56 +00:00
Simon Genin (ges) b5e78103b5 [Add] developer: add section on js title service
closes odoo/documentation#1239

X-original-commit: eca14b6620
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-10-29 12:45:21 +00:00
Simon Genin (ges) 0cb3072c0e [Add] developer: add js user service
closes odoo/documentation#1236

X-original-commit: 1757e01eca
Signed-off-by: Simon Genin (ges@odoo) <ges@odoo.com>
2021-10-29 08:14:38 +00:00
Géry Debongnie 2dfdf8600f [IMP] developer: add section on context in js framework page
closes odoo/documentation#1231

X-original-commit: 9b02ea8474
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-28 10:07:49 +00:00
Géry Debongnie e9a6934319 [ADD] developer: add a reference page on hooks (js)
closes odoo/documentation#1224

X-original-commit: eea6a94411
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-10-26 12:10:47 +00:00
Géry Debongnie 642f68cad1 [ADD] developer: add page on generic components (js)
closes odoo/documentation#1222

X-original-commit: 8bdbb415b5
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-10-26 08:55:12 +00:00
Jonathan Castillo (jcs) 6f550c494e [ADD] maintain: revert and update "db_online"
task-2601835

closes odoo/documentation#1221

X-original-commit: d7f4475901
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-25 14:08:03 +00:00
Géry Debongnie 7e466dd686 [MOV] developer: move assets doc into its own page
closes odoo/documentation#1217

X-original-commit: e19e13606b
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-10-22 13:57:18 +00:00
Géry Debongnie c80f8ee403 [ADD] developer: add new page on registries (js)
closes odoo/documentation#1216

X-original-commit: a5a669a5eb
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-10-22 13:24:00 +00:00
Julien Van Roy 3235a7e612 [FIX] developer/reference: fix missing slash in javascript/qweb, debugging section
closes odoo/documentation#1215

X-original-commit: 7fbf1c3ef2
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-22 13:15:06 +00:00
Géry Debongnie 7fc45f6e68 [ADD] developer: add page on services (js)
closes odoo/documentation#1212

X-original-commit: ddad75982f
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-22 12:59:55 +00:00
Géry Debongnie 32de28100e [ADD] developer: add javascript module page
This commit moves most of the content out of the javascript reference
and into a more visible page.

closes odoo/documentation#1211

X-original-commit: c6f813f4cb
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-22 12:44:44 +00:00
lejeune quentin 34565a1608 [ADD] point_of_sale: configure https in the POS
The default protocol int the POS with "other device"
is on HTTP.

This doc explain how to activate the HTTPS in the POS

closes odoo/documentation#1205

X-original-commit: a160504b8d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-21 11:02:43 +00:00
Olivier Dony a9d7bf46a6 [ADD] legal/license: update licenses for v15 2021-10-20 11:28:04 +02:00
Olivier Dony 9075b02cb7 [FIX] legal/terms: fr: simplify limitation of liability
The english version has a confusing wording, using "strict ngligence"
instead of "strict liability" in this sentence:
  "(...) regardless of the form of action, whether in contract, tort
   (including strict negligence) or any other legal (...)"

In FR/BE this would seeem to refer to the notion of "responsabilité
objective" ou "responsabilité sans faute".

Yet this extra precision seems confusing and does not seem to add to the
already broad clause. It seems simpler to omit it.

The typical english wording for this clause is simply:
"regardless of the form of action, whether in contract, tort or otherwise".
2021-10-20 11:20:54 +02:00
Olivier Dony c580e3db4e [CHG] legal/tos: specify pricelist for global customers 2021-10-20 11:18:04 +02:00
Antoine Vandevenne (anv) f29549b144 [FIX] extract_api: bring back extract_api doc lost with be1653cc
closes odoo/documentation#1199

X-original-commit: 59df6b90ae
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-20 07:38:46 +00:00
Géry Debongnie 5e91babfb0 [ADD] developer: add page on owl component system
closes odoo/documentation#1189

X-original-commit: b4e8e475f0
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-10-15 17:59:54 +00:00
Géry Debongnie 2503b1249a [ADD] developer: add javascript framework overview
closes odoo/documentation#1188

X-original-commit: ff5a50856f
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-15 14:41:50 +00:00
Jonathan Castillo (jcs) f553a6b744 [IMP] upgrade: create new "upgrade" section in "install and maintain"
closes odoo/documentation#1187

X-original-commit: fd006b4a3c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Jonathan <jcs-odoo@users.noreply.github.com>
2021-10-15 11:45:07 +00:00
Jonathan Castillo (jcs) a1707b2eb1 [IMP] maintain: on premise filename change and media movement
X-original-commit: 8ca7d66faa
Part-of: odoo/documentation#1187
2021-10-15 11:45:07 +00:00
Jonathan Castillo (jcs) 533e11c19e [IMP] maintain: update versions upgrade
task-2600310

X-original-commit: 84ceee3fda
Part-of: odoo/documentation#1187
2021-10-15 11:45:07 +00:00
Valentin Chevalier (vcr) efdff9f6e5 [FIX] payment_acquirers/paypal: broken link
Users couldn't click on Paypal and saw the HTTP link instead of only 'Paypal'

closes odoo/documentation#1176

X-original-commit: a4aa310b85
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-12 14:47:56 +00:00
Xavier 678eca0721 [IMP] mail plugins: improve the naming consistency of plugins
The plugins were named "Odoo-Gmail Plugin" / "Gmail Plugin" and "Odoo-Outlook Plugin" /
"Outlook Plugin". I chose the later version for both plugins consistently.
I also added a reference to both the Gmail and Outlook docs in the main Mail Plugins doc.

closes odoo/documentation#1171

X-original-commit: 4331177bb6
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-11 10:11:54 +00:00
Xavier b8ff49a6f1 [IMP] mail plugins: add gmail plugin + update and move outlook plugin
Task ID: 2662764

closes odoo/documentation#1168

X-original-commit: debe8cb393
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-07 20:08:48 +00:00
Demesmaeker 06688f4dc7 [IMP] payment_acquirers: revamp online payment providers' documentation
task-2654702

closes odoo/documentation#1165

X-original-commit: 3a2bbc028b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-05 17:30:49 +00:00
Antoine Vandevenne (anv) fc60cda6e5 [REL] supported_versions: update list of versions and add end of support
closes odoo/documentation#1163

X-original-commit: b28e34b357
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-05 17:22:11 +00:00
Antoine Vandevenne (anv) 32a7b54872 [IMP] contributing: adapt the GitHub workflow to the new doc theme
closes odoo/documentation#1160

X-original-commit: 8043d92b24
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-05 14:23:52 +00:00
Denis Ledoux a67e991124 [FIX] maintain: upgrade command line link
closes odoo/documentation#1150

X-original-commit: 7276929071
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-10-05 14:06:01 +02:00
Tiffany Chang (tic) 9195e02602 [IMP] developer/{howtos,reference}: update training to match v15 changes
- Reference v15 training solutions
- Refer to Command namespace instead of triplets (e.g.
  Command.create(values) instead of (0, 0, values)
- Add notice about OWL transition
- Add reference to @api.ondelete (instead of override unlink())
- Remove references to SavepointCase (now only TransactionCase) from
  unit test topic

- Also add missing reference documentation for ondelete

closes odoo/documentation#1146

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-05 14:06:01 +02:00
Tiffany Chang (tic) c0aba501da [IMP] developer/howtos: proofread adv topics
- Cleaned up the language a tiny bit
- Fixed small errors/typos
- Add some missing info for dashboard topic
- Updated unit test exercise to match what's in the solutions repo

Part-of: odoo/documentation#1146
2021-10-05 14:06:01 +02:00
Tiffany Chang (tic) c1b8e7f7a1 [IMP] developer/howtos: encourage linters more
There have been complaints of newbies not setting up their linters
therefore let's emphasize their use/setup more in the tutorial and hope
for the best.

Part-of: odoo/documentation#1146
2021-10-05 14:06:01 +02:00
Jonathan Castillo (jcs) 7d9e8af153 [IMP] maintain: update test doc link in versions upgrade
closes odoo/documentation#1141

X-original-commit: 0842b682fc
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-05 14:06:01 +02:00
Raf Geens 3ac968915b [FIX] app/accounting: Fix outdated Colombian test server url
The test server url for Carvajal T&S was out of date and has been
updated with the correct one. Carvajal has also split into 2
different companies, with new customers using the new company (CSC)
by default but the older company (CTS) still being available for
existing customers. See task 2508208. So the documentation was
updated to include both of them.

CTS (Carvajal T&S) was being used to refer to Carvajal in general,
so to avoid confusion those mentions have been changed to just
"Carvajal" since it can refer to either CTS or CSC.

closes odoo/documentation#1138

X-original-commit: 396df2abdd
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-05 14:06:01 +02:00
Jonathan Castillo (jcs) 217b8d0542 [FIX] subscriptions: wrong Odoo Tutorials link
task-2636416

closes odoo/documentation#1136

X-original-commit: ebf216cc8e
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-05 14:06:01 +02:00
Antoine Vandevenne (anv) 76b8472e3b [IMP] conf: hide saas branches from the version switcher 2021-10-05 14:06:01 +02:00
Mathieu Duckerts-Antoine 7dbb57f87a [IMP] developer/views: adapt doc after views refactoring
Brings some modification to the documentation on cohort, graph, and
pivot views according to the recent refactoring of the reporting views
in owl.

Related commits:

closes odoo/documentation#1123

Community: odoo/odoo#73311
Enterprise: odoo/enterprise#19469
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-09-07 15:01:02 +00:00
“odoo-dama” 2e0efb46e7 [ADD] ebay: new doc for account deletion notifications
task-2504306

closes odoo/documentation#1121

X-original-commit: bef9941434
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne <anv@odoo.com>
2021-09-06 15:44:57 +00:00
Demesmaeker 697df5e5ae [FIX] sale_amazon: remove the installation request of delivery
Since delivery is now a dependency of `sale_amazon`, the user don't have to
install it anymore. But they are still asked to get a tracking reference, so
this part stay untouched.

task-2635654

closes odoo/documentation#1117

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-09-06 06:49:48 +00:00
Raf Geens 33d4bdaf29 [FIX] accounting/l10n_mx: Updated Mexican modules list
The list of Mexican accounting modules in the documentation was out of
date, with many of them no longer existing. Several new modules have
been added as well.

closes odoo/documentation#1114

X-original-commit: 5b42479993
Signed-off-by: Antoine Vandevenne (anv) <AntoineVDV@users.noreply.github.com>
Signed-off-by: Raf Geens <raf-odoo@users.noreply.github.com>
2021-08-25 13:29:14 +00:00
“odoo-frc” fe1065b044 [IMP] iap_tools: Update doc about iap_charge & authorize
closes odoo/documentation#1101

Signed-off-by: Antoine Vandevenne (anv) <AntoineVDV@users.noreply.github.com>
2021-08-17 11:58:21 +00:00
Victor Feyens 7bbfcd10ec [FIX] Makefile: avoid confusing // in build dir path
When locally building the doc (aka make), CURRENT_LANG is not defined,
which results in HTML_BUILD_DIR = _build/html//, resulting in commands
& logs like the following

mkdir -p _build/html//_static
pysassc extensions/odoo_theme/static/style.scss _build/html//_static/style.css

This has no impact on linux builds, but could be unclear/confusing for some non tech
users (can it have any impact on other OS's/distros ?)

closes odoo/documentation#1096

X-original-commit: d8684e8963
Signed-off-by: Antoine Vandevenne (anv) <AntoineVDV@users.noreply.github.com>
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-08-06 15:16:02 +00:00
Victor Feyens ffd7ef57ab [FIX] core: wrong redirections
Cf #1054

closes odoo/documentation#1088

X-original-commit: 1211d3ae40
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-08-05 08:47:53 +00:00
Xavier-Do efbb1a6fc3 [FIX] makefile: fix overridden css
The previous makefile was compiling css beside the style.scss and
the style.css was copied at the end.

The new makefile compile css directly in the build dir.

Since this file was still present in the source because of the .gitignore,
sphinx was using this old version of style.css, overriding the new compiled
css file at the end.

Removing it from gitignore should helpFix this problem.

This commit also fix some path in makefile.
(not critical but this should fix a potential error in static command)

closes odoo/documentation#1089

X-original-commit: fd56d8c170
Signed-off-by: Antoine Vandevenne (anv) <AntoineVDV@users.noreply.github.com>
Signed-off-by: Xavier Dollé (xdo) <xdo@odoo.com>
2021-08-05 08:49:59 +00:00
Donatienne Pirlot (dopi) f0550c30c6 [REM] developer/upgrade: remove outdated page
task-2613841

closes odoo/documentation#1082

X-original-commit: eee063a8b1
Signed-off-by: Antoine Vandevenne (anv) <AntoineVDV@users.noreply.github.com>
2021-08-03 14:35:58 +00:00
Antoine Vandevenne (anv) 667524fe71 [FIX] Makefile: fix CSS compilation for multi-version/lang builds
Commit 547d90a allowed `BUILD_DIR` to be defined from the CLI but didn't
update usages of `HTML_BUILD_DIR`. When building the documentation for
multiple versions and/or languages, we should rely on `HTML_BUILD_DIR`
to point to the appropriate directory.

closes odoo/documentation#1078

X-original-commit: 9bad0540b0
Signed-off-by: Antoine Vandevenne (anv) <AntoineVDV@users.noreply.github.com>
2021-08-03 12:20:30 +00:00
Antoine Vandevenne (anv) b65e2e7848 [MERGE] Forward-port of branch 14.0 to master 2021-07-30 09:11:13 +02:00
Benjamin Frantzen (bfr) 61b6fe53e1 [ADD] accounting/l10n_it: new doc about EDI SDICoop in italy
closes odoo/documentation#1071

Signed-off-by: Antoine Vandevenne (anv) <AntoineVDV@users.noreply.github.com>
2021-07-29 13:09:51 +00:00
Antoine Vandevenne (anv) 17880034b4 [MERGE] Forward-port of branch 14.0 to master 2021-07-29 15:09:12 +02:00
Antoine Vandevenne (anv) 310eff87de [MERGE] Forward-port of branch 13.0 to 14.0 2021-07-29 15:08:06 +02:00
Antoine Vandevenne (anv) d1da272f21 [MERGE] Forward-port of branch 12.0 to 13.0 2021-07-29 15:06:22 +02:00
Valentino 55255072de [IMP] accounting/l10n: add library needed to print reports in chile.rst
If the user is hosted in Odoo SH or On-Premise, he should manually
install a library. This addition helps explains how to do it.
2021-07-26 13:52:05 +02:00
Odoo Translation Bot 97524ccda0 [I18N] Update translation terms from Transifex 2021-07-25 02:30:24 +02:00
Odoo Translation Bot 2be02aec24 [I18N] Update translation terms from Transifex 2021-07-25 01:30:33 +02:00
Odoo Translation Bot 666e7324bc [I18N] Update translation terms from Transifex 2021-07-25 01:30:31 +02:00
AdrienPr 28359b6bd6 [FIX] dev/howtos/themes: correct wrong code example
Since the update of the themes tutorial, the id of the snippet template was modified
but this part of the tutorial wasn't updated accordingly.

This commit updates the referenced template id to make sure the tutorial works
as expected.

Finetuning of https://github.com/odoo/odoo/commit/08d44d444490713ca39618a67f441bbd84b8b900
2021-07-22 14:43:16 +02:00
Iago Alonso 098b5c5485 [FIX] administration/*/deploy: enforce consistent indentation in nginx config.
The indentation of the provided default nginx config wasn't consistent.
This commit enforces the indentation of two spaces for the nginx config.

Also cleans a bit the .rst useless empty lines.
2021-07-22 14:28:36 +02:00
Antoine Vandevenne (anv) d9620d54e7 [MERGE] Forward-port of branch 14.0 to master 2021-07-20 12:57:18 +02:00
Antoine Vandevenne (anv) 6594686062 [MERGE] Forward-port of branch 13.0 to 14.0 2021-07-20 12:55:24 +02:00
Antoine Vandevenne (anv) 5f29b23c70 [MERGE] Forward-port of branch 12.0 to 13.0 2021-07-20 12:53:44 +02:00
Xavier-Do 9a31ed8f67 [IMP] allow to define BUILD_DIR and better odoo detection
Building documentation implies some constraints: the source folder is
readonly, mainly because the sources are shared accros builds.

This implies that nor a symlink and a _build dir cannot be added in the
source directory.

The symlink will work in most cases localy for user with strange
multiverse structure, but if not found, the fallback will check in
parent directory. Most users and runbot will have all sources in the
same directory (both in universe and basic multiverse cases)
-(version?)
   -odoo
   -enterprise
   -upgrade
   -documentation

The second change will check if BUILD_DIR is defined before setting it,
allowing to use 'make BUILD_DIR=../build' to output the documentation
somewhere else.
2021-07-20 12:48:57 +02:00
Odoo Translation Bot afdd438818 [I18N] Update translation terms from Transifex 2021-07-18 02:30:17 +02:00
Odoo Translation Bot ef2443f2fa [I18N] Update translation terms from Transifex 2021-07-18 01:30:42 +02:00
Odoo Translation Bot ec10063ab9 [I18N] Update translation terms from Transifex 2021-07-18 01:30:26 +02:00
Jonathan Castillo (jcs) 69364e7ddb [IMP] accounting: remove deprecated tip in "reconciliation/use_cases"
task-2605395
2021-07-16 10:14:48 +02:00
Odoo Translation Bot bc257a8f5e [I18N] Update translation terms from Transifex 2021-07-11 02:30:18 +02:00
Odoo Translation Bot 0ccf35c29a [I18N] Update translation terms from Transifex 2021-07-11 01:30:24 +02:00
Odoo Translation Bot 2b076ce94f [I18N] Update translation terms from Transifex 2021-07-11 01:30:22 +02:00
Valentin Chevalier d30cb941c5 [IMP] guidelines: remove a deprecated tag
The 'oldname' tag has been deprecated for a few years
2021-07-09 10:51:13 +02:00
Demesmaeker e528bbcfb5 [IMP] amazon_connector: add a note about the new amazon delivery policy
task-2573260
2021-07-08 11:14:00 +02:00
Victor Feyens 76cfe25774 [MERGE] Forward-port of branch 14.0 to master 2021-07-07 16:45:18 +02:00
Victor Feyens 5ae6578b83 [MERGE] Forward-port of branch 13.0 to 14.0 2021-07-07 16:44:12 +02:00
Victor Feyens 6c2e3e099e [REV] services: keep what can i expect page
This doc page is still frequently used by the support.
This commit partly reverts https://github.com/odoo/documentation/commit/16418c020b138540a6f387e91cc5e0e9c7318cd2
to keep the page as a hidden orphan page.

In the future, the content of this page should be moved
in the support contract and/or an independent odoo.com page
2021-07-07 16:38:09 +02:00
Florian Gilbert 4e070ab14c [DEL] accounting: doc about Paypal 2021-07-07 15:46:47 +02:00
Florian Gilbert 4bd0353e2f [ADD] accounting: new doc about Salt Edge 2021-07-07 15:46:47 +02:00
Florian Gilbert 2c9ce286d7 [IMP] accounting: update doc about Ponto 2021-07-07 15:46:47 +02:00
Florian Gilbert 64784c41ed [IMP] accounting: improve doc about bank synchronization 2021-07-07 15:46:47 +02:00
Antoine Vandevenne (anv) f8f784c0b0 [MERGE] Forward-port of branch 14.0 to master 2021-07-07 15:40:27 +02:00
Antoine Vandevenne (anv) be1653cc51 [MERGE] Forward-port of branch 13.0 to 14.0 2021-07-07 15:39:35 +02:00
Fabien Pinckaers 16418c020b [IMP] *: introduce tables of contents in top-level app pages 2021-07-07 14:56:38 +02:00
Antoine Vandevenne (anv) bf061f6d56 [MERGE] Forward-port of branch 14.0 to master 2021-07-05 16:29:34 +02:00
Antoine Vandevenne (anv) cc8c33c848 [MERGE] Forward-port of branch 13.0 to 14.0 2021-07-05 16:26:30 +02:00
Antoine Vandevenne (anv) b4ef20a970 [MERGE] Forward-port of branch 12.0 to 13.0 2021-07-05 16:24:34 +02:00
Jonathan Castillo 7548209ed1 [IMP] accounting: refresh tax mapping addition to "eu_distance_selling"
- since the merge, the feature name got a different capitalization. This
  is updated in the text
- the image is moved after the paragraph with `align:center` as the
  `align:right` currently has an overflow issue with the following
  admonition.

task-2587075
2021-07-05 16:21:33 +02:00
Jonathan Castillo bfe6f805a8 [ADD] accounting: new doc about EU intra-community distance selling
task-2582383
2021-07-05 16:21:33 +02:00
Odoo Translation Bot ebd932134d [I18N] Update translation terms from Transifex 2021-07-04 02:30:51 +02:00
Odoo Translation Bot f63e7e77d1 [I18N] Update translation terms from Transifex 2021-07-04 01:31:08 +02:00
Odoo Translation Bot b152653337 [I18N] Update translation terms from Transifex 2021-07-04 01:31:05 +02:00
Jonathan Castillo 8467404116 [IMP] accounting: refresh tax mapping addition to "eu_distance_selling"
- since the merge, the feature name got a different capitalization. This
  is updated in the text
- the image is moved after the paragraph with `align:center` as the
  `align:right` currently has an overflow issue with the following
  admonition.

task-2587075
2021-07-01 11:37:01 +02:00
Jonathan Castillo 2fafbc1b15 [FIX] general: add a redirection for previous "base_import" toc page
This toc page seems to have been shared and used. This redirection
now helps users find the content they're looking for.

task-2587076
2021-07-01 10:51:31 +02:00
abd-msyukyu-odoo 197dc14e78 [IMP] developer/views: document new kanban field attribute
This commit relates to a new community feature:
  A read_group on a date(time) field will also return a __range property with
  the date bounds of the group [from, to[

The community commit also introduces a new xml attribute
`allow_group_range_value` for `<kanban>` `<field>`, and this commit is the
documentation for that attribute.

allow_group_range_value (boolean):
  - to perform a drag&drop or a quickCreate, we must be able to get and use the
    value from the group containing the record. The last date of the group will
    be taken as the record's field value.

  - allows (or disallows) date(time) non-readonly fields to be:
    - draggable
    - quick created

  - defaults to false.

Task-ID: 2243913
Community PR odoo/odoo#69380
  Commit: [IMP] core, web: add a range for date(time) read_group
2021-07-01 10:38:12 +02:00
Jonathan Castillo 8752e14dee [ADD] accounting: new doc about EU intra-community distance selling
task-2582383
2021-06-28 14:20:54 +02:00
Odoo Translation Bot a5ab764c04 [I18N] Update translation terms from Transifex 2021-06-27 02:30:52 +02:00
Odoo Translation Bot 1e520cbbfc [I18N] Update translation terms from Transifex 2021-06-27 01:31:05 +02:00
Odoo Translation Bot 46643653bf [I18N] Update translation terms from Transifex 2021-06-27 01:31:04 +02:00
Jonathan Castillo 3355500414 [IMP] accounting/l10n: add tip about fisaly registration in "germany" 2021-06-25 16:21:00 +02:00
Antoine Vandevenne (anv) 94e033c5e8 [MERGE] Forward-port of branch 14.0 to master 2021-06-25 16:03:40 +02:00
Antoine Vandevenne (anv) 245dd60bb4 [MERGE] Forward-port of branch 13.0 to 14.0 2021-06-25 15:59:04 +02:00
Antoine Vandevenne (anv) 7faf5ff926 [MERGE] Forward-port of branch 12.0 to 13.0 2021-06-25 15:51:46 +02:00
Ivan Yelizariev // IEL 8831e33e53 [FIX] correct path for the licence text 2021-06-25 12:21:57 +02:00
Jonathan Castillo 65ece5951e [ADD] accounting/l10n: information to use pos in Germany with TSS
task-2574610

Co-authored-by: Jacky Trinh <trj@odoo.com>
Co-authored-by: Jonathan Castillo <jcs@odoo.com>
2021-06-25 10:32:00 +02:00
Victor Feyens 3687dc5d1e [REM][MOV] legal: useless "licenses" toctree page 2021-06-24 16:51:50 +02:00
Victor Feyens 819d1d7332 [REM][MOV] legal: remove empty privacy page
* Also move the cla page since the intermediate "others" page isn't
useful anymore.
2021-06-24 16:51:50 +02:00
Jonathan Castillo c84ac0f7e4 [IMP] admin/odoo.sh: supported versions in "getting_started/create"
task-2581302
2021-06-24 16:48:17 +02:00
Jonathan Castillo b423c066f9 [ADD] general: content about installing and upgrading apps and modules
task-2579050
2021-06-23 15:41:40 +02:00
Jonathan Castillo e55138742f [IMP] general: add intro for "general" + imp uninstalling apps/modules
task-2575136
2021-06-22 14:28:43 +02:00
Jonathan Castillo 5583691ae2 [IMP] general: move content about user deactivation to "users"
task-2575136

- general: move content about user deactivation to "users"
- the content is straighter to the point
2021-06-22 14:28:43 +02:00
Ivan Yelizariev 5b59088a71 [IMP] rdtraining: no need to add web to dependencies
`web` is not used directly and is installed automatically anyway.
Having both `web` and `base` looks excessively, so coaches usually ask to delete
`base`. But more correct solution is adding `base` only. Completly skipping
dependencies is not good either -- see https://github.com/odoo/documentation/commit/76e05ccfb8413966d44f81a74da51d049f0a3996
2021-06-21 15:00:35 +02:00
Kevin Scannell ce9e496873 [IMP] ecommerce: update 'product variants'
task-2486400
2021-06-21 11:07:59 +02:00
Alex Tuyls c34e7eea30 [IMP] l10n_cl : fix typos
Fixed a couple of English grammar mistakes in the invoice PDF report paragraph.
2021-06-21 10:08:13 +02:00
Odoo Translation Bot d8a669e6fc [I18N] Update translation terms from Transifex 2021-06-20 02:30:58 +02:00
Odoo Translation Bot 889ff02027 [I18N] Update translation terms from Transifex 2021-06-20 01:31:12 +02:00
Odoo Translation Bot d4f3830eba [I18N] Update translation terms from Transifex 2021-06-20 01:31:08 +02:00
Ray Carnes bba648dc66 [IMP] inventory: add infos to "expiration_dates" + english improvements
+ rst cleanup (jcs)
2021-06-18 11:15:03 +02:00
Valentino 99511bb2d7 [IMP] l10n_mx: add warning about MXN currency usage
This is a result of feedback we've received, in previous MX DOC versions
we were specifying that the company/main currency should be MXN.
2021-06-18 10:22:43 +02:00
Xavier (xpl) db02edc371 [ADD] applications/sales: Rental app documentation
* pricing
* rental agreement
* picking & return receipt

task: 2538109
2021-06-17 14:39:20 +02:00
Tal Shechtman d59bc40f4a [IMP] general settings: update google auth
task-2229412
2021-06-15 09:31:15 +02:00
Martin Trigaux 192d9349c1 [MERFE] Froward port of 13.0 to 14.0 2021-06-14 16:11:22 +02:00
Martin Trigaux 0421e03141 [I18N] *: export 13.0 source terms 2021-06-14 16:06:08 +02:00
Martin Trigaux c38dbf59ce [MERGE] Forward port of 12.0 into 13.0 2021-06-14 16:04:49 +02:00
Martin Trigaux cafa11ac70 [I18N] *: export pot files
Including the new sphinx.pot containing the theme translations (filename chosen by sphinx)
2021-06-14 15:01:01 +02:00
Martin Trigaux 207bfd6684 [IMP] extension: mark HTML content as translatable 2021-06-14 15:01:01 +02:00
Martin Trigaux 3a915ce2d1 [FIX] conf: translate the theme
Adding the templates_path to make the theme discoverable
Courtesy of https://blog.1a23.com/2020/03/07/translate-text-in-sphinx-templates-and-configurations/
2021-06-14 15:00:16 +02:00
Martin Trigaux e33ff19702 [I18N] *: export 14.0 source terms 2021-06-14 13:37:23 +02:00
Jonathan Castillo 0fcc6fc9d8 [FIX] contributing: wrong doc reference to "memento" 2021-06-14 09:00:14 +02:00
Odoo Translation Bot a040ad6797 [I18N] Update translation terms from Transifex 2021-06-13 02:30:16 +02:00
Odoo Translation Bot ecd044ba15 [I18N] Update translation terms from Transifex 2021-06-13 01:30:28 +02:00
Odoo Translation Bot 7c2bcdb980 [I18N] Update translation terms from Transifex 2021-06-13 01:30:27 +02:00
Antoine Vandevenne (anv) c3eb3f015e [MERGE] Forward-port of branch 14.0 to master 2021-06-11 17:06:51 +02:00
Antoine Vandevenne (anv) cffb0b341a [MERGE] Forward-port of branch 13.0 to 14.0 2021-06-11 17:04:01 +02:00
Antoine Vandevenne (anv) 1f81173389 [MERGE] Forward-port of branch 12.0 to 13.0 2021-06-11 17:03:26 +02:00
Antoine Vandevenne (anv) 23a40f9748 [IMP] contributing: encourage flat pages hierarchy
task-2563614
2021-06-11 10:52:35 +02:00
Antoine Vandevenne (anv) ec1dc7b632 [IMP] contributing: list supported metadata directives
The opportunity is also take to refresh the section about admonitions
and to add undocumented admonitions.

task-2534984
2021-06-11 10:52:35 +02:00
keli brugalli (kbr) 1faf5486a7 [IMP] sales: fix typos
Fixed a couple of english grammar mistakes in the introduction paragraph.
Fixed can be fast-forwaded to 13 and 14 as well.
2021-06-09 16:16:22 +02:00
rjo-odoo 015f456d80 [IMP] website: minor sentence modification in "domain_name" 2021-06-09 14:36:49 +02:00
Carlo Stemberger 28da20b840 [FIX] localizations: typos in the Italian localization doc 2021-06-09 14:31:04 +02:00
Antoine Vandevenne (anv) 457008fab7 [MERGE] Forward-port of branch 14.0 to master 2021-06-09 12:40:56 +02:00
Antoine Vandevenne (anv) b30f28a3c4 [MERGE] Forward-port of branch 13.0 to 14.0 2021-06-09 12:22:50 +02:00
Antoine Vandevenne (anv) 251438d569 [MERGE] Forward-port of branch 12.0 to 13.0 2021-06-09 12:10:06 +02:00
Antoine Vandevenne (anv) 1d3375f1a8 [IMP] *: exclude empty TOC pages from search results
When searching for a string that can be found in a TOC page's content,
that page is listed in the search results. This is not a wanted behavior
because TOC pages without the 'show-content' metadata directive are not
supposed to be accessible.

This commit adds a 'nosearch' metadata directive to all TOC pages
without a 'show-content' metadata directive, hence removing them from
search results.

task-2527419
2021-06-09 11:55:34 +02:00
Victor Feyens 7c3106e95c [IMP] dev/howtos: hide deprecated and outdated tutorial
Now that the new rd&training is deployed, we shouldn't highlight this page anymore

Fixes #1017
2021-06-09 11:45:39 +02:00
Elisabeth Dickinson c8750ae032 [FIX] odoo_theme: fix header display on small screen widths
The highlight-link was pushing the header height to be on two lines.
It is now absolutely positioned below the searchbar instead of to its right.
The switchers now push themselves to the right instead of being pushed by the searchbar-wrapper.
2021-06-09 11:22:58 +02:00
Gabo 525d05e068 [FIX] developer/howtos: wizard example 2021-06-09 10:14:17 +02:00
Jonathan Castillo 08f8a3d0c0 [REM] content/applications/*: delete unused images 2021-06-09 09:58:59 +02:00
Valentino 4c92915aba [IMP] accounting/l10n: "closing entries" section in "mexico" 2021-06-09 09:30:31 +02:00
Jonathan Castillo e95ff9c5ed [FIX] general: redirection for "export-data" 2021-06-08 14:06:04 +02:00
Ivan Yelizariev 8b201ca924 [IMP] developer/*: clarify --test-tags
Corresponding PRs to odoo/odoo:

https://github.com/odoo/odoo/pull/71130
https://github.com/odoo/odoo/pull/71331

---

task-2431630
2021-06-07 09:39:06 +02:00
Antoine Vandevenne (anv) f6d3c5628d [MERGE] Forward-port of branch 14.0 to master 2021-06-07 09:18:35 +02:00
Antoine Vandevenne (anv) 5469c2fb2c [MERGE] Forward-port of branch 13.0 to 14.0 2021-06-07 09:15:53 +02:00
Antoine Vandevenne (anv) a8cfd6c6c5 [MERGE] Forward-port of branch 12.0 to 13.0 2021-06-07 09:09:43 +02:00
Antoine Vandevenne (anv) b1b48759ba [IMP] README: update links according to redirects made in 675f7bc8 2021-06-07 08:43:55 +02:00
Odoo Translation Bot dc7679a20b [I18N] Update translation terms from Transifex 2021-06-06 02:30:18 +02:00
Odoo Translation Bot 2ec074d5a0 [I18N] Update translation terms from Transifex 2021-06-06 01:31:46 +02:00
Odoo Translation Bot 9db11c78c9 [I18N] Update translation terms from Transifex 2021-06-06 01:30:32 +02:00
Antoine Vandevenne (anv) fffaca7384 [FIX] contributing: fix admonition padding
The padding was not correctly set because the admonition was included
in an <ul> element which was itself inside another <ul> element.
The table below the admonition is also moved outside of the <ul>
because it is semantically incorrect.
2021-06-04 17:44:23 +02:00
Antoine Vandevenne (anv) ddb5523d03 [REM] contributing: remove unused image file 2021-06-04 17:44:23 +02:00
Antoine Vandevenne (anv) 10e0a48ac0 [IMP] contributing: flatten hierarchy of "documentation" pages
The content of the introduction guide is moved to the parent page which
is itself renamed to "Write documentation". The homepage's quick links
are adapted accordingly.

The chance is also taken to move media files in the appropriate folder.

task-2558998
2021-06-04 17:44:23 +02:00
Elisabeth Dickinson 49baf6b4d7 [IMP] odoo_theme: fix layout on esoteric screens 2021-06-04 17:27:11 +02:00
Jonathan Castillo 193e22492c [MERGE] Forward-port of branch 13.0 to 14.0 2021-06-04 17:21:14 +02:00
Antoine Vandevenne (anv) 2591ddc6d2 [FIX] odoo_theme: fix crash on menu loading introduced with 675f7bc8 2021-06-04 16:24:58 +02:00
Jonathan Castillo 400b3f52b7 [MOV] general: renames "odoo_basics" into "users" + split content
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.

Since other docs were moved away from the section "basics" with previous
commits, this category is renamed "users settings"
This commit:
- renames "basics" into "users settings"
- moves the content from "odoo_basics/users" to "users"
  - it moves the content about "access rights" to a child doc

task-2535899
2021-06-04 13:51:18 +02:00
Jonathan Castillo 2fb77cf3ff [MOV] general: removes main "settings" section + move content
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.

This commit:
- removes the main "settings" section
  - move its content to general/odoo_basics
- moves "general/mobile" content to "general"
- moves the content of the doc "developer_mode/activate" to "general"
  - it replaces the references to that doc with `:ref:` directives
    rather than `:doc:` directives
  - it is worth noting that it also fixes plenty of links that
    previously referred to "developer_mode" (the category) rather than
	"developer_mode/activate" (the document)

task-2535899
2021-06-04 13:51:18 +02:00
Jonathan Castillo 9493bbf4f4 [IMP] general: merge all docs about data import/export into one doc
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.

This commit merges all docs about data import/export into a single doc:
- base_import/import_faq -> export_import_data
- base_import/adapt_template -> export_import_data
- odoo_basics/export-data -> export_import_data

task-2535899
2021-06-04 13:51:18 +02:00
Jonathan Castillo 8c036a0321 [IMP] general: merge all docs about unsplash into one doc
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.

This commit merges all docs about unsplash into a single doc:
- "unsplash/unsplash_access_key" -> unsplash
- "unsplash/unsplash_application_id" -> unsplash

task-2535899
2021-06-04 13:51:18 +02:00
Jonathan Castillo 2b6f89f26e [MOV] general: move "payment_acquirer" content up to its parent page
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.

This commit improves the structure of the "general" section:
- moves the content of "payment_acquirers/payment_acquirers" to its
  parent page, as main content for this category.

It also improves the content of the note about sensitive data.

task-2535899
2021-06-04 13:51:18 +02:00
Jonathan Castillo 6940f68cb5 [MOV] general: single docs content up to their parent pages
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.

This commit improves the structure of the "general" section:
- it moves the content of the doc "in_app_purchase" to its parent page
  "multi_companies"
- it moves the content of the doc "tags/take_tags" to "odoo_basics/tags"
- it moves the content of the doc "manage_multi_companies" to its parent
  page "multi_companies"

task-2535899
2021-06-04 13:51:18 +02:00
Antoine Vandevenne (anv) 4c6947da4f [IMP] Makefile: update build instructions following merge of 46c21826 2021-06-04 13:49:20 +02:00
Antoine Vandevenne (anv) 675f7bc899 [FIX] odoo_theme: highlight all occurrences of a same entry in the menu
When a page is referenced multiple times in the global toctree, only its
latest TOC entry was highlighted (and expanded if it's a TOC page).
This commit allows a page to be referenced multiple times at any level
of the global TOC while correctly highlighting all of its TOC entries.

task-2551473
2021-06-04 11:44:03 +02:00
Ivan Yelizariev // IEL b33ce0a6ca [FIX] dev: remove confusing phrase "US states"
the file contains other countries states too
2021-06-03 17:52:53 +02:00
Olivier Dony d409bc0639 [FIX] legal: fix confusing /12.0 pdf links 2021-06-03 17:34:51 +02:00
ren-odoo 451f1ccee7 [IMP] Accounting: Update Chilean localization
Add important explanation about Tax on Invoice lines.
2021-06-02 12:03:31 +02:00
Elisabeth Dickinson 7efbf490f6 [FIX] odoo_theme: padding fix in sidenav 2021-05-31 16:04:41 +02:00
Victor Feyens 79f8baadd3 [MERGE] Forward-port of branch 14.0 to master 2021-05-31 15:27:38 +02:00
Victor Feyens a1e7024fa0 [MERGE] Forward-port of branch 13.0 to 14.0 2021-05-31 15:16:09 +02:00
Victor Feyens c9b6795179 [FIX][REM] wrong forward-ported files 2021-05-31 15:01:04 +02:00
Victor Feyens 40afc9d9f0 [MERGE] Forward-port of branch 12.0 to 13.0 2021-05-31 14:54:23 +02:00
Victor Feyens bfec9a58f9 [FIX] code: typos 2021-05-31 14:44:18 +02:00
Victor Feyens becf7a207d [FIX] content/applications/*: typos
found with codespell
2021-05-31 14:44:18 +02:00
Victor Feyens 0a4e0610c6 [FIX] content/administration/*: typos 2021-05-31 14:44:18 +02:00
Victor Feyens e96bc804d3 [FIX] content/developer/*: typos
Found with codespell
2021-05-31 14:44:18 +02:00
Romaric PINSET LEPRETRE 2f4c713be1 [FIX] app/website: Gengo isn't supported in v14 anymore
Cf. https://github.com/odoo/odoo/pull/58678#issuecomment-700627182
2021-05-31 13:29:58 +02:00
Odoo Translation Bot 4483a86907 [I18N] Update translation terms from Transifex 2021-05-30 02:31:25 +02:00
Odoo Translation Bot eb0304c958 [I18N] Update translation terms from Transifex 2021-05-30 01:31:35 +02:00
Odoo Translation Bot 3ae10515b9 [I18N] Update translation terms from Transifex 2021-05-30 01:31:25 +02:00
Antoine Vandevenne (anv) f3bf048221 [MERGE] Forward-port of branch 14.0 to master 2021-05-28 17:38:56 +02:00
Antoine Vandevenne (anv) 1758c674e6 [MERGE] Forward-port of branch 13.0 to 14.0 2021-05-28 17:38:04 +02:00
Antoine Vandevenne (anv) 4ca0d019c7 [MERGE] Forward-port of branch 12.0 to 13.0 2021-05-28 17:31:45 +02:00
Elisabeth Dickinson fa267e5cfc [FIX] odoo_theme: design fixes
- change button color (in line with odoo.com)
- adapt margin above h2
- change gray variable on footer (to use the same as everywhere else)
- fix grey background in nav
- fix opacity on icon when active in nav
- add icons on mobile homepage
- fix missing homepage separator in mobile
- fix nav top padding on mobile (hidden by searchbar)
- adjust nav's active links styles
- adjust margin on version switcher
- hide toctree-wrapper when show-content is in meta
- fix highlighted-link on tablet screen
- style toctree-wrapper (a lil bit)
- hide local toc while page is loading
- SCSS linting
2021-05-28 17:06:58 +02:00
Bruno Boi dee28c59a1 [IMP] developer/reference: add a gantt view option
new option: disable_drag_drop
2021-05-28 15:56:49 +02:00
Ivan Yelizariev 76e05ccfb8 [IMP] manifest: add note about 'base' module in depends 2021-05-28 12:49:27 +02:00
Sébastien Theys ead1b9a533 [IMP] javascript_reference: apply changes from odoo/odoo#67009
task-2476867
2021-05-27 17:43:42 +02:00
Odoo Translation Bot 05d99f94d6 [I18N] Update translation terms from Transifex 2021-05-27 11:06:08 +02:00
Xavier (xpl) ba635bdc02 [ADD] documents: new documents app + workflow actions
task-2534638
2021-05-27 11:02:46 +02:00
Noura 6b616c1bd0 [IMP] manufacturing: add warning regarding scrap location
The destination location in manufacturing order shouldn't be a scrap location.
Otherwise, the user won't be able to complete manufacturing orders.
2021-05-27 09:02:28 +02:00
Elisabeth Dickinson 74e7da5694 [FIX] odoo_theme: hide searchbar on scroll in mobile 2021-05-26 17:38:29 +02:00
Ivan Yelizariev 90b848eb45 [REM] dev guidelines: remove obsolete requirements from python 2 2021-05-26 13:11:06 +02:00
Jairo Llopis e1adedc2e5 [FIX] mail: how to choose allowed "From" addresses
- Document changes from https://github.com/odoo/odoo/pull/69218.
- Explain that Office365 is now usable.
2021-05-26 11:49:36 +02:00
Elisabeth Dickinson 88f00fe611 [FIX] odoo_theme: remove images from homepage
task-2534617
2021-05-26 11:40:14 +02:00
Victor Feyens e11f010783 [IMP] developer/orm: add tip on related field dependencies 2021-05-26 10:52:37 +02:00
Ivan Yelizariev 4d0f63e3eb [FIX] developer/orm: related fields default values
* readonly is True for related fields.

Since Odoo 12: https://github.com/odoo/odoo/commit/52a8ed3c0c72b21baf589bc9b91a030d9da661a8

This commit also highlights all the default values of related fields, fixing
the misleading message about related computed in sudo mode (since it can
be disabled with compute_sudo or related_sudo = False)

---

task-2451749
2021-05-26 10:52:37 +02:00
bonesbe 6dd282f6e1 [IMP] general: add user pref image 2021-05-26 08:31:35 +02:00
Ivan Yelizariev 86cefde583 [FIX] rdtraining: improve git commands
no need to fetch all branches from odoo/technical-training-sandbox

Also, ``git push`` without upstream may not work depending on git
version/configuration:

```
$ git push -u master-my_first_branch-IEL
fatal: The current branch master-my_first_branch-IEL has no upstream branch.
To push the current branch and set the remote as upstream, use

    git push --set-upstream master-my_first_branch-IEL master-my_first_branch-IEL
```
2021-05-25 14:37:47 +02:00
Victor Feyens 10612f0ba7 [FIX] odoo_theme: unclickable :show-content: pages in global toctree
When navigating the themes tutorial (developer/howto/themes), the
rdtraining page wasn't clickable in the global toc, even though it was
specified as :show-content: (note that the rdtraining is only in 14.0+).

The heuristic extracting the pagename from a toctree node wasn't
considering the current depth if the page referenced by the toctree
node was in the same folder than the current page.

Explanation:

We are computing the toctree for the page developer/howtos/themes. One
of the toctree nodes references the rdtraining page, with a relative
link, i.e. `rdtraining.html`.

We were wrongfully looking for `show_content` in the metadata of the
`rdtraining` page, instead of `developer/howtos/rdtraining`, since we
didn't consider the current document depth when the reference didn't
contain any `/`.

This commit ensures that if the current document has a depth > 1, this
depth is currently considered, even for links referencing documents in
the same folder.

task-2538297
2021-05-25 14:13:01 +02:00
Victor Feyens 131f48bc38 [IMP] developer/reference/orm: document Command enum & methods 2021-05-25 12:39:33 +02:00
Julien Castiaux 78ffc619ea [IMP] core: Revamp odoo.fields.Command doc
Thanks to the update of sphinx, we can use `:members:` to document an
`IntEnum` class.
2021-05-25 10:00:10 +02:00
Odoo Translation Bot 8a160c3437 [I18N] Update translation terms from Transifex 2021-05-23 02:31:26 +02:00
Odoo Translation Bot cdd5fc8049 [I18N] Update translation terms from Transifex 2021-05-23 01:31:50 +02:00
Antoine Vandevenne (anv) d9bd94ed3c [MERGE] Forward-port of branch 14.0 to master 2021-05-21 17:23:57 +02:00
Antoine Vandevenne (anv) 4b1a61a7aa [MERGE] Forward-port of branch 13.0 to 14.0 2021-05-21 17:21:55 +02:00
Antoine Vandevenne (anv) 647b6d924d [MERGE] Forward-port of branch 12.0 to 13.0 2021-05-21 17:16:22 +02:00
Jonathan Castillo 5c3a4e60e2 [IMP] expenses: ref content to top-level TOC page
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.

This commit:

- renames "expense" to "expenses" as it is in the app and in the title
- restructures the files
- moves the media files from "media" folder to "expenses" folder
- adds a short intro to expenses

task-2535899
2021-05-21 17:13:42 +02:00
Jonathan Castillo d66de0d1f2 [IMP] accounting: move in-odoo to top-level TOC page + imp structure
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.

This commit improves the structure of the "Accounting" app:
- it moves the doc "in-odoo" in the top "app" level and its content is
  included in "accounting.rst" (the content will later be improved)

  - adds new intro
  - changes external links to mementos to correct doc references

- it renames the category accounting/overview to
  accounting/getting_started
- it renames the category accounting/overview/getting_started to
  accounting/getting_started/initial_configuration
- it moves "memento" one level above, from
  accounting/overview/main_concepts to the renamed
  accounting/getting_started as it is the last doc remaining in this
  category
- it renames the app "Invoicing and Accounting" to
  "Accounting and Invoicing" since the focus should be on "Accounting"

task-2535899
2021-05-21 17:13:42 +02:00
Jonathan Castillo 7f3b2a1edd [IMP] sign: add content to top-level TOC page + improve structure
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.

This commit improves the structure of the "Sign" app:

- it removes a useless "overview" category
- it adds a brief explanation at the "app" level, including links to
  relevant docs

task-2535899
2021-05-21 17:13:42 +02:00
Raf Geens 806761eec5 [FIX] developer: correct cr.execute signature in ORM doc
`cr.execute` takes a single argument which is a list, a tuple, or a dict.
2021-05-21 16:56:36 +02:00
Antoine Vandevenne (anv) b96c1338c9 [MERGE] Forward-port of branch 14.0 to master 2021-05-20 15:07:52 +02:00
Antoine Vandevenne (anv) 80f24e5533 [MERGE] Forward-port of branch 13.0 to 14.0 2021-05-20 14:55:28 +02:00
Antoine Vandevenne (anv) 1f9cd600cc [MERGE] Forward-port of branch 12.0 to 13.0 2021-05-20 14:46:35 +02:00
BVE defd620d5e [ADD] accounting: restriction for re sequencing
The re sequencing feature done by WAN is perturbing our french customer
In order to explain the reason the feature is, let's state what has been
decided by the product owner (TSB)

opw-2389435
2021-05-19 16:57:10 +02:00
BVE c135e49668 [IMP] accounting: removing none existing module
The module ' l10n_fr_certification ' has been integrate in the account module.
so this is not installable anymore. Removed this but kept the explanation
for the POS.
opw-2389435
2021-05-19 16:57:10 +02:00
Victor Feyens 46c21826fc [IMP] Makefile: build in parallel by default 2021-05-19 15:03:39 +02:00
Victor Feyens 2ddac026f1 [FIX] extensions: support parallel read
Now that patchqueue was removed, we can consider supporting the parallel 
read with our local extensions.

Since we only have basic extensions, not storing any data on the build 
environment, the change mainly consists of specifying the extensions as 
parallelizable.

The only specific case is the html domain, since the base html domain 
requires the support of the method merge_domaindata in parallel read 
mode.  Since we do not need to share anything between the envs for this 
extension, we can simply ignore the method.
2021-05-19 15:03:39 +02:00
Antoine Vandevenne (anv) ee0083cdc7 [MERGE] Forward-port of branch 14.0 to master 2021-05-19 12:39:22 +02:00
Victor Feyens d0c2cb17bc [ADD] developer/howtos: R&D Training
The new R&D training is intended to replace the existing technical
training(s). It is organized as follow:

- A core training, with chapters to follow in order (1 - 16)
- Advanced topics, with independent chapters (A - O)

The advanced topics should be done after the core training.

Co-authored-by: Nicolas Martinelli <nim@odoo.com>
Co-authored-by: Jorge Pinna Puissant <jpp@odoo.com>
Co-authored-by: wan <wan@odoo.com>
Co-authored-by: Xavier Morel <xmo@odoo.com>
Co-authored-by: Tiffany Chang (tic) <tic@odoo.com>
2021-05-18 15:24:16 +02:00
Martin Trigaux e9d06b7881 [I18N] *: export pot files
And fetch matching translations
2021-05-18 08:16:09 +02:00
Victor Feyens b88c9ef6a9 [MERGE] Forward-port of branch 14.0 to master 2021-05-17 19:06:45 +02:00
Victor Feyens 8ad392222b [MERGE] Forward-port of branch 13.0 to 14.0 2021-05-17 19:00:31 +02:00
Victor Feyens 87ab494b42 [MERGE] Forward-port of branch 12.0 to 13.0 2021-05-17 18:29:11 +02:00
Victor Feyens ba72b396a4 [FIX] redirects: odoo_sh documentation page
This redirection was seemingly forgotten in the nginx redirections deployed online,
we will cover it through the redirects file then.
2021-05-17 15:36:08 +02:00
Victor Feyens dc49cd9e7b [IMP] *: links improvements
* use absolute paths when cleaner than relative paths
* fix some sphinx issues / todos
2021-05-17 15:32:24 +02:00
Victor Feyens 326de4b39e [FIX] *: absolute links to odoo.com/documentation 2021-05-17 15:32:24 +02:00
Adrien Dieudonne 83eaee0196 [FIX] theme: hide "Try Odoo" button on iOS
According to the app-store guidelines we are not allowed to sell from
the iOS app.

Our updates are currently blocked because of this.
In the rush, we have no choice but to hide "Try Odoo for FREE" buttons
that redirects the customer to the subscription page.
This is unfortunately not allowed by Apple who consider this
as "In-App Purchase".

Note that in the old documentation (https://www.odoo.com/documentation/user),
this button was located in the header which was hidden in the app
(see related PR).

Source: https://developer.apple.com/app-store/review/guidelines/#business

Related PR:
odoo/mobile-ios#102
odoo/mobile-ios#103

Task-id: 2483253
2021-05-17 09:38:02 +02:00
Odoo Translation Bot 88e7e8d6db [I18N] Update translation terms from Transifex 2021-05-16 01:31:02 +02:00
Martin Trigaux 9e77998bc1 [I18N] *: export pot files 2021-05-14 18:48:27 +02:00
Martin Trigaux c1d09cb79d [I18N] *: export all .pot files
.tx/config: update the list of files

Fetch newly generated .po files from Transifex
2021-05-14 16:55:06 +02:00
Martin Trigaux 769f5d9728 [FIX] translate the documentation
Monkeypatch the docname_to_domain to avoid having one big "application.pot" file
2021-05-14 16:55:06 +02:00
Martin Trigaux 2d9ad82bd6 [MERGE] forward port of 12.0 to 13.0 2021-05-14 16:29:54 +02:00
Martin Trigaux 9e49550239 [I18N] *: export all .pot files
.tx/config: update the list of files

Fetch newly generated .po files from Transifex
2021-05-14 16:21:26 +02:00
Martin Trigaux bea76554f9 [FIX] translate the documentation
Monkeypatch the docname_to_domain to avoid having one big "application.pot" file
2021-05-14 16:16:06 +02:00
Antoine Vandevenne (anv) 2ded74bbd6 [MERGE] Forward-port of branch 14.0 to master 2021-05-12 18:35:42 +02:00
Victor Feyens 106f9fa99a [MERGE] Forward-port of branch 14.0 to master 2021-05-11 15:40:53 +02:00
Victor Feyens b97c0bd230 [MERGE] Forward-port of branch 14.0 to master 2021-05-11 15:27:40 +02:00
Antoine Vandevenne (anv) e76e1f41b6 [MERGE] Forward-port of branch 14.0 to master 2021-05-05 11:13:34 +02:00
Antoine Vandevenne (anv) e09beafe99 [MERGE] Forward-port of branch 14.0 to master 2021-05-04 17:58:31 +02:00
Antoine Vandevenne (anv) 903e80a756 [MERGE] Forward-port of branch 14.0 to master 2021-05-04 16:54:16 +02:00
Antoine Vandevenne (anv) 5cc85f00c5 [MERGE] Forward-port of branch 14.0 to master 2021-05-03 11:41:53 +02:00
Antoine Vandevenne (anv) aecd62eb9a [MERGE] Forward-port of branch 14.0 to master 2021-04-27 12:21:22 +02:00
Antoine Vandevenne (anv) 337e9c8df0 [MERGE] Forward-port of branch 14.0 to master 2021-04-01 10:56:58 +02:00
Victor Feyens b5274bdd95 [REL] master branch
Pure copy of branch 14.0 atm.

Will contain the master developer documentation once the two documentation
(user & developer) are merged together.
2021-03-25 15:09:25 +01:00
3465 changed files with 318635 additions and 449082 deletions
+2
View File
@@ -0,0 +1,2 @@
# Include RST files in language statistics on GitHub.
*.rst linguist-detectable
-11
View File
@@ -1,11 +0,0 @@
# All changes to technical files (build environment and Sphinx extensions) have to be approved
/extensions/ @odoo/doc-review
.gitignore @odoo/doc-review
commit_template.txt @odoo/doc-review
conf.py @odoo/doc-review
Makefile @odoo/doc-review
requirements.txt @odoo/doc-review
# All changes to legal material have to be approved
/content/legal/ @odoo/legal
/content/legal.rst @odoo/legal
+2 -2
View File
@@ -1,10 +1,10 @@
*.pyc
.*
*.mo
.*
!.gitattributes
# Sphinx build files
_build/
extensions/odoo_theme/static/style.css
# Dependencies
odoo
+25 -150
View File
@@ -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
+23 -17
View File
@@ -1,8 +1,16 @@
# 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
ifndef CURRENT_LANG
CURRENT_LANG = en
endif
SPHINX_BUILD = sphinx-build
@@ -11,13 +19,14 @@ SPHINXOPTS = -D project_root=$(ROOT) -D canonical_version=$(CANONICAL_VERSIO
-D versions=$(VERSIONS) -D languages=$(LANGUAGES) -D language=$(CURRENT_LANG) \
-D is_remote_build=$(IS_REMOTE_BUILD) \
-A google_analytics_key=$(GOOGLE_ANALYTICS_KEY) \
-A plausible_script=$(PLAUSIBLE_SCRIPT) \
-A plausible_domain=$(PLAUSIBLE_DOMAIN) \
-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 +46,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: $(HTML_BUILD_DIR)/_static/style.css
@echo "Starting build..."
$(SPHINX_BUILD) -c $(CONFIG_DIR) -b html $(SPHINXOPTS) $(SOURCE_DIR) $(HTML_BUILD_DIR)
@echo "Build finished."
@@ -55,24 +63,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
$(HTML_BUILD_DIR)/_static/style.css: extensions/odoo_theme/static/style.scss extensions/odoo_theme/static/scss/*.scss
@echo "Compiling stylesheets..."
pysassc $(subst .css,.scss,$@) $@
mkdir -p $(HTML_BUILD_DIR)/_static
python3 -m pysassc extensions/odoo_theme/static/style.scss $(HTML_BUILD_DIR)/_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: $(HTML_BUILD_DIR)/_static/style.css
cp -r extensions/odoo_theme/static/* $(HTML_BUILD_DIR)/_static/
cp -r static/* $(HTML_BUILD_DIR)/_static/
+7 -11
View File
@@ -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.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,15 +34,11 @@ 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.
If you have a pull request that is ready for review, request one from the
[odoo/doc-review](https://github.com/orgs/odoo/teams/doc-review) team.
## Learn More
To learn more about Odoo, in addition to the documentation, have a look at
+156 -45
View File
@@ -1,10 +1,14 @@
import re
import os
import shutil
import sys
from pathlib import Path
import docutils
from pygments.lexers import JsonLexer, XmlLexer
from sphinx.ext import graphviz
from sphinx.util import logging
import sphinx
_logger = logging.getLogger(__name__)
@@ -18,7 +22,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'
@@ -52,42 +56,72 @@ add_function_parentheses = True
#=== Extensions configuration ===#
source_read_replace_vals = {
'GITHUB_PATH': f'https://github.com/odoo/odoo/blob/{version}',
'GITHUB_ENT_PATH': f'https://github.com/odoo/enterprise/blob/{version}',
}
# Add extensions directory to PYTHONPATH
extension_dir = Path('extensions')
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_sources_candidate_dirs = (Path('odoo'), Path('../odoo'))
odoo_sources_dirs = [
d for d in odoo_sources_candidate_dirs if d.is_dir() and (d / 'odoo-bin').exists()
]
odoo_dir_in_path = False
if not odoo_dir.is_dir():
if not odoo_sources_dirs:
_logger.warning(
f"Could not find Odoo sources directory at {odoo_dir.absolute()}.\n"
f"The 'Developer' documentation will be built but autodoc directives will be skipped.\n"
f"In order to fully build the 'Developer' documentation, clone the repository with "
f"`git clone https://github.com/odoo/odoo` or create a symbolink link."
"Could not find Odoo sources directory in neither of the following folders:\n"
"%(dir_list)s\n"
"The 'Developer' documentation will be built but autodoc directives will be skipped.\n"
"In order to fully build the 'Developer' documentation, clone the repository with "
"`git clone https://github.com/odoo/odoo` or create a symbolic link.",
{'dir_list': '\n'.join([f'\t- {d.resolve()}' for d in odoo_sources_candidate_dirs])},
)
else:
sys.path.insert(0, str(odoo_dir.absolute()))
if (3, 6) < sys.version_info < (3, 7):
# Running odoo needs python 3.7 min but monkey patch version_info to be compatible with 3.6.
sys.version_info = (3, 7, 0)
odoo_dir = odoo_sources_dirs[0].resolve()
source_read_replace_vals['ODOO_RELPATH'] = '/../' + str(odoo_sources_dirs[0])
source_read_replace_vals['ODOO_ABSPATH'] = str(odoo_dir)
sys.path.insert(0, str(odoo_dir))
import odoo.addons
odoo.addons.__path__.append(str(odoo_dir) + '/addons')
from odoo import release as odoo_release # Don't collide with Sphinx's 'release' config option
odoo_version = odoo_release.version if 'alpha' not in odoo_release.version else 'master'
odoo_version = odoo_release.version.replace('~', '-') # Change saas~XX.Y to saas-XX.Y
odoo_version = 'master' if 'alpha' in odoo_release.version else odoo_version
if release != odoo_version:
_logger.warning(
f"Found Odoo sources directory but with version '{odoo_version}' incompatible with "
f"documentation version '{version}'.\n"
f"The 'Developer' documentation will be built but autodoc directives will be skipped.\n"
f"In order to fully build the 'Developer' documentation, checkout the matching branch"
f" with `cd odoo && git checkout {version}`."
"Found Odoo sources in %(directory)s but with version '%(odoo_version)s' incompatible "
"with documentation version '%(doc_version)s'.\n"
"The 'Developer' documentation will be built but autodoc directives will be skipped.\n"
"In order to fully build the 'Developer' documentation, checkout the matching branch"
" with `cd odoo && git checkout %(doc_version)s`.",
{'directory': odoo_dir, 'odoo_version': odoo_version, 'doc_version': version},
)
else:
_logger.info(f"Found Odoo sources directory matching documentation version {release}.")
_logger.info(
"Found Odoo sources in %(directory)s matching documentation version '%(version)s'.",
{'directory': odoo_dir, 'version': release},
)
odoo_dir_in_path = True
# Mapping between odoo models related to master data and the declaration of the
# data. This is used to point users to available xml_ids when giving values for
# a field with the autodoc_field extension.
model_references = {
'account.account.type': 'addons/account/data/data_account_type.xml',
'res.country': 'odoo/addons/base/data/res_country_data.xml',
'res.currency': 'odoo/addons/base/data/res_currency_data.xml',
}
# The Sphinx extensions to use, as module names.
# They can be extensions coming with Sphinx (named 'sphinx.ext.*') or custom ones.
extensions = [
# Parse Python docstrings (autodoc, automodule, autoattribute directives)
'sphinx.ext.autodoc' if odoo_dir_in_path else 'autodoc_placeholder',
# Link sources in other projects (used to build the reference doc)
'sphinx.ext.intersphinx',
@@ -100,27 +134,37 @@ extensions = [
# Youtube and Vimeo videos integration (youtube, vimeo directives)
'embedded_video',
'exercise_admonition',
'custom_admonitions',
# Redirection generator
'redirects',
# Code switcher (switcher and case directives)
'switcher',
# Content tabs
'sphinx_tabs.tabs',
# Strange html domain logic used in memento pages
'html_domain',
]
if odoo_dir_in_path:
# GitHub links generation
extensions += [
'sphinx.ext.linkcode',
'github_link',
# Parse Python docstrings (autodoc, automodule, autoattribute directives)
'sphinx.ext.autodoc',
'autodoc_field',
]
else:
extensions += [
'autodoc_placeholder',
]
extensions.append('sphinx.ext.graphviz' if shutil.which('dot') else 'graphviz_placeholder')
todo_include_todos = False
intersphinx_mapping = {
'pillow': ('https://pillow.readthedocs.io/en/stable/', None),
'python': ('https://docs.python.org/3/', None),
'werkzeug': ('https://werkzeug.palletsprojects.com/en/1.0.x/', None),
}
@@ -128,8 +172,28 @@ intersphinx_mapping = {
github_user = 'odoo'
github_project = 'documentation'
locale_dirs = ['locale/']
supported_languages = {
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]
# The version names that should be shown in the version switcher, if the config option `versions`
# is populated. If a version is passed to `versions` but is not listed here, it will not be shown.
versions_names = {
'master': "Master",
'saas-15.2': "Odoo Online",
'saas-15.1': "Odoo Online",
'15.0': "Odoo 15",
'14.0': "Odoo 14",
'13.0': "Odoo 13",
}
# The language names that should be shown in the language switcher, if the config option `languages`
# is populated. If a language is passed to `languages` but is not listed here, it will not be shown.
languages_names = {
'de': 'Deutsch',
'en': 'English',
'es': 'Español',
@@ -143,6 +207,9 @@ supported_languages = {
# The specifications of redirect rules used by the redirects extension.
redirects_file = 'redirects.txt'
sphinx_tabs_disable_tab_closing = True
sphinx_tabs_disable_css_loading = True
#=== Options for HTML output ===#
html_theme = 'odoo_theme'
@@ -167,7 +234,7 @@ html_permalinks = True # Sphinx >= 3.5
# Additional JS & CSS files that can be imported with the 'custom-js' and 'custom-css' metadata.
# Lists are empty because the files are specified in extensions/themes.
html_js_files = []
html_css_files = []
html_css_files = ["css/js.css"]
# PHP lexer option to not require <?php
highlight_options = {
@@ -185,7 +252,7 @@ latex_elements = {
'tableofcontents': '', # no TOC
# Output manually in latex docs
'releasename': '14.0',
'releasename': release,
}
latex_additional_files = ['static/latex/odoo.sty']
@@ -225,6 +292,22 @@ latex_logo = 'static/img/odoo_logo.png'
# If true, show URL addresses after external links.
latex_show_urls = 'True'
# https://github.com/sphinx-doc/sphinx/issues/4054#issuecomment-329097229
def source_read_replace(app, docname, source):
"""Substitute parts of strings with computed values.
Since the RST substitution is not working everywhere, i.e. in directives'
options, we need to be able to input those values when reading the sources.
This is using the config `source_read_replace_vals`, mapping a name to its
replacement. This will look for the name surrounded by curly braces in the source.
Meant to be connected to the `source-read` event.
"""
result = source[0]
for key in app.config.source_read_replace_vals:
result = result.replace(f"{{{key}}}", app.config.source_read_replace_vals[key])
source[0] = result
def setup(app):
# Generate all alternate URLs for each document
@@ -233,12 +316,34 @@ def setup(app):
app.add_config_value('versions', None, 'env')
app.add_config_value('languages', None, 'env')
app.add_config_value('is_remote_build', None, 'env') # Whether the build is remotely deployed
app.add_config_value('source_read_replace_vals', {}, 'env')
app.connect('source-read', source_read_replace)
app.add_lexer('json', JsonLexer)
app.add_lexer('xml', XmlLexer)
app.connect('html-page-context', _generate_alternate_urls)
# Add a `condition` option on directives to ignore them based on config values
app.add_config_value('odoo_dir_in_path', None, 'env')
def context_eval(expr):
return eval(expr, {confval.name: confval.value for confval in app.config})
def patch(to_patch):
to_patch.option_spec['condition'] = context_eval
original_run = to_patch.run
def new_run(self):
if not self.options.get('condition', True):
return []
return original_run(self)
to_patch.run = new_run
for to_patch in (
sphinx.directives.code.LiteralInclude,
docutils.parsers.rst.directives.tables.CSVTable,
):
patch(to_patch)
def _generate_alternate_urls(app, pagename, templatename, context, doctree):
""" Add keys of required alternate URLs for the current document in the rendering context.
@@ -270,15 +375,18 @@ def _generate_alternate_urls(app, pagename, templatename, context, doctree):
The entry 'version' is added by Sphinx in the rendering context.
"""
# If the list of versions is not set, assume that the project has no alternate version
_alternate_versions = app.config.versions and app.config.versions.split(',') or []
context['alternate_versions'] = [
(_alternate_version, _build_url(_version=_alternate_version))
for _alternate_version in sorted(_alternate_versions, reverse=True)
if _alternate_version != version and (
_alternate_version != 'master' or pagename.startswith('developer')
)
]
context['version_display_name'] = versions_names[version]
# If the list of versions is not set, assume the project has no alternate version
_provided_versions = app.config.versions and app.config.versions.split(',') or []
# Map alternate versions to their display names and URLs.
context['alternate_versions'] = []
for _alternate_version, _display_name in versions_names.items():
if _alternate_version in _provided_versions and _alternate_version != version:
context['alternate_versions'].append(
(_display_name, _build_url(_alternate_version))
)
def _localize():
""" Add the pairs of (lang, code, url) for the current document in the rendering context.
@@ -289,19 +397,22 @@ def _generate_alternate_urls(app, pagename, templatename, context, doctree):
"""
_current_lang = app.config.language or 'en'
# Replace the context value by its translated description ("Français" instead of "french")
context['language'] = supported_languages.get(_current_lang)
context['language'] = languages_names.get(_current_lang)
# If the list of languages is not set, assume that the project has no alternate language
_alternate_languages = app.config.languages and app.config.languages.split(',') or []
context['alternate_languages'] = [
(
supported_languages.get(_alternate_lang),
_alternate_lang.split('_')[0] if _alternate_lang != 'en' else 'x-default',
_build_url(_lang=_alternate_lang),
)
for _alternate_lang in _alternate_languages
if _alternate_lang in supported_languages and _alternate_lang != _current_lang
]
_provided_languages = app.config.languages and app.config.languages.split(',') or []
# Map alternate languages to their display names and URLs.
context['alternate_languages'] = []
for _alternate_lang, _display_name in languages_names.items():
if _alternate_lang in _provided_languages and _alternate_lang != _current_lang:
context['alternate_languages'].append(
(
_display_name,
_alternate_lang.split('_')[0] if _alternate_lang != 'en' else 'x-default',
_build_url(_lang=_alternate_lang),
)
)
def _build_url(_version=None, _lang=None):
if app.config.is_remote_build:
+16 -8
View File
@@ -1,14 +1,22 @@
==============
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/upgrade
administration/odoo_sh
administration/db_management
administration/enterprise
-10
View File
@@ -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>`__
Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 35 KiB

-415
View File
@@ -1,415 +0,0 @@
.. |assistance-contact| replace::
If you need Odoo assistance on this matter, please contact your Odoo Account Manager or contact
our `Sales department`_.
.. _Sales department: mailto:sales@odoo.com
.. _db-upgrade:
=======
Upgrade
=======
.. _db-upgrade/overview:
Overview
========
.. _db-upgrade/process:
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>`.
.. _db-upgrade/definition:
Definition
~~~~~~~~~~
An upgrade is switching to a newer version of Odoo (e.g., Odoo 13.0 to Odoo 14.0)
An upgrade does not cover:
* changing :ref:`Editions <db-upgrade/faq/editions-change>` (i.e., Community to Enterprise edition)
* switching :ref:`hosting type <db-upgrade/faq/hosting-types-switch>` (i.e., On-Premise to Online or
Odoo.sh)
* migration from another ERP to Odoo
.. note:: |assistance-contact|
.. _db-upgrade/process-workflow:
Process workflow
~~~~~~~~~~~~~~~~
The upgrade process in a nutshell:
#. You create a test upgrade request.
#. | The request is processed by Odoo:
| This happens via an automated process that runs the database through an upgrade script and
takes between 20 and 120 minutes. Only if an issue(s) arises will we have to intervene
manually and adjust the script specifically to your database until the upgrade succeeds.
#. Odoo delivers a test database.
#. You test your database for possible discrepancies (see :ref:`db-upgrade/test-guidance`)
#. If there are any discrepancies, you report them to the Upgrade support team via the
:ref:`Help portal <db-upgrade/test-assistance>`.
#. We will fix the issues and send you a new test database.
#. Once you completed the testing and are happy with the result, you decide on a date and time when
you stop users from accessing Odoo, freeze all data entries and create an upgrade request for the
production upgrade.
#. Odoo delivers the production database through the automated process.
#. You restore it in your Production environment a few short hours later and continue working on the
newly upgraded database.
.. _db-upgrade/service-level:
Service Level Agreement
-----------------------
What is covered by the Enterprise Licence?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Databases hosted on Odoos Cloud platforms (Saas and Odoo.sh) or On-Premise (Self-Hosting) enjoy the
following service at all times.
The upgrade of:
* standard applications
* Studio customization (as long as the Studio app is still active)
* customizations done by our consulting and developer services *if* they are covered by a
Maintenance of Customisations subscription
The Upgrade Service is limited to the technical conversion and adaptation of your database (standard
modules and data) to make it compatible with the targeted version.
What upgrading does NOT cover
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* The cleaning of pre-existing data & configuration while upgrading
* Any new developments and/or upgrade of your own :ref:`custom modules
<db-upgrade/faq/custom-modules>`
* `Training <https://www.odoo.com/learn>`_ on the new version
You can get more information about your Enterprise Licence on our :ref:`Odoo Enterprise Subscription
Agreement <upgrade>` page.
.. note:: |assistance-contact|
.. _db-upgrade/get-started:
Get started
===========
The upgrade process varies depending on where your database is hosted.
.. _db-upgrade/online:
Online (SaaS)
-------------
If you are hosted Online, please check our :ref:`instruction page for our Online (SaaS) customers
<upgrade_button>`.
.. _db-upgrade/odoo-sh:
Odoo.sh
-------
If you are Odoo.sh hosted, check our :doc:`specific instructions to be able to upgrade
<odoo_sh/advanced/upgrade_your_database>`.
.. _db-upgrade/on-premise:
On-Premise
----------
There are two possibilities:
#. Via the interface of our `website form <https://upgrade.odoo.com>`_
#. | For technically-advanced users and partners, via the following command line (to be used on the
machine where your database is hosted):
| ``python <(curl -s beta.upgrade.odoo.com/upgrade) test -d <your db name> -t 14.0``
What does it do?
~~~~~~~~~~~~~~~~
The above command will dump your database to a file, then send it to the upgrade platform for
upgrade, displaying you the live logs, then restore the upgraded database back on your server as a
duplicate test database.
.. _db-upgrade/steps:
Steps
=====
.. _db-upgrade/steps-test:
The testing phase
-----------------
.. _db-upgrade/test-process:
Test process
~~~~~~~~~~~~
Also referred to as the pre-production phase, the test phase allows you to review an upgraded
version of your database without affecting your production database in any way.
We suggest that you run the test upgrade process at least once, but you can do it as often as you
want (one at a time).
Once you receive your upgraded test database, you should check that all data, processes and
functionality are still correct and working as expected.
If you do find discrepancies, you'll be able to:
* | :ref:`Report your issues <db-upgrade/test-assistance>`
| and/or
* Ask for a new :ref:`test request <db-upgrade/test-db-request>` after the reported issues have
been fixed in the upgrade script.
When you do not find any discrepancies, you'll be able to:
* Move on to the upgrade of your :ref:`production database <db-upgrade/production-live>`.
.. _db-upgrade/test-db-request:
Request a test database
~~~~~~~~~~~~~~~~~~~~~~~
When filling the `website form <https://upgrade.odoo.com>`_, select *Testing* purpose.
.. image:: media/db-upgrade-test-purpose.png
:align: center
:alt: Selection of the "Testing" purpose in the upgrade form on Odoo
.. _db-upgrade/test-guidance:
Test guidance
~~~~~~~~~~~~~
Every business and organization has its own operational needs and will have to test its specific
Odoo instance respectively. However, we recommend you look at `the test scenario
<https://drive.google.com/open?id=1Lm4JqbsHBirB1wMi14UChoz_YHLjx5ec>`_ we created, a high-level idea
of what you should test and look out for.
.. todo:: change link "test scenario" once the related doc is published
.. _db-upgrade/test-assistance:
Assistance
~~~~~~~~~~
If you encounter issues or problems in the **test database**, please contact the Odoo Upgrade
Support:
#. Connect to our `Odoo Support page <https://www.odoo.com/help>`_.
#. Under the *Ticket Description* section, select *An issue related to my upgrade* ticket type.
.. image:: media/db-upgrade-test-assistance.png
:align: center
:alt: Selection of "An issue related to my upgrade" as Ticket Type in the support form on Odoo
.. warning::
If you choose another *Ticket Description* type, the request will be redirected to another
team than the upgrade one and will slow down the processing and response time.
#. Please provide as much detail as you can. Where applicable, illustrate the current and previous
flows with videos and/or screenshots. This will avoid clarifying questions and speed up the
resolution process significantly.
.. image:: media/db-upgrade-test-assistance-details.png
:align: center
:alt: "Detailed Description" field in the support form on Odoo
.. note::
* The purpose of the test phase is not to correct existing data or configurations in your
database.
* |assistance-contact|
.. _db-upgrade/steps-production:
The production launch
---------------------
.. _db-upgrade/production-live:
Production goes live
~~~~~~~~~~~~~~~~~~~~
The production upgrade request is when you decide to upgrade your current database with all your
production data (invoices, VAT returns, inventories, current orders) to a new version of your choice.
After your :ref:`tests <db-upgrade/steps-test>` are completed to your satisfaction, submit the
request to upgrade your production database via our `website form <https://upgrade.odoo.com>`_.
Select *Production* purpose.
.. image:: media/db-upgrade-production-purpose.png
:align: center
:alt: Selection of the "Production" purpose in the upgrade form on Odoo
.. danger::
Going into production without first testing may lead to:
- business interruptions (e.g. no longer having the possibility to validate an action)
- poor customer experiences (e.g. an eCommerce website that does not work correctly)
.. _db-upgrade/production-assistance:
Assistance
~~~~~~~~~~
If you encounter issues or problems in the **production database**, please contact the **Odoo
Support**:
#. Connect to our `Odoo Support page <https://www.odoo.com/help>`_.
#. Under the *Ticket Description* section, select the appropriate type related to your issue but
**do not select** the option *An issue related to my upgrade*.
.. note::
After upgrading to production, the support will be provided by the Support team instead of the
Upgrade team.
#. Please provide as much detail as you can. Where applicable, illustrate the current and previous
flows with videos and/or screenshots. This will avoid clarifying questions and speed up the
resolution process significantly.
.. image:: media/db-upgrade-production-assistance-details.png
:align: center
:alt: "Detailed Description" field in the support form on Odoo
.. warning::
If you choose *An issue related to my upgrade* as ticket type, the request will be redirected
to another team than the support one and will slow down the processing and response time.
.. _db-upgrade/faq:
FAQ
===
.. _db-upgrade/faq/why:
Why upgrade?
------------
* You benefit from the latest features of the :ref:`new major version
<db-upgrade/faq/release-notes>` released by Odoo.
* If you are in an :ref:`unsupported version <db-upgrade/supported-versions>`, you get a new version
with support.
.. _db-upgrade/faq/when:
When to upgrade?
----------------
Whenever you want. You can make your upgrade request as soon as a new version is released on our
`website form <https://upgrade.odoo.com>`_.
.. _db-upgrade/faq/availability:
Availability of the new version
-------------------------------
Please kindly note that as soon as we announce the release of a new major version (usually at the
end of year), the Upgrade Service team needs to adapt the upgrade scripts to it, which is why the
new version is not immediately available for existing databases.
.. _db-upgrade/faq/finalization:
Finalization of the upgrade (:abbr:`ETA (Estimated Time of Arrival)`)
---------------------------------------------------------------------
Unfortunately, it is impossible to give time estimates for every upgrade request. Odoo offers so
many possibilities (e.g. branding, workflows, customization, etc) that it can get tricky to upgrade,
and translate to the new structure. If you use multiple apps managing sensitive data (e.g.,
Accounting, Inventory, etc.), some cases may still require a human intervention, making the process
slower.
This is especially true during the first months following the release of a new major version, which
can significantly lengthen the upgrade delay.
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.
So, in a nutshell, what can impact your upgrade lead time?
* Source & targeted versions
* Installed apps
* Volume of data
* Amount of customization (models, fields, methods, workflows, reports, website, etc.)
* Installation of new apps or configuration changes after the start of the test phase
Usually, the delays experienced during the first request (waiting time between the time you
submitted your first request for a test upgrade) can generally give you an idea of the time to wait
for the production request.
.. _db-upgrade/faq/custom-modules:
Upgrade of the custom modules
-----------------------------
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
`partners <https://www.odoo.com/partners>`_ or you can do it yourself.
.. note:: |assistance-contact|
.. _db-upgrade/faq/editions-change:
Editions change (from Community to Enterprise)
----------------------------------------------
An upgrade does not cover a change of `Editions <https://www.odoo.com/page/editions>`_
.. note:: |assistance-contact|
.. _db-upgrade/faq/hosting-types-switch:
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>`.
.. note:: |assistance-contact|
.. _db-upgrade/faq/release-notes:
Release Notes by version
------------------------
Open our `Release Note <https://www.odoo.com/page/release-notes>`_ page to get a summary of the new
features and improvements made in each version.
.. _db-upgrade/assistance:
Assistance
==========
.. _db-upgrade/contact:
Contact our Upgrade service support
-----------------------------------
Should you have any more questions about the upgrade, do not hesitate to send a message to `Odoo
Upgrade Team <mailto:upgrade@odoo.com>`_. We will be very pleased to answer it as soon as possible.
.. _db-upgrade/supported-versions:
Supported versions
------------------
Please note that Odoo provides support and bug fixing only for the three last major versions of Odoo.
This is a factor to take into consideration before upgrading. If you are on an older version, we
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>`.
-10
View File
@@ -1,10 +0,0 @@
==========
Deployment
==========
.. toctree::
deployment/deploy
deployment/cdn
deployment/email_gateway
+10 -752
View File
@@ -1,756 +1,14 @@
:nosearch:
.. _setup/install:
=======
Install
=======
===============
Installing Odoo
===============
.. If you add content on this page, remove the redirect rule 'install -> install/install'
There are multiple ways to install Odoo, or not install it at all, depending
on the intended use case.
.. toctree::
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,15 +1,13 @@
==============
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
not generally necessary for a development systems that is not exposed on the
internet.
.. warning:: If you are setting up a public server, be sure to check our :ref:`security` recommandations!
.. warning:: If you are setting up a public server, be sure to check our :ref:`security` recommendations!
.. _db_filter:
@@ -65,15 +63,15 @@ in ``/etc/odoo.conf`` set:
dbfilter = ^%d$
.. note::
Setting a proper :option:`--db-filter <odoo-bin --db-filter>` is an important part
of securing your deployment.
Once it is correctly working and only matching a single database per hostname, it
is strongly recommended to block access to the database manager screens,
and to use the ``--no-database-list`` startup 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_.
PostgreSQL
==========
@@ -171,7 +169,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>`_
@@ -197,7 +195,6 @@ be better monitored and resource-restricted.
.. warning:: multiprocessing mode currently isn't available on Windows
Worker number calculation
-------------------------
@@ -230,16 +227,14 @@ like nginx or apache. When doing so, you'll need to forward some more http Heade
to Odoo, and activate the proxy_mode in Odoo configuration to have Odoo read those
headers.
Configuration sample
--------------------
* Server with 4 CPU, 8 Thread
* 60 concurrent users
* 60 users / 6 = 10 <- 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
@@ -290,59 +285,58 @@ in ``/etc/nginx/sites-enabled/odoo.conf`` set:
#odoo server
upstream odoo {
server 127.0.0.1:8069;
server 127.0.0.1:8069;
}
upstream odoochat {
server 127.0.0.1:8072;
server 127.0.0.1:8072;
}
# http -> https
server {
listen 80;
server_name odoo.mycompany.com;
rewrite ^(.*) https://$host$1 permanent;
listen 80;
server_name odoo.mycompany.com;
rewrite ^(.*) https://$host$1 permanent;
}
server {
listen 443;
server_name odoo.mycompany.com;
proxy_read_timeout 720s;
proxy_connect_timeout 720s;
proxy_send_timeout 720s;
listen 443 ssl;
server_name odoo.mycompany.com;
proxy_read_timeout 720s;
proxy_connect_timeout 720s;
proxy_send_timeout 720s;
# Add Headers for odoo proxy mode
proxy_set_header X-Forwarded-Host $host;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header X-Real-IP $remote_addr;
# Add Headers for odoo proxy mode
proxy_set_header X-Forwarded-Host $host;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header X-Real-IP $remote_addr;
# SSL parameters
ssl on;
ssl_certificate /etc/ssl/nginx/server.crt;
ssl_certificate_key /etc/ssl/nginx/server.key;
ssl_session_timeout 30m;
ssl_protocols TLSv1.2;
ssl_ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384;
ssl_prefer_server_ciphers off;
# SSL parameters
ssl_certificate /etc/ssl/nginx/server.crt;
ssl_certificate_key /etc/ssl/nginx/server.key;
ssl_session_timeout 30m;
ssl_protocols TLSv1.2;
ssl_ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384;
ssl_prefer_server_ciphers off;
# log
access_log /var/log/nginx/odoo.access.log;
error_log /var/log/nginx/odoo.error.log;
# log
access_log /var/log/nginx/odoo.access.log;
error_log /var/log/nginx/odoo.error.log;
# Redirect longpoll requests to odoo longpolling port
location /longpolling {
proxy_pass http://odoochat;
}
# Redirect longpoll requests to odoo longpolling port
location /longpolling {
proxy_pass http://odoochat;
}
# Redirect requests to odoo backend server
location / {
proxy_redirect off;
proxy_pass http://odoo;
}
# Redirect requests to odoo backend server
location / {
proxy_redirect off;
proxy_pass http://odoo;
}
# common gzip
gzip_types text/css text/scss text/plain text/xml application/xml application/json application/javascript;
gzip on;
# common gzip
gzip_types text/css text/scss text/plain text/xml application/xml application/json application/javascript;
gzip on;
}
Odoo as a WSGI Application
@@ -386,7 +380,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.
@@ -394,20 +388,112 @@ The solutions to support livechat/motifications in a WSGI application are:
with ``/longpolling/`` to
:option:`the longpolling port <odoo-bin --longpolling-port>`.
Serving Static Files
====================
.. _deploy/streaming:
For development convenience, Odoo directly serves all static files in its
modules. This may not be ideal when it comes to performances, and static
files should generally be served by a static HTTP server.
Serving static files and attachments
====================================
Odoo static files live in each module's ``static/`` folder, so static files
can be served by intercepting all requests to :samp:`/{MODULE}/static/{FILE}`,
and looking up the right module (and file) in the various addons paths.
For development convenience, Odoo directly serves all static files and attachments in its modules.
This may not be ideal when it comes to performances, and static files should generally be served by
a static HTTP server.
Serving static files
--------------------
Odoo static files are located in each module's :file:`static/` folder, so static files can be served
by intercepting all requests to :samp:`/{MODULE}/static/{FILE}`, and looking up the right module
(and file) in the various addons paths.
.. example::
Say Odoo has been installed via the **debian packages** for Community and Enterprise, the addons
paths is :file:`/usr/lib/python3/dist-packages/odoo/addons`. Using the above NGINX (https)
configuration, the following location block should be added to serve static files via NGINX.
.. code-block:: nginx
location @odoo {
# copy-paste the content of the / location block
}
# Serve static files right away
location ~ ^/[^/]+/static/.+$ {
root /usr/lib/python3/dist-packages/odoo/addons;
try_files $uri @odoo;
expires 24h;
}
.. example::
Say Odoo has been installed via the **source**, and the two git repositories for Community and
Enterprise has been cloned in :file:`/opt/odoo` and :file:`/opt/odoo-enterprise` respectively.
The addons paths is ``/opt/odoo/odoo,/opt/odoo/addons,/opt/odoo-enterprise``. Using the above
NGINX (https) configuragion, the following location block should be added to serve static files
via NGINX.
.. code-block:: nginx
location @odoo {
# copy-paste the content of the / location block
}
# Serve static files right away
location ~ ^/[^/]+/static/.+$ {
try_files /static-base$uri /static-addons$uri /static-enterprise$uri @odoo$uri;
expires 24h;
}
location /static-base {
internal;
alias /opt/odoo/odoo/addons;
}
location /static-addons {
internal;
alias /opt/odoo/addons;
}
location /static-enterprise {
internal;
alias /opt/odoo-enterprise;
}
.. warning::
The actual NGINX configuration you need is highly dependent on your own installation. The two
above snippets only highlight two possible configurations and may not be used as-is.
Serving attachments
-------------------
Attachments are files stored in the filestore which access is regulated by Odoo. They cannot be
directly accessed via a static web server as accessing them requires multiple lookups in the
database to determine where the files are stored and whether the current user can access them or
not.
Nevertheless, once the file has been located and the access rights verified by Odoo, it is a good
idea to serve the file using the static web server instead of Odoo. For Odoo to delegate serving
files to the static web server, the `X-Sendfile <https://tn123.org/mod_xsendfile/>`_ (apache) or
`X-Accel <https://www.nginx.com/resources/wiki/start/topics/examples/x-accel/>`_ (nginx) extensions
must be enabled and configured on the static web server. Once it is set up, start Odoo with the
:option:`--x-sendfile <odoo-bin --x-sendfile>` CLI flag (this unique flag is used for both
X-Sendfile and X-Accel).
.. note::
- The X-Sendfile extension for apache (and compatible web servers) does not require any
supplementary configuration.
- The X-Accel extension for NGINX **does** require the following additionnal configuration:
.. code-block:: nginx
location /web/filestore {
internal;
alias /path/to/odoo/data-dir/filestore;
}
In case you don't know what is the path to your filestore, start Odoo with the
:option:`--x-sendfile <odoo-bin --x-sendfile>` option and navigate to the ``/web/filestore`` URL
directly via Odoo (don't navigate to the URL via NGINX). This logs a warnings, the message
contains the configuration you need.
.. todo:: test whether it would be interesting to serve filestored attachments
via this, and how (e.g. possibility of mapping ir.attachment id to
filestore hash in the database?)
.. _security:
@@ -559,9 +645,6 @@ Here is what it could look like for blocking the IP for 15 minutes when
findtime = 60 ; within 1 min /!\ Should be adjusted with the TZ offset
logpath = /var/log/odoo.log ; set the actual odoo log path here
.. _db_manager_security:
Database Manager Security
@@ -624,12 +707,10 @@ Here are the supported browsers:
.. warning:: Please make sure your browser is up-to-date and still supported by
its publisher before filing a bug report.
.. note::
Since Odoo 13.0, ES6 is supported. Therefore, IE support is dropped.
.. [#different-machines]
to have multiple Odoo installations use the same PostgreSQL database,
or to provide more computing resources to both software.
@@ -1,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
<email_communication/inbound_messages>`.
+708
View File
@@ -0,0 +1,708 @@
.. _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 Community 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
-----
Prepare
~~~~~~~
.. tabs::
.. group-tab:: Debian/Ubuntu
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
.. group-tab:: Fedora
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
~~~~~~~~~~
.. tabs::
.. group-tab:: Debian/Ubuntu
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/15.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.
.. group-tab:: Fedora
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/15.0/nightly/rpm/odoo.repo
$ sudo dnf install -y odoo
$ sudo systemctl enable odoo
$ sudo systemctl start odoo
.. note::
At this moment, there is no nightly repository for the Enterprise Edition.
Distribution package
~~~~~~~~~~~~~~~~~~~~
.. tabs::
.. group-tab:: Debian/Ubuntu
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_>`_.
.. note::
Odoo 15.0 'deb' package currently supports `Debian 11 (Bullseye)`_, `Ubuntu 20.04 (Focal)`_
or above.
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
- 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
.. group-tab:: Fedora
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_>`_.
.. note::
Odoo 15.0 'rpm' package supports Fedora 34.
Once downloaded, the package can be installed using the 'dnf' package manager:
.. code-block:: console
$ sudo dnf localinstall odoo_15.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.
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 <https://git-scm.com/>`_ to be installed on your machine and that you
have basic knowledge of git commands.
Community Edition:
.. tabs::
.. group-tab:: Windows
.. code-block:: doscon
C:\> git clone https://github.com/odoo/odoo.git
.. group-tab:: Linux
.. code-block:: console
$ git clone https://github.com/odoo/odoo.git
.. group-tab:: Mac OS
.. code-block:: console
$ git clone https://github.com/odoo/odoo.git
Enterprise Edition: (see :ref:`setup/install/editions` to get access)
.. tabs::
.. group-tab:: Windows
.. code-block:: doscon
C:\> git clone https://github.com/odoo/enterprise.git
.. group-tab:: Linux
.. code-block:: console
$ git clone https://github.com/odoo/enterprise.git
.. group-tab:: Mac OS
.. 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
~~~~~~
.. tabs::
.. group-tab:: Windows
Odoo requires Python 3.7 or later to run. Visit `Python's download page <https://www.python.org/downloads/windows/>`_
to download and install the latest version of Python 3 on your machine.
During installation, check **Add Python 3 to PATH**, then click **Customize Installation** and make
sure that **pip** is checked.
.. note::
If Python 3 is already installed, make sure that the version is 3.7 or above, as previous
versions are not compatible with Odoo.
.. code-block:: doscon
C:\> python --version
Verify also that pip_ is installed for this version.
.. code-block:: doscon
C:\> pip --version
.. group-tab:: Linux
Odoo requires Python 3.7 or later to run. Use your package manager to download and install Python 3
on your machine if it is not already done.
.. note::
If Python 3 is already installed, make sure that the version is 3.7 or above, as previous
versions are not compatible with Odoo.
.. code-block:: console
$ python3 --version
Verify also that pip_ is installed for this version.
.. code-block:: console
$ pip3 --version
.. group-tab:: Mac OS
Odoo requires Python 3.7 or later to run. Use your preferred package manager (homebrew_, macports_)
to download and install Python 3 on your machine if it is not already done.
.. note::
If Python 3 is already installed, make sure that the version is 3.7 or above, as previous
versions are not compatible with Odoo.
.. code-block:: console
$ python3 --version
Verify also that pip_ is installed for this version.
.. code-block:: console
$ pip3 --version
PostgreSQL
~~~~~~~~~~
.. tabs::
.. group-tab:: Windows
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:
:file:`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`.
.. group-tab:: Linux
Odoo uses PostgreSQL as database management system. Use your package manager to download and
install PostgreSQL (supported version: 10.0 and later).
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.
.. group-tab:: Mac OS
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.
.. _install/dependencies:
Dependencies
~~~~~~~~~~~~
.. tabs::
.. group-tab:: Windows
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
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: :file:`C:\\Users\\<user>\\AppData\\Roaming\\npm\\`).
.. group-tab:: Linux
Using your **distribution packages** is the preferred way of installing dependencies.
Alternatively, you can install the python dependencies with **pip**.
.. tabs::
.. tab:: Debian/Ubuntu
For Debian-based systems, the packages are listed in the `debian/control
<https://github.com/odoo/odoo/blob/master/debian/control>`_ file of the Odoo sources.
On Debian/Ubuntu, the following commands should install the required packages:
.. code-block:: console
$ cd /CommunityPath
$ sed -n -e '/^Depends:/,/^Pre/ s/ python3-\(.*\),/python3-\1/p' debian/control | sudo xargs apt-get install -y
.. tab:: Install with pip
As some of the python packages need a compilation step, they require system libraries to
be installed.
On Debian/Ubuntu-based systems, the following command should install these required
libraries:
.. code-block:: console
$ sudo apt install python3-pip libldap2-dev libpq-dev libsasl2-dev
Odoo dependencies are listed in the :file:`requirements.txt` file located at the root of
the Odoo community directory.
.. note::
| The python packages in :file:`requirements.txt` are based on their stable/LTS
Debian/Ubuntu corresponding version at the moment of the Odoo release.
| E.g., for Odoo 15.0, the `python3-babel` package version is 2.8.0 in Debian
Bullseye and 2.6.0 in Ubuntu Focal. The lowest version is then chosen in the
:file:`requirements.txt`.
.. tip::
It can be preferable 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 (:file:`CommunityPath`) and run
**pip** on the requirements file to install the requirements for the current user.
.. code-block:: console
$ cd /CommunityPath
$ pip install -r requirements.txt
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
.. group-tab:: Mac OS
Odoo dependencies are listed in the `requirements.txt` file located at the root of the Odoo
community directory.
.. tip::
It can be preferable 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.
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
.. important::
`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.
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:
.. tabs::
.. group-tab:: Windows
.. code-block:: doscon
C:\> cd CommunityPath/
C:\> python odoo-bin -r dbuser -w dbpassword --addons-path=addons -d mydb
Where `CommunityPath` is the path of the Odoo Community installation, `dbuser` is the
PostgreSQL login, `dbpassword` is the PostgreSQL password and `mydb` is the default database
to serve on `localhost:8069`.
.. group-tab:: Linux
.. code-block:: console
$ cd /CommunityPath
$ python3 odoo-bin --addons-path=addons -d mydb
Where `CommunityPath` is the path of the Odoo Community installation and `mydb` is the default
database to serve on `localhost:8069`.
.. group-tab:: Mac OS
.. code-block:: console
$ cd /CommunityPath
$ python3 odoo-bin --addons-path=addons -d mydb
Where `CommunityPath` is the path of the Odoo Community installation and `mydb` is the default
database to serve on `localhost:8069`.
.. seealso::
- :doc:`The exhaustive list of arguments for odoo-bin </developer/misc/other/cmdline>`.
.. _setup/install/docker:
Docker
======
The full documentation on how to use Odoo with Docker can be found on the
official Odoo `docker image <https://hub.docker.com/_/odoo/>`_ page.
.. _Debian 11 (Bullseye): https://www.debian.org/releases/bullseye/
.. _demo: https://demo.odoo.com
.. _docker: https://www.docker.com
.. _download: https://www.odoo.com/page/download
.. _Ubuntu 20.04 (Focal): http://releases.ubuntu.com/20.04/
.. _EPEL: https://fedoraproject.org/wiki/EPEL
.. _PostgreSQL: http://www.postgresql.org
.. _the official installer:
.. _install pip:
https://pip.pypa.io/en/latest/installing.html#install-pip
.. _Quilt: http://en.wikipedia.org/wiki/Quilt_(software)
.. _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
.. _Editions: https://www.odoo.com/pricing#pricing_table_features
.. _nightly: https://nightly.odoo.com/
.. _extra: https://nightly.odoo.com/extra/
+15
View File
@@ -0,0 +1,15 @@
:nosearch:
========
Maintain
========
.. toctree::
maintain/domain_names
maintain/update
maintain/enterprise
maintain/hosting_changes
maintain/online
maintain/on_premise
maintain/supported_versions
@@ -0,0 +1,334 @@
============
Domain names
============
A **domain name** works as an address for your website. It makes the Internet much more accessible
as it allows users to type a meaningful web address, such as ``www.odoo.com``, rather than its
server's IP address with a series of numbers.
You can use a custom domain name to access your Odoo database and websites:
- By :ref:`registering a free domain name with Odoo <domain-name/odoo-register>` (for Odoo Online
databases)
- By :ref:`configuring a custom domain that you already own <domain-name/existing>`.
.. note::
Odoo Online and Odoo.sh databases, including their websites, use by default a subdomain of
``odoo.com`` for both the URL and the emails (e.g., ``https://example.odoo.com``).
.. important::
Odoo offers a :ref:`free custom domain name <domain-name/odoo-register>` to all Odoo Online
databases for one year. Visitors can then access your website with an address such as
``www.example.com`` rather than the default ``example.odoo.com``.
.. seealso::
- `Odoo Tutorials: Register a Free Domain Name
<https://www.odoo.com/slides/slide/register-a-free-domain-name-1663>`_
- `Odoo Quick Tips: Get a free domain name! <https://www.youtube.com/watch?v=eAfgeNOHLP4>`_
.. _domain-name/about:
About domain names
==================
Having a **good domain name** is as important to your branding as the name of your business or
organization as it is the first thing your visitors will notice. We recommend you keep them *simple,
short, easy to remember and spell*.
A **subdomain** is a domain that is a part of another domain. It often refers to the additional part
that comes before the main domain name. Traditionally, most websites use the ``www.`` subdomain,
but any string of letters can be used as well. You can use subdomains to direct your visitors to
other websites than your main website or to specific pages (e.g., ``experience.odoo.com`` points to
a specific page.)
All domain names are referenced in the **Domain Name System**, or **DNS**, which works as a giant
directory for the Internet. There are many DNS servers, so any modification to the DNS can take up
to 72 hours to propagate worldwide on all servers.
.. _domain-name/odoo-register:
Register a free domain name with Odoo
=====================================
You can register a domain name for your Odoo Online database directly from Odoo Website or your
database manager.
.. important::
- Your domain name is **free for one year** if you register it with Odoo!
- The domain name is registered with `Gandi <https://www.gandi.net/>`_, the domain name
registrar.
- You are the owner of the domain name and can use it for other purposes.
- Odoo manages payment and technical support for you.
To do so, go to :menuselection:`Website --> Go to website --> Promote --> Domain Name`.
Alternatively, open your `database manager <https://www.odoo.com/my/databases>`_, click on the
:guilabel:`settings` button next to your database, then on :guilabel:`Domain names`.
.. image:: domain_names/register-promote.png
:align: center
:alt: Clicking on Domain Names from an Odoo website
Search for the domain name of your choice to check its availability, then select the one you want to
register for your website.
.. image:: domain_names/register-search.png
:align: center
:alt: The search of the domain name example.com shows which associated domains are available.
Next, fill in the form with your information to become the domain name owner.
Your domain name is directly linked to your database, but you still have to :ref:`map your domain
name with your website <domain-name/website-map>`.
.. note::
- Free domain names are also available for free Odoo Online databases (if you installed one app
only, for example). In this case, Odoo reviews your request and your website to avoid abuse.
This process may take up to three days.
- This is not available for Odoo.sh databases yet.
.. _domain-name/odoo-manage:
Manage your domain name registered with Odoo
--------------------------------------------
To manage the DNS records of your domain name registered with Odoo or to visualize the contacts
associated with it, open your `database manager <https://www.odoo.com/my/databases>`_, click on the
:guilabel:`settings` button next to your database, on :guilabel:`Domain names`, and then on
:guilabel:`Contacts` or :guilabel:`DNS`.
.. image:: domain_names/manage.png
:align: center
:alt: Management of the domain names linked to an Odoo database
.. note::
Please `submit a support ticket <https://www.odoo.com/help>`_ if you need further assistance to
manage your domain name.
.. _domain-name/existing:
Configure your existing domain name
===================================
If you already own a domain name, you can use it to point to your website.
To avoid any issue with the :ref:`SSL certificate validation <domain-name/ssl>`, we highly recommend
that you proceed with the following actions in this order:
#. :ref:`Add a CNAME record <domain-name/cname>` on your domain name's DNS zone.
#. :ref:`Map your domain name with your Odoo database <domain-name/db-map>`.
#. :ref:`Map your domain name with your Odoo website <domain-name/website-map>`.
.. _domain-name/cname:
Add a CNAME record
------------------
A **CNAME record** is a type of DNS record that points to the IP address of another website rather
than to directly to an IP address.
You need a CNAME record that points to your Odoo database. The requirements are detailed in your
database manager.
.. tabs::
.. group-tab:: Odoo Online
The target address is the current address of your database, as defined at its creation (e.g.,
``example.odoo.com``)
.. group-tab:: Odoo.sh
Your project's main address is defined in :menuselection:`Settings --> Project Name`.
If you want to target a specific branch (production, staging or development), go to
:menuselection:`Branches --> select your branch --> Settings --> Custom domains`, and click on
:guilabel:`How to set up my domain?`. A message indicates which address your CNAME record
should target.
#. Open your domain name's manager dashboard.
#. Open the **DNS zone** management page for the domain name you want to configure.
#. Create a **CNAME record** pointing to the address of your database.
While Odoo suggests creating a CNAME record for your ``www.`` subdomain (``www.example.com``, you
can of course use any domain name of your choice, with any subdomain (e.g.,
``anything.example.com``).
.. example::
You own the domain name ``example.com``, and you have an Odoo Online database at the address
``example.odoo.com``. You want to access your Odoo database primarily with the domain
``www.example.com`` but also with the :ref:`naked domain <domain-name/naked-domain>`
``example.com``.
To do so, you create a CNAME record for the ``www`` subdomain, with ``example.odoo.com`` as the
target. The DNS zone manager generates the following rule and adds it to your DNS zone: ``www IN
CNAME example.odoo.com.``
You also create a redirection from ``example.com`` to ``wwww.example.com``.
Your new DNS records are propagated to all DNS servers.
.. note::
Here are some specific guidelines to create a CNAME record:
- `GoDaddy <https://www.godaddy.com/help/add-a-cname-record-19236>`_
- `Namecheap <https://www.namecheap.com/support/knowledgebase/article.aspx/9646/2237/how-to-create-a-cname-record-for-your-domain>`_
- `OVH <https://docs.ovh.com/us/en/domains/web_hosting_how_to_edit_my_dns_zone/#add-a-new-dns-record>`_
- `CloudFlare <https://support.cloudflare.com/hc/en-us/articles/360019093151>`_
- `Google Domains <https://support.google.com/domains/answer/3290350?hl=en>`_
.. _domain-name/naked-domain:
Naked domain
~~~~~~~~~~~~
A **naked domain** is a domain name that doesn't have any subdomain at the beginning of the address
(e.g., ``odoo.com`` instead of ``www.odoo.com``).
You may want your naked domain to redirect to your website as some visitors may not type the full
domain name to access your website.
#. Open your domain name's manager dashboard.
#. Create a **redirection** from the naked domain (``example.com``) to your main domain name
(``www.example.com``).
.. note::
Depending on your domain name registrar, this redirection may be already pre-configured.
.. _domain-name/db-map:
Map your domain name with your Odoo database
--------------------------------------------
.. tabs::
.. group-tab:: Odoo Online
Open your `database manager <https://www.odoo.com/my/databases>`_, click on the
:guilabel:`settings` button next to your database, on :guilabel:`Domain names`, and then on
:guilabel:`Use my own domain` at the bottom of the right column.
Type the domain name you want to add to this database, then click on :guilabel:`Verify` to
check if the CNAME record is correctly configured. Once done, click on :guilabel:`I confirm,
it's done`.
.. image:: domain_names/online-map.png
:align: center
:alt: Verification of the CNAME records of a domain name before mapping it with a database
.. group-tab:: Odoo.sh
Go to :menuselection:`Branches --> select your branch --> Settings --> Custom domains`, type
the domain name you want to add to this database, then click on :guilabel:`Add domain`.
.. image:: domain_names/odoo-sh-map.png
:align: center
:alt: Mapping a domain name with an Odoo.sh branch
.. seealso::
- :ref:`Odoo.sh branches: settings tab <odoosh-gettingstarted-branches-tabs-settings>`
.. warning::
Make sure to :ref:`add a CNAME record <domain-name/cname>` to your domain name's DNS **before**
mapping your domain name with your Odoo database.
Failing to do so may impede the validation of the :ref:`SSL certificate <domain-name/ssl>` and
would result in a *certificate name mismatch* error. This is often displayed by web browsers as a
warning such as *"Your connection is not private"*.
If this is the case and you have added the domain name to your database's settings less than five
days ago, wait 24 hours as the validation may still happen. Otherwise, please `submit a support
ticket <https://www.odoo.com/help>`_ including screenshots of your CNAME records.
.. _domain-name/ssl:
SSL encryption (HTTPS protocol)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**SSL encryption** is an encryption-based Internet security protocol. It allows your visitors to
navigate your website through a secure connection, which appears as an ``https://`` protocol at the
beginning of your web address, rather than a non-secure ``http://`` protocol.
Odoo generates a separate SSL certificate for each domain :ref:`mapped in the database manager
<domain-name/db-map>`, using integration with `Let's Encrypt Certificate Authority and ACME protocol
<https://letsencrypt.org/how-it-works/>`_.
.. note::
- The certificate generation may take up to 24h.
- Several attempts to validate your certificate are made during the five days following the
moment you add your domain name in your database's settings.
- If you already use another service, you can keep using it or simply change for Odoo.
.. _domain-name/web-base-url:
Web base URL of a database
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. note::
If you have Odoo Website, you can disregard this part and directly :ref:`map your domain name
with your website <domain-name/website-map>`.
The **web base URL** of a database, or **root URL** affects your main website address and all the
links sent to your customers (e.g., quotations, portal links, etc.).
To configure it, access your Odoo database with your custom address, then log in as an administrator
of your database (any user in the *Settings* group) from the login screen.
.. warning::
Connecting to your database with the original Odoo subdomain address (e.g., ``example.odoo.com``
also updates the web base URL of your database. See below to prevent these automatic updates.
Alternatively, you can do it manually. To do so, activate the :ref:`developer mode
<developer-mode>`, then go to :menuselection:`Settings --> Technical --> System Parameters`.
Find the key called ``web.base.url`` (or create it if it does not exist) and enter the full address
of your website as value, such as ``https://www.example.com``.
.. note::
The URL must include the protocol ``https://`` (or ``http://``) and must not end with a slash
(``/``).
To prevent the automatic update of the web base URL when an administrator logs in the database, you
can create the following System Parameter:
- key: ``web.base.url.freeze``
- value: ``True``
.. _domain-name/website-map:
Map your domain name with your website
======================================
Mapping your domain name to your website isn't the same as mapping it with your database:
- It defines your domain name as the main one for your website, helping search engines to index your
website properly.
- It defines your domain name as the base URL for your database, including the portal links sent by
email to your customers.
- If you have multiple websites, it maps your domain name with the appropriate website.
Go to :menuselection:`Website --> Configuration --> Settings --> Website Info`. If you have multiple
websites, select the one you want to configure.
In the :guilabel:`Domain` field, fill in the web address of your website (e.g.,
``https://www.example.com``) and click on :guilabel:`Save`.
.. image:: domain_names/website-settings.png
:align: center
:alt: Configuring https://www.example.com as the Domain of the website
.. warning::
Mapping your domain name with your Odoo website prevents Google from indexing both your custom
domain name ``www.example.com`` and your original odoo database address ``example.odoo.com``.
If both addresses are already indexed, it may take some time before Google removes the indexation
of the second address. You may also try using the `Google Search Console
<https://search.google.com/search-console/welcome>`_ to fix this.
.. note::
If you have multiple websites and companies on your database, make sure that you select the
right :guilabel:`Company` in the website settings, next to the :guilabel:`Domain` settings. Doing
so indicates Odoo which URL to use as the :ref:`base URL <domain-name/web-base-url>` according to
the company in use.
.. seealso::
- :doc:`/applications/general/email_communication/email_servers`
Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.2 KiB

@@ -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.
@@ -11,8 +11,6 @@ Depending on the platforms, you have to do it by yourself or contact our support
From on-premises to Odoo Online
===============================
.. warning:: Odoo Online is not compatible with **non-standard apps**.
1. Create a :ref:`duplicate <duplicate_premise>` of your database: in this duplicate, uninstall all the **non-standard apps**.
2. Grab a "dump with filestore" of your database by using the Database Manager.
3. **If you have time constraints, contact us earlier to schedule the transfer.**
@@ -20,6 +18,11 @@ From on-premises to Odoo Online
5. We will make sure your database is compatible and upload it to our cloud. In case of technical issues, we will get in touch with you.
6. It's done!
.. important::
- Odoo Online is not compatible with **non-standard apps**.
- The database you are moving to Odoo Online must be in a :doc:`supported version
<supported_versions>`.
From on-premises to Odoo.sh
===========================
@@ -49,7 +52,7 @@ From Odoo.sh to Odoo Online
1. Uninstall all the **non-standard apps**: test it in a staging build first, then do it in your production build.
2. **If you have time constraints, contact us earlier to schedule the transfer.**
3. `Create a support ticket <https://www.odoo.com/help>`_ and attach the dump (if the file is too large, use any file transfer service and attach the link to your ticket). Also include your subscription number and the URL you want to use for your database (e.g.: my-company.odoo.com).
3. `Create a support ticket <https://www.odoo.com/help>`_ and include your subscription number and the URL you want to use for your database (e.g.: my-company.odoo.com).
4. We will make sure your database is compatible and upload it to our cloud. In case of technical issues, we will get in touch with you.
5. It's done!
@@ -59,4 +62,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.
@@ -1,9 +1,6 @@
.. _db_premise:
===============================
On-premises Database management
===============================
==============================
On-premise database management
==============================
Register a database
===================
@@ -12,7 +9,7 @@ To register your database, you just need to enter your Subscription Code in the
banner in the App Switcher. Make sure you do not add extra spaces before or after
your subscription code. If the registration is successful, it will turn green and
will provide you with the Expiration Date of your freshly-registered database. You
can check this Epiration Date in the About menu (Odoo 9) or in the Settings Dashboard
can check this Expiration Date in the About menu (Odoo 9) or in the Settings Dashboard
(Odoo 10).
Registration Error Message
@@ -21,7 +18,7 @@ Registration Error Message
If you are unable to register your database, you will likely encounter this
message:
.. image:: media/error_message_sub_code.png
.. image:: on_premise/error_message_sub_code.png
:align: center
:alt: Something went wrong while registering your database,
you can try again or contact Odoo Help
@@ -44,14 +41,14 @@ Solutions
* You can unlink the old database yourself on your `Odoo Contract
<https://accounts.odoo.com/my/subscription>`__ with the button "Unlink database"
.. image:: media/unlink_single_db.png
.. image:: on_premise/unlink_single_db.png
:align: center
A confirmation message will appear; make sure this is the correct database as
it will be deactivated shortly:
.. image:: media/unlink_confirm_enterprise_edition.png
.. image:: on_premise/unlink_confirm_enterprise_edition.png
:align: center
@@ -65,7 +62,7 @@ Solutions
<https://accounts.odoo.com/my/subscription>`__, a short message will appear
specifying which database is problematic:
.. image:: media/unlink_db_name_collision.png
.. image:: on_premise/unlink_db_name_collision.png
:align: center
@@ -96,7 +93,7 @@ Error message due to too many users
If you have more users in your local database than provisionned in your
Odoo Enterprise subscription, you may encounter this message:
.. image:: media/add_more_users.png
.. image:: on_premise/add_more_users.png
:align: center
:alt: This database will expire in X days, you
have more users than your subscription allows
@@ -125,7 +122,7 @@ Database expired error message
If your database reaches its expiration date before your renew your subscription,
you will encounter this message:
.. image:: media/database_expired.png
.. image:: on_premise/database_expired.png
:align: center
:alt: This database has expired.
@@ -157,7 +154,7 @@ You can duplicate your database by accessing the database manager on your
server (<odoo-server>/web/database/manager). In this page, you can easily
duplicate your database (among other things).
.. image:: media/db_manager.gif
.. image:: on_premise/db_manager.gif
:align: center
@@ -175,5 +172,5 @@ System Parameters`, we advise you to use a `uuid generator <https://www.uuidtool
use the unix command ``uuidgen`` to generate a new uuid. You can then simply replace it like any
other record by clicking on it and using the edit button.
.. image:: media/db_uuid.png
.. image:: on_premise/db_uuid.png
:align: center

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: 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: 18 KiB

After

Width:  |  Height:  |  Size: 18 KiB

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 14 KiB

+155
View File
@@ -0,0 +1,155 @@
=================================
Online (SaaS) database management
=================================
To manage a database, sign in to https://www.odoo.com and access the `database management page
<https://www.odoo.com/my/databases>`_ by clicking on the user icon, then on *My Databases*.
.. image:: online/my-databases.png
:align: center
:alt: Clicking on the user icon opens a drop-down menu. "My databases" button is highlighted.
.. note::
Make sure you are connected as the administrator of the database you want to manage.
.. image:: online/dropdown-menu.png
:align: right
:alt: Clicking on the gear icon opens the drop-down menu.
Open the drop-down menu next to the database you want to manage by clicking on the gear icon.
Several actions are available:
- :ref:`online/upgrade`
- :ref:`online/duplicate`
- :ref:`online/rename`
- :ref:`online/download`
- :ref:`online/domains`
- :ref:`online/tags`
- :ref:`online/delete`
- :ref:`online/contact-support`
- :ref:`online/users`
.. _online/upgrade:
Upgrade
=======
If you are *not* on the latest **Online version**, you should receive an invitation to :doc:`upgrade
<../upgrade>` your database. A **Rolling Release button** on your database's main screen proposes an
upgrade to the latest version (e.g., 13.0 to 15.1).
.. important::
- | **If your Odoo database's version is lower than the latest major release:**
| You must upgrade your database within two months. After these two months, an automatic
upgrade is initiated.
- | **If your Odoo database's version is equal to or higher than the latest major release:**
| You can disregard the invitation to upgrade as you probably wouldn't benefit from new
features every two months.
.. note::
Versions that are not supported anymore become deprecated and need to be updated to avoid
security issues. We recommend you initiate the upgrade of the database yourself, as this method
allows you to request a test upgrade of your database to check for any discrepancies.
.. seealso::
- :doc:`../upgrade`
- :doc:`supported_versions`
.. _online/duplicate:
Duplicate
=========
Make an exact copy of the database to be able to perform testing without compromising the daily
operations.
.. important::
- By checking *For testing purposes*, all external communication (emails, payments, delivery
orders, etc.) are disabled by default on the duplicated database.
- Duplicate databases expire automatically after 15 days.
.. _online/rename:
Rename
======
Rename the database and its URL.
.. _online/download:
Download
========
Download instantly a ZIP file with a backup of the database.
.. note::
Databases are backed up daily according to the `Odoo Cloud SLA
<https://www.odoo.com/cloud-sla>`_.
.. _online/domains:
Domains
=======
Configure custom domains to access the database via another URL.
.. seealso::
- :doc:`domain_names`
.. _online/tags:
Tags
====
Add tags to sort your databases out. You can search the tags in the search bar.
.. _online/delete:
Delete
======
Delete a database instantly.
.. danger::
Deleting a database means that all data is permanently lost. The deletion is instant and for all
users. It is recommended to create a backup of the database before deleting it.
Read carefully the warning message that pops up and proceed only if you fully understand the
implications of deleting a database:
.. image:: online/delete.png
:align: center
:alt: A warning message is prompted before deleting a database.
.. note::
- Only an administrator can delete a database.
- The database name is immediately available for a new database.
- It is not possible to delete a database if it is expired or linked to a subscription. If
needed, please get in touch with `Odoo Support <https://www.odoo.com/help>`_.
- To delete your account, please get in touch with `Odoo Support <https://www.odoo.com/help>`_.
.. _online/contact-support:
Contact Support
===============
Access the Odoo `support page <https://www.odoo.com/help>`_ with your database's details already
pre-filled.
.. _online/users:
Invite / Remove Users
=====================
To invite users, fill out the email address of the new user and click on *Invite*. To add multiple
users, click on *Add more users*.
.. image:: online/invite-users.png
:align: center
:alt: Clicking on "Add more users" adds additional email fields.
To remove users, select the users to remove and click on *Remove*.
.. seealso::
- :doc:`/applications/general/users/manage_users`
Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.6 KiB

@@ -0,0 +1,87 @@
.. _supported_versions:
==================
Supported versions
==================
Odoo provides support and bug fixing **for the 3 last major versions** of Odoo.
.. note::
Odoo releases intermediary versions called **Online versions** on the :doc:`Odoo Online <online>`
hosting every two months. Odoo Online users can then benefit from the latest features of Odoo.
- Admins of Odoo Online databases are invited to :doc:`upgrade <../upgrade>` them regularly.
- Online versions are *not* released for Odoo.sh and On-Premise installations.
- Online versions are listed below as *SaaS*.
What's the support status of my Odoo?
=====================================
This matrix shows the support status of every version.
**Major releases are in bold type.**
+-----------------+-------------+----------+-------------+----------------+------------------------+
| | Odoo Online | Odoo.sh | On-Premise | Release date | End of support |
+=================+=============+==========+=============+================+========================+
| Odoo saas~15.2 | |green| | N/A | N/A | March 2022 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo saas~15.1 | |red| | N/A | N/A | February 2022 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 15.0** | |green| | |green| | |green| | October 2021 | October 2024 (planned) |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 14.0** | |green| | |green| | |green| | October 2020 | October 2023 (planned) |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 13.0** | |green| | |green| | |green| | October 2019 | October 2022 (planned) |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo saas~12.3 | |red| | N/A | N/A | August 2019 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 12.0** | |red| | |red| | |red| | October 2018 | October 2021 |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo saas~11.3 | |red| | N/A | N/A | April 2018 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 11.0** | |red| | |red| | |red| | October 2017 | October 2020 |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo 10.saas~15 | |red| | N/A | N/A | March 2017 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo 10.saas~14 | |red| | N/A | N/A | January 2017 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 10.0** | |red| | |red| | |red| | October 2016 | October 2019 |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo 9.saas~11 | |red| | N/A | N/A | May 2016 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 9.0** | |red| | N/A | |red| | October 2015 | October 2018 |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| Odoo 8.saas~6 | |red| | N/A | N/A | February 2015 | |
+-----------------+-------------+----------+-------------+----------------+------------------------+
| **Odoo 8.0** | |red| | N/A | |red| | September 2014 | October 2017 |
+-----------------+-------------+----------+-------------+----------------+------------------------+
.. note::
|green| Supported version
|red| End-of-support
N/A Never released for this platform
🏁 Future version, not released yet
.. This is an awful way to display colored circles but "Large Green Circle Emoji" was only released
in 2019 (see https://unicode-table.com/en/1F7E2/). Let's wait a few more years...
.. |green| image:: data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMzIuMTkgMjMyLjE5Ij48Y2lyY2xlIGN4PSIxMTYuMDkiIGN5PSIxMTYuMDkiIHI9IjExNi4wOSIgc3R5bGU9ImZpbGw6IzAwYTcwMCIvPjwvc3ZnPg==
:width: 15
.. |red| image:: data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMzIuMTkgMjMyLjE5Ij48Y2lyY2xlIGN4PSIxMTYuMDkiIGN5PSIxMTYuMDkiIHI9IjExNi4wOSIgc3R5bGU9ImZpbGw6I2QwMDAwMCIvPjwvc3ZnPg==
:width: 15
I run an older version of Odoo/OpenERP/TinyERP
==============================================
OpenERP 7.0, 6.1, 6.0 and 5.0 is not supported anymore, on any platform.
TinyERP 4.0, 3.0, 2.0 and 1.0 is not supported anymore, on any platform.
Even though we don't support older versions, you can always `upgrade from any version <https://upgrade.odoo.com/>`_.
@@ -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.
Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.9 KiB

+3 -1
View File
@@ -1,5 +1,7 @@
:nosearch:
=======
Odoo sh
Odoo.sh
=======
+1 -1
View File
@@ -1,3 +1,4 @@
:nosearch:
=================
Advanced
@@ -8,5 +9,4 @@ Advanced
advanced/containers
advanced/submodules
advanced/upgrade_your_database
advanced/frequent_technical_questions
@@ -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*":
@@ -232,6 +232,6 @@ Save the file and then run the Odoo Shell:
Finally, *via* the Odoo Shell, you can trigger the piece of code/function/method
you want to debug.
.. image:: ./media/pdb_sh.png
.. image:: containers/pdb_sh.png
:align: center
:alt: Console screenshot showing ``pdb`` running in an Odoo.sh shell.

Before

Width:  |  Height:  |  Size: 72 KiB

After

Width:  |  Height:  |  Size: 72 KiB

@@ -44,7 +44,7 @@ On Odoo.sh, in the branches view of your project, choose the branch in which you
In the upper right corner, click on the *Submodule* button, and then on *Run*.
.. image:: ./media/advanced-submodules-button.png
.. image:: submodules/advanced-submodules-button.png
:align: center
A dialog with a form is shown. Fill the inputs as follows:
@@ -53,12 +53,12 @@ A dialog with a form is shown. Fill the inputs as follows:
* Branch: The branch you want to use.
* Path: The folder in which you want to add this submodule in your branch.
.. image:: ./media/advanced-submodules-dialog.png
.. image:: submodules/advanced-submodules-dialog.png
:align: center
On Github, you can get the repository URL with the *Clone or download* button of the repository. Make sure to *use SSH*.
.. image:: ./media/advanced-submodules-github-sshurl.png
.. image:: submodules/advanced-submodules-github-sshurl.png
:align: center
.. _odoosh-advanced-submodules-withgit:
@@ -1,48 +0,0 @@
=====================
Upgrade your database
=====================
.. _odoosh-advanced-upgrade_your_database:
Download and Upload your database
=================================
Download a dump of your database (from the :ref:`Builds view <odoosh-gettingstarted-builds-download-dump>`), choose the
exact copy and without filestore options. Upload the .sql.gz dump on https://upgrade.odoo.com/upload and
select the Testing Purpose. If you have custom code, you can choose to have it upgraded by us, or do it yourself. Once
it's processed, you'll get a dump of the database in return.
.. warning::
Do *not* upload *backups* of your production database (found in the Backups tab of the production branch) as these
are incompatible with the Upgrade platform - they contain your complete sources, etc. that are not needed for the
upgrade. Make sure to download a **Dump** instead - either through the Backups tab using the *Download Dump* button
or through the Builds page by using the *Download Dump* entry of the contextual menu of your latest production build.
Test your upgraded database
===========================
Create a staging branch that will run the upgraded database. Either make sure your production branch's code is
compatible between the two Odoo versions and fork your production branch, or make a new staging branch containing
the upgraded code.
Once the staging build is done (it doesn't matter if it failed due to the version incompatibility), import your
upgraded dump in the backups tab of the branch. The platform will automatically detect the version of the dump and
change the version of Odoo's source code to the corresponding version for the build.
Test the upgraded database and make sure everything runs as it's supposed to.
Replace your existing production database
=========================================
Once you've tested everything and you're satisfied, start the process over to get an up-to-date upgraded dump:
* Make a new dump of your production database (as described in step 1)
* Upload it on upgrade.odoo.com and select the Production purpose
* Receive the newly upgraded dump and import it in your production branch. The build might get marked as failed because
the platform will run it with the upgraded databases' Odoo version together with the old custom code.
* Merge or commit the upgraded custom code in the production branch
If anything goes wrong, remember you can restore a backup. The platform will always make one before you make any
Odoo.sh operation on the production database. If the restored backup comes from a previous version, the platform will
detect it and change the project's Odoo version back if it needs to.
@@ -1,3 +1,4 @@
:nosearch:
=================
Get started
@@ -8,7 +8,7 @@ Overview
The branches view gives you an overview of the different branches your repository has.
.. image:: ./media/interface-branches.png
.. image:: branches/interface-branches.png
:align: center
.. _odoosh-gettingstarted-branches-stages:
@@ -20,7 +20,7 @@ Odoo.sh offers three different stages for your branches: production, staging and
You can change the stage of a branch by drag and dropping it into the stage section title.
.. image:: ./media/interface-branches-stagechange.png
.. image:: branches/interface-branches-stagechange.png
:align: center
.. _stage_production:
@@ -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,
@@ -109,7 +109,7 @@ Merging your branches
---------------------
You can merge your branches easily by drag and dropping them into each other.
.. image:: ./media/interface-branches-merge.png
.. image:: branches/interface-branches-merge.png
:align: center
When you want to test the changes of your development branches with the production data,
@@ -156,7 +156,7 @@ An overview of your branch history:
* The messages of the commits and their authors,
* The various events linked to the platform, such as stage changes, database imports, backup restores.
.. image:: ./media/interface-branches-history.png
.. image:: branches/interface-branches-history.png
:align: center
For each event, a status is displayed in the top right-hand corner.
@@ -172,7 +172,7 @@ This tab contains the mail catcher. It displays an overview of the emails sent b
The mail catcher is available for your development and
staging branches as the emails of your production database are really sent instead of being intercepted.
.. image:: ./media/interface-branches-mails.png
.. image:: branches/interface-branches-mails.png
:align: center
:scale: 50%
@@ -181,7 +181,7 @@ Shell
A shell access to your container. You can perform basic linux commands (:code:`ls`, :code:`top`)
and open a shell on your database by typing :code:`psql`.
.. image:: ./media/interface-branches-shell.png
.. image:: branches/interface-branches-shell.png
:align: center
You can open multiple tabs and drag-and-drop them to arrange the layout as you wish,
@@ -197,7 +197,7 @@ Editor
An online integrated development environment (IDE) to edit the source code.
You can also open terminals, Python consoles and even Odoo Shell consoles.
.. image:: ./media/interface-branches-editor.png
.. image:: branches/interface-branches-editor.png
:align: center
You can open multiple tabs and drag-and-drop them to arrange the layout as you wish,
@@ -207,17 +207,19 @@ Monitoring
----------
This link contains various monitoring metrics of the current build.
.. image:: ./media/interface-branches-monitoring.png
.. image:: branches/interface-branches-monitoring.png
:align: center
You can zoom, change the time range or select a specific metric on each graph.
On the graphs, annotations help you relate to changes on the build (database import, git push, etc...).
.. _odoosh/logs:
Logs
----
A viewer to have a look to your server logs.
.. image:: ./media/interface-branches-logs.png
.. image:: branches/interface-branches-logs.png
:align: center
Different logs are available:
@@ -241,7 +243,7 @@ Backups
A list of the backups available for download and restore, the ability to perform a manual backup and to import a
database.
.. image:: ./media/interface-branches-backups.png
.. image:: branches/interface-branches-backups.png
:align: center
Odoo.sh makes daily backups of the production database. It keeps 7 daily, 4 weekly and 3 monthly backups.
@@ -283,7 +285,7 @@ Settings
--------
Here you can find a couple of settings that only apply to the currently selected branch.
.. image:: ./media/interface-branches-settings.jpg
.. image:: branches/interface-branches-settings.jpg
:align: center
**Behaviour upon new commit**
@@ -300,7 +302,7 @@ back from staging to development will automatically be set to 'Do nothing'.
Choose the modules to install automatically for your development builds.
.. image:: ./media/interface-settings-modulesinstallation.png
.. image:: branches/interface-settings-modulesinstallation.png
:align: center
* *Install only my modules* will install the modules of the branch only. This is the default option.
@@ -318,15 +320,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.
@@ -382,7 +384,9 @@ we are considering the feature if there is enough demand.
In case the domain of your users email addresses use SPF (Sender Policy Framework) or DKIM
(DomainKeys Identified Mail), don't forget to authorize Odoo as a sending host in your domain name
settings to increase the deliverability of your outgoing emails.
The configuration steps are explained in the :ref:`Discuss app documentation <discuss-email_servers-spf-compliant>`.
The configuration steps are explained in the documentation about :ref:`SPF
<email_communication/spf_compliant>` and :ref:`DKIM <email_communication/dkim_compliant>`.
.. Warning::
Forgetting to configure your SPF or DKIM to authorize Odoo as a sending host can lead to the
@@ -393,7 +397,7 @@ Shell commands
==============
In the top right-hand corner of the view, different shell commands are available.
.. image:: ./media/interface-branches-shellcommands.png
.. image:: branches/interface-branches-shellcommands.png
:align: center
Each command can be copied in the clipboard to be used in a terminal,
@@ -462,12 +466,12 @@ To do so, follow these steps:
(only apply the step 1)
#. Paste the copied content to your profile SSH keys and press "Add"
.. image:: ./media/SSH-key-pasting.png
.. image:: branches/SSH-key-pasting.png
:align: center
#. The key should appear below
.. image:: ./media/SSH-key-appearing.png
.. image:: branches/SSH-key-appearing.png
:align: center
Connection
@@ -481,7 +485,7 @@ To connect to your builds using ssh use the following command in a terminal:
You will find a shortcut for this command into the SSH tab in the upper right corner.
.. image:: ./media/SSH-panel.png
.. image:: branches/SSH-panel.png
:align: center
Provided you have the :ref:`correct access rights <odoosh-gettingstarted-settings-collaborators>` on the project,

Before

Width:  |  Height:  |  Size: 6.1 KiB

After

Width:  |  Height:  |  Size: 6.1 KiB

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 23 KiB

Before

Width:  |  Height:  |  Size: 4.7 KiB

After

Width:  |  Height:  |  Size: 4.7 KiB

@@ -13,7 +13,7 @@ In Odoo.sh, a build is considered as a database loaded by an Odoo server
running on a specific revision of your project repository in a containerized environment.
Its purpose is to test the well-behavior of the server, the database and the features with this revision.
.. image:: ./media/interface-builds.png
.. image:: builds/interface-builds.png
:align: center
In this view, a row represents a branch, and a cell of a row represents a build of this branch.
@@ -95,7 +95,7 @@ Features
The production branch will always appear first,
and then the other branches are ordered by last build created. You can filter out the branches.
.. image:: ./media/interface-builds-branches.png
.. image:: builds/interface-builds-branches.png
:align: center
For each branch, you can access the last build's database using the *Connect* link and jump to the branch code using
@@ -103,7 +103,7 @@ the *Github* link. For other branches than the production, you can create a new
of the branch using the link *rebuild*. This last link is not available when there is already a build in progress for
the branch.
.. image:: ./media/interface-builds-build.png
.. image:: builds/interface-builds-build.png
:align: center
For each build, you can access the revision changes using the button with the Github icon.
@@ -113,7 +113,7 @@ in the dropdown menu of the *Connect* button.
.. _odoosh-gettingstarted-builds-download-dump:
.. image:: ./media/interface-builds-build-dropdown.png
.. image:: builds/interface-builds-build-dropdown.png
:align: center
.. _odoosh-gettingstarted-builds-dropdown-menu:

Some files were not shown because too many files have changed in this diff Show More