X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/e927819d5d84724b732dbf762741b2939986b090..007413f9b42b9ba9047ed82fc75b5fbef35e7467:/DOCKER.md?ds=sidebyside diff --git a/DOCKER.md b/DOCKER.md index 52036327d..bddb9695b 100644 --- a/DOCKER.md +++ b/DOCKER.md @@ -1,13 +1,13 @@ # Using Docker and Docker Compose for Development and Testing -These instructions are designed for setting up The Rails Port 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: +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/) -**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. +**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 first step is to fork/clone the repo to your local machine: git clone https://github.com/openstreetmap/openstreetmap-website.git @@ -54,7 +54,7 @@ This will launch one Docker container for each 'service' specified in `docker-co Run the Rails database migrations: - docker-compose run --rm web bundle exec rake db:migrate + docker-compose run --rm web bundle exec rails db:migrate ### Tests @@ -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.