Merge remote-tracking branch 'upstream/pull/2907' into master
[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 You can install the software directly on your machine, which is the traditional and probably best-supported approach. However, there is an alternative which may be easier: Vagrant. This installs the software into a virtual machine, which makes it easier to get a consistent development environment and may avoid installation difficulties. For Vagrant instructions, see [VAGRANT.md](VAGRANT.md).
7
8 These instructions are based on Ubuntu 18.04 LTS, which is the platform used by the OSMF servers.
9 The instructions also work, with only minor amendments, for all other current Ubuntu releases, Fedora and MacOSX
10
11 We don't recommend attempting to develop or deploy this software on Windows. If you need to use Windows, then try developing this software using Ubuntu in a virtual machine, or use [Vagrant](VAGRANT.md).
12
13 ## Dependencies
14
15 Many of the dependencies are managed through the standard Ruby on Rails mechanisms -
16 i.e. ruby gems specified in the Gemfile and installed using bundler. However, there are a large number
17 of packages required before you can get the various gems installed.
18
19 ## Minimum requirements
20
21 * Ruby 2.5+
22 * PostgreSQL 9.1+
23 * ImageMagick
24 * Bundler (see note below about [developer Ruby setup](#rbenv))
25 * Javascript Runtime
26
27 These can be installed on Ubuntu 18.04 or later with:
28
29 ```
30 sudo apt-get update
31 sudo apt-get install ruby2.5 libruby2.5 ruby2.5-dev bundler \
32                      libmagickwand-dev libxml2-dev libxslt1-dev nodejs \
33                      apache2 apache2-dev build-essential git-core firefox-geckodriver \
34                      postgresql postgresql-contrib libpq-dev libsasl2-dev \
35                      imagemagick libffi-dev libgd-dev libarchive-dev libbz2-dev
36 sudo gem2.5 install bundler
37 ```
38
39 ### Alternative platforms
40
41 #### Fedora
42
43 For Fedora, you can install the minimum requirements with:
44
45 ```
46 sudo dnf install ruby ruby-devel rubygem-rdoc rubygem-bundler rubygems \
47                  libxml2-devel js \
48                  gcc gcc-c++ git \
49                  postgresql postgresql-server postgresql-contrib \
50                  perl-podlators ImageMagick libffi-devel gd-devel libarchive-devel \
51                  bzip2-devel nodejs-yarn
52 ```
53
54 If you didn't already have PostgreSQL installed then create a PostgreSQL instance and start the server:
55
56 ```
57 sudo postgresql-setup initdb
58 sudo systemctl start postgresql.service
59 ```
60
61 Optionally set PostgreSQL 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 PostgreSQL:
72
73 * Install Postgres.app from https://postgresapp.com/
74 * Make sure that you've initialized and started Postgresql from the app (there should be a little elephant icon in your systray).
75 * Add PostgreSQL to your path, by editing your profile:
76
77 `nano ~/.profile`
78
79 and adding:
80
81 `export PATH=/Applications/Postgres.app/Contents/MacOS/bin:$PATH`
82
83 After this, you may need to start a new shell window, or source the profile again by running `. ~/.profile`.
84
85 Installing other dependencies:
86
87 * Install Homebrew from https://brew.sh/
88 * Install the latest version of Ruby: `brew install ruby`
89 * Install other dependencies: `brew install imagemagick libxml2 gd yarn pngcrush optipng pngquant jhead jpegoptim gifsicle svgo`
90 * Install Bundler: `gem install bundler` (you might need to `sudo gem install bundler` if you get an error about permissions - or see note below about [developer Ruby setup](#rbenv))
91
92 You will need to tell `bundler` that `libxml2` is installed in a Homebrew location. If it uses the system-installed one then you will get errors installing the `libxml-ruby` gem later on<a name="macosx-bundle-config"></a>.
93
94 ```
95 bundle config build.libxml-ruby --with-xml2-config=/usr/local/opt/libxml2/bin/xml2-config
96 ```
97
98 If you want to run the tests, you need `geckodriver` as well:
99
100 ```
101 brew tap homebrew/cask
102 brew cask install geckodriver
103 ```
104
105 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.
106
107 ## Cloning the repository
108
109 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:
110
111 ```
112 git clone https://github.com/openstreetmap/openstreetmap-website.git
113 ```
114
115 To clone only the most recent version (~23MB), instead use a 'shallow clone':
116
117 ```
118 git clone --depth=1 https://github.com/openstreetmap/openstreetmap-website.git
119 ```
120
121 If you want to add in the full history later on, perhaps to run `git blame` or `git log`, run `git fetch --depth=1000000`
122
123
124 ## Ruby gems
125
126 We use [Bundler](http://gembundler.com/) to manage the rubygems required for the project.
127
128 ```
129 cd openstreetmap-website
130 bundle install
131 ```
132
133 ## Node.js modules
134
135 We use [Yarn](https://yarnpkg.com/) to manage the Node.js modules required for the project.
136
137 ```
138 bundle exec rake yarn:install
139 ```
140
141 ## Prepare local settings file
142
143 This is a workaround. [See issues/2185 for details](https://github.com/openstreetmap/openstreetmap-website/issues/2185#issuecomment-508676026).
144
145 ```
146 touch config/settings.local.yml
147 ```
148
149 ## Storage setup
150
151 The Rails port needs to be configured with an object storage facility - for
152 development and testing purposes you can use the example configuration:
153
154 ```
155 cp config/example.storage.yml config/storage.yml
156 ```
157
158 ## Database setup
159
160 The Rails Port uses three databases -  one for development, one for testing, and one for production. The database-specific configuration
161 options are stored in `config/database.yml`, which we need to create from the example template.
162
163 ```
164 cp config/example.database.yml config/database.yml
165 ```
166
167 PostgreSQL is configured to, by default, accept local connections without requiring a username or password. This is fine for development.
168 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
169 instructions below as appropriate.
170
171 ### PostgreSQL account setup
172
173 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 databases.
174
175 ```
176 sudo -u postgres -i
177 createuser -s <username>
178 exit
179 ```
180
181 ### Create the databases
182
183 To create the three databases - for development, testing and production - run:
184
185 ```
186 bundle exec rake db:create
187 ```
188
189 ### PostgreSQL Btree-gist Extension
190
191 We need to load the `btree-gist` extension, which is needed for showing changesets on the history tab.
192
193 ```
194 psql -d openstreetmap -c "CREATE EXTENSION btree_gist"
195 ```
196
197 ### PostgreSQL Functions
198
199 We need to install some special functions into the PostgreSQL database:
200
201 ```
202 psql -d openstreetmap -f db/functions/functions.sql
203 ```
204
205 ### Database structure
206
207 To create all the tables, indexes and constraints, run:
208
209 ```
210 bundle exec rake db:migrate
211 ```
212
213 ## Running the tests
214
215 To ensure that everything is set up properly, you should now run:
216
217 ```
218 bundle exec rake test:db
219 ```
220
221 This test will take a few minutes, reporting tests run, assertions, and any errors. If you receive no errors, then your installation is successful.
222
223 The unit tests may output parser errors related to "Attribute lat redefined." These can be ignored.
224
225 ### Starting the server
226
227 Rails comes with a built-in webserver, so that you can test on your own machine without needing a server. Run
228
229 ```
230 bundle exec rails server
231 ```
232
233 You can now view the site in your favourite web-browser at [http://localhost:3000/](http://localhost:3000/)
234
235 Note that the OSM map tiles you see aren't created from your local database - they are just the standard map tiles.
236
237 # Configuration
238
239 After installing this software, you may need to carry out some [configuration steps](CONFIGURE.md), depending on your tasks.
240
241 # Installing compiled shared library database functions (optional)
242
243 There are special database functions required by a (little-used) API call, the migrations and diff replication. The former two are provided as *either* pure SQL functions or a compiled shared library. The SQL versions are installed as part of the recommended install procedure above and the shared library versions are recommended only if you are running a production server making a lot of `/changes` API calls or need the diff replication functionality.
244
245 If you aren't sure which you need, stick with the SQL versions.
246
247 Before installing the functions, it's necessary to install the PostgreSQL server development packages. On Ubuntu this means:
248
249 ```
250 sudo apt-get install postgresql-server-dev-all
251 ```
252
253 On Fedora:
254
255 ```
256 sudo dnf install postgresql-devel
257 ```
258
259 The library then needs compiling.
260
261 ```
262 cd db/functions
263 make libpgosm.so
264 cd ../..
265 ```
266
267 If you previously installed the SQL versions of these functions, we'll need to delete those before adding the new ones:
268
269 ```
270 psql -d openstreetmap -c "DROP FUNCTION IF EXISTS maptile_for_point"
271 psql -d openstreetmap -c "DROP FUNCTION IF EXISTS tile_for_point"
272 ```
273
274 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.
275
276 ```
277 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"
278 psql -d openstreetmap -c "CREATE FUNCTION tile_for_point(int4, int4) RETURNS int8 AS '`pwd`/db/functions/libpgosm', 'tile_for_point' LANGUAGE C STRICT"
279 psql -d openstreetmap -c "CREATE FUNCTION xid_to_int4(xid) RETURNS int4 AS '`pwd`/db/functions/libpgosm', 'xid_to_int4' LANGUAGE C STRICT"
280 ```
281
282 # Ruby development install and versions<a name="rbenv"></a> (optional)
283
284 For simplicity, this document explains how to install all the website dependencies as "system" dependencies. While this is simpler, and usually faster, you might want more control over the process or the ability to install multiple different versions of software alongside eachother. For many developers, [`rbenv`](https://github.com/rbenv/rbenv) is the easiest way to manage multiple different Ruby versions on the same computer - with the added advantage that the installs are all in your home directory, so you don't need administrator permissions.
285
286 If you choose to install Ruby and Bundler via `rbenv`, then you do not need to install the system libraries for Ruby:
287
288 * For Ubuntu, you do not need to install the following packages: `ruby2.5 libruby2.5 ruby2.5-dev bundler`,
289 * For Fedora, you do not need to install the following packages: `ruby ruby-devel rubygem-rdoc rubygem-bundler rubygems`
290 * For MacOSX, you do not need to `brew install ruby` - but make sure you've installed a version of Ruby using `rbenv` before running `gem install bundler`!
291
292 After installing a version of Ruby with `rbenv` (the latest stable version is a good place to start), you will need to make that the default. From inside the `openstreetmap-website` directory, run:
293
294 ```
295 rbenv local $VERSION
296 ```
297
298 Where `$VERSION` is the version you installed. Then install bundler:
299
300 ```
301 gem install bundler
302 ```
303
304 You should now be able to proceed with the rest of the installation. If you're on MacOSX, make sure you set up the [config override for the libxml2 location](#macosx-bundle-config) _after_ installing bundler.