Merge remote-tracking branch 'upstream/pull/3797'

[rails.git] / DOCKER.md

diff --git a/DOCKER.md b/DOCKER.md
index b47a27ea98751aa20100f63c29fb37d885f4d6b6..d0b16db07771de5528ada1e5154f415cf3e5d695 100644 (file)
--- a/DOCKER.md
+++ b/DOCKER.md
@@ -1,17 +1,15 @@
-# 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 `openstreetmap-website` 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/)
 
-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:
+**Windows users: You must enable symlinks before cloning the repository.** This repository uses symbolic links that are not enabled by default on Windows. To enable them, [turn on Developer Mode](https://windowsreport.com/windows-11-developer-mode/) on Windows and run `git config --global core.symlinks true` to enable symlinks in Git. See [this StackOverflow question](https://stackoverflow.com/questions/5917249/git-symbolic-links-in-windows) for more information.
 
-    git clone https://github.com/openstreetmap/openstreetmap-website.git
-
-To clone only the most recent version (~23MB), instead use a 'shallow clone':
+The first step is to fork/clone the repo to your local machine:
 
-    git clone --depth=1 https://github.com/openstreetmap/openstreetmap-website.git
+    git clone https://github.com/openstreetmap/openstreetmap-website.git
 
 Now change working directory to the `openstreetmap-website`:
 
@@ -33,9 +31,11 @@ This is a workaround. [See issues/2185 for details](https://github.com/openstree
 
     touch config/settings.local.yml
 
+**Windows users:** `touch` is not an availible command in Windows so just create a `settings.local.yml` file in the `config` directory, or if you have WSL you can run `wsl touch config/settings.local.yml`.
+
 ## Installation
 
-In the root directory run:
+To build local Docker images run from the root directory of the repository:
 
     docker-compose build
 
@@ -54,13 +54,19 @@ This will launch one Docker container for each 'service' specified in `docker-co
 
 Run the Rails database migrations:
 
-    docker-compose run --rm web rake db:migrate
+    docker-compose run --rm web bundle exec rake db:migrate
+
+### Tests
+
+Run the test suite by running:
+
+    docker-compose run --rm web bundle exec rails test:all
 
 ### 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,21 +75,30 @@ 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.
+**Windows users:** Powershell uses `` ` `` and CMD uses `^` at the end of each line, e.g.:
 
-### Additional Configuration
+    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"
 
-See `CONFIGURE.md` for information on how to manage users and enable OAuth for iD, JOSM etc.
+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.
 
-### Tests
+### Additional Configuration
 
-    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