almet/ihatemoney
1
0
Fork 0
mirror of https://github.com/spiral-project/ihatemoney.git synced 2025-05-05 20:51:49 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update installation doc to include doc about production values, fix #266.

Browse source
This commit is contained in:
Phyks (Lucas Verney) 2017-10-30 03:41:04 +01:00
parent b94bad829c
commit f6427d0683
2 changed files with 28 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
docs/installation.rst
View file

@ -157,28 +157,43 @@ properly.
Defaults given here, are those for development mode. To know defaults on your Defaults given here, are those for development mode. To know defaults on your
deployed instance, simply look at your *ihatemoney.cfg*. deployed instance, simply look at your *ihatemoney.cfg*.
Production values are recommended values for use in production.
+-------------------------------+---------------------------------+----------------------------------------------------------------------------------------+ +-------------------------------+---------------------------------+----------------------------------------------------------------------------------------+
| Setting name | Default | What does it do? | | 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 | | 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`_. | | | | 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. `ihatemoney conf-example ihatemoney.cfg` | | SECRET_KEY | ``tralala`` | The secret key used to encrypt the cookies. |
| | | sets it to something random, which is good. | | | | |
| | | **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 adress to use when sending | | MAIL_DEFAULT_SENDER | ``("Budget manager", | A python tuple describing the name and email adress to use when sending |
| | "budget@notmyidea.org")`` | emails. | | | "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. | | 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 | | | | Hashed password to access protected endpoints. If left empty, all administrative |
| ADMIN_PASSWORD | ``""`` | tasks are disabled. | | ADMIN_PASSWORD | ``""`` | tasks are disabled. |
| | | To generate the proper password HASH, use ``ihatemoney generate_password_hash`` | | | | |
| | | and copy the output into the value of *ADMIN_PASSWORD*. | | | | **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 | | 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 | | | | If set to ``False``, the password needs to be entered (and as such, defined in the |
| | | settings). | | | | settings). |
+-------------------------------+---------------------------------+----------------------------------------------------------------------------------------+ +-------------------------------+---------------------------------+----------------------------------------------------------------------------------------+
| ACTIVATE_ADMIN_DASHBOARD | ``False`` | If set to `True`, the dashboard will become accessible entering the admin password | | ACTIVATE_ADMIN_DASHBOARD | ``False`` | If set to `True`, the dashboard will become accessible entering the admin password |

7
ihatemoney/run.py
View file

@ -28,6 +28,13 @@ def setup_database(app):
alembic_setup = db.engine.dialect.has_table(con, 'alembic_version') alembic_setup = db.engine.dialect.has_table(con, 'alembic_version')
return tables_exist and not alembic_setup return tables_exist and not alembic_setup
sqlalchemy_url = app.config.get('SQLALCHEMY_DATABASE_URI')
if sqlalchemy_url.startswith('sqlite:////tmp'):
warnings.warn(
'The database is currently stored in /tmp and might be lost at '
'next reboot.'
)
db.init_app(app) db.init_app(app)
db.app = app db.app = app