Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Update docs for editing config through admin interface.

Change around order of field in admin interface to make
initial config a bit more sensible.
  • Loading branch information...
commit 76bea9fce3b13b4f2fb91fdc4d312ffe733b7e30 1 parent 2f3fbf6
@struan struan authored
View
6 README.pod
@@ -58,7 +58,7 @@ Create a new Apache vhost based on C<conf/httpd-conf.example>
=item *
Copy C<conf/general.yml-example> to C<conf/general.yml> and update
-the defaults accordingly.
+the database details.
=item *
@@ -70,6 +70,10 @@ Restart the webserver
=item *
+Visit C</admin/config> and update the configuration for your site.
+
+=item *
+
Edit the crontab from C<conf/crontab> to replace the placeholders and
install it. See C<notes/INSTALL.pod> for more details on the placeholders.
View
38 notes/INSTALL.pod
@@ -164,41 +164,39 @@ packaging system.
=head1 SETTINGS
-The settings for FixMyStreet are defined in C<conf/general.yml> using the YAML
-markup language. There are some defaults in C<conf/general.yml-example> which
-you should copy to C<conf/general.yml>.
+The database settings for FixMyStreet are defined in C<conf/general.yml> using
+YAML. You can copy C<conf/general.yml-example> and edit the settings in there.
-The bare minimum of settings you will need to fill in or update are:
+All other configuration is done through the admin interface which should be
+accessible from C</admin/config> once your server is running. There's explanation
+there of what the settings do ( hover over the form labels for more details ), however
+the minimum you will need to fill in are:
=over
-=item FMS_DB_PASS
+=item Staging Site
-This is the password for the database.
+If this is checked then all email ( alerts and reports ) will be sent to the
+contact email address (see below). Use this for development sites.
-=item BASE_URL
+=item Site URL
The URL for the homepage of your FixMyStreet install.
-=item EMAIL_DOMAIN
-
-The email domain that emails will be sent from
-
-=item CONTACT_EMAIL
+=item Contact Email
The email address to be used on the site for the contact us form.
-=item STAGING_SITE
+=item Email Domain Name
-If this is 1 then all email ( alerts and reports ) will be sent to the
-contact email address. Use this for development sites.
+The email domain that emails will be sent from
-=item UPLOAD_CACHE
+=item Upload Cache
This is the location where imaged will be stored as they are being uploaded.
It should be accessible by and writeable by the FixMyStreet process.
-=item GEO_CACHE
+=item Geo Cache
This is the location where Geolocation data will be cached.
It should be accessible by and writeable by the FixMyStreet process.
@@ -206,9 +204,9 @@ It should be accessible by and writeable by the FixMyStreet process.
=back
If you are using Bing or Google maps you should also set one of
-BING_MAPS_API_KEY or GOOGLE_MAPS_API_KEY.
+Bing Maps API key or Google Maps API key.
-If you are using a MaPit install you should update MAPIT_URL.
+If you are using a MaPit install you should update the MaPit URL.
=head2 Generate CSS
@@ -246,7 +244,7 @@ on a live site.
=head2 Next Steps
-The admin site should be protected using HTTP AUTH.
+The admin site ( C</admin> ) should be protected using HTTP AUTH.
Customise your install using Templates, CSS and a Cobrand module. See C<notes/customisation.pod>
for details.
View
18 notes/customisation.pod
@@ -77,24 +77,26 @@ all Cobrands should inherit from. A Cobrand module can then override any of the
methods from the default Cobrand.
FixMyStreet uses the hostname of the current request along with the contents
-of the C<ALLOWED_COBRANDS> config option to determine which cobrand to use.
-C<ALLOWED_COBRANDS> is a list of cobrand names with an optional hostname match.
+of the C<Allowed Cobrands> config option to determine which cobrand to use.
+C<Allowed Cobrands> is a list of cobrand names with an optional hostname match.
override. If there is no hostname override then the first cobrand name that
matches all or part of the hostname of the current request is used. If there is
a hostname override then that is compared against the hostname of the current
-request. For example if C<ALLOWED_COBRANDS> is
+request. C<Allowed Cobrands> can be configured through the admin interface.
- ALLOWED_COBRANDS:
- - fixmypark_fr: 'fr.fixmypark'
- - fixmypark
+As an example if C<Allowed Cobrands> has the following:
+
+ Cobrand Name Cobrand host
+ fixmypark_fr fr.fixmypark
+ fixmypark
then a request to www.fixmypark.com will use the fixmypark cobrand but a
request to fr.fixmypark.com will use fixmypark_fr. If no Cobrand listed in
-C<ALLOWED_COBRANDS> matches then the default Cobrand will be used.
+C<Allowed Cobrands> matches then the default Cobrand will be used.
This means you can provide multiple Cobrands for the site if you require, e.g.
for providing different languages, and FixMyStreet will use the first match
-listed in C<ALLOWED_COBRANDS>.
+listed in C<Allowed Cobrands>.
Many of the functions in the Cobrand module are used by FixMyStreet in the UK
to allow the site to offer versions localised to a single authority and should
View
76 templates/web/default/admin/edit_config.html
@@ -30,6 +30,44 @@
</fieldset>
<fieldset>
+ <legend>Email configuration</legend>
+
+ <p>
+ <label title="Name used in the emails" for="contact_name">Contact Name:</label>
+ <input id="contact_name" type="text" name="CONTACT_NAME"[% ' disabled' IF !active_config.exists('CONTACT_NAME') %] value="[% config.CONTACT_NAME %]" size="40" />
+ </p>
+
+ <p>
+ <label title="Reply To email addressed used on outgoing mails" for="contact_email">Contact email</label>
+ <input id="contact_email" type="text" name="CONTACT_EMAIL"[% ' disabled' IF !active_config.exists('CONTACT_EMAIL') %] value="[% config.CONTACT_EMAIL %]" size="50" />
+ </p>
+
+ <p>
+ <label title="Smarthost to use for sending mail, If empty then localhost will be used" for="smtp_smarthost">SMTP Smarthost</label>
+ <input id="smtp_smarthost" type="text" name="SMTP_SMARTHOST"[% ' disabled' IF !active_config.exists('SMTP_SMARTHOST') %] value="[% config.SMTP_SMARTHOST %]" size="30" />
+ </p>
+
+ <p>
+ <label title="Domain name from which emails are sent. This is most likely to be the hostname of the site without the www" for="email_domain">Email Domain name</label>
+ <input id="email_domain" type="text" name="EMAIL_DOMAIN"[% ' disabled' IF !active_config.exists('EMAIL_DOMAIN') %] value="[% config.EMAIL_DOMAIN %]" size="30" />
+ </p>
+ </fieldset>
+
+ <fieldset>
+ <legend>Cache locations</legend>
+
+ <p>
+ <label title="Directory to use to cache results of Geolocation lookups. Must be full path" for="geo_cache">Geolocation Cache Location</label>
+ <input id="geo_cache" type="text" name="GEO_CACHE"[% ' disabled' IF !active_config.exists('GEO_CACHE') %] value="[% config.GEO_CACHE %]" size="50" />
+ </p>
+
+ <p>
+ <label title="Directory where uploaded images are temporarily stored while awaiting processing" for="upload_cache">Image Upload Cache Location</label>
+ <input id="upload_cache" type="text" name="UPLOAD_CACHE"[% ' disabled' IF !active_config.exists('UPLOAD_CACHE') %] value="[% config.UPLOAD_CACHE %]" size="50" />
+ </p>
+ </fieldset>
+
+ <fieldset>
<legend>Allowed Cobrands</legend>
<p>
@@ -82,30 +120,6 @@
</fieldset>
<fieldset>
- <legend>Email configuration</legend>
-
- <p>
- <label title="Name used in the emails" for="contact_name">Contact Name:</label>
- <input id="contact_name" type="text" name="CONTACT_NAME"[% ' disabled' IF !active_config.exists('CONTACT_NAME') %] value="[% config.CONTACT_NAME %]" size="40" />
- </p>
-
- <p>
- <label title="Reply To email addressed used on outgoing mails" for="contact_email">Contact email</label>
- <input id="contact_email" type="text" name="CONTACT_EMAIL"[% ' disabled' IF !active_config.exists('CONTACT_EMAIL') %] value="[% config.CONTACT_EMAIL %]" size="50" />
- </p>
-
- <p>
- <label title="Smarthost to use for sending mail, If empty then localhost will be used" for="smtp_smarthost">SMTP Smarthost</label>
- <input id="smtp_smarthost" type="text" name="SMTP_SMARTHOST"[% ' disabled' IF !active_config.exists('SMTP_SMARTHOST') %] value="[% config.SMTP_SMARTHOST %]" size="30" />
- </p>
-
- <p>
- <label title="Domain name from which emails are sent. This is most likely to be the hostname of the site without the www" for="email_domain">Email Domain name</label>
- <input id="email_domain" type="text" name="EMAIL_DOMAIN"[% ' disabled' IF !active_config.exists('EMAIL_DOMAIN') %] value="[% config.EMAIL_DOMAIN %]" size="30" />
- </p>
- </fieldset>
-
- <fieldset>
<legend>External Services</legend>
<p>
@@ -159,20 +173,6 @@
</p>
</fieldset>
- <fieldset>
- <legend>Cache locations</legend>
-
- <p>
- <label title="Directory to use to cache results of Geolocation lookups. Must be full path" for="geo_cache">Geolocation Cache Location</label>
- <input id="geo_cache" type="text" name="GEO_CACHE"[% ' disabled' IF !active_config.exists('GEO_CACHE') %] value="[% config.GEO_CACHE %]" size="50" />
- </p>
-
- <p>
- <label title="Directory where uploaded images are temporarily stored while awaiting processing" for="upload_cache">Image Upload Cache Location</label>
- <input id="upload_cache" type="text" name="UPLOAD_CACHE"[% ' disabled' IF !active_config.exists('UPLOAD_CACHE') %] value="[% config.UPLOAD_CACHE %]" size="50" />
- </p>
- </fieldset>
-
<p>
<input type="submit" value="Save" />
</p>
Please sign in to comment.
Something went wrong with that request. Please try again.