-# 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/)
-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 users: You must 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.
-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:
+The first step is to fork/clone the repo to your local machine:
git clone https://github.com/openstreetmap/openstreetmap-website.git
-To clone only the most recent version (~23MB), instead use a 'shallow clone':
-
- git clone --depth=1 https://github.com/openstreetmap/openstreetmap-website.git
-
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/docker.database.yml config/database.yml
-### App configuration
+## Prepare local settings file
- cp config/settings.yml config/settings.local.yml
+This is a workaround. [See issues/2185 for details](https://github.com/openstreetmap/openstreetmap-website/issues/2185#issuecomment-508676026).
-### Installation
+ touch config/settings.local.yml
-In the root directory run:
+**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:
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:
### 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:
+Run the test suite by running:
- docker-compose run --rm web rake yarn:install
+ docker-compose run --rm web bundle exec rails test:all
-Once these are complete you should be able to visit the app at http://localhost:3000
+### Loading an OSM extract
-If localhost does not work, you can use the IP address of the docker-machine.
+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.
-### Tests
+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
+
+You can now use Docker to load this extract into your local Docker-based OSM instance:
+
+ 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"
+
+**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"
- docker-compose run --rm web rake test:db
+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`](CONFIGURE.md) for information on how to manage users and enable OAuth for iD, JOSM etc.
### Bash
Similarly, if you want to `exec` in the db container use:
docker-compose exec db bash
-
-### Populating the database
-
-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.
-
-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:
-
- docker-compose run --rm web osmosis \
- --read-pbf /path/to/file.osm.pbf \
- --write-apidb \
- host="db" \
- database="openstreetmap" \
- user="openstreetmap" \
- validateSchemaVersion="no"
projects / rails.git / blobdiff