Docker DEV environment

This text describes workflow based on our docker image.

Before you start

1. You need to know the basics about docker (images, containers, volumes,...). Those information can be found here.
2. You need to be familiar with ER/EP.
3. You need an initial database (demo data, for example).

Build image

There are two options basically. You can use the official v10 image OR build your own image from git.

Because images on www.git.easy.cz are strictly for production use, we will describe how to build them yourselves.

Dockerfile

From repository Dockerfile remove "production"-related config

ENV RAILS_DIR="${HOME}/current" \
    RAILS_DATA="${HOME}/files" \
    RAILS_LOG="${HOME}/log" \
    RUBY_VERSION="${RUBY_VERSION}" \
# [-  RAILS_ENV="production" \-]
    RAILS_MAX_WORKERS="1" \
    RAILS_MAX_THREADS="1"
# [-RUN bundle config set without 'development test'-]

Docker-compose.yml

Use your own docker-compose file:

# development-compose.yml
version: '3'
services:
  db:
    image: mysql:8.0
    env_file: .env
    ports:
      - 3306
    volumes:
      - db_data:/var/lib/mysql

  app:
#    image: registry.git.easy8.com/easyproject_com/stable:latest
    build:
      context: "./"
      args:
        DB: mysql
    volumes:
      - gem_cache:/usr/local/bundle/gems
      - ./plugins:/opt/easy/current/plugins
    ports:
      - 3000:3000
    environment:
      RAILS_ENV: development
      RAILS_SERVE_STATIC_FILES: 1
      RAILS_LOG_TO_STDOUT: 1
      PDF_CHROME_URL: http://pdf_chrome:9222
      PDF_RENDER_BASE_URL: http://app:3000
    env_file: .env
    links:
      - db
    depends_on:
      - db
      - pdf_chrome
    command: server
  pdf_chrome:
    image: chromedp/headless-shell:stable
    command:
      - --disable-gpu
      - --disable-dev-shm-usage
    expose:
      - "9222"
  vue_js:
    build:
      context: .
      dockerfile: Dockerfile-easy_vue
    volumes:
      - ./plugins/easy_vue:/opt/easy_vue

volumes:
  db_data:
  gem_cache:

Dockerfile-easy_vue

If you are a Vue.js developer, you will need node and run DEV npm (yarn). For this you need to create a new Dockerfile-easy_vue in rails root:

Make sure that you have in .env NODES__EASYSOFTWARE__COM token from here.

FROM node:18.8.0
ENV HOME "/opt/easy_vue"
VOLUME "/opt/easy_vue"
WORKDIR ${HOME}

ARG NODES__EASYSOFTWARE__COM
ENV NODES__EASYSOFTWARE__COM $NODES__EASYSOFTWARE__COM

RUN npm config set //nodes.easysoftware.com/:_authToken ${NODES__EASYSOFTWARE__COM}
RUN npm config set //nodes.easysoftware.com/:always-auth true
RUN npm config set @easy:registry https://nodes.easysoftware.com

COPY ./plugins/easy_vue ${HOME}
RUN npm ci

CMD npm run dev

bin/docker-entrypoint.sh

Here you need remove "production" env from puma:

"server" | "start")
    export RAILS_LOG_TO_STDOUT=1
    bundle exec puma --dir "${RAILS_DIR}"[- -e production-] -p 3000 -C "${RAILS_DIR}/config/easy_puma.rb"
    ;;

.env

Finally you need to define .env file which contains ALL required variables in one place:

DB_HOST=db
MYSQL_DATABASE=easy
MYSQL_ROOT_PASSWORD=root
MYSQL_USER=devel
MYSQL_PASSWORD=devel
RAILS_ENV=development
NODES__EASYSOFTWARE__COM=<YOUR TOKEN>
PDF_CHROME_URL=http://pdf_chrome:9222
PDF_RENDER_BASE_URL=http://app:3000

For local Rails outside Docker, start Chrome manually and make Rails reachable from that container:

docker run --rm -p 9222:9222 --add-host=host.docker.internal:host-gateway chromedp/headless-shell:stable --disable-gpu --disable-dev-shm-usage
PDF_CHROME_URL=http://localhost:9222 PDF_RENDER_BASE_URL=http://host.docker.internal:3000 bin/rails s -b 0.0.0.0

If printable template content references Vite dev assets directly, keep Vite reachable from the Chrome container as well, for example with VITE_RUBY_HOST=0.0.0.0 bin/vite dev.

RubyMine officially supports Docker. There is a way how to use Docker container as a ruby interpreter.

Also you can read the guide on how to use VScode with Docker.

And lastly, check Docker documentation