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