Lock note during status update to avoid race condition

[rails.git] / DOCKER.md

diff --git a/DOCKER.md b/DOCKER.md
index 2350684593143643d670ce6455622d3ced9cdb50..f6caa698898a4ce50a4bb2b8a6d4c266f120dbe4 100644 (file)
--- a/DOCKER.md
+++ b/DOCKER.md
@@ -1,25 +1,38 @@
-# 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.

 
 

-- [Install Docker](https://docs.docker.com/install/)
-- [Install Docker Compose](https://docs.docker.com/compose/install/)
+## Install Docker

 
 

-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).
+### Windows

 
 

-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:
+1. Use Docker Desktop via [docker.com Download](https://www.docker.com/products/docker-desktop/).

 
 

-    git clone https://github.com/openstreetmap/openstreetmap-website.git
+2. You have to enable git symlinks before cloning the repository.
+   This repository uses symbolic links that are not enabled by default on Windows git. 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.
+
+### Mac
+
+- Use Docker Desktop via [docker.com Download](https://www.docker.com/products/docker-desktop/).
+- Or [Homebrew](https://formulae.brew.sh/cask/docker).
+
+### Linux

 
 

-To clone only the most recent version (~23MB), instead use a 'shallow clone':
+Use [Docker Engine](https://docs.docker.com/engine/install/ubuntu/) with the [docker-compose-plugin](https://docs.docker.com/compose/install/linux/)

 
 

-    git clone --depth=1 https://github.com/openstreetmap/openstreetmap-website.git
+## Clone repository
+
+The first step is to fork/clone the repo to your local machine:
+
+    git clone https://github.com/openstreetmap/openstreetmap-website.git

 
 Now change working directory to the `openstreetmap-website`:
 
     cd openstreetmap-website
 
 
 Now change working directory to the `openstreetmap-website`:
 
     cd openstreetmap-website
 

-### Storage setup
+## Initial Setup
+
+### Storage

 
     cp config/example.storage.yml config/storage.yml
 
 
     cp config/example.storage.yml config/storage.yml
 


@@ -33,67 +46,89 @@ This is a workaround. [See issues/2185 for details](https://github.com/openstree
 
     touch config/settings.local.yml
 
 
     touch config/settings.local.yml
 

-### Installation
+**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
+    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:
 
 
 To launch the app run:
 

-    docker-compose up -d
+    docker compose up -d

 
 This will launch one Docker container for each 'service' specified in `docker-compose.yml` and run them in the background. There are two options for inspecting the logs of these running containers:
 
 
 This will launch one Docker container for each 'service' specified in `docker-compose.yml` and run them in the background. There are two options for inspecting the logs of these running containers:
 

-- You can tail logs of a running container with a command like this: `docker-compose logs -f web` or `docker-compose logs -f db`.
-- Instead of running the containers in the background with the `-d` flag, you can launch the containers in the foreground with `docker-compose up`. The downside of this is that the logs of all the 'services' defined in `docker-compose.yml` will be intermingled. If you don't want this you can mix and match - for example, you can run the database in background with `docker-compose up -d db` and then run the Rails app in the foreground via `docker-compose up web`.
+- You can tail logs of a running container with a command like this: `docker compose logs -f web` or `docker compose logs -f db`.
+- Instead of running the containers in the background with the `-d` flag, you can launch the containers in the foreground with `docker compose up`. The downside of this is that the logs of all the 'services' defined in `docker-compose.yml` will be intermingled. If you don't want this you can mix and match - for example, you can run the database in background with `docker compose up -d db` and then run the Rails app in the foreground via `docker compose up web`.

 
 ### Migrations
 
 
 ### 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
+    docker compose run --rm web bundle exec rails db:migrate

 
 

-### Node.js modules
+### Tests

 
 

-We use Yarn to manage the Node.js modules required for the project:
+Prepare the test database:

 
 

-    docker-compose run --rm web rake yarn:install
+     docker compose run --rm web bundle exec rails db:test:prepare

 
 

-Once these are complete you should be able to visit the app at http://localhost:3000
+Run the test suite:

 
 

-If localhost does not work, you can use the IP address of the docker-machine.
+    docker compose run --rm web bundle exec rails test:all

 
 

-### Tests
+### Loading an OSM extract

 
 

-    docker-compose run --rm web rake test:db
+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.

 
 

-### Bash
+For example, let's download the District of Columbia from Geofabrik or [any other region](https://download.geofabrik.de):

 
 

-If you want to get into a web container and run specific commands you can fire up a throwaway container to run bash in via:
+    wget https://download.geofabrik.de/north-america/us/district-of-columbia-latest.osm.pbf

 
 

-    docker-compose run --rm web bash
+You can now use Docker to load this extract into your local Docker-based OSM instance:

 
 

-Alternatively, if you want to use the already-running `web` container then you can `exec` into it via:
+    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"

 
 

-    docker-compose exec web bash
+**Windows users:** Powershell uses `` ` `` and CMD uses `^` at the end of each line, e.g.:

 
 

-Similarly, if you want to `exec` in the db container use:
+    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"

 
 

-    docker-compose exec db bash
+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.

 
 

-### Populating the database
+### Additional Configuration

 
 

-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.
+See [`CONFIGURE.md`](CONFIGURE.md) for information on how to manage users and enable OAuth for iD, JOSM etc.

 
 

-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:
+### Bash

 
 

-    docker-compose run --rm web osmosis \
-        --read-pbf /path/to/file.osm.pbf \
-        --write-apidb \
-        host="db" \
-        database="openstreetmap" \
-        user="openstreetmap" \
-        validateSchemaVersion="no"
+If you want to get into a web container and run specific commands you can fire up a throwaway container to run bash in via:
+
+    docker compose run --rm web bash
+
+Alternatively, if you want to use the already-running `web` container then you can `exec` into it via:
+
+    docker compose exec web bash
+
+Similarly, if you want to `exec` in the db container use:
+
+    docker compose exec db bash