Need help with docker-rails?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

ledermann
867 Stars 136 Forks MIT License 4.1K Commits 1 Opened issues

Description

Dockerize Rails 6 with ActionCable, Webpacker, Stimulus, Elasticsearch, Sidekiq

Services available

!
?

Need anything else?

Contributors list

# 32,925
Ruby
Rails
elastic...
XML
2102 commits
# 9,169
nextjs
GraphQL
probot-...
Less
260 commits
# 749
GitHub
rust-la...
wechat-...
query-l...
64 commits
# 2,957
query-l...
python-...
mvvm-fr...
wechat-...
33 commits
# 474,699
stimulu...
referen...
sidekiq
elastic...
1 commit
# 181
nextjs
postman...
graphql...
angular...
1 commit

Docker-Rails

Maintainability

Simple Rails 6.1 application to demonstrate using Docker for production deployment. The application is a very simple kind of CMS (content management system) allowing to manage posts. Beside the boring CRUD functionality it has some non-default features.

This project aims to build a lean Docker image for use in production. Therefore it's based on the official Alpine Ruby image, uses multi-stage building and some optimizations that I described in my blog. This results in an image size of ~80MB.

Features

Why?

This project demonstrates my way of building Rails applications. The techniques used to build the app should not be considered as "best practice", maybe there are better ways to build. Any feedback would be appreciated.

Multi container architecture

There is an example docker-compose.production.yml. The whole stack is divided into multiple different containers:

  • app: Main part. It contains the Rails code to handle web requests (by using the Puma gem). See the Dockerfile for details. The image is based on the Alpine variant of the official Ruby image and uses multi-stage building.
  • worker: Background processing. It contains the same Rails code, but only runs Sidekiq
  • db: PostgreSQL database
  • elasticsearch: Full text search engine
  • redis: In-memory key/value store (used by Sidekiq, ActionCable and for caching)
  • backup: Regularly backups the database as a dump via CRON to an Amazon S3 bucket

Check it out!

To start up the application in your local Docker environment:

git clone https://github.com/ledermann/docker-rails.git
cd docker-rails
docker-compose build
docker-compose up

Wait some minutes while the database will be prepared by fetching articles from Wikipedia. Then, navigate your browser to

http://[DOCKER_HOST]:[DOCKER_PORT]
.

Sign in to the admin account:

Enjoy!

Tests / CI

On every push, the test suite (including RuboCop checks) is performed via GitHub Actions. If successful, a production image is built and pushed to a private GitLab Docker Registry.

Production deployment

The Docker image build includes precompiled assets only (no node_modules and no sources). The spec folder is removed and the Alpine packages for Node and Yarn are not installed.

The stack is ready to host with traefik or nginx proxy and letsencrypt-nginx-proxy-companion.

Demo

A demo installation is set up on https://docker-rails.georg-ledermann.de.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.