Command-line interface: odoo-bin - Odoo 10.0

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 (requires -d).

-u <modules>, --update <modules>

comma-separated list of modules to update before running the server (requires -d).

--addons-path <directories>

comma-separated list of directories in which modules are stored. These directories are scanned for modules (nb: when and why?)

--workers <count>

if count is not 0 (the default), enables multiprocessing and sets up the specified number of HTTP workers (sub-processes processing HTTP and RPC requests).

A number of options allow limiting and recycling workers:

--limit-request <limit>

Number of requests a worker will process before being recycled and restarted.

Defaults to 8196.

--limit-memory-soft <limit>

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 2048MiB.

--limit-memory-hard <limit>

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 2560MiB.

--limit-time-cpu <limit>

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.

--limit-time-real <limit>

Prevents the worker from taking longer than <limit> seconds to process a request. If the limit is exceeded, the worker is killed.

Differs from --limit-time-cpu in that this is a "wall time" limit including e.g. SQL queries.

Defaults to 120.

--max-cron-threads <count>

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

-s, --save

saves the server configuration to the current configuration file ($HOME/.odoorc by default, and can be overridden using -c)

--proxy-mode

enables the use of X-Forwarded-* headers through Werkzeug's proxy support.

--test-enable

runs tests after installing modules

--dev <feature,feature,...,feature>
  • 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 t-debug='debugger'
  • (i)p(u)db: start the chosen python debugger in the code when an unexpected error is raised before logging and returning the error.

database

-r <user>, --db_user <user>

database username, used to connect to PostgreSQL.

-w <password>, --db_password <password>

database password, if using password authentication.

--db_host <hostname>

host for the database server

  • localhost on Windows
  • UNIX socket otherwise
--db_port <port>

port the database listens on, defaults to 5432

--db-filter <filter>

hides databases that do not match <filter>. The filter is a regular expression, with the additions that:

  • %h is replaced by the whole hostname the request is made on.

  • %d is replaced by the subdomain the request is made on, with the exception of www (so domain odoo.com and www.odoo.com both match the database odoo).

    These operations are case sensitive. Add option (?i) to match all databases (so domain odoo.com using (?i)%d matches the database Odoo).

--db-template <template>

when creating new databases from the database-management screens, use the specified template database. Defaults to template1.

--pg_path </path/to/postgresql/binaries>

Path to the PostgreSQL binaries that are used by the database manager to dump and restore databases. You have to specify this option only if these binaries are located in a non-standard directory.

Internationalisation

Use these options to translate Odoo to another language. See i18n section of the user manual. Option '-d' is mandatory. Option '-l' is mandatory in case of importation

--load-language <languages>

specifies the languages (separated by commas) for the translations you want to be loaded

-l, --language <language>

specify the language of the translation file. Use it with --i18n-export or --i18n-import

--i18n-export <filename>

export all sentences to be translated to a CSV file, a PO file or a TGZ archive and exit.

--i18n-import <filename>

import a CSV or a PO file with translations and exit. The '-l' option is required.

--i18n-overwrite

overwrites existing translation terms on updating a module or importing a CSV or a PO file.

--modules

specify modules to export. Use in combination with --i18n-export

built-in HTTP

--no-xmlrpc

do not start the HTTP or long-polling workers (may still start cron workers)

--xmlrpc-interface <interface>

TCP/IP address on which the HTTP server listens, defaults to 0.0.0.0 (all addresses)

--xmlrpc-port <port>

Port on which the HTTP server listens, defaults to 8069.

--longpolling-port <port>

TCP port for long-polling connections in multiprocessing or gevent mode, defaults to 8072. Not used in default (threaded) mode.

logging

By default, Odoo displays all logging of level info except for workflow logging (warning only), and log output is sent to stdout. Various options are available to redirect logging to other destinations and to customize the amount of logging output

--logfile <file>

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

--logrotate

enables log rotation daily, keeping 30 backups. Log rotation frequency and number of backups is not configurable.

--syslog

logs to the system's event logger: syslog on unices and the Event Log on Windows.

Neither is configurable

--log-db <dbname>

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

--log-handler <handler-spec>

LOGGER:LEVEL, enables LOGGER at the provided LEVEL e.g. odoo.models:DEBUG will enable all logging messages at or above DEBUG level in the models.

  • The colon : is mandatory
  • The logger can be omitted to configure the root (default) handler
  • If the level is omitted, the logger is set to INFO

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
--log-request

enable DEBUG logging for RPC requests, equivalent to --log-handler=odoo.http.rpc.request:DEBUG

--log-response

enable DEBUG logging for RPC responses, equivalent to --log-handler=odoo.http.rpc.response:DEBUG

--log-web

enables DEBUG logging of HTTP requests and responses, equivalent to --log-handler=odoo.http:DEBUG

--log-sql

enables DEBUG logging of SQL querying, equivalent to --log-handler=odoo.sql_db:DEBUG

--log-level <level>

Shortcut to more easily set predefined levels on specific loggers. "real" levels (critical, error, warn, debug) are set on the odoo and werkzeug loggers (except for debug which is only set on odoo).

Odoo also provides debugging pseudo-levels which apply to different sets of loggers:

debug_sql

sets the SQL logger to debug

equivalent to --log-sql

debug_rpc

sets the odoo and HTTP request loggers to debug

equivalent to --log-level debug --log-request

debug_rpc_answer

sets the odoo and HTTP request and response loggers to debug

equivalent to --log-level debug --log-request --log-response

Scaffolding

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.

-t <template>

a template directory, files are passed through jinja2 then copied to the destination directory

name

the name of the module to create, may munged in various manners to generate programmatic names (e.g. module directory name, model names, …)

destination

directory in which to create the new module, defaults to the current directory

Configuration file

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 - removed and other - are replaced by _ e.g. --db-template becomes db_template.

Some conversions don't match the pattern:

  • --db-filter becomes dbfilter
  • --no-xmlrpc corresponds to the xmlrpc boolean
  • logging presets (all options starting with --log- except for --log-handler and --log-db) just add content to log_handler, use that directly in the configuration file
  • --smtp is stored as smtp_server
  • --database is stored as db_name
  • --debug is stored as debug_mode (a boolean)
  • --i18n-import and --i18n-export aren't available at all from configuration files

The default configuration file is $HOME/.odoorc which can be overridden using --config. Specifying --save will save the current configuration state back to that file.