aboutsummaryrefslogtreecommitdiffstats
path: root/conf/general.yml-example
blob: 4a06a2affacb6a65b6dc623cfc4048399f39b77b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# general.yml-example:
# Example values for the "general" config file.
#
# Configuration parameters, in YAML syntax.
#
# 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.

# PostgreSQL database details for FixMyStreet
FMS_DB_HOST: 'localhost'
FMS_DB_PORT: '5432'
FMS_DB_NAME: 'fms'
FMS_DB_USER: 'fms'
FMS_DB_PASS: ''

# The base URL of the install.
BASE_URL: 'http://www.example.org'
# Use the below if you're using the Catalyst development server
#   BASE_URL: 'http://localhost:3000'

# Email domain used for emails, and contact name/email for admin use.
EMAIL_DOMAIN: 'example.org'
CONTACT_EMAIL: 'team@example.org'
CONTACT_NAME: 'FixMyStreet'
# Address used for emails you don't expect a reply to (e.g. confirmation
# emails); can be same as CONTACT_EMAIL above, of course, if you don't have a
# special address.
DO_NOT_REPLY_EMAIL: 'do-not-reply@example.org'

# Whether this is a development site or not. It will mean e.g. templates/
# CSS modified times aren't cached
STAGING_SITE: 1
# Normally, a staging site will route all reports to CONTACT_EMAIL on a
# development site (when STAGING_SITE is 1), to guard against sending fake
# reports to live places. Set this to 1 if you want a dev site to route
# reports as normal.
SEND_REPORTS_ON_STAGING: 0

# What to use as front page/alert example places placeholder
# Defaults to High Street, Main Street
EXAMPLE_PLACES: [ 'High Street', 'Main Street' ]

# An array of languages for the site, in the following format:
# <language code>,<pretty name>,<locale>
# Do not remove the en-gb line as it is needed for correct operation.
LANGUAGES:
  - 'en-gb,English,en_GB'

# If you're running an installation that is being used in a different time zone
# from the server, you can set the time zone here (standard time zone string)
TIME_ZONE: ""

# File locations for uploaded photos and cached geocoding results.
UPLOAD_DIR: '../upload/'
GEO_CACHE: '../cache/'

# Location of MapIt, to map points to administrative areas, and what types of
# area from it you want to use. If left blank, a default area will be used
# everywhere (a URL needs to be given for non-web things, like sending of
# reports, to function).
# If using the Catalyst development server, set to
#   MAPIT_URL: 'http://localhost:3000/fakemapit/'
#   MAPIT_TYPES: [ 'ZZZ' ]
# In the UK, you probably want, to cover all councils:
#   MAPIT_URL: 'http://mapit.mysociety.org/'
#   MAPIT_TYPES: [ 'DIS', 'LBO', 'MTD', 'UTA', 'CTY', 'COI', 'LGD' ]
# But perhaps MAPIT_TYPES: [ 'WMC' ] if you want to report on a per-constituency basis?
# If our global MapIt (using OpenStreetMap data) contains boundaries you can use:
#   MAPIT_URL: 'http://global.mapit.mysociety.org/'
# And then specify whichever type code have the boundaries you want:
#   MAPIT_TYPES: [ 'O06' ]
MAPIT_URL: ''
MAPIT_TYPES: [ 'ZZZ' ]

# If your MapIt has the concept of council wards (subareas of councils, where
# people can sign up for alerts, but not report things), then you can give the
# MapIt type codes for them here.
# You can probably leave this blank, but in the UK we use something like:
#   MAPIT_TYPES_CHILDREN: [ 'DIW', 'LBW', 'MTW', 'UTE', 'UTW', 'CED', 'COP', 'LGW' ]
MAPIT_TYPES_CHILDREN: ''

# Which service to use to look up results from e.g. front page searches.
# Possible choices are Google, Bing, or OSM (blank will use OSM by default).
GEOCODER: ''

# If you wish to use Google Maps or Bing Maps Geocoding, get and put the
# relevant key here.
GOOGLE_MAPS_API_KEY: ''
BING_MAPS_API_KEY: ''

# This provdes parameters that are included in geocoding requests, to hopefully
# return more useful results. The options vary depending which geocoder you use,
# or you can specify all for if you change geocoder. For the default OSM, you can use:
#   GEOCODING_DISAMBIGUATION:
#     bounds: [ <min lat>, <min lon>, <max lat>, <max lon> ]
#     country: <country code to restrict results to>
#     town: <string added to geocoding requests if not already there>
#
# If using Bing, you can use town and bounds, plus any of:
#     centre: "<lat>,<lon>"
#     bing_culture: <culture code, see http://msdn.microsoft.com/en-us/library/hh441729.aspx>
#     bing_country: <country name, only accept results that match this>
#
# If using Google, you can use:
#     centre: "<lat>,<lon>"
#     span: "<lat span>,<lon span>"
#     google_country: <.ccTLD to restrict results to>
#     lang: <language for results>
#
GEOCODING_DISAMBIGUATION: ''

# The type of map you want to use. If left blank, the default is OpenStreetMap.
# Other options are currently pretty UK specific, including "FMS" for UK
# FixMyStreet.
MAP_TYPE: 'OSM'

# FixMyStreet uses a templating cobrand system to provide different looks for
# different installations. If your site was at moon.example.org, and your templates
# were in the templates/web/moon directory, you would use:
#   ALLOWED_COBRANDS:
#     - moon: 'moon.example.org'
# This also allows development servers to map to different cobrands if needed,
# using DNS subdomains for example.
ALLOWED_COBRANDS:
  - cobrand_one
  - cobrand_two: 'hostname_substring2'

# This is only used in "offensive report" emails to provide a link directly to
# the admin interface. If wanted, set to the full URL of your admin interface.
ADMIN_BASE_URL: ''

# How many items are returned in the GeoRSS feeds by default
RSS_LIMIT: '20'
# How many reports to show per page on the All Reports pages
ALL_REPORTS_PER_PAGE: 100

# If you wish to send email through a SMTP server elsewhere, change this
# variable.
SMTP_SMARTHOST: 'localhost'

# Gaze is a world-wide service for population density lookups. You can leave
# this as is.
GAZE_URL: 'http://gaze.mysociety.org/gaze'

# Should problem reports link to the council summary pages?
AREA_LINKS_FROM_PROBLEMS: '0'

# used to override the STAGING SERVER safety mechanism in send-reports
TESTING_COUNCILS: ''

# if you're using Message Manager, include the URL here (see https://github.com/mysociety/message-manager/)
MESSAGE_MANAGER_URL: ''

# -----------------------------------------------------------------------

# fixmystreet.com specific config variables. You won't need any of these.
KASABI_API_KEY: ''
LONDON_REPORTIT_URL: ''
LONDON_REPORTIT_KEY: ''
LONDON_REPORTIT_SECRET: ''
AUTH_SHARED_SECRET: ''
HEARFROMYOURMP_BASE_URL: ''