Commit Graph

15 Commits

Author SHA1 Message Date
Sylvain Francis
fbc787474f [IMP] reference/cli: db-filter for Web UI
The odoo-bin help for the db-filter says:
`Regular expressions for filtering available databases for Web UI.`

However, the current documentation does not mention that the filters
only affect the Web UI, and not the cron workers.

closes odoo/documentation#15375

Signed-off-by: Sylvain Francis (syf) <syf+odoo@odoo.com>
2025-11-20 16:03:53 +00:00
Julien Castiaux
5279c3f988 [IMP] developer: new CLI commands and improvements
Added the existing `deploy`, `obfuscate`, `upgrade_code` commands.
Reviewed titles to make the commands stand out in the ToC.

task-4866527

fixes odoo/documentation#14046
backport of ef7efd613d

closes odoo/documentation#15213

Signed-off-by: Julien Castiaux (juc) <juc@odoo.com>
2025-11-17 14:08:12 +00:00
Alvaro Fuentes
feff94c007 [IMP] developer/reference/cli: improve docs of --upgrade-path
Be explicit about what we expect as parameter.

closes odoo/documentation#12571

X-original-commit: 942fd6dd41
Related: odoo/odoo#202583
Signed-off-by: Alvaro Fuentes Suarez (afu) <afu@odoo.com>
2025-03-20 12:25:56 +00:00
Alvaro Fuentes
3d16401d6d [IMP] developer/reference/cli: --pre-upgrade-scripts
Document the new cli option.

X-original-commit: bcad893864
Part-of: odoo/documentation#12571
Related: odoo/odoo#202583
Signed-off-by: Alvaro Fuentes Suarez (afu) <afu@odoo.com>
2025-03-20 12:25:56 +00:00
Odoo's Mergebot
47791ada79 [FW][IMP] developer/reference/cli: neutralize option
closes odoo/documentation#12171

Forward-port-of: odoo/documentation#11478
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Chris Smith <cgsmith105@gmail.com>
Co-authored-by: Chris Smith <chris@cgsmith.net>
2025-03-05 13:27:09 +00:00
William Braeckman
ea9c8bd807 [IMP] developer/reference/cli: --limit-time-cron-conn
Document the newly created config option.

closes odoo/documentation#11822

See: https://github.com/odoo/odoo/pull/194141
X-original-commit: de2241eb7c
Related: odoo/odoo#194705
Signed-off-by: William Braeckman (wbr) <wbr@odoo.com>
2025-01-22 15:58:12 +00:00
Jonathan Castillo (jcs)
10cd2a061b [MOV] documentation structure reorganization
This commit aims to improve the documentation's navigability by
redefining some categories' purposes and titles.

There is a redirection rule for each documentation page moved.
This ensures that users won't have a 404 error message.

task-3217827

closes odoo/documentation#8061

Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
2024-03-11 15:03:04 +00:00
Nathan Marotte (nama)
9776aa010c [ADD] Upgrade documentation: How-to-guide for developers
closes odoo/documentation#7335

X-original-commit: 44f4683519
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-01-11 08:46:59 +00:00
Julien Castiaux
c847bdc4dd [FIX] developer/reference/cli: log on stderr
Odoo is actually logging on sys.stderr and not sys.stdout[^1][^2][^3].

Remove passage about the workflows, the workflows were an OpenERP
feature removed almost a decade ago in odoo/odoo@98cb4719db.

Fixes: #7210

[^1]: b3b9b2b49e/odoo/netsvc.py (L156)
[^2]: b3b9b2b49e/odoo/netsvc.py (L198)
[^3]: https://docs.python.org/3/library/logging.handlers.html#logging.StreamHandler

closes odoo/documentation#7272

X-original-commit: c55e8f251a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Julien Castiaux (juc) <juc@odoo.com>
2024-01-05 03:24:45 +00:00
Julien Castiaux
e28bed32d0 [IMP] developer/reference/cli: --proxy-mode
Many customers struggle with their web server configuration, notably
regarding the `--proxy-mode` option and the way `X-Forwarded-*` HTTP
request headers are interpreted within Odoo.

The `--proxy-mode` section has been updated to cover the most common
misunderstandings and to give guidances on how to setup a web server.

Odoo always only takes the last entry of the `X-Forwarded-*` request
header because there are situations where it is not possible to
determine which last n-th entry to use. Employees might access their
odoo database via the internal network: connecting directly to nginx,
while customers might access the database via an additional proxy such
as cloudflare. The real IP of employees would be the last inside the
`X-Forwarded-For` chain, while the real IP of customers would be the
*second* last entry inside the chain. It would be incorrect to always
take the same nth last entry inside the chain. The cloudflare's own IP
address must be discarded from the chain. Web servers usually feature
a way to ignore trusted IP from the chain, a way so that the real IP
of the user is always the last entry inside the chain. Odoo relies on
such feature to be active and configured.

Prior discussions about `X-Forwarded-For`:
* odoo/odoo#104947
* odoo/odoo#118629
* odoo/odoo#139536

All `X-Forwarded-*` headers are ignored in case the `X-Forwarded-Host`
header is missing (even with `--proxy-mode`). System admin might be
tempted to not set this header and to set `Host` instead, this is
broken as this a user-agent would be able to spoof `X-Forwarded-Host`
and Odoo would use that instead of the correct `Host`.

Prior discussions about `X-Forwarded-Host`:
* odoo/odoo#63277
* odoo/odoo#70117

closes odoo/documentation#6743

X-original-commit: 3d91c57b57
Signed-off-by: Julien Castiaux (juc) <juc@odoo.com>
2023-12-03 08:26:32 +00:00
Rémy Voet (ryv)
6cb55a5cce [FIX] developer: fix bad documentation of --unaccent
In the CLI, `--unaccent` try to enable PostgreSQL unaccent extention
when odoo is responsible to create new database(s).

closes odoo/documentation#6244

X-original-commit: 1639d22efd
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Rémy Voet (ryv) <ryv@odoo.com>
2023-10-31 07:11:43 +00:00
Leloup Loïc (lole)
f18162fe2a [IMP] cli: add unit to memory options
The documentation is unclear about the unit used for the --limit-memory-soft
and --limit-memory-hard options of odoo-bin.  The unit used is bytes, but
it isn't mentioned and the default unit is shown in mebibytes, causing
confusion.

closes odoo/documentation#5794

X-original-commit: 9fadc3355d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-09-11 10:29:04 +00:00
Xavier (XPL)
ea53f06197 [REF] install: move intro to main install page and split by install type
This PR moves the introduction about the different installation methods and editions found on the
install/install.rst page directly under the main install/ page. It creates three pages, one per
installation method documented on the install/install.rst page (Docker being documented on
docker.com and maintained by us), and moves the related content there. In addition, it fixes various
typos/grammar issues and improves the content according to the documentation guidelines. Various
references and links across the documentation had to be fixed accordingly.

task-3459070

closes odoo/documentation#5543

X-original-commit: 91c28fd433
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2023-08-19 07:58:45 +02:00
Christophe Monniez
899ee1c4c1 [FIX] deploy: reference the config parameter
The deploy documentation is assuming that `/etc/odoo.conf` is the
default config file, which is not the case.

With this commit, the configuration file references the cli
documentation.

closes odoo/documentation#4808

X-original-commit: 8aed7988ba
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Christophe Monniez (moc) <moc@odoo.com>
2023-06-20 18:02:00 +02:00
Antoine Vandevenne (anv)
ed4b8c1320 [MOV] developer/cli: move "Command-line interface (CLI)" to the reference dir
task-2991663

closes odoo/documentation#3660

X-original-commit: 3dc6bb83c1
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-23 16:09:00 +01:00