Installing DEV with Docker [Beta]

Our docker implementation is incomplete and may not work smoothly. Please, kindly report any issues!

Installing prerequisites

These prerequisites assume you're working on an operating system supported by Docker.

Docker and Docker Compose

Docker is available for many different operating systems. We recommend you follow the Docker CE install guide, which illustrates multiple installation options for each OS.

You're also going to need Docker Compose, to start multiple containers. We recommend you follow the Docker Compose install guide as well.

Installing DEV

  1. Fork DEV's repository, e.g.
  2. Clone your forked repository, eg. git clone<your-username>/
  3. Set up your environment variables/secrets

    • Take a look at Envfile. This file lists all the ENV variables we use and provides a fake default for any missing keys. You'll need to get your own free Algolia credentials to get your development environment running.
    • The backend guide will show you how to get free API keys for additional services that may be required to run certain parts of the app.
    • For any key that you wish to enter/replace:

      1. Create config/application.yml by copying from the provided template (i.e. with bash: cp config/sample_application.yml config/application.yml). This is a personal file that is ignored in git.
      2. Obtain the development variable and apply the key you wish to enter/replace. i.e.:
    • Update the redis url variables by adding the following lines into config/application.yml:

       REDIS_URL: "redis://redis:6379"
       REDIS_SESSIONS_URL: "redis://redis:6379"
    • You do not need "real" keys for basic development. Some features require certain keys, so you may be able to add them as you go.

Running the Docker app (basic)

Docker compose will by default use postgres:9.6 as the database version, should you want to update that set the `POSTGRESVERSION` variable in your environment and start the container again_

  1. run docker-compose build
  2. run docker-compose run web rails db:setup
  3. run docker-compose run web yarn
  4. run docker-compose run web rails search:setup
  5. run docker-compose up
  6. That's it! Navigate to http://localhost:3000

Running the Docker app (advanced)

DEV provides a script which can be used to run the Docker app with custom options.

Please execute the script itself to view all additional options:


Known Problems & Solutions

  • Should you experience problems with the Elasticsearch container, try to increase the memory and/or swap allocation for Docker. On macOS this can be done via the GUI:

    docker gui

  • In case rails server doesn't start with the following message:

    Data update scripts need to be run before you can start the application. Please run rails data_updates:run (RuntimeError)

    run the following command:

    docker-compose run web rails data_updates:run