diff --git a/trytond/doc/topics/configuration.rst b/trytond/doc/topics/configuration.rst index de51013c7c..86c9eb2d0b 100644 --- a/trytond/doc/topics/configuration.rst +++ b/trytond/doc/topics/configuration.rst @@ -37,11 +37,15 @@ asks them to be named like their module. :backlinks: entry :depth: 2 +.. _config-web: + web --- Defines the behavior of the web interface. +.. _config-web.listen: + listen ~~~~~~ @@ -54,12 +58,16 @@ Default ``localhost:8000`` To listen on all IPv4 interfaces use the value ``0.0.0.0:8000`` and for all IPv6 interfaces use ``[::]:8000``. +.. _config-web.hostname: + hostname ~~~~~~~~ Defines the hostname to use when generating a URL when there is no request context available, for example during a cron job. +.. _config-web.root: + root ~~~~ @@ -67,6 +75,8 @@ Defines the root path served by ``GET`` requests. Default: Under the ``www`` directory of user's home running ``trytond``. +.. _config-web.num_proxies: + num_proxies ~~~~~~~~~~~ @@ -74,6 +84,8 @@ The number of proxy servers in front of ``trytond``. Default: 0 +.. _config-web.cache_timeout: + cache_timeout ~~~~~~~~~~~~~ @@ -81,6 +93,8 @@ The cache timeout in seconds. Default: 12h +.. _config-web.cors: + cors ~~~~ @@ -92,6 +106,8 @@ For example:: http://example.com https://example.com +.. _config-web.avatar_base: + avatar_base ~~~~~~~~~~~ @@ -102,6 +118,8 @@ Default: ``''`` .. note:: It can be used to setup a CDN. +.. _config-web.avatar_timeout: + avatar_timeout ~~~~~~~~~~~~~~ @@ -109,11 +127,15 @@ The time in seconds that the avatar can be stored in cache. Default: 7 days +.. _config-database: + database -------- Defines how the database is managed. +.. _config-database.uri: + uri ~~~ @@ -161,6 +183,8 @@ The recognized query parameters can be found in SQLite's `documentation `__. +.. _config-database.path: + path ~~~~ @@ -170,6 +194,8 @@ The directory where Tryton stores files and so the user running Default: The :file:`db` folder under the user home directory running :command:`trytond`. +.. _config-database.list: + list ~~~~ @@ -177,6 +203,8 @@ A boolean value to list available databases. Default: ``True`` +.. _config-database.retry: + retry ~~~~~ @@ -184,6 +212,8 @@ The number of retries when a database operational error occurs during a request. Default: ``5`` +.. _config-database.subquery_threshold: + subquery_threshold ~~~~~~~~~~~~~~~~~~ @@ -191,6 +221,8 @@ The number of records in the target relation under which a sub-query is used. Default: ``1000`` +.. _config-database.language: + language ~~~~~~~~ @@ -199,6 +231,8 @@ table for translations. Default: ``en`` +.. _config-database.avatar_filestore: + avatar_filestore ~~~~~~~~~~~~~~~~ @@ -207,6 +241,8 @@ This configuration value indicates whether the avatars should be stored in the Default: ``False`` +.. _config-database.avatar_prefix: + avatar_prefix ~~~~~~~~~~~~~ @@ -214,12 +250,16 @@ The prefix to use with the :ref:`FileStore ` to store avatars. Default: ``None`` +.. _config-database.default_name: + default_name ~~~~~~~~~~~~ The name of the database to use for operations without a database name. Default: ``template1`` for PostgreSQL, ``:memory:`` for SQLite. +.. _config-database.timeout: + timeout ~~~~~~~ @@ -227,6 +267,8 @@ The timeout duration in seconds after which the connections to unused databases are closed. Default: ``1800`` (30 minutes) +.. _config-database.minconn: + minconn ~~~~~~~ @@ -234,12 +276,16 @@ The minimum number of connections to keep in the pool (if the backend supports pool) per process. Default: ``1`` +.. _config-database.maxconn: + maxconn ~~~~~~~ The maximum number of simultaneous connections to the database per process. Default: ``64`` +.. _config-database.unaccent_function: + unaccent_function ~~~~~~~~~~~~~~~~~ @@ -247,6 +293,8 @@ The name of the unaccent function. Default: ``unaccent`` +.. _config-database.similarity_function: + similarity_function ~~~~~~~~~~~~~~~~~~~ @@ -254,9 +302,13 @@ The name of the similarity function. Default: ``similarity`` +.. _config-request: + request ------- +.. _config-request.max_size: + max_size ~~~~~~~~ @@ -264,6 +316,8 @@ The maximum size in bytes of unauthenticated request (zero means no limit). Default: 2MB +.. _config-request.max_size_authenticated: + max_size_authenticated ~~~~~~~~~~~~~~~~~~~~~~ @@ -271,6 +325,8 @@ The maximum size in bytes of an authenticated request (zero means no limit). Default: 2GB +.. _config-request.timeout: + timeout ~~~~~~~ @@ -279,11 +335,15 @@ depending on the parameters. Default: ``60`` +.. _config-cache: + cache ----- Defines size of various cache. +.. _config-cache.transaction: + transaction ~~~~~~~~~~~ @@ -291,6 +351,8 @@ The number of contextual caches kept per transaction. Default: ``10`` +.. _config-cache.model: + model ~~~~~ @@ -298,6 +360,8 @@ The number of different model kept in the cache per transaction. Default: ``200`` +.. _config-cache.record: + record ~~~~~~ @@ -307,6 +371,8 @@ It can be changed locally using the ``_record_cache_size`` key in Default: ``2000`` +.. _config-cache.field: + field ~~~~~ @@ -315,6 +381,8 @@ The number of field to load with an ``eager`` :attr:`Field.loading Default: ``100`` +.. _config-cache.default: + default ~~~~~~~ @@ -322,6 +390,8 @@ The default :attr:`~trytond.cache.Cache.size_limit` of :class:`~trytond.cache.Ca Default: ``1024`` +.. _config-cache.clean_timeout: + clean_timeout ~~~~~~~~~~~~~ @@ -331,6 +401,8 @@ channels if the back-end supports them. Default: ``300`` +.. _config-cache.count_timeout: + count_timeout ~~~~~~~~~~~~~ @@ -338,6 +410,8 @@ The cache timeout duration in seconds of the estimation of records. Default: ``86400`` (1 day) +.. _config-cache.count_clear: + count_clear ~~~~~~~~~~~ @@ -346,9 +420,13 @@ cleared. Default: ``1000`` +.. _config-queue: + queue ----- +.. _config-queue.worker: + worker ~~~~~~ @@ -357,6 +435,8 @@ the end of the requests. Default: ``False`` +.. _config-queue.clean_days: + clean_days ~~~~~~~~~~ @@ -364,6 +444,8 @@ The number of days after which processed tasks are removed. Default: ``30`` +.. _config-queue.batch_size: + batch_size ~~~~~~~~~~ @@ -371,9 +453,13 @@ The default number of the instances to process in a batch. Default: ``20`` +.. _config-error: + error ----- +.. _config-error.clean_days: + clean_days ~~~~~~~~~~ @@ -381,6 +467,8 @@ The number of days after which reported errors are removed. Default: ``90`` +.. _config-table: + table ----- @@ -394,6 +482,8 @@ For example:: account.invoice.line = acc_inv_line account.invoice.tax = acc_inv_tax +.. _config-ssl: + ssl --- @@ -401,11 +491,15 @@ Activates SSL_ on the web interface. .. note:: It is recommended to delegate the SSL support to a proxy. +.. _config-ssl.privatekey: + privatekey ~~~~~~~~~~ The path to the private key. +.. _config-ssl.certificate: + certificate ~~~~~~~~~~~ @@ -415,11 +509,15 @@ The path to the certificate. Set only one of ``privatekey`` or ``certificate`` to ``true`` if the SSL is delegated. +.. _config-email: + email ----- .. note:: Email settings can be tested with the ``trytond-admin`` command +.. _config-email.uri: + uri ~~~ @@ -442,6 +540,8 @@ The uri accepts the following additional parameters: Default: ``smtp://localhost:25`` +.. _config-email.from: + from ~~~~ @@ -454,6 +554,8 @@ For example:: Default: The login name of the :abbr:`OS (Operating System)` user. +.. _config-email.retry: + retry ~~~~~ @@ -461,9 +563,13 @@ The number of retries when the SMTP server returns a temporary error. Default: ``5`` +.. _config-session: + session ------- +.. _config-session.authentications: + authentications ~~~~~~~~~~~~~~~ @@ -497,6 +603,8 @@ refer to their documentation for more information. Default: ``password`` +.. _config-session.authentication_ip_network: + authentication_ip_network ~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -505,6 +613,8 @@ authentication method option. Default: ``''`` +.. _config-session.max_age: + max_age ~~~~~~~ @@ -512,6 +622,8 @@ The time in seconds that a session stay valid. Default: ``2592000`` (30 days) +.. _config-session.timeout: + timeout ~~~~~~~ @@ -519,6 +631,8 @@ The time in seconds without activity before the session is no more fresh. Default: ``300`` (5 minutes) +.. _config-session.max_attempt: + max_attempt ~~~~~~~~~~~ @@ -528,6 +642,8 @@ attempts over a period of ``timeout``. Default: ``5`` +.. _config-session.max_attempt_ip_network: + max_attempt_ip_network ~~~~~~~~~~~~~~~~~~~~~~ @@ -537,6 +653,8 @@ counting is done on all attempts over a period of ``timeout``. Default: ``300`` +.. _config-session.ip_network_4: + ip_network_4 ~~~~~~~~~~~~ @@ -545,6 +663,8 @@ attempts. Default: ``32`` +.. _config-session.ip_network_6: + ip_network_6 ~~~~~~~~~~~~ @@ -553,9 +673,13 @@ attempts. Default: ``56`` +.. _config-password: + password -------- +.. _config-password.length: + length ~~~~~~ @@ -563,11 +687,15 @@ The minimal length required for the user password. Default: ``8`` +.. _config-password.forbidden: + forbidden ~~~~~~~~~ The path to a file containing one forbidden password per line. +.. _config-password.reset_timeout: + reset_timeout ~~~~~~~~~~~~~ @@ -575,6 +703,8 @@ The time in seconds until the reset password expires. Default: ``86400`` (24h) +.. _config-password.passlib: + passlib ~~~~~~~ @@ -585,11 +715,15 @@ If no path is set, Tryton will use the schemes ``argon2``, ``scrypt``, Default: ``None`` +.. _config-attachment: + attachment ---------- Defines how to store the attachments +.. _config-attachment.filestore: + filestore ~~~~~~~~~ @@ -597,6 +731,8 @@ A boolean value to store attachment in the :ref:`FileStore `. Default: ``True`` +.. _config-attachment.store_prefix: + store_prefix ~~~~~~~~~~~~ @@ -604,9 +740,13 @@ The prefix to use with the ``FileStore``. Default: ``None`` +.. _config-bus: + bus --- +.. _config-bus.allow_subscribe: + allow_subscribe ~~~~~~~~~~~~~~~ @@ -614,11 +754,15 @@ A boolean value to allow clients to subscribe to bus channels. Default: ``False`` +.. _config-bus.url_host: + url_host ~~~~~~~~ If set redirects bus requests to the host URL. +.. _config-bus.long_polling_timeout: + long_polling_timeout ~~~~~~~~~~~~~~~~~~~~ @@ -627,6 +771,8 @@ polling for bus messages Default: ``300`` +.. _config-bus.cache_timeout: + cache_timeout ~~~~~~~~~~~~~ @@ -635,6 +781,8 @@ discarded. Default: ``300`` +.. _config-bus.select_timeout: + select_timeout ~~~~~~~~~~~~~~ @@ -642,9 +790,13 @@ The timeout duration of the select call when listening on a channel. Default: ``5`` +.. _config-html: + html ---- +.. _config-html.src: + src ~~~ @@ -652,6 +804,8 @@ The URL pointing to `TinyMCE `_ editor. Default: ``https://cloud.tinymce.com/stable/tinymce.min.js`` +.. _config-html.plugins: + plugins ~~~~~~~ @@ -661,6 +815,8 @@ It can be overridden for specific models and fields using the names: Default: ``''`` +.. _config-html.css: + css ~~~ @@ -670,6 +826,8 @@ It can be overridden for specific models and fields using the names: Default: ``[]`` +.. _config-html.class: + class ~~~~~ @@ -679,6 +837,8 @@ It can be overridden for specific models and fields using the names: Default: ``''`` +.. _config-wsgi_middleware: + wsgi middleware ---------------