Better document configuration files location and override

This commit is contained in:
Baptiste Jonglez 2021-10-10 18:34:24 +02:00
parent bbe00ebb57
commit c1ef4033b6

View file

@ -13,6 +13,21 @@ To know defaults on your deployed instance, simply look at your
"Production values" are the recommended values for use in production. "Production values" are the recommended values for use in production.
Configuration files
-------------------
By default, Ihatemoney loads its configuration from ``/etc/ihatemoney/ihatemoney.cfg``.
If you need to load the configuration from a custom path, you can define the
``IHATEMONEY_SETTINGS_FILE_PATH`` environment variable with the path to the configuration
file.
For instance ::
export IHATEMONEY_SETTINGS_FILE_PATH="/path/to/your/conf/file.cfg"
The path should be absolute. A relative path will be interpreted as being
inside ``/etc/ihatemoney/``.
`SQLALCHEMY_DATABASE_URI` `SQLALCHEMY_DATABASE_URI`
------------------------- -------------------------
@ -142,12 +157,3 @@ possible to configure it to act differently, thanks to the great
* **MAIL_PASSWORD** : default **None** * **MAIL_PASSWORD** : default **None**
* **DEFAULT_MAIL_SENDER** : default **None** * **DEFAULT_MAIL_SENDER** : default **None**
Using an alternate settings path
--------------------------------
You can put your settings file where you want, and pass its path to the
application using the ``IHATEMONEY_SETTINGS_FILE_PATH`` environment variable.
For instance ::
export IHATEMONEY_SETTINGS_FILE_PATH="/path/to/your/conf/file.cfg"