Skip to content

Commit

Permalink
Add further instructions for Windows users
Browse files Browse the repository at this point in the history
  • Loading branch information
lectrician1 committed Sep 16, 2022
1 parent aae5cd3 commit e927819
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion DOCKER.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ 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/)

The first step is to fork/clone the repo to your local machine:
**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

Expand All @@ -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:
Expand Down Expand Up @@ -78,6 +82,18 @@ You can now use Docker to load this extract into your local Docker-based OSM ins
user="openstreetmap" \
validateSchemaVersion="no"

**Windows users:** Powershell uses ` and CMD uses ^.

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
Expand Down

0 comments on commit e927819

Please sign in to comment.