Ignore additional 'large' directories during Docker build step

[rails.git] / DOCKER.md

diff --git a/DOCKER.md b/DOCKER.md
index 2350684593143643d670ce6455622d3ced9cdb50..b47a27ea98751aa20100f63c29fb37d885f4d6b6 100644 (file)
--- a/DOCKER.md
+++ b/DOCKER.md
@@ -5,8 +5,6 @@ Using [Docker](https://www.docker.com/) will allow you to install the OpenStreet
 - [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:
 
     git clone https://github.com/openstreetmap/openstreetmap-website.git
@@ -19,7 +17,9 @@ 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 +33,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:
 
     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,19 +52,34 @@ This will launch one Docker container for each 'service' specified in `docker-co
 
 ### Migrations
 
-While the `db' service is running, open another terminal windows and run:
+Run the Rails database migrations:
 
     docker-compose run --rm web rake db:migrate
 
-### Node.js modules
+### 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:
 
-We use Yarn to manage the Node.js modules required for the project:
+    wget https://download.geofabrik.de/north-america/us/district-of-columbia-latest.osm.pbf
+
+You can now use Docker to load this extract into your local Docker-based OSM instance:
+
+    docker-compose run --rm web osmosis \
+        -verbose    \
+        --read-pbf district-of-columbia-latest.osm.pbf \
+        --write-apidb \
+            host="db" \
+            database="openstreetmap" \
+            user="openstreetmap" \
+            validateSchemaVersion="no"
 
-    docker-compose run --rm web rake yarn:install
+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 these are complete you should be able to visit the app at http://localhost:3000
+### Additional Configuration
 
-If localhost does not work, you can use the IP address of the docker-machine.
+See `CONFIGURE.md` for information on how to manage users and enable OAuth for iD, JOSM etc.
 
 ### Tests
 
@@ -83,17 +98,3 @@ Alternatively, if you want to use the already-running `web` container then you c
 Similarly, if you want to `exec` in the db container use:
 
     docker-compose exec db bash
-
-### Populating the database
-
-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.
-
-After installing but before creating any users or data, import an extract with [Osmosis](https://wiki.openstreetmap.org/wiki/Osmosis) and the `--write-apidb` task. The `web` container comes with `osmosis` pre-installed. So to populate data with a `.osm.pbf` use the following command:
-
-    docker-compose run --rm web osmosis \
-        --read-pbf /path/to/file.osm.pbf \
-        --write-apidb \
-        host="db" \
-        database="openstreetmap" \
-        user="openstreetmap" \
-        validateSchemaVersion="no"