aboutsummaryrefslogtreecommitdiff
path: root/ihatemoney/conf-templates/ihatemoney.cfg.j2
diff options
context:
space:
mode:
authorJocelynDelalande <JocelynDelalande@users.noreply.github.com>2017-10-23 18:05:50 +0200
committerAlexis Metaireau <alexis@notmyidea.org>2017-10-23 18:05:50 +0200
commite3285bef364a675f97b9e4f08c47a45405399561 (patch)
tree3b9caa6f10a544de6f635ed570a1f3223229003e /ihatemoney/conf-templates/ihatemoney.cfg.j2
parentefd2b66ac6dd5018939e4d8a9ed5e6bc326559bf (diff)
downloadihatemoney-mirror-e3285bef364a675f97b9e4f08c47a45405399561.zip
ihatemoney-mirror-e3285bef364a675f97b9e4f08c47a45405399561.tar.gz
ihatemoney-mirror-e3285bef364a675f97b9e4f08c47a45405399561.tar.bz2
Enhance install process by generating config files from templates (#275)
* Add a command to generate configuration examples Config files are generated from templates (which remplace previous example files). - solve the issue of hard-to-explain configuration examples - ease pkg path seeking (avoid it, actually) - add working defaults for sqlite and unix socket paths (instead of /replace/me/path/example) - move settings comments from default_settings.py to ihatemoney.cfg.j2, as it is the one that will be facing user. * Use generate-config command in install doc Also follow the new working defaults of templates for socket and db path. * Fix doc settings table On the long term, plaintext tables might destroy humanity. * Mention templates dir URL in documentation As requested by @almet
Diffstat (limited to 'ihatemoney/conf-templates/ihatemoney.cfg.j2')
-rw-r--r--ihatemoney/conf-templates/ihatemoney.cfg.j236
1 files changed, 36 insertions, 0 deletions
diff --git a/ihatemoney/conf-templates/ihatemoney.cfg.j2 b/ihatemoney/conf-templates/ihatemoney.cfg.j2
new file mode 100644
index 0000000..5dfb9d4
--- /dev/null
+++ b/ihatemoney/conf-templates/ihatemoney.cfg.j2
@@ -0,0 +1,36 @@
+# You can find more information about what these settings mean in the
+# documentation, available online at
+# http://ihatemoney.readthedocs.io/en/latest/installation.html#configuration
+
+# Turn this on if you want to have more output on what's happening under the
+# hood. DO NOT TURN IT ON IN PRODUCTION.
+DEBUG = False
+
+# The database URI, reprensenting the type of database and how to connect to it.
+# Enter an absolute path here.
+SQLALCHEMY_DATABASE_URI = 'sqlite:///var/lib/ihatemoney/ihatemoney.sqlite'
+SQLACHEMY_ECHO = DEBUG
+
+# Will likely become the default value in flask-sqlalchemy >=3 ; could be removed
+# then:
+SQLALCHEMY_TRACK_MODIFICATIONS = False
+
+# This secret key is random and auto-generated, it protects cookies and user sessions
+SECRET_KEY = "{{ secret_key }}"
+
+# A python tuple describing the name and email adress of the sender of the mails.
+MAIL_DEFAULT_SENDER = ("Budget manager", "budget@notmyidea.org") # CUSTOMIZE
+
+# If set to True, a demonstration project will be activated.
+ACTIVATE_DEMO_PROJECT = True
+
+# If not empty, the specified password must be entered to create new projects.
+# DO NOT enter the password in cleartext. Generate a password hash with
+# "ihatemoney generate_password_hash" instead.
+ADMIN_PASSWORD = ""
+
+# If set to True (default value) anyone can create a new project.
+ALLOW_PUBLIC_PROJECT_CREATION = True
+
+# If set to True, an administration dashboard is available.
+ACTIVATE_ADMIN_DASHBOARD = False