Command-line Params in ODOO Explained
Hello Community, Here are the Server Parameters using which you can perform operations by command-line while starting instance of OpenERP(V7) and V8 - ODOO. These will help you to perform some tasks directly from command-line while you start odoo using : python odoo.py or python openerp-server Here are the syntaxes and examples of command-line interface in V8 - ODOO.
-d <database>, --database <database>
database used when installing or updating modules, and -d is can't work alone so you will need to use any other parameter with this.
Eg. you can use -u with -d so u can update module directly using command-line before running the server.
python odoo.py -d database1 -u module1
-i <modules>, --init <modules>
comma-separated list of modules to install before running the server (requires -d).
python odoo.py -d database1 -i module1, module2, module3
-u <modules>, --update <modules>
comma-separated list of modules to update before running the server (requires -d).
python odoo.py -d database1 -u module1, module2, module3
comma-separated list of directories in which modules are stored. These directories are scanned for modules (nb: when and why?)(NOTE: Give the full path of addons<comma-separated> according to your system directories)
python odoo.py --addons-path=addons/,/home/serpentcs/custom_modules/
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).
python odoo.py --workers 4
A number of options allow limiting and recyling 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.
Differs from --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 multithreading mode and processes in multiprocessing mode.
For multiprocessing 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/.openerp_serverrc by default, overridable using -c)
enables the use of X-Forwarded-* headers through Werkzeug’s proxy support.
runs tests after installing modules
when an unexpected error is raised (not a warning or an access error), automatically starts pdb 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
- localhost on Windows
- 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:
- %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 andwww.odoo.com both match the database odoo)
when creating new databases from the database-management screens, use the specified template database. Defaults totemplate1.
do not start the HTTP or long-polling workers (may still start cron workers)
TCP/IP address on which the HTTP server listens, defaults to 0.0.0.0 (all addresses)
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 logging (warning only), and log output is sent to stdout. Various options are available to redirect logging to other destinations and to customize the amout 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:LEVEL, enables LOGGER at the provided LEVEL e.g. openerp.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.py --log-handler :DEBUG --log-handler werkzeug:CRITICAL --log-handler openerp.fields:WARNING
enable DEBUG logging for RPC requests, equivalent to --log-handler=openerp.http.rpc.request:DEBUG
enable DEBUG logging for RPC responses, equivalent to --log-handler=openerp.http.rpc.response:DEBUG
enables DEBUG logging of HTTP requests and responses, equivalent to --log-handler=openerp.http:DEBUG
enables DEBUG logging of SQL querying, equivalent to --log-handler=openerp.sql_db:DEBUG
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.py scaffold subcommand.
a template directory, files are passed through jinja2 then copied to the destination directory
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- 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 dbname
- --debug is stored as debug_mode (a boolean)
- --i18n-import and --i18n-export aren’t available at all from configuration files