aboutsummaryrefslogtreecommitdiffstats
path: root/docs/install/ami.md
blob: 5f6df3af48638366d042b6edd0cf744b506d2d33 (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
---
layout: page
title: AMI for EC2
---

# FixMyStreet AMI for EC2

<p class="lead">
  To help people to get started with the FixMyStreet platform, we have
  created an AMI (Amazon Machine Image) with a basic installation of
  FixMyStreet, which you can use to create a running server on an Amazon
  EC2 instance.
</p>

Note that this is just one of [many ways to install FixMyStreet]({{ "/install/" | relative_url }}).

## Installing on Amazon's Web Services

If you don't have your own server, or simply prefer to use an external one, you
can use Amazon Web Services (AWS) instead. They provide difference scale
servers, called instances. The smallest instance, the Micro, will be [free
for a year](http://aws.amazon.com/free/).

The AMI we've prepared for you can be found in the **EU West (Ireland)**
region, with the ID `ami-0a9b70ca6708395b5` and name "FixMyStreet installation
2018-09-06". You can launch an instance based on that AMI with
[this link](https://console.aws.amazon.com/ec2/home?region=eu-west-1#launchAmi=ami-0a9b70ca6708395b5).

When you create an EC2 instance based on that AMI, make sure that you
choose Security Groups that allow at least inbound HTTP, HTTPS and
SSH, and perhaps SMTP as well for email.

When your EC2 instance is launched, you will be able to log in as the
`ubuntu` user.  This user can `sudo` freely to run commands as root.
However, the code is actually owned by (and runs as) the `fms` user.
After creating the instance, you may want to edit a configuration
file to set a couple of parameters.  That configuration file is
`/home/fms/fixmystreet/conf/general.yml`, which can be edited with:

    ubuntu@ip-10-58-191-98:~$ sudo su - fms
    fms@ip-10-58-191-98:~$ cd fixmystreet
    fms@ip-10-58-191-98:~/fixmystreet$ nano conf/general.yml

You should set 
<code><a href="{{ "/customising/config/#contact_email" | relative_url }}">CONTACT_EMAIL</a></code>
and
<code><a href="{{ "/customising/config/#do_not_reply_email" | relative_url }}">DO_NOT_REPLY_EMAIL</a></code>
or whatever you wish to use. postfix is installed so that outgoing email will
work, but this may need further configuration.

Then you should restart the Catalyst FastCGI server with:

    fms@ip-10-58-191-98:~/fixmystreet$ logout
    ubuntu@ip-10-58-191-98:~$ sudo /etc/init.d/fixmystreet restart

If you find the hostname of your EC2 instance from the AWS console,
you should then be able to see the site at http://your-ec2-hostname.eu-west-1.compute.amazonaws.com

By default, the admin part of the website (`/admin`) requires a user with
superuser permission to log in. In order to use this
interface, you will need to create a username and password for one or
more superusers.  To add such a user, you can use the `createsuperuser`
command, as follows:

    ubuntu@ip-10-58-66-208:~$ sudo su - fms
    fms@ip-10-58-191-98:~$ cd fixmystreet
    fms@ip-10-58-191-98:~/fixmystreet$ bin/createsuperuser fmsadmin@example.org password
    fmsadmin@example.org is now a superuser.

This basic installation uses the default cobrand, with a
(deliberately) rather garish colour scheme.  

## Installation complete... now customise

You should then proceed
to [customise your installation](/customising/).

Please also see the instructions for [updating your installation](/updating/ami/).