aboutsummaryrefslogtreecommitdiffstats
path: root/conf
diff options
context:
space:
mode:
authorMatthew Somerville <matthew-github@dracos.co.uk>2014-11-26 16:21:46 +0000
committerMatthew Somerville <matthew-github@dracos.co.uk>2014-11-26 16:21:46 +0000
commit7903d4475b45cd09de5d89e04dfd0a90b13ea079 (patch)
treee308557bd4a0d678e05b2f0e9fdd611ec89d9e4a /conf
parentea829cf5596513bbeb6868f652ae11324439ee82 (diff)
Provide guidance at top of example config file.
Diffstat (limited to 'conf')
-rw-r--r--conf/general.yml-example15
1 files changed, 11 insertions, 4 deletions
diff --git a/conf/general.yml-example b/conf/general.yml-example
index e98022052..fc20a90ea 100644
--- a/conf/general.yml-example
+++ b/conf/general.yml-example
@@ -1,10 +1,17 @@
# general.yml-example:
-# Example values for the "general" config file.
+# This file contains example values for the "general.yml" config file. It
+# contains various configuration parameters, in YAML syntax.
#
-# Configuration parameters, in YAML syntax.
+# For more information about this file, and general documentation on setting up
+# the FixMyStreet platform, please see http://fixmystreet.org/
#
-# Copy this file to one called "general.yml" in the same directory. Or
-# have multiple config files and use a symlink to change between them.
+# Specific details about this file can be found at
+# http://fixmystreet.org/customising/config/
+#
+# To start, you can copy this file to one called "general.yml" in the same
+# directory. Or have multiple config files and use a symlink to change between
+# them. Using the install script or AMI will have created a general.yml file
+# for you.
# PostgreSQL database details for FixMyStreet
FMS_DB_HOST: 'localhost'