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

[rails.git] / DOCKER.md

diff --git a/DOCKER.md b/DOCKER.md
index 07d488c732ebce68718d589029683af17b654deb..870e3e26eacfe3329aea537249eb58436bd0d595 100644 (file)
--- a/DOCKER.md
+++ b/DOCKER.md
@@ -5,6 +5,8 @@ These instructions are designed for setting up The Rails Port for development an
 - [Install Docker](https://docs.docker.com/install/)
 - [Install Docker Compose](https://docs.docker.com/compose/install/)
 
+**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.
+
 The first step is to fork/clone the repo to your local machine:
 
     git clone https://github.com/openstreetmap/openstreetmap-website.git
@@ -29,6 +31,8 @@ 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
 
 To build local Docker images run from the root directory of the repository:
@@ -56,13 +60,13 @@ Run the Rails database migrations:
 
 Run the test suite by running:
 
-    docker-compose run --rm web bundle exec rake test:db
+    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
 
@@ -71,17 +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.:
+
+    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`](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.
+See [`CONFIGURE.md`](CONFIGURE.md) for information on how to manage users and enable OAuth for iD, JOSM etc.
 
 ### Bash