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