Merge pull request #2409 from jalessio/docker-compose-take2
authorAndy Allan <git@gravitystorm.co.uk>
Wed, 3 Feb 2021 18:07:29 +0000 (18:07 +0000)
committerGitHub <noreply@github.com>
Wed, 3 Feb 2021 18:07:29 +0000 (18:07 +0000)
Add Docker Compose Support for Development Environment

1  2 
INSTALL.md

diff --combined INSTALL.md
index 49f4a78d03d30d62760120e9a236b0156ea5c948,1215cc2613ca62e40aff6bd4dd8414d8e4b923a7..c8811fc3fcc54ccff2068765268a75b7438660b8
@@@ -3,7 -3,11 +3,11 @@@
  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).
+ You can install the software directly on your machine, which is the traditional and probably best-supported approach. However, there
+ are two alternatives which make it easier to get a consistent development environment and may avoid installation difficulties:
+ * **Vagrant** This installs the software into a virtual machine. For Vagrant instructions see [VAGRANT.md](VAGRANT.md).
+ * **Docker** This installs the software using containerization. For Docker instructions see [DOCKER.md](DOCKER.md).
  
  These instructions are based on Ubuntu 20.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
@@@ -240,7 -244,7 +244,7 @@@ After installing this software, you ma
  
  # 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 making a lot of `/changes` API calls or need the diff replication functionality.
 +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.
  
@@@ -267,12 -271,14 +271,12 @@@ 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 maptile_for_point"
  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 maptile_for_point(int8, int8, int4) RETURNS int4 AS '`pwd`/db/functions/libpgosm', 'maptile_for_point' LANGUAGE C STRICT"
  psql -d openstreetmap -c "CREATE FUNCTION tile_for_point(int4, int4) RETURNS int8 AS '`pwd`/db/functions/libpgosm', 'tile_for_point' LANGUAGE C STRICT"
  psql -d openstreetmap -c "CREATE FUNCTION xid_to_int4(xid) RETURNS int4 AS '`pwd`/db/functions/libpgosm', 'xid_to_int4' LANGUAGE C STRICT"
  ```