examples/docker/README.md
The files in this directory let you run any generated example application in containers alongside Postgres and Redis. Mount the repository into the containers, point APP_PATH at your generated host app, and start the stack with Docker Compose.
Note: When running in Docker, Ruby version management (rbenv, asdf, etc.) is handled by the container image itself. All commands run directly without needing version manager prefixes. The Dockerfile specifies the Ruby version, and the container environment ensures the correct version is active.
examples/basic_host/template.rb).env.example to .env and update APP_PATH so it points at your generated example directory (relative to the repository root). Example: APP_PATH=/workspace/examples/source_monitor_basic.examples/docker, run docker compose up --build.The stack launches three Rails processes:
web – Runs bin/rails server bound to 0.0.0.0:3000.worker – Runs bin/rails solid_queue:start.scheduler – Runs bin/jobs --recurring_schedule_file=config/recurring.yml.Services share a persistent bundle cache (bundle volume) and Postgres data directory (postgres-data). Redis stores realtime messages for the advanced example but remains optional for the basic and custom adapter templates.
The entrypoint script accepts the following commands:
web (default)workerschedulerTo open a shell inside the web container:
docker compose run --rm web bash
Gemfile.lock exists under APP_PATH; the entrypoint checks for it and warns if it is missing.npm install fails, add Node dependencies to your example app or remove package.json.DATABASE_URL / REDIS_URL in .env to match your infrastructure when deploying beyond local Compose.