👤 Author: Nick Yeoman.

Docker Compose file collection reference with the intent of running in production.

Requirements and Support

• Minimum Docker Engine: 20.10.0
• Minimum Docker Compose CLI: v2.0.0

🤔 Assumptions

These compose files make a few assumptions:

1. You are only running on one host.
2. You are using Nginx Proxy Manager (although most have redundant port access).
3. Volumes are stored in the project folder under "data", git ignored and backed up externally.

📚 Workflow

The intended workflow is as follows:

1. Copy cookbook.env to .env of your project
2. Copy the docker-compse.yml file to your project
3. Concatonate the sample.env to .env in your project
4. OPTIONAL: concatonate network.yml into your docker-compose.yml

You may have to use multiple containers, such as Maria or postgres for db.

Docker Compose Template

Adopting an order/template to the docker compose files as follows:

# [App Name] Docker Compose Template (e.g., CORXN)

services:
  [service-name]:
    image: ${APPNAME_IMAGE_NAME:-user/name:latest}
    restart: ${APPNAME_RESTART:-unless-stopped}
    volumes:  # Templated with VOL_PATH, CONFIG_PATH or LOG_PATH
      - ${VOL_PATH:-./data}/appname/dir:/data
      - ${CONFIG_PATH:-./config}/appname/dir:/config
      - ${LOG_PATH:-./logs}/appname/dir:/var/logs
      - /etc/localtime:/etc/localtime:ro
    environment:  # Grouped: Universal first, app-specific after
      - TZ=${TZ:-UTC}
      - [APP_VAR1]=${[APP_VAR1]:-default}
      - [APP_VAR2]=${[APP_VAR2]:-default}
    ports: # Can remove this for proxy
      - "${APP_PORT:-9999}:9999"
    networks:
      - proxy
      - internal
    network_mode: "host"
    depends_on:
      - [db-service]  # e.g., mariadb
    healthcheck:  # Optional: App-specific
      test: ["CMD", "curl", "-f", "http://localhost:[port]"]
      interval: 30s
      timeout: 10s
      retries: 3
    labels:  # Optional
      - "traefik.enable=false"
    command:  # Override entrypoint if needed
    user: "1000:1000"  # Non-root

Decisions

container_name

As we are going to rely on COMPOSE_PROJECT_NAME to create our project names, container_name has been left out of the template intentionally.

Paths

I use 3 Paths strategies:

1. VOL_PATH, usually ./data is a data directory that is not in git, backed up externally.
2. CONFIG_PATH usually ./config is stored in git (text files)
3. LOG_PATH, usually ./logs is not stored in git or backed up.

Similar Projects

• Awesome Compose - A starting point for integrating different services using a Compose file.
• Docker compose collection Deploy multiple services easily and quickly.
• hotio.dev - These are images not compose files, but very useful.