Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add further Docker installation instructions for Windows users #3692

Merged
merged 1 commit into from
Oct 19, 2022
Merged

Add further Docker installation instructions for Windows users #3692

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion DOCKER.md
View file
Open in desktop
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