Browse Source

Add new settings documention

Jocelyn Delande 9 years ago
parent
commit
114449fa25
1 changed files with 22 additions and 2 deletions
  1. 22 2
      README.md

+ 22 - 2
README.md

@@ -24,13 +24,33 @@ For development, install `dev.txt` requirements too:
 Set up configuration
 ====================
 
-Create and edit configuration file `wifiwithme/settings/local.py`
-following this example:
+You may want to create and edit configuration file
+`wifiwithme/settings/local.py` (no setting is mandatory at the
+moment):
+
+URL Prefix
+----------
+
+Optionaly, you can define an url prefix (ex: `/foo/`) so that wifi-with-me is
+accessible under *http://example.com/foo/* :
+
+    URL_PREFIX='foo/'
+
+Notifications
+-------------
+
+If you to receive notifications on each new contrib, customize those :
+
+List of notification recipients:
 
     NOTIFICATION_EMAILS=['admin@example.tld']
 
+Notification sender address:
+
     DEFAULT_FROM_EMAIL='notifier@example.tld'
 
+The wifi-with-me website URL (for links included in emails :)
+
     SITE_URL="http://example.tld"
 
 But theses are optional settings for testing.