Merge remote-tracking branch 'openstreetmap/pull/1120'

[rails.git] / INSTALL.md

diff --git a/INSTALL.md b/INSTALL.md
index 2f954d1060fc86a241945769a89d8222154b4632..0343629110c39f2e1ca128547483a64e0e9e5d69 100644 (file)
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -3,11 +3,12 @@
 These instructions are designed for setting up The Rails Port for development and testing.
 If you want to deploy the software for your own project, then see the notes at the end.
 
 These instructions are designed for setting up The Rails Port for development and testing.
 If you want to deploy the software for your own project, then see the notes at the end.
 

+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).
+

 These instructions are based on Ubuntu 12.04 LTS, which is the platform used by the OSMF servers.
 The instructions also work, with only minor amendments, for all other current Ubuntu releases, Fedora and MacOSX
 
 These instructions are based on Ubuntu 12.04 LTS, which is the platform used by the OSMF servers.
 The instructions also work, with only minor amendments, for all other current Ubuntu releases, Fedora and MacOSX
 

-We don't recommend attempting to develop or deploy this software on Windows. If you need to use Windows, then
-try developing this sofware using Ubuntu in a virtual machine.
+We don't recommend attempting to develop or deploy this software on Windows. If you need to use Windows, then try developing this sofware using Ubuntu in a virtual machine, or use [Vagrant](VAGRANT.md).

 
 ## Dependencies
 
 
 ## Dependencies
 


@@ -17,26 +18,24 @@ of packages required before you can get the various gems installed.
 
 ## Minimum requirements
 
 
 ## Minimum requirements
 

-* Ruby 1.9.3
+* Ruby 2.0

 * RubyGems 1.3.1+
 * Postgres 8.3+
 * ImageMagick
 * Bundler
 * Javascript Runtime
 
 * RubyGems 1.3.1+
 * Postgres 8.3+
 * ImageMagick
 * Bundler
 * Javascript Runtime
 

-These can be installed on Ubuntu 10.10 or later with:
+These can be installed on Ubuntu 14.04 or later with:

 
 ```
 
 ```

-sudo apt-get install ruby1.9.1 libruby1.9.1 ruby1.9.1-dev ri1.9.1 \
+sudo apt-get install ruby2.0 libruby2.0 ruby2.0-dev \

                      libmagickwand-dev libxml2-dev libxslt1-dev nodejs \
                      apache2 apache2-threaded-dev build-essential git-core \
                      postgresql postgresql-contrib libpq-dev postgresql-server-dev-all \
                      libmagickwand-dev libxml2-dev libxslt1-dev nodejs \
                      apache2 apache2-threaded-dev build-essential git-core \
                      postgresql postgresql-contrib libpq-dev postgresql-server-dev-all \

-                     libsasl2-dev
-gem1.9.1 install bundle
+                     libsasl2-dev imagemagick
+sudo gem2.0 install bundler

 ```
 
 ```
 

-Note that the "1.9.1" Ubuntu packages do in fact contain ruby 1.9.3.
-

 ### Alternative platforms
 
 #### Fedora
 ### Alternative platforms
 
 #### Fedora


@@ -48,7 +47,7 @@ sudo yum install ruby ruby-devel rubygem-rdoc rubygem-bundler rubygems \
                  libxml2-devel js \
                  gcc gcc-c++ git \
                  postgresql postgresql-server postgresql-contrib postgresql-devel \
                  libxml2-devel js \
                  gcc gcc-c++ git \
                  postgresql postgresql-server postgresql-contrib postgresql-devel \

-                 perl-podlators
+                 perl-podlators ImageMagick

 ```
 
 If you didn't already have Postgres installed then create a Postgres instance and start the server:
 ```
 
 If you didn't already have Postgres installed then create a Postgres instance and start the server:


@@ -159,14 +158,6 @@ bundle exec rake db:create
 
 We need to load the btree-gist extension, which is needed for showing changesets on the history tab.
 
 
 We need to load the btree-gist extension, which is needed for showing changesets on the history tab.
 

-For PostgreSQL < 9.1 (change the version number in the path as necessary):
-
-```
-psql -d openstreetmap < /usr/share/postgresql/9.0/contrib/btree_gist.sql
-```
-
-For PostgreSQL >= 9.1:
-

 ```
 psql -d openstreetmap -c "CREATE EXTENSION btree_gist"
 ```
 ```
 psql -d openstreetmap -c "CREATE EXTENSION btree_gist"
 ```


@@ -202,7 +193,7 @@ bundle exec rake db:migrate
 To ensure that everything is set up properly, you should now run:
 
 ```
 To ensure that everything is set up properly, you should now run:
 
 ```

-bundle exec rake test
+bundle exec rake test:db

 ```
 
 This test will take a few minutes, reporting tests run, assertions, and any errors. If you receive no errors, then your installation is successful.
 ```
 
 This test will take a few minutes, reporting tests run, assertions, and any errors. If you receive no errors, then your installation is successful.