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