238 lines
4.5 KiB
ReStructuredText
238 lines
4.5 KiB
ReStructuredText
.. _topics-configuration:
|
|
|
|
=============================
|
|
Configuration file for Tryton
|
|
=============================
|
|
|
|
The configuration file controls some aspects of the behavior of Tryton.
|
|
The file uses a simple ini-file format. It consists of sections, led by a
|
|
`[section]` header and followed by `name = value` entries:
|
|
|
|
.. highlight:: ini
|
|
|
|
::
|
|
|
|
[database]
|
|
uri = postgresql://user:password@localhost/
|
|
path = /var/lib/trytond
|
|
|
|
For more information see ConfigParser_.
|
|
|
|
.. _ConfigParser: http://docs.python.org/2/library/configparser.html
|
|
|
|
Sections
|
|
========
|
|
|
|
This section describes the different main sections that may appear in a Tryton
|
|
configuration file, the purpose of each section, its possible keys, and their
|
|
possible values.
|
|
Some modules could request the usage of other sections for which the guideline
|
|
asks them to be named like their module.
|
|
|
|
web
|
|
---
|
|
|
|
Defines the behavior of the web interface.
|
|
|
|
listen
|
|
~~~~~~
|
|
|
|
Defines the couple of host (or IP address) and port number separated by a colon
|
|
to listen on.
|
|
|
|
Default `localhost:8000`
|
|
|
|
hostname
|
|
~~~~~~~~
|
|
|
|
Defines the hostname.
|
|
|
|
root
|
|
~~~~
|
|
|
|
Defines the root path served by `GET` requests.
|
|
|
|
Default: `/var/www/localhost/tryton`
|
|
|
|
database
|
|
--------
|
|
|
|
Defines how the database is managed.
|
|
|
|
uri
|
|
~~~
|
|
|
|
Contains the URI to connect to the SQL database. The URI follows the RFC-3986_.
|
|
The typical form is:
|
|
|
|
database://username:password@host:port/
|
|
|
|
Default: `sqlite://`
|
|
|
|
The available databases are:
|
|
|
|
PostgreSQL
|
|
**********
|
|
|
|
`pyscopg2` supports two type of connections:
|
|
|
|
- TCP/IP connection: `postgresql://user:password@localhost:5432/`
|
|
- Unix domain connection: `postgresql://username:password@/`
|
|
|
|
SQLite
|
|
******
|
|
|
|
The only possible URI is: `sqlite://`
|
|
|
|
MySQL
|
|
*****
|
|
|
|
Same as for PostgreSQL.
|
|
|
|
path
|
|
~~~~
|
|
|
|
The directory where Tryton stores files and so the user running `trytond`
|
|
must have write access on this directory.
|
|
|
|
Default: `/var/lib/trytond/`
|
|
|
|
list
|
|
~~~~
|
|
|
|
A boolean value to list available databases.
|
|
|
|
Default: `True`
|
|
|
|
retry
|
|
~~~~~
|
|
|
|
The number of retries when a database operational error occurs during a request.
|
|
|
|
Default: `5`
|
|
|
|
language
|
|
~~~~~~~~
|
|
|
|
The main language of the database that will be used for storage in the main
|
|
table for translations.
|
|
|
|
Default: `en_US`
|
|
|
|
cache
|
|
-----
|
|
|
|
Defines size of various cache.
|
|
|
|
model
|
|
~~~~~
|
|
|
|
The number of different model kept in the cache per transaction.
|
|
|
|
Default: `200`
|
|
|
|
record
|
|
~~~~~~
|
|
|
|
The number of record loaded kept in the cache of the list.
|
|
It can be changed locally using the `_record_cache_size` key in
|
|
:attr:`Transaction.context`.
|
|
|
|
Default: `2000`
|
|
|
|
field
|
|
~~~~~
|
|
|
|
The number of field to load with an `eager` :attr:`Field.loading`.
|
|
|
|
Default: `100`
|
|
|
|
table
|
|
-----
|
|
|
|
This section allows to override the default generated table name for a
|
|
:class:`ModelSQL`. The main goal is to bypass limitation on the name length of
|
|
the database backend.
|
|
For example::
|
|
|
|
[table]
|
|
account.invoice.line = acc_inv_line
|
|
account.invoice.tax = acc_inv_tax
|
|
|
|
ssl
|
|
---
|
|
|
|
Activates SSL_ on all network protocols.
|
|
|
|
.. note:: SSL_ is activated by defining privatekey.
|
|
Please refer to SSL-CERT_ on how to use private keys and certficates.
|
|
|
|
privatekey
|
|
~~~~~~~~~~
|
|
|
|
The path to the private key.
|
|
|
|
certificate
|
|
~~~~~~~~~~~
|
|
|
|
The path to the certificate.
|
|
|
|
email
|
|
-----
|
|
|
|
uri
|
|
~~~
|
|
|
|
The SMTP-URL_ to connect to the SMTP server which is extended to support SSL_
|
|
and STARTTLS_.
|
|
The available protocols are:
|
|
|
|
- `smtp`: simple SMTP
|
|
- `smtp+tls`: SMTP with STARTTLS
|
|
- `smtps`: SMTP with SSL
|
|
|
|
Default: `smtp://localhost:25`
|
|
|
|
from
|
|
~~~~
|
|
|
|
Defines the default `From` address for emails sent by Tryton.
|
|
|
|
session
|
|
-------
|
|
|
|
timeout
|
|
~~~~~~~
|
|
|
|
The time in seconds until a session expires.
|
|
|
|
Default: `600`
|
|
|
|
super_pwd
|
|
~~~~~~~~~
|
|
|
|
The server password used to authenticate from the client for database
|
|
management tasks. It is encrypted using using the Unix `crypt(3)` routine.
|
|
A password can be generated using this command line::
|
|
|
|
python -c 'import getpass,crypt,random,string; print crypt.crypt(getpass.getpass(), "".join(random.sample(string.ascii_letters + string.digits, 8)))'
|
|
|
|
report
|
|
------
|
|
|
|
unoconv
|
|
~~~~~~~
|
|
|
|
The parameters for `unoconv`.
|
|
|
|
Default: `pipe,name=trytond;urp;StarOffice.ComponentContext`
|
|
|
|
|
|
.. _JSON-RPC: http://en.wikipedia.org/wiki/JSON-RPC
|
|
.. _XML-RPC: http://en.wikipedia.org/wiki/XML-RPC
|
|
.. _RFC-3986: http://tools.ietf.org/html/rfc3986
|
|
.. _SMTP-URL: http://tools.ietf.org/html/draft-earhart-url-smtp-00
|
|
.. _SSL: http://en.wikipedia.org/wiki/Secure_Sockets_Layer
|
|
.. _SSL-CERT: https://docs.python.org/library/ssl.html#ssl.wrap_socket
|
|
.. _STARTTLS: http://en.wikipedia.org/wiki/STARTTLS
|