X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/8cef62cd2cec4a297e46b4f2a86c9afeadb3b283..8930fafdfb3f8e57fa059c6b10633e3f4242e0bd:/INSTALL.md diff --git a/INSTALL.md b/INSTALL.md index b14a2d32b..ea892ae29 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -33,7 +33,7 @@ These can be installed on Ubuntu 20.04 or later with: sudo apt-get update sudo apt-get install ruby2.7 libruby2.7 ruby2.7-dev \ libvips-dev libxml2-dev libxslt1-dev nodejs \ - apache2 apache2-dev build-essential git-core firefox-geckodriver \ + build-essential git-core firefox-geckodriver \ postgresql postgresql-contrib libpq-dev libsasl2-dev \ libffi-dev libgd-dev libarchive-dev libbz2-dev yarnpkg sudo gem2.7 install bundler @@ -137,7 +137,7 @@ bundle install We use [Yarn](https://yarnpkg.com/) to manage the Node.js modules required for the project. ``` -bundle exec rake yarn:install +bundle exec bin/yarn install ``` ## Prepare local settings file @@ -185,23 +185,7 @@ exit To create the three databases - for development, testing and production - run: ``` -bundle exec rake db:create -``` - -### PostgreSQL Btree-gist Extension - -We need to load the `btree-gist` extension, which is needed for showing changesets on the history tab. - -``` -psql -d openstreetmap -c "CREATE EXTENSION btree_gist" -``` - -### PostgreSQL Functions - -We need to install some special functions into the PostgreSQL database: - -``` -psql -d openstreetmap -f db/functions/functions.sql +bundle exec rails db:create ``` ### Database structure @@ -209,7 +193,7 @@ psql -d openstreetmap -f db/functions/functions.sql To create all the tables, indexes and constraints, run: ``` -bundle exec rake db:migrate +bundle exec rails db:migrate ``` ## Running the tests @@ -240,44 +224,6 @@ Note that the OSM map tiles you see aren't created from your local database - th After installing this software, you may need to carry out some [configuration steps](CONFIGURE.md), depending on your tasks. -# Installing compiled shared library database functions (optional) - -There are special database functions required by a (little-used) API call, the migrations and diff replication. The former two are provided as *either* pure SQL functions or a compiled shared library. The SQL versions are installed as part of the recommended install procedure above and the shared library versions are recommended only if you are running a production server and need the diff replication functionality. - -If you aren't sure which you need, stick with the SQL versions. - -Before installing the functions, it's necessary to install the PostgreSQL server development packages. On Ubuntu this means: - -``` -sudo apt-get install postgresql-server-dev-all -``` - -On Fedora: - -``` -sudo dnf install postgresql-devel -``` - -The library then needs compiling. - -``` -cd db/functions -make libpgosm.so -cd ../.. -``` - -If you previously installed the SQL versions of these functions, we'll need to delete those before adding the new ones: - -``` -psql -d openstreetmap -c "DROP FUNCTION IF EXISTS tile_for_point" -``` - -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. - -``` -psql -d openstreetmap -c "CREATE FUNCTION tile_for_point(int4, int4) RETURNS int8 AS '`pwd`/db/functions/libpgosm', 'tile_for_point' LANGUAGE C STRICT" -``` - # Ruby development install and versions (optional) For simplicity, this document explains how to install all the website dependencies as "system" dependencies. While this is simpler, and usually faster, you might want more control over the process or the ability to install multiple different versions of software alongside eachother. For many developers, [`rbenv`](https://github.com/rbenv/rbenv) is the easiest way to manage multiple different Ruby versions on the same computer - with the added advantage that the installs are all in your home directory, so you don't need administrator permissions.