DOCKER.md

   1 # Using Docker and Docker Compose for Development and Testing
   2
   3 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:
   4
   5 - [Install Docker](https://docs.docker.com/install/)
   6 - [Install Docker Compose](https://docs.docker.com/compose/install/)
   7
   8 **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.
   9
  10 The first step is to fork/clone the repo to your local machine:
  11
  12     git clone https://github.com/openstreetmap/openstreetmap-website.git
  13
  14 Now change working directory to the `openstreetmap-website`:
  15
  16     cd openstreetmap-website
  17
  18 ## Initial Setup
  19
  20 ### Storage
  21
  22     cp config/example.storage.yml config/storage.yml
  23
  24 ### Database
  25
  26     cp config/docker.database.yml config/database.yml
  27
  28 ## Prepare local settings file
  29
  30 This is a workaround. [See issues/2185 for details](https://github.com/openstreetmap/openstreetmap-website/issues/2185#issuecomment-508676026).
  31
  32     touch config/settings.local.yml
  33
  34 **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`.
  35
  36 ## Installation
  37
  38 To build local Docker images run from the root directory of the repository:
  39
  40     docker-compose build
  41
  42 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.
  43
  44 To launch the app run:
  45
  46     docker-compose up -d
  47
  48 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:
  49
  50 - You can tail logs of a running container with a command like this: `docker-compose logs -f web` or `docker-compose logs -f db`.
  51 - 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`.
  52
  53 ### Migrations
  54
  55 Run the Rails database migrations:
  56
  57     docker-compose run --rm web bundle exec rails db:migrate
  58
  59 ### Tests
  60
  61 Run the test suite by running:
  62
  63     docker-compose run --rm web bundle exec rails test:all
  64
  65 ### Loading an OSM extract
  66
  67 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.
  68
  69 For example, let's download the District of Columbia from Geofabrik or [any other region](https://download.geofabrik.de):
  70
  71     wget https://download.geofabrik.de/north-america/us/district-of-columbia-latest.osm.pbf
  72
  73 You can now use Docker to load this extract into your local Docker-based OSM instance:
  74
  75     docker-compose run --rm web osmosis \
  76         -verbose    \
  77         --read-pbf district-of-columbia-latest.osm.pbf \
  78         --log-progress \
  79         --write-apidb \
  80             host="db" \
  81             database="openstreetmap" \
  82             user="openstreetmap" \
  83             validateSchemaVersion="no"
  84
  85 **Windows users:** Powershell uses `` ` `` and CMD uses `^` at the end of each line, e.g.:
  86
  87     docker-compose run --rm web osmosis `
  88         -verbose    `
  89         --read-pbf district-of-columbia-latest.osm.pbf `
  90         --log-progress `
  91         --write-apidb `
  92             host="db" `
  93             database="openstreetmap" `
  94             user="openstreetmap" `
  95             validateSchemaVersion="no"
  96
  97 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.
  98
  99 ### Additional Configuration
 100
 101 See [`CONFIGURE.md`](CONFIGURE.md) for information on how to manage users and enable OAuth for iD, JOSM etc.
 102
 103 ### Bash
 104
 105 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:
 106
 107     docker-compose run --rm web bash
 108
 109 Alternatively, if you want to use the already-running `web` container then you can `exec` into it via:
 110
 111     docker-compose exec web bash
 112
 113 Similarly, if you want to `exec` in the db container use:
 114
 115     docker-compose exec db bash