Localisation updates from https://translatewiki.net.

[rails.git] / DOCKER.md

diff --git a/DOCKER.md b/DOCKER.md
index a0327d16e5bdfadb7a0339f8137b986f049a5170..ce04309392f88d97391924c4a47c0b769c41e998 100644 (file)
--- a/DOCKER.md
+++ b/DOCKER.md
@@ -1,25 +1,21 @@
-# Using Docker and Docker Compose to run OpenStreetMap
+# Using Docker and Docker Compose for Development and Testing
 
-Using [Docker](https://www.docker.com/) will allow you to install the OpenStreetMap application and all its dependencies in Docker images and then run them in containers, almost with a single command. You will need to install Docker and Docker Compose on your development machine:
+These instructions are designed for setting up The Rails Port for development and testing using [Docker](https://www.docker.com/). This will allow you to install the OpenStreetMap application and all its dependencies in Docker images and then run them in containers, almost with a single command. You will need to install Docker and Docker Compose on your development machine:
 
 - [Install Docker](https://docs.docker.com/install/)
 - [Install Docker Compose](https://docs.docker.com/compose/install/)
 
-These instructions gloss over the precise details of the dependencies and their configuration but these can be found in full detail at [INSTALL.md](INSTALL.md).
-
-The first step is to fork/clone the repo to your local machine. 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:
+The first step is to fork/clone the repo to your local machine:
 
     git clone https://github.com/openstreetmap/openstreetmap-website.git
 
-To clone only the most recent version (~23MB), instead use a 'shallow clone':
-
-    git clone --depth=1 https://github.com/openstreetmap/openstreetmap-website.git
-
 Now change working directory to the `openstreetmap-website`:
 
     cd openstreetmap-website
 
-### Storage setup
+## Initial Setup
+
+### Storage
 
     cp config/example.storage.yml config/storage.yml
 
@@ -33,13 +29,13 @@ This is a workaround. [See issues/2185 for details](https://github.com/openstree
 
     touch config/settings.local.yml
 
-### Installation
+## Installation
 
-In the root directory run:
+To build local Docker images run from the root directory of the repository:
 
     docker-compose build
 
-Now if this is your first time running or you have removed cache this will take some time to complete. So grab tea/coffee and sit tight. Once the Docker images have finished building you can launch the images as containers.
+If this is your first time running or you have removed cache this will take some time to complete. Once the Docker images have finished building you can launch the images as containers.
 
 To launch the app run:
 
@@ -52,15 +48,21 @@ This will launch one Docker container for each 'service' specified in `docker-co
 
 ### Migrations
 
-While the `db` service is running, open another terminal window and run:
+Run the Rails database migrations:
+
+    docker-compose run --rm web bundle exec rake db:migrate
+
+### Tests
+
+Run the test suite by running:
 
-    docker-compose run --rm web rake db:migrate
+    docker-compose run --rm web bundle exec rake test:db
 
 ### Loading an OSM extract
 
 This installation comes with no geographic data loaded. You can either create new data using one of the editors (Potlatch 2, iD, JOSM etc) or by loading an OSM extract. Here an example for loading an OSM extract into your Docker-based OSM instance.
 
-For example, let's download the District of Columbia from Geofabrik:
+For example, let's download the District of Columbia from Geofabrik or [any other region](https://download.geofabrik.de):
 
     wget https://download.geofabrik.de/north-america/us/district-of-columbia-latest.osm.pbf
 
@@ -69,22 +71,18 @@ You can now use Docker to load this extract into your local Docker-based OSM ins
     docker-compose run --rm web osmosis \
         -verbose    \
         --read-pbf district-of-columbia-latest.osm.pbf \
+        --log-progress \
         --write-apidb \
             host="db" \
             database="openstreetmap" \
             user="openstreetmap" \
             validateSchemaVersion="no"
 
-Once you have data loaded for Washington, DC you should be able to navigate to `http://localhost:3000/#map=12/38.8938/-77.0146` to begin working with your local instance.
+Once you have data loaded for Washington, DC you should be able to navigate to [`http://localhost:3000/#map=12/38.8938/-77.0146`](http://localhost:3000/#map=12/38.8938/-77.0146) to begin working with your local instance.
 
 ### Additional Configuration
 
-See `CONFIGURE.md` for information on how to manage users and enable OAuth for iD, JOSM etc.
-
-
-### Tests
-
-    docker-compose run --rm web rake test:db
+See [`CONFIGURE.md`](CONFIGURE.md) for information on how to manage users and enable OAuth for iD, JOSM etc.
 
 ### Bash