foodsoft/doc/SETUP_DEVELOPMENT_DOCKER.md

Foodsoft on Docker

This document explains setting up Foodsoft with Docker for development. system. Another option is to run it within an existing system. If instead you just want to run Foodsoft without changing its code, please refer to hosting or deployment.

Requirements

• Docker (=> 1.9.1)
• Docker Compose (=> 1.4)
• Nothing more, no Ruby, MySQL, Redis etc!

For installing instructions see https://docs.docker.com/installation/. Docker runs on every modern Linux kernel, but also with a little help on MacOS and Windows!

Prerequisites (Linux only)

To install Docker without root privileges, see Run the Docker daemon as a non-root user (Rootless mode): https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user

Prerequisites (Windows only)

To avoid line-ending issues with shell scripts, make sure to configure Git autocrlf to keep linux line endings via

git config --local core.autocrlf input

Don't forget to do a clean checkout (delete everything except .git directory) afterwards.

Setup

Then start the database server and setup foodsoft development (this will take some time, containers needs to be pulled from docker registry and a lot dependencies needs to be installed)

docker-compose -f docker-compose-dev.yml up -d mariadb
docker-compose -f docker-compose-dev.yml run --rm foodsoft \
  bundle install
docker-compose -f docker-compose-dev.yml run --rm foodsoft \
  bundle exec rake foodsoft:setup_development_docker

Optionally an initial database (here seeded with small.en) can be loaded by running

docker-compose -f docker-compose-dev.yml run --rm foodsoft \
  bundle exec rake db:schema:load db:seed:small.en

To avoid having to pass the -f argument all the time, it is recommended to setup an alias, e.g. by adding the following line to your ~/.bashrc

alias docker-compose-dev='docker-compose -f docker-compose-dev.yml'

then reload it by executing . ~/.bashrc. Following commands assume this is setup.

Usage

Start containers (in foreground, stop them with Ctrl-C)

docker-compose-dev up

(Login using the default credentials: admin/secret)

Run a rails/rake command

docker-compose-dev run --rm foodsoft bundle exec rake db:migrate

Open a rails console

docker-compose-dev run --rm foodsoft bundle exec rails c

Setup the test database

docker-compose-dev run --rm mariadb mariadb --host=mariadb --password=secret --execute="CREATE DATABASE test"
docker-compose-dev run --rm foodsoft bundle exec rake db:schema:load RAILS_ENV=test DATABASE_URL=mysql2://root:secret@mariadb/test?encoding=utf8mb4

Run the tests

docker-compose-dev run --rm foodsoft ./bin/test

Jump in a running container for debugging.

docker exec -ti foodsoft_foodsoft_1 bash

Notes

Receiving mails

Go to http://localhost:1080

Manage database

Go to http://localhost:2080

Gemfile updates

As the gem bundle is stored in a volume, you can run

docker-compose-dev run --rm foodsoft bundle install
docker-compose-dev restart foodsoft foodsoft_worker

Do this each time you update your Gemfile.

Database configuration

To make this easier we use the environment variable DATABASE_URL (and TEST_DATABASE_URL when using the testing script).