DOCKER.md

   1 # Using Docker and Docker Compose to run OpenStreetMap
   2
   3 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:
   4
   5 - [Install Docker](https://docs.docker.com/install/)
   6 - [Install Docker Compose](https://docs.docker.com/compose/install/)
   7
   8 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).
   9
  10 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:
  11
  12     git clone https://github.com/openstreetmap/openstreetmap-website.git
  13
  14 To clone only the most recent version (~23MB), instead use a 'shallow clone':
  15
  16     git clone --depth=1 https://github.com/openstreetmap/openstreetmap-website.git
  17
  18 Now change working directory to the `openstreetmap-website`:
  19
  20     cd openstreetmap-website
  21
  22 ### Storage setup
  23
  24     cp config/example.storage.yml config/storage.yml
  25
  26 ### Database
  27
  28     cp config/docker.database.yml config/database.yml
  29
  30 ## Prepare local settings file
  31
  32 This is a workaround. [See issues/2185 for details](https://github.com/openstreetmap/openstreetmap-website/issues/2185#issuecomment-508676026).
  33
  34     touch config/settings.local.yml
  35
  36 ### Installation
  37
  38 In the root directory run:
  39
  40     docker-compose build
  41
  42 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.
  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 While the `db` service is running, open another terminal window and run:
  56
  57     docker-compose run --rm web rake db:migrate
  58
  59 ### Loading an OSM extract
  60
  61 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.
  62
  63 For example, let's download the District of Columbia from Geofabrik:
  64
  65     wget https://download.geofabrik.de/north-america/us/district-of-columbia-latest.osm.pbf
  66
  67 You can now use Docker to load this extract into your local Docker-based OSM instance:
  68
  69     docker-compose run --rm web osmosis \
  70         -verbose    \
  71         --read-pbf district-of-columbia-latest.osm.pbf \
  72         --write-apidb \
  73             host="db" \
  74             database="openstreetmap" \
  75             user="openstreetmap" \
  76             validateSchemaVersion="no"
  77
  78 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.
  79
  80 ### Additional Configuration
  81
  82 See `CONFIGURE.md` for information on how to manage users and enable OAuth for iD, JOSM etc.
  83
  84
  85 ### Tests
  86
  87     docker-compose run --rm web rake test:db
  88
  89 ### Bash
  90
  91 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:
  92
  93     docker-compose run --rm web bash
  94
  95 Alternatively, if you want to use the already-running `web` container then you can `exec` into it via:
  96
  97     docker-compose exec web bash
  98
  99 Similarly, if you want to `exec` in the db container use:
 100
 101     docker-compose exec db bash