Running the server
-d <database>, --database <database>
database used when installing or updating modules.
-i <modules>, --init <modules>
comma-separated list of modules to install before running the server
-u <modules>, --update <modules>
comma-separated list of modules to update before running the server
comma-separated list of directories in which modules are stored. These directories are scanned for modules (nb: when and why?)
count is not 0 (the default), enables multiprocessing and sets up
the specified number of HTTP workers (sub-processes processing HTTP
and RPC requests).
multiprocessing mode is only available on Unix-based systems
A number of options allow limiting and recycling workers:
Number of requests a worker will process before being recycled and restarted.
Defaults to 8196.
Maximum allowed virtual memory per worker. If the limit is exceeded, the worker is killed and recycled at the end of the current request.
Defaults to 640MB.
Hard limit on virtual memory, any worker exceeding the limit will be immediately killed without waiting for the end of the current request processing.
Defaults to 768MB.
Prevents the worker from using more than <limit> CPU seconds for each request. If the limit is exceeded, the worker is killed.
Defaults to 60.
Prevents the worker from taking longer than <limit> seconds to process a request. If the limit is exceeded, the worker is killed.
--limit-time-cpu in that this is a "wall time"
limit including e.g. SQL queries.
Defaults to 120.
number of workers dedicated to cron jobs. Defaults to 2. The workers are threads in multi-threading mode and processes in multi-processing mode.
For multi-processing mode, this is in addition to the HTTP worker processes.
-c <config>, --config <config>
provide an alternate configuration file
saves the server configuration to the current configuration file
$HOME/.odoorc by default, and can be overridden using
enables the use of
X-Forwarded-* headers through Werkzeug's proxy
proxy mode must not be enabled outside of a reverse proxy scenario
runs tests after installing modules
all: all the features below are activated
xml: read template qweb from xml file directly instead of database. Once a template has been modified in database, it will be not be read from the xml file until the next update/init.
reload: restart server when python file are updated (may not be detected depending on the text editor used)
qweb: break in the evaluation of qweb template when a node contains
(i)p(u)db: start the chosen python debugger in the code when an unexpected error is raised before logging and returning the error.
-r <user>, --db_user <user>
database username, used to connect to PostgreSQL.
-w <password>, --db_password <password>
database password, if using password authentication.
host for the database server
- UNIX socket otherwise
port the database listens on, defaults to 5432
hides databases that do not match
<filter>. The filter is a
regular expression, with the additions that:
%his replaced by the whole hostname the request is made on.
%dis replaced by the subdomain the request is made on, with the exception of
www.odoo.comboth match the database
when creating new databases from the database-management screens, use the
specified template database. Defaults to
do not start the HTTP or long-polling workers (may still start cron workers)
has no effect if
--test-enable is set, as tests
require an accessible HTTP server
TCP/IP address on which the HTTP server listens, defaults to
Port on which the HTTP server listens, defaults to 8069.
TCP port for long-polling connections in multiprocessing or gevent mode, defaults to 8072. Not used in default (threaded) mode.
By default, Odoo displays all logging of level
info except for workflow
warning only), and log output is sent to
options are available to redirect logging to other destinations and to
customize the amount of logging output
sends logging output to the specified file instead of stdout. On Unix, the file can be managed by external log rotation programs and will automatically be reopened when replaced
enables log rotation daily, keeping 30 backups. Log rotation frequency and number of backups is not configurable.
Neither is configurable
logs to the
ir.logging model (
ir_logging table) of the specified
database. The database can be the name of a database in the "current"
PostgreSQL, or a PostgreSQL URI for e.g. log aggregation
LOGGER at the provided
odoo.models:DEBUG will enable all logging messages at or above
DEBUG level in the models.
- The colon
- The logger can be omitted to configure the root (default) handler
- If the level is omitted, the logger is set to
The option can be repeated to configure multiple loggers e.g.
$ odoo-bin --log-handler :DEBUG --log-handler werkzeug:CRITICAL --log-handler odoo.fields:WARNING
enable DEBUG logging for RPC requests, equivalent to
enable DEBUG logging for RPC responses, equivalent to
enables DEBUG logging of HTTP requests and responses, equivalent to
enables DEBUG logging of SQL querying, equivalent to
Shortcut to more easily set predefined levels on specific loggers. "real"
debug) are set on the
werkzeug loggers (except for
debug which is only
Odoo also provides debugging pseudo-levels which apply to different sets of loggers:
sets the SQL logger to
odooand HTTP request loggers to
--log-level debug --log-request
odooand HTTP request and response loggers to
--log-level debug --log-request --log-response
Scaffolding is the automated creation of a skeleton structure to simplify bootstrapping (of new modules, in the case of Odoo). While not necessary it avoids the tedium of setting up basic structures and looking up what all starting requirements are.
Scaffolding is available via the odoo-bin scaffold subcommand.
a template directory, files are passed through jinja2 then copied to
the name of the module to create, may munged in various manners to generate programmatic names (e.g. module directory name, model names, …)
directory in which to create the new module, defaults to the current directory
Most of the command-line options can also be specified via a configuration
file. Most of the time, they use similar names with the prefix
- are replaced by
Some conversions don't match the pattern:
--no-xmlrpccorresponds to the
- logging presets (all options starting with
--log-db) just add content to
log_handler, use that directly in the configuration file
--smtpis stored as
--databaseis stored as
--debugis stored as
--i18n-exportaren't available at all from configuration files