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 16.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.3
  22 * RubyGems 1.3.1+
  23 * PostgreSQL 9.1+
  24 * ImageMagick
  25 * Bundler
  26 * Javascript Runtime
  27
  28 These can be installed on Ubuntu 16.04 or later with:
  29
  30 ```
  31 sudo apt-get install ruby2.3 libruby2.3 ruby2.3-dev \
  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
  36 sudo gem2.3 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 yum 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
  51 ```
  52
  53 If you didn't already have PostgreSQL installed then create a PostgreSQL instance and start the server:
  54
  55 ```
  56 sudo postgresql-setup initdb
  57 sudo systemctl start postgresql.service
  58 ```
  59
  60 Optionally set PostgreSQL to start on boot:
  61
  62 ```
  63 sudo systemctl enable postgresql.service
  64 ```
  65
  66 #### MacOSX
  67
  68 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.
  69
  70 Installing PostgreSQL:
  71
  72 * Install Postgres.app from https://postgresapp.com/
  73 * Add PostgreSQL to your path, by editing your profile:
  74
  75 `nano ~/.profile`
  76
  77 and adding:
  78
  79 `export PATH=/Applications/Postgres.app/Contents/MacOS/bin:$PATH`
  80
  81 Installing other dependencies:
  82
  83 * Install Homebrew from https://brew.sh/
  84 * Install the latest version of Ruby: `brew install ruby`
  85 * Install ImageMagick: `brew install imagemagick`
  86 * Install libxml2: `brew install libxml2 --with-xml2-config`
  87 * If you want to run the tests, you need `phantomjs` as well: `brew install phantomjs`
  88 * Install Bundler: `gem install bundler`
  89
  90 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.
  91
  92 ## Cloning the repository
  93
  94 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:
  95
  96 ```
  97 git clone https://github.com/openstreetmap/openstreetmap-website.git
  98 ```
  99
 100 To clone only the most recent version (~23MB), instead use a 'shallow clone':
 101
 102 ```
 103 git clone --depth=1 https://github.com/openstreetmap/openstreetmap-website.git
 104 ```
 105
 106 If you want to add in the full history later on, perhaps to run `git blame` or `git log`, run `git fetch --depth=1000000`
 107
 108
 109 ## Ruby gems
 110
 111 We use [Bundler](http://gembundler.com/) to manage the rubygems required for the project.
 112
 113 ```
 114 cd openstreetmap-website
 115 bundle install
 116 ```
 117
 118 ## Application setup
 119
 120 We need to create the `config/application.yml` file from the example template. This contains various configuration options.
 121
 122 ```
 123 cp config/example.application.yml config/application.yml
 124 ```
 125
 126 You can customize your installation of The Rails Port by changing the values in `config/application.yml`
 127
 128 ## Database setup
 129
 130 The Rails Port uses three databases -  one for development, one for testing, and one for production. The database-specific configuration
 131 options are stored in `config/database.yml`, which we need to create from the example template.
 132
 133 ```
 134 cp config/example.database.yml config/database.yml
 135 ```
 136
 137 PostgreSQL is configured to, by default, accept local connections without requiring a username or password. This is fine for development.
 138 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
 139 instructions below as appropriate.
 140
 141 ### PostgreSQL account setup
 142
 143 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.
 144
 145 ```
 146 sudo -u postgres -i
 147 createuser -s <username>
 148 exit
 149 ```
 150
 151 ### Create the databases
 152
 153 To create the three databases - for development, testing and production - run:
 154
 155 ```
 156 bundle exec rake db:create
 157 ```
 158
 159 ### PostgreSQL Btree-gist Extension
 160
 161 We need to load the `btree-gist` extension, which is needed for showing changesets on the history tab.
 162
 163 ```
 164 psql -d openstreetmap -c "CREATE EXTENSION btree_gist"
 165 ```
 166
 167 ### PostgreSQL Functions
 168
 169 We need to install special functions into the PostgreSQL databases, and these are provided by a library that needs compiling first.
 170
 171 ```
 172 cd db/functions
 173 make libpgosm.so
 174 cd ../..
 175 ```
 176
 177 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.
 178
 179 ```
 180 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"
 181 psql -d openstreetmap -c "CREATE FUNCTION tile_for_point(int4, int4) RETURNS int8 AS '`pwd`/db/functions/libpgosm', 'tile_for_point' LANGUAGE C STRICT"
 182 psql -d openstreetmap -c "CREATE FUNCTION xid_to_int4(xid) RETURNS int4 AS '`pwd`/db/functions/libpgosm', 'xid_to_int4' LANGUAGE C STRICT"
 183 ```
 184
 185 ### Database structure
 186
 187 To create all the tables, indexes and constraints, run:
 188
 189 ```
 190 bundle exec rake db:migrate
 191 ```
 192
 193 ## Running the tests
 194
 195 To ensure that everything is set up properly, you should now run:
 196
 197 ```
 198 bundle exec rake test:db
 199 ```
 200
 201 This test will take a few minutes, reporting tests run, assertions, and any errors. If you receive no errors, then your installation is successful.
 202
 203 The unit tests may output parser errors related to "Attribute lat redefined." These can be ignored.
 204
 205 ### Starting the server
 206
 207 Rails comes with a built-in webserver, so that you can test on your own machine without needing a server. Run
 208
 209 ```
 210 bundle exec rails server
 211 ```
 212
 213 You can now view the site in your favourite web-browser at `http://localhost:3000/`
 214
 215 Note that the OSM map tiles you see aren't created from your local database - they are just the standard map tiles.
 216
 217 # Configuration
 218
 219 After installing this software, you may need to carry out some [configuration steps](CONFIGURE.md), depending on your tasks.