Merge remote-tracking branch 'jfirebaugh/legacy-params'
[rails.git] / INSTALL.md
1 # Installation
2
3 These instructions are designed for setting up The Rails Port for development and testing.
4 If you want to deploy the software for your own project, then see the notes at the end.
5
6 These instructions are based on Ubuntu 12.04 LTS, which is the platform used by the OSMF servers.
7 The instructions also work, with only minor amendments, for all other current Ubuntu releases, Fedora and MacOSX
8
9 We don't recommend attempting to develop or deploy this software on Windows. If you need to use Windows, then
10 try developing this sofware using Ubuntu in a virtual machine.
11
12 ## Dependencies
13
14 Many of the dependencies are managed through the standard Ruby on Rails mechanisms -
15 i.e. ruby gems specified in the Gemfile and installed using bundler. However, there are a large number
16 of packages required before you can get the various gems installed.
17
18 ## Minimum requirements
19
20 * Ruby 1.9.3
21 * RubyGems 1.3.1+
22 * Postgres 8.3+
23 * ImageMagick
24 * Bundler
25 * Javascript Runtime
26
27 These can be installed on Ubuntu 10.10 or later with:
28
29 ```
30 sudo apt-get install ruby1.9.1 libruby1.9.1 ruby1.9.1-dev ri1.9.1 \
31                      libmagickwand-dev libxml2-dev libxslt1-dev nodejs \
32                      apache2 apache2-threaded-dev build-essential git-core \
33                      postgresql postgresql-contrib libpq-dev postgresql-server-dev-all \
34                      libsasl2-dev
35 gem1.9.1 install bundle
36 ```
37
38 Note that the "1.9.1" Ubuntu packages do in fact contain ruby 1.9.3.
39
40 ### Alternative platforms
41
42 #### Fedora
43
44 For Fedora, you can install the minimum requirements with:
45
46 ```
47 sudo yum install ruby ruby-devel rubygem-rdoc rubygem-bundler rubygems \
48                  libxml2-devel js \
49                  gcc gcc-c++ git \
50                  postgresql postgresql-server postgresql-contrib postgresql-devel \
51                  perl-podlators
52 ```
53
54 If you didn't already have Postgres installed then create a Postgres instance and start the server:
55
56 ```
57 sudo postgresql-setup initdb
58 sudo systemctl start postgresql.service
59 ```
60
61 Optionally set Postgres to start on boot:
62
63 ```
64 sudo systemctl enable postgresql.service
65 ```
66
67 #### MacOSX
68
69 For MacOSX, you will need XCode installed from the Mac App Store; OS X 10.7 (Lion) or later; and some familiarity with Unix development via the Terminal.
70
71 Installing Postgres:
72
73 * Install Postgres.app from http://postgresapp.com/
74 * Add Postgres to your path, by editing your profile:
75
76 `nano ~/.profile`
77
78 and adding:
79
80 `export PATH=/Applications/Postgres.app/Contents/MacOS/bin:$PATH`
81
82 Installing other dependencies:
83
84 * Install Homebrew from http://mxcl.github.io/homebrew/
85 * Install the latest version of Ruby: brew install ruby
86 * Install ImageMagick: brew install imagemagick
87 * Install Bundler: gem install bundler
88
89 Note that OS X does not have a /home directory by default, so if you are using the GPX functions, you will need to change the directories specified in config/application.yml.
90
91 ## Cloning the repository
92
93 The repository is reasonably large (~150MB) and it's unlikely that you need the full history. If you are happy to wait for it all to download, run:
94
95 ```
96 git clone https://github.com/openstreetmap/openstreetmap-website.git
97 ```
98
99 To clone only the most recent version (~23MB), instead use a 'shallow clone':
100
101 ```
102 git clone --depth=1 https://github.com/openstreetmap/openstreetmap-website.git
103 ```
104
105 If you want to add in the full history later on, perhaps to run `git blame` or `git log`, run `git fetch --depth=1000000`
106
107
108 ## Ruby gems
109
110 We use [Bundler](http://gembundler.com/) to manage the rubygems required for the project.
111
112 ```
113 cd openstreetmap-website
114 bundle install
115 ```
116
117 ## Application setup
118
119 We need to create the `config/application.yml` file from the example template. This contains various configuration options.
120
121 ```
122 cp config/example.application.yml config/application.yml
123 ```
124
125 You can customize your installation of The Rails Port by changing the values in `config/application.yml`
126
127 ## Database setup
128
129 The Rails Port uses three databases -  one for development, one for testing, and one for production. The database-specific configuration
130 options are stored in `config/database.yml`, which we need to create from the example template.
131
132 ```
133 cp config/example.database.yml config/database.yml
134 ```
135
136 PostgreSQL is configured to, by default, accept local connections without requiring a username or password. This is fine for development.
137 If you wish to set up your database differently, then you should change the values found in the `config/database.yml` file, and amend the
138 instructions below as appropriate.
139
140 ### PostgreSQL account setup
141
142 We need to create a PostgreSQL role (i.e. user account) for your current user, and it needs to be a superuser so that we can create more database.
143
144 ```
145 sudo -u postgres -i
146 createuser -s <username>
147 exit
148 ```
149
150 ### Create the databases
151
152 To create the three databases - for development, testing and production - run:
153
154 ```
155 bundle exec rake db:create
156 ```
157
158 ### PostgreSQL Btree-gist Extension
159
160 We need to load the btree-gist extension, which is needed for showing changesets on the history tab.
161
162 For PostgreSQL < 9.1 (change the version number in the path as necessary):
163
164 ```
165 psql -d openstreetmap < /usr/share/postgresql/9.0/contrib/btree_gist.sql
166 ```
167
168 For PostgreSQL >= 9.1:
169
170 ```
171 psql -d openstreetmap -c "CREATE EXTENSION btree_gist"
172 ```
173
174 ### PostgreSQL Functions
175
176 We need to install special functions into the postgresql databases, and these are provided by a library that needs compiling first.
177
178 ```
179 cd db/functions
180 make libpgosm.so
181 cd ../..
182 ```
183
184 Then we create the functions within each database. We're using `pwd` to substitute in the current working directory, since PostgreSQL needs the full path.
185
186 ```
187 psql -d openstreetmap -c "CREATE FUNCTION maptile_for_point(int8, int8, int4) RETURNS int4 AS '`pwd`/db/functions/libpgosm', 'maptile_for_point' LANGUAGE C STRICT"
188 psql -d openstreetmap -c "CREATE FUNCTION tile_for_point(int4, int4) RETURNS int8 AS '`pwd`/db/functions/libpgosm', 'tile_for_point' LANGUAGE C STRICT"
189 psql -d openstreetmap -c "CREATE FUNCTION xid_to_int4(xid) RETURNS int4 AS '`pwd`/db/functions/libpgosm', 'xid_to_int4' LANGUAGE C STRICT"
190 ```
191
192 ### Database structure
193
194 To create all the tables, indexes and constraints, run:
195
196 ```
197 bundle exec rake db:migrate
198 ```
199
200 ## Running the tests
201
202 To ensure that everything is set up properly, you should now run:
203
204 ```
205 bundle exec rake test
206 ```
207
208 This test will take a few minutes, reporting tests run, assertions, and any errors. If you receive no errors, then your installation is successful.
209
210 The unit tests may output parser errors related to "Attribute lat redefined." These can be ignored.
211
212 ### Starting the server
213
214 Rails comes with a built-in webserver, so that you can test on your own machine without needing a server. Run
215
216 ```
217 bundle exec rails server
218 ```
219
220 You can now view the site in your favourite web-browser at `http://localhost:3000/`
221
222 Note that the OSM map tiles you see aren't created from your local database - they are just the standard map tiles.
223
224 # Configuration
225
226 After installing this software, you may need to carry out some [configuration steps](CONFIGURE.md), depending on your tasks.