From e927819d5d84724b732dbf762741b2939986b090 Mon Sep 17 00:00:00 2001 From: lectrician1 Date: Fri, 16 Sep 2022 16:34:28 -0400 Subject: [PATCH 1/2] Add further instructions for Windows users --- DOCKER.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/DOCKER.md b/DOCKER.md index 1def8b1cb..52036327d 100644 --- a/DOCKER.md +++ b/DOCKER.md @@ -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 @@ -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: @@ -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 From 2837e9970f9db17bdc8ec6fed1cb6d8548422d87 Mon Sep 17 00:00:00 2001 From: Andy Allan Date: Wed, 19 Oct 2022 16:11:57 +0100 Subject: [PATCH 2/2] Minor tweaks to the markdown, in particular to wrap code characters in backticks --- DOCKER.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/DOCKER.md b/DOCKER.md index 52036327d..870e3e26e 100644 --- a/DOCKER.md +++ b/DOCKER.md @@ -7,7 +7,7 @@ These instructions are designed for setting up The Rails Port for development an **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. +The first step is to fork/clone the repo to your local machine: git clone https://github.com/openstreetmap/openstreetmap-website.git @@ -82,17 +82,17 @@ 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 ^. +**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" + 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.