]> git.openstreetmap.org Git - rails.git/blob - INSTALL.md
Merge remote-tracking branch 'upstream/pull/2305'
[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
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 \
34                      postgresql postgresql-contrib libpq-dev postgresql-server-dev-all \
35                      libsasl2-dev 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 postgresql-devel \
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 * Add PostgreSQL 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 https://brew.sh/
85 * Install the latest version of Ruby: `brew install ruby`
86 * Install ImageMagick: `brew install imagemagick`
87 * Install libxml2: `brew install libxml2 --with-xml2-config`
88 * If you want to run the tests, you need `phantomjs` as well: `brew install phantomjs`
89 * Install Bundler: `gem install bundler`
90
91 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.
92
93 ## Cloning the repository
94
95 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:
96
97 ```
98 git clone https://github.com/openstreetmap/openstreetmap-website.git
99 ```
100
101 To clone only the most recent version (~23MB), instead use a 'shallow clone':
102
103 ```
104 git clone --depth=1 https://github.com/openstreetmap/openstreetmap-website.git
105 ```
106
107 If you want to add in the full history later on, perhaps to run `git blame` or `git log`, run `git fetch --depth=1000000`
108
109
110 ## Ruby gems
111
112 We use [Bundler](http://gembundler.com/) to manage the rubygems required for the project.
113
114 ```
115 cd openstreetmap-website
116 bundle install
117 ```
118
119 ## Node.js modules
120
121 We use [Yarn](https://yarnpkg.com/) to manage the Node.js modules required for the project.
122
123 ```
124 bundle exec rake yarn:install
125 ```
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 databases.
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 ```
163 psql -d openstreetmap -c "CREATE EXTENSION btree_gist"
164 ```
165
166 ### PostgreSQL Functions
167
168 We need to install special functions into the PostgreSQL databases, and these are provided by a library that needs compiling first.
169
170 ```
171 cd db/functions
172 make libpgosm.so
173 cd ../..
174 ```
175
176 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.
177
178 ```
179 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"
180 psql -d openstreetmap -c "CREATE FUNCTION tile_for_point(int4, int4) RETURNS int8 AS '`pwd`/db/functions/libpgosm', 'tile_for_point' LANGUAGE C STRICT"
181 psql -d openstreetmap -c "CREATE FUNCTION xid_to_int4(xid) RETURNS int4 AS '`pwd`/db/functions/libpgosm', 'xid_to_int4' LANGUAGE C STRICT"
182 ```
183
184 ### Database structure
185
186 To create all the tables, indexes and constraints, run:
187
188 ```
189 bundle exec rake db:migrate
190 ```
191
192 ## Running the tests
193
194 To ensure that everything is set up properly, you should now run:
195
196 ```
197 bundle exec rake test:db
198 ```
199
200 This test will take a few minutes, reporting tests run, assertions, and any errors. If you receive no errors, then your installation is successful.
201
202 The unit tests may output parser errors related to "Attribute lat redefined." These can be ignored.
203
204 ### Starting the server
205
206 Rails comes with a built-in webserver, so that you can test on your own machine without needing a server. Run
207
208 ```
209 bundle exec rails server
210 ```
211
212 You can now view the site in your favourite web-browser at [http://localhost:3000/](http://localhost:3000/)
213
214 Note that the OSM map tiles you see aren't created from your local database - they are just the standard map tiles.
215
216 # Configuration
217
218 After installing this software, you may need to carry out some [configuration steps](CONFIGURE.md), depending on your tasks.