X-Git-Url: https://git.openstreetmap.org/rails.git/blobdiff_plain/550c4a3a45814fde5c809334c85f1ebc47659a82..eba12dc876709d335c378beb67b7b8ae9f7ef10c:/INSTALL.md diff --git a/INSTALL.md b/INSTALL.md index 3d591c92d..b14a2d32b 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,6 +1,6 @@ # Installation -These instructions are designed for setting up The Rails Port for development and testing. +These instructions are designed for setting up `openstreetmap-website` for development and testing. If you want to deploy the software for your own project, then see the notes at the end. You can install the software directly on your machine, which is the traditional and probably best-supported approach. However, there @@ -12,7 +12,7 @@ are two alternatives which make it easier to get a consistent development enviro These instructions are based on Ubuntu 20.04 LTS, which is the platform used by the OSMF servers. The instructions also work, with only minor amendments, for all other current Ubuntu releases, Fedora and MacOSX -We don't recommend attempting to develop or deploy this software on Windows. If you need to use Windows, then try developing this software using Ubuntu in a virtual machine, or use [Vagrant](VAGRANT.md). +We don't recommend attempting to develop or deploy this software on Windows. Some Ruby gems may not be supported. If you need to use Windows the easiest solutions in order are [Docker](DOCKER.md), [Vagrant](VAGRANT.md), and Ubuntu in a virtual machine. ## Dependencies @@ -150,7 +150,7 @@ touch config/settings.local.yml ## Storage setup -The Rails port needs to be configured with an object storage facility - for +`openstreetmap-website` needs to be configured with an object storage facility - for development and testing purposes you can use the example configuration: ``` @@ -159,7 +159,7 @@ cp config/example.storage.yml config/storage.yml ## Database setup -The Rails Port uses three databases - one for development, one for testing, and one for production. The database-specific configuration +`openstreetmap-website` uses three databases - one for development, one for testing, and one for production. The database-specific configuration options are stored in `config/database.yml`, which we need to create from the example template. ```