INSTALL.md

   1 # Installation
   2
   3 These instructions are designed for setting up `openstreetmap-website` development enviroment. If you want to deploy the software for your own project, then see the [Production Deployment Notes](#production-deployment-notes).
   4
   5 ## Installation Options
   6
   7 You can setup development enviroment by:
   8
   9 ### Containerized Installation
  10
  11 We also offer a containerized environment with Docker which may avoid installation difficulties. See [DOCKER.md](DOCKER.md) for complete instructions.
  12
  13 ### Manual Installation
  14
  15 Install dependencies directly on your machine (traditional approach, covered in this guide). This gives you the most control and is often preferred by experienced developers on Linux systems.
  16
  17 ---
  18
  19 **Platform Support:** These instructions are based on Ubuntu 24.04 LTS, though the OSMF servers are currently running Debian 12. The instructions also work, with only minor amendments, for all other current Ubuntu releases, Fedora and macOS.
  20
  21 > [!WARNING]
  22 > **Windows Note:** We don't recommend using this approach for development and deployment on Windows. Some Ruby gems may not be supported. If you are using Windows, we recommend containerized setup using [Docker](DOCKER.md).
  23
  24 ## Manual Installation Guide
  25
  26 ### Prerequisites
  27
  28 Many of the dependencies are managed through the standard Ruby on Rails mechanisms - i.e. ruby gems specified in the Gemfile and installed using bundler. However, there are some packages required before you can get the various gems installed.
  29
  30 **Minimum requirements:**
  31 * Ruby 3.2+
  32 * PostgreSQL 13+
  33 * Bundler (see note below about [developer Ruby setup](#ruby-version-manager-optional))
  34 * JavaScript Runtime
  35
  36 ### Step 1: Install System Dependencies
  37
  38 #### Ubuntu 24.04 LTS
  39
  40 ```bash
  41 sudo apt-get update
  42 sudo apt-get install ruby ruby-dev ruby-bundler \
  43                      libvips-dev libxml2-dev libxslt1-dev nodejs \
  44                      build-essential git-core \
  45                      postgresql postgresql-contrib libpq-dev libsasl2-dev \
  46                      libffi-dev libgd-dev libarchive-dev libyaml-dev libbz2-dev npm
  47 sudo npm install --global yarn
  48 ```
  49
  50 > [!TIP]
  51 > On Ubuntu 24.04, you may need to start PostgreSQL:
  52 >
  53 > ```bash
  54 > sudo systemctl start postgresql.service
  55 > ```
  56
  57 #### Fedora
  58
  59 ```bash
  60 sudo dnf install ruby ruby-devel rubygem-rdoc rubygem-bundler rubygems \
  61                  libxml2-devel nodejs \
  62                  gcc gcc-c++ git \
  63                  postgresql postgresql-server postgresql-contrib libpq-devel \
  64                  perl-podlators libffi-devel gd-devel libarchive-devel \
  65                  libyaml-devel bzip2-devel nodejs-yarn vips-devel
  66 ```
  67
  68 On Fedora, if you didn't already have PostgreSQL installed then create a PostgreSQL instance and start the server:
  69
  70 ```bash
  71 sudo postgresql-setup initdb
  72 sudo systemctl start postgresql.service
  73 ```
  74
  75 Optionally set PostgreSQL to start on boot:
  76
  77 ```bash
  78 sudo systemctl enable postgresql.service
  79 ```
  80
  81 #### macOS
  82
  83 For macOS, you will need [Xcode Command Line Tools](https://mac.install.guide/commandlinetools/); OS X 10.7 (Lion) or later; and some familiarity with Unix development via the Terminal.
  84
  85 **Installing PostgreSQL:**
  86
  87 * Install Postgres.app from https://postgresapp.com/
  88 * Make sure that you've initialized and started Postgresql from the app (there should be a little elephant icon in your systray).
  89 * Add PostgreSQL to your path, by editing your profile:
  90
  91 ```bash
  92 nano ~/.profile
  93 ```
  94
  95 and adding:
  96
  97 ```bash
  98 export PATH=/Applications/Postgres.app/Contents/Versions/latest/bin:$PATH
  99 ```
 100
 101 After this, you may need to start a new shell window, or source the profile again by running `. ~/.profile`.
 102
 103 **Installing other dependencies:**
 104
 105 * Install Homebrew from https://brew.sh/
 106 * Install the latest version of Ruby: `brew install ruby`
 107 * Install other dependencies: `brew install libxml2 gd yarn pngcrush optipng pngquant jhead jpegoptim gifsicle svgo advancecomp vips`
 108 * Install Bundler: `gem install bundler` (you might need to `sudo gem install bundler` if you get an error about permissions - or see note below about [developer Ruby setup](#ruby-version-manager-optional))
 109
 110 You will need to tell `bundler` that `libxml2` is installed in a Homebrew location. If it uses the system-installed one then you will get errors installing the `libxml-ruby` gem later on.
 111
 112 ```bash
 113 bundle config build.libxml-ruby --with-xml2-config=/usr/local/opt/libxml2/bin/xml2-config
 114 ```
 115
 116 If you want to run the tests, you need `geckodriver` as well:
 117
 118 ```bash
 119 brew install geckodriver
 120 ```
 121
 122 > [!NOTE]
 123 > OS X does not have a /home directory by default, so if you are using the GPX functions, you will need to change the directories specified in config/application.yml.
 124
 125 </details>
 126
 127 ### Step 2: Clone the Repository
 128
 129 The repository is reasonably large (~150MB) and it's unlikely that you need the full history. If you are happy to wait for it all to download, run:
 130
 131 ```bash
 132 git clone https://github.com/openstreetmap/openstreetmap-website.git
 133 ```
 134
 135 > [!TIP]
 136 > To clone only the most recent version (~23MB), instead use a 'shallow clone':
 137 >
 138 > ```bash
 139 > git clone --depth=1 https://github.com/openstreetmap/openstreetmap-website.git
 140 > ```
 141 >
 142 > If you want to add in the full history later on, perhaps to run `git blame` or `git log`, run `git fetch --depth=1000000`
 143
 144 ### Step 3: Install Application Dependencies
 145
 146 #### Ruby gems
 147
 148 We use [Bundler](https://bundler.io/) to manage the rubygems required for the project.
 149
 150 ```bash
 151 cd openstreetmap-website
 152 bundle install
 153 ```
 154
 155 #### Node.js modules
 156
 157 We use [Yarn](https://yarnpkg.com/) to manage the Node.js modules required for the project.
 158
 159 ```bash
 160 bundle exec bin/yarn install
 161 ```
 162
 163 ### Step 4: Prepare Configuration Files
 164
 165 #### Local settings file
 166
 167 > [!NOTE]
 168 > This is a workaround. [See issues/2185 for details](https://github.com/openstreetmap/openstreetmap-website/issues/2185#issuecomment-508676026).
 169
 170 ```bash
 171 touch config/settings.local.yml
 172 ```
 173
 174 #### Storage setup
 175
 176 `openstreetmap-website` needs to be configured with an object storage facility - for development and testing purposes you can use the example configuration:
 177
 178 ```bash
 179 cp config/example.storage.yml config/storage.yml
 180 ```
 181
 182 ### Step 5: Database Setup
 183
 184 `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.
 185
 186 ```bash
 187 cp config/example.database.yml config/database.yml
 188 ```
 189
 190 > [!IMPORTANT]
 191 > PostgreSQL is configured to, by default, accept local connections without requiring a username or password. This is fine for development. If you wish to set up your database differently, then you should change the values found in the `config/database.yml` file, and amend the instructions below as appropriate.
 192
 193 #### PostgreSQL account setup
 194
 195 We need to create a PostgreSQL role (i.e. user account) for your current user, and it needs to be a superuser so that we can create more databases.
 196
 197 ```bash
 198 sudo -u postgres -i
 199 createuser -s <username>
 200 exit
 201 ```
 202
 203 #### Create the databases
 204
 205 To create the three databases - for development, testing and production - run:
 206
 207 ```bash
 208 bundle exec rails db:create
 209 ```
 210
 211 #### Database structure
 212
 213 To create all the tables, indexes and constraints, run:
 214
 215 ```bash
 216 bundle exec rails db:migrate
 217 ```
 218
 219 ## Validate Your Installation
 220
 221 ### Running the tests
 222
 223 To ensure that everything is set up properly, you should now run:
 224
 225 ```bash
 226 bundle exec rails test:all
 227 ```
 228
 229 This test will take a few minutes, reporting tests run, assertions, and any errors. If you receive no errors, then your installation is successful.
 230
 231 > [!NOTE]
 232 > The unit tests may output parser errors related to "Attribute lat redefined." These can be ignored.
 233
 234 ### Starting the server
 235
 236 Rails comes with a built-in webserver, so that you can test on your own machine without needing a server. Run
 237
 238 ```bash
 239 bundle exec rails server
 240 ```
 241
 242 You can now view the site in your favourite web-browser at [http://localhost:3000/](http://localhost:3000/)
 243
 244 > [!NOTE]
 245 > The OSM map tiles you see aren't created from your local database - they are just the standard map tiles.
 246
 247 ## What's Next?
 248
 249 🎉 **Congratulations!** You have successfully installed the OpenStreetMap website.
 250
 251 **Next steps:**
 252 * **Configuration:** See [CONFIGURE.md](CONFIGURE.md) for populating the database with data, creating users, setting up OAuth, and other configuration tasks.
 253 * **Contributing:** Check out [CONTRIBUTING.md](CONTRIBUTING.md) for coding style guidelines, testing procedures, and how to submit your contributions.
 254
 255 ## Ruby Version Manager (Optional)
 256
 257 For simplicity, this document explains how to install all the website dependencies as "system" dependencies. While this is simpler, and usually faster, you might want more control over the process or the ability to install multiple different versions of software alongside each other. For many developers, [`rbenv`](https://github.com/rbenv/rbenv) is the easiest way to manage multiple different Ruby versions on the same computer - with the added advantage that the installs are all in your home directory, so you don't need administrator permissions.
 258
 259 If you choose to install Ruby and Bundler via `rbenv`, then you do not need to install the system libraries for Ruby:
 260
 261 * For Ubuntu, you do not need to install the following packages: `ruby ruby-dev ruby-bundler`,
 262 * For Fedora, you do not need to install the following packages: `ruby ruby-devel rubygem-rdoc rubygem-bundler rubygems`
 263 * For macOS, you do not need to `brew install ruby`
 264
 265 > [!IMPORTANT]
 266 > On macOS, make sure you've installed a version of Ruby using `rbenv` before running `gem install bundler`!
 267
 268 After installing a version of Ruby with `rbenv` (the latest stable version is a good place to start), you will need to make that the default. From inside the `openstreetmap-website` directory, run:
 269
 270 ```bash
 271 rbenv local $VERSION
 272 ```
 273
 274 Where `$VERSION` is the version you installed. Then install bundler:
 275
 276 ```bash
 277 gem install bundler
 278 ```
 279
 280 You should now be able to proceed with the rest of the installation. If you're on macOS, make sure you set up the [config override for the libxml2 location](#macos-click-to-expand) _after_ installing bundler.
 281
 282 ## Production Deployment Notes
 283
 284 > [!WARNING]
 285 > Production deployment requires careful configuration and is significantly different from development setup.
 286
 287 If you want to deploy `openstreetmap-website` for production use, you'll need to make a few changes:
 288
 289 > [!IMPORTANT]
 290 > It's not recommended to use `rails server` in production. Our recommended approach is to use [Phusion Passenger](https://www.phusionpassenger.com/). Instructions are available for [setting it up with most web servers](https://www.phusionpassenger.com/documentation_and_support#documentation).
 291
 292 * Passenger will, by design, use the Production environment and therefore the production database - make sure it contains the appropriate data and user accounts.
 293
 294 > [!TIP]
 295 > The included version of the map call is quite slow and eats a lot of memory. You should consider using [CGIMap](https://github.com/zerebubuth/openstreetmap-cgimap) instead.
 296
 297 * Make sure you generate the i18n files and precompile the production assets: `RAILS_ENV=production bundle exec i18n export; bundle exec rails assets:precompile`
 298 * Make sure the web server user as well as the rails user can read, write and create directories in `tmp/`.