This page describes how to install the FixMyStreet platform manually. You can use this if you're used to setting up web applications — but the other installation options may be easier:
Note that this is just one of many ways to install FixMyStreet (the other ways are easier!).
If you prefer to set up each required component of FixMyStreet yourself, proceed with the instructions below.
1. Get the code
Fetch the latest version from GitHub:
2. Install prerequisite packages
a. Debian / Linux
If you’re using Debian or Ubuntu, then the packages to install required
dependencies are listed in
conf/packages.generic. To install all of them you
can run e.g.:
A similar list of packages should work for other Debian-based distributions. (Please let us know if you would like to contribute such a package list or instructions for other distributions.)
Install either MacPorts or HomeBrew (you might well have one already), and then use the command below to install a few packages that FixMyStreet needs, for which it’s much simpler to install via a packaging system.
You will need to install gettext, jhead, libpng, openssl (perhaps version 1.1), p5-locale-gettext, p5-perlmagick, and postgresql13-server.
Some Perl modules may fail to install without certain packages and paths in place. Hopefully the following variables should deal with all of them:
You need Perl 5 (we currently test on 5.26 upwards, though it will probably work back to 5.14), ImageMagick with the perl bindings, and gettext. If you’re expecting a lot of traffic it’s recommended that you install memcached: http://memcached.org/
3. Create a new PostgreSQL database
The default settings assume the database is called fms and the user the same.
You can change these if you like. Using the defaults, create a user and
database using the following (do not worry if the
CREATE LANGUAGE step gives
an error that it already exists, it might well do depending on how your
PostgreSQL was installed):
You should be able to connect to the database with
psql -U fms fms – if not,
you will need to investigate how to allow access to your PostgreSQL database.
4. Install required dependencies, and other setup
FixMyStreet uses a number of Perl modules from CPAN; to install them, and perform other set up functions, run:
This should tell you what it is doing as it goes. It takes some time, so feel free to continue with further steps whilst it’s running.
It is possible you may need to install some source packages to allow some of the included modules to be built, including expat (libexpat1-dev), postgresql, or the GMP math library (libgmp3-dev).
As well as installing dependencies, this script compiles our CSS (using
bin/make_css), installs the database schema (using
and compiles any translation
.mo files (using
When the script above asks to install Image::Magick, it may fail depending on where imagemagick was installed. In this case, if you’ve installed with homebrew, then the following should hopefully work:
5. Set up config
The settings for FixMyStreet are defined in
conf/general.yml using the YAML
markup language. There are some defaults in
you should copy to
conf/general.yml; note that if you are using the Vagrant
environment, a simple
conf/general.yml file should already have been
configured for you.
The bare minimum of settings you will need to fill in or update are:
- FMS_DB_PASS – this is the password for the database. (Also obviously change any other database settings you did differently here.)
- BASE_URL – for using the development server, set to
'http://localhost:3000/'. This is the URL of the homepage of your FixMyStreet installation.
- MAPIT_URL – for the development server, set to
'http://localhost:3000/fakemapit/'. This would be the URL of a MapIt installation, as and when you use one.
Some others you might want to look at, though the defaults are enough for it to run:
- EMAIL_DOMAIN – the email domain that emails will be sent from
- CONTACT_EMAIL – the email address to be used on the site for the contact us form.
- DO_NOT_REPLY_EMAIL – the email address to be used on the site for e.g. confirmation emails.
- STAGING_SITE – if this is 1 then all email (alerts and reports) will be sent to the contact email address. Use this for development sites.
- PHOTO_STORAGE_OPTIONS.UPLOAD_DIR – this is the location where images will be stored when they are uploaded. It should be accessible by and writeable by the FixMyStreet process.
- GEO_CACHE – this is the location where Geolocation data will be cached. It should be accessible by and writeable by the FixMyStreet process.
If you are using Bing or Google maps you should also set one of BING_MAPS_API_KEY or GOOGLE_MAPS_API_KEY.
6. Set up some required data
You need to generate the data used for the
/reports page (this is run by the
crontab, but to have it working from the start, we can run the script
The development server can now hopefully be run with:
The server will be accessible as http://localhost:3000/, and will
automatically restart if you update the code or
If you need to run the server under HTTPS, to e.g. develop the service worker
or geolocation, then you can run
script/server --listen :3000:ssl
--ssl-cert=my.crt --ssl-key=my.key --Reload perllib,conf where my.crt and
my.key point to a key and self-signed certificate you have generated using
openssl req -x509 -newkey rsa:4096 -sha256 -nodes -keyout
my.key -out my.crt -subj "/CN=My local CA" -days 3650.
Post-install: Things you might want to change
- Create a superuser with the
bin/createsuperuserscript to access admin site.
- Customise your install using Templates, CSS and a Cobrand module.
- Add contact details for authorities and categories using the admin interface.
You will also need a tile server to serve up map tiles. FixMyStreet can currently use tile servers such as Bing, OpenStreetMap and Google, defaulting to OpenStreetMap.
Finally, you will need a geolocation service to turn addresses into longitude and latitudes. FixMyStreet currently includes code to use Bing, Google, and OpenStreetMap geolocation services, again defaulting to OpenStreetMap.
There is an example crontab in
conf/crontab-example. You can use that as a
base for your own user crontab.
For production use of FixMyStreet, we suggest you use Apache or nginx, with either FastCGI or Plack/PSGI.
There is an example Apache vhost configuration file in
conf/httpd.conf-example, which contain a
sample configuration and the required redirect rules.
The sample configuration will need the following modules enabled:
For most Linux distributions you should be able to install these using the distribution’s packaging system.
There is an example nginx configuration in
nginx, you need to run the application service separately - the
conf/systemd.example files are example scripts you
could use to run it as a daemon.
Check it’s working
At this point you should be able to restart the webserver and see your FixMyStreet installation at the configured URL. See our testing page on running the test suite.
See some troubleshooting hints if something’s not working for you.
When you’ve finished
Please see the instructions for updating your code once it’s installed.
If you want to know which bits of FixMyStreet are in which directory, see this summary of the directory structure.