diff options
Diffstat (limited to 'docs/installation.rst')
| -rw-r--r-- | docs/installation.rst | 114 |
1 files changed, 72 insertions, 42 deletions
diff --git a/docs/installation.rst b/docs/installation.rst index 4829c5d..2da0d94 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -189,49 +189,79 @@ deployed instance, simply look at your *ihatemoney.cfg*. Production values are recommended values for use in production. +`SQLALCHEMY_DATABASE_URI` +------------------------- -+-------------------------------+---------------------------------+----------------------------------------------------------------------------------------+ -| Setting name | Default | What does it do? | -+===============================+=================================+========================================================================================+ -| SQLALCHEMY_DATABASE_URI | ``sqlite:///tmp/ihatemoney.db`` | Specifies the type of backend to use and its location. More information on the | -| | | format used can be found on `the SQLAlchemy documentation`_. | -| | | | -| | | **Production value:** Set it to some path on your disk. Typically | -| | | ``sqlite:///home/ihatemoney/ihatemoney.db``. Do *not* store it under ``/tmp`` as this | -| | | folder is cleared at each boot. | -+-------------------------------+---------------------------------+----------------------------------------------------------------------------------------+ -| SECRET_KEY | ``tralala`` | The secret key used to encrypt the cookies. | -| | | | -| | | **Production value:** `ihatemoney conf-example ihatemoney.cfg` sets it to something | -| | | random, which is good. | -+-------------------------------+---------------------------------+----------------------------------------------------------------------------------------+ -| MAIL_DEFAULT_SENDER | ``("Budget manager", | A python tuple describing the name and email address to use when sending | -| | "budget@notmyidea.org")`` | emails. | -| | | | -| | | **Production value:** Any tuple you want. | -+-------------------------------+---------------------------------+----------------------------------------------------------------------------------------+ -| ACTIVATE_DEMO_PROJECT | ``True`` | If set to `True`, a demo project will be available on the frontpage. | -| | | | -| | | **Production value:** Usually, you will want to set it to ``False`` for a private | -| | | instance. | -+-------------------------------+---------------------------------+----------------------------------------------------------------------------------------+ -| | | Hashed password to access protected endpoints. If left empty, all administrative | -| ADMIN_PASSWORD | ``""`` | tasks are disabled. | -| | | | -| | | **Production value:** To generate the proper password HASH, use | -| | | ``ihatemoney generate_password_hash`` and copy the output into the value of | -| | | *ADMIN_PASSWORD*. | -+-------------------------------+---------------------------------+----------------------------------------------------------------------------------------+ -| ALLOW_PUBLIC_PROJECT_CREATION | ``True`` | If set to ``True``, everyone can create a project without entering the admin password | -| | | If set to ``False``, the password needs to be entered (and as such, defined in the | -| | | settings). | -+-------------------------------+---------------------------------+----------------------------------------------------------------------------------------+ -| ACTIVATE_ADMIN_DASHBOARD | ``False`` | If set to `True`, the dashboard will become accessible entering the admin password | -| | | If set to `True`, a non empty ADMIN_PASSWORD needs to be set | -+-------------------------------+---------------------------------+----------------------------------------------------------------------------------------+ -| APPLICATION_ROOT | ``""`` | If empty, ihatemoney will be served at domain root (e.g: *http://domain.tld*), if set | -| | | to ``"foo"``, it will be served from a "folder" (e.g: *http://domain.tld/foo*) | -+-------------------------------+---------------------------------+----------------------------------------------------------------------------------------+ +Specifies the type of backend to use and its location. More information on the +format used can be found on `the SQLAlchemy documentation`_. + +- **default value:** ``sqlite:///tmp/ihatemoney.db`` +- **Production value:** Set it to some path on your disk. Typically + ``sqlite:///home/ihatemoney/ihatemoney.db``. Do *not* store it under + ``/tmp`` as this folder is cleared at each boot. + +`SECRET_KEY` +------------ + +The secret key used to encrypt the cookies. + +- **Production value:** `ihatemoney conf-example ihatemoney.cfg` sets it to + something random, which is good. + +`MAIL_DEFAULT_SENDER` +--------------------- + +A python tuple describing the name and email address to use when sending emails. + +- **Default value:** ``("Budget manager", "budget@notmyidea.org")`` +- **Production value:** Any tuple you want. + +`ACTIVATE_DEMO_PROJECT` +----------------------- + +If set to `True`, a demo project will be available on the frontpage. + +- **Default value:** ``True`` +- **Production value:** Usually, you will want to set it to ``False`` for a + private instance. + +`ADMIN_PASSWORD` +---------------- + +Hashed password to access protected endpoints. If left empty, all administrative +tasks are disabled. + +- **Default value:** ``""`` (empty string) +- **Production value:** To generate the proper password HASH, use + ``ihatemoney generate_password_hash`` and copy the output into the value of + *ADMIN_PASSWORD*. + +`ALLOW_PUBLIC_PROJECT_CREATION` +------------------------------- + +If set to ``True``, everyone can create a project without entering the admin +password. If set to ``False``, the password needs to be entered (and as such, +defined in the settings). + +- **Default value:** : ``True``. + + +`ACTIVATE_ADMIN_DASHBOARD` +-------------------------- + +If set to `True`, the dashboard will become accessible entering the admin +password, if set to `True`, a non empty ADMIN_PASSWORD needs to be set. + +- **Default value**: ``False`` + +`APPLICATION_ROOT` +------------------ + +If empty, ihatemoney will be served at domain root (e.g: *http://domain.tld*), +if set to ``"somestring"``, it will be served from a "folder" +(e.g: *http://domain.tld/somestring*). + +- **Default value:** ``""`` (empty string) .. _the SQLAlchemy documentation: http://docs.sqlalchemy.org/en/latest/core/engines.html#database-urls |