Parcourir la source

Improve installation doc

Mathieu il y a 6 ans
Parent
commit
b716e2598b
1 fichiers modifiés avec 19 ajouts et 11 suppressions
  1. 19 11
      README.md

+ 19 - 11
README.md

@@ -6,7 +6,12 @@ a virtual environment (like virtualenv).
 
 Install packages:
 
-     # apt-get install python3-pip python3-virtualenv libyaml-dev
+     # apt-get install python3-pip python3-virtualenv virtualenv libyaml-dev
+
+Retrieve the repository:
+
+    $ git clone https://code.ffdn.org/FFDN/wifi-with-me.git
+    $ cd wifi-with-me
 
 Create and activate the virtualenv with:
 
@@ -24,8 +29,8 @@ For development, install `dev.txt` instead:
 Set up configuration
 ====================
 
-Then create and edit a `wifiwithme/settings/local.py` configuration file
-`wifiwithme/settings/local.py`.
+Then create and edit the configuration file `wifiwithme/settings/local.py`
+according to following instructions:
 
 Mandatory settings
 ------------------
@@ -49,28 +54,31 @@ You **must** Define some details about your ISP in the ISP variable, eg:
         }
     }
 
-    SITE_URL='https://wifi.faimaison.net
+    SITE_URL='https://wifi.faimaison.net'
+    ALLOWED_HOST=['wifi.faimaison.net']
 
 Optional settings
 -----------------
 
 ### Website URL
 
-The wifi-with-me website URL (for links included in emails :)
-
-    SITE_URL="http://example.tld"
+The wifi-with-me website URL, for links included in emails (Defaults to
+`http://localhost:8000`):
 
-
-## URL Prefix
+    SITE_URL="https://example.com"
 
 Optionaly, you can define an url prefix (ex: `/foo/`) so that wifi-with-me is
-accessible under *http://example.com/foo/* :
+accessible under *http://example.com/foo/*:
 
     URL_PREFIX='foo/'
 
+If the website is accessible under several hostnames, list these here:
+
+    ALLOWED_HOST=['example.com', 'wifi.example.com']
+
 ### Notifications
 
-If you to receive notifications on each new contrib, customize those :
+If you want to receive notifications on each new contrib, customize those:
 
 List of notification recipients: