docker-compose.yaml

## Service Definitions
services:

  ## Klippy Services
  ##
  klipper:
    image: mkuf/klipper:latest
    restart: unless-stopped
    privileged: true
    logging:
      driver: none
    depends_on:
      init:
        condition: service_completed_successfully
    command: >
      -I printer_data/run/klipper.tty
      -a printer_data/run/klipper.sock
      printer_data/config/printer.cfg
      -l printer_data/logs/klippy.log
    volumes:
      - /dev:/dev
      - ./config:/opt/printer_data/config
      - run:/opt/printer_data/run
      - gcode:/opt/printer_data/gcodes
      - log:/opt/printer_data/logs
    labels:
      org.prind.service: klipper

  ## WebApi
  ##
  moonraker:
    image: mkuf/moonraker:latest
    restart: unless-stopped
    pid: host
    logging:
      driver: none
    depends_on:
      init:
        condition: service_completed_successfully
      klipper:
        condition: service_started
    volumes:
      - /dev/null:/opt/klipper/config/null
      - /dev/null:/opt/klipper/docs/null
      - /run/dbus:/run/dbus
      - /run/systemd:/run/systemd
      - run:/opt/printer_data/run
      - gcode:/opt/printer_data/gcodes
      - log:/opt/printer_data/logs
      - moonraker-db:/opt/printer_data/database
      - ./config:/opt/printer_data/config
    profiles:
      - fluidd
      - mainsail
      - klipperscreen
      - moonraker-telegram-bot
      - mobileraker_companion
    labels:
      org.prind.service: moonraker
      traefik.enable: true
      traefik.http.services.moonraker.loadbalancer.server.port: 7125
      traefik.http.routers.moonraker.rule: PathPrefix(`/websocket`) ||  PathPrefix(`/printer`) ||  PathPrefix(`/api`) ||  PathPrefix(`/access`) ||  PathPrefix(`/machine`) || PathPrefix(`/server`)
      traefik.http.routers.moonraker.entrypoints: web

  ## Frontends
  ##
  octoprint:
    image: octoprint/octoprint:minimal
    restart: unless-stopped
    depends_on:
      klipper:
        condition: service_started
    privileged: true
    volumes:
      - /dev:/dev
      - run:/opt/printer_data/run
      - octoprint:/octoprint
      - ./config/octoprint.yaml:/octoprint/octoprint/config.yaml
    profiles:
      - octoprint
    labels:
      org.prind.service: octoprint
      traefik.enable: true
      traefik.http.services.octoprint.loadbalancer.server.port: 5000
      traefik.http.routers.octoprint.rule: PathPrefix(`/`)
      traefik.http.routers.octoprint.entrypoints: web

  fluidd:
    image: ghcr.io/fluidd-core/fluidd:latest
    restart: unless-stopped
    profiles:
      - fluidd
    labels:
      org.prind.service: fluidd
      traefik.enable: true
      traefik.http.services.fluidd.loadbalancer.server.port: 80
      traefik.http.routers.fluidd.rule: PathPrefix(`/`)
      traefik.http.routers.fluidd.entrypoints: web

  mainsail:
    image: ghcr.io/mainsail-crew/mainsail:edge
    restart: unless-stopped
    profiles:
      - mainsail
    labels:
      org.prind.service: mainsail
      traefik.enable: true
      traefik.http.services.mainsail.loadbalancer.server.port: 80
      traefik.http.routers.mainsail.rule: PathPrefix(`/`)
      traefik.http.routers.mainsail.entrypoints: web

  ## additional Services
  ##
  klipperscreen:
    image: mkuf/klipperscreen:latest
    restart: unless-stopped
    network_mode: host
    pid: host
    profiles:
      - klipperscreen
    volumes:
      - /run/dbus:/run/dbus
      - /run/systemd:/run/systemd
      - /etc/localtime:/etc/localtime:ro
      - /tmp/.X11-unix:/tmp/.X11-unix
      - ./config:/opt/cfg
    labels:
      org.prind.service: klipperscreen

  moonraker-telegram-bot:
    image: lefskiy/moonraker-telegram-bot:development
    restart: unless-stopped
    logging:
      driver: none
    profiles:
      - moonraker-telegram-bot
    volumes:
      - gcode:/opt/printer_data/gcodes
      - log:/opt/printer_data/logs
      - ./config:/opt/printer_data/config
    labels:
      org.prind.service: moonraker-telegram-bot

  mobileraker_companion:
    image: ghcr.io/clon1998/mobileraker_companion:latest
    restart: unless-stopped
    profiles:
      - mobileraker_companion
    volumes:
      - ./config:/opt/printer_data/config
    labels:
      org.prind.service: mobileraker_companion

  hostmcu:
    image: mkuf/klipper:latest-hostmcu
    restart: unless-stopped
    privileged: true
    volumes:
      - /dev:/dev
      - run:/opt/printer_data/run
    profiles:
      - hostmcu
    labels:
      org.prind.service: hostmcu

  moonraker-obico:
    image: ghcr.io/thespaghettidetective/moonraker-obico:latest
    restart: unless-stopped
    privileged: true
    volumes:
      - ./config:/opt/printer_data/config
      - log:/opt/printer_data/logs
    profiles:
      - moonraker-obico
    labels:
      org.prind.service: moonraker-obico

  ## Accompanying Services/Infra
  ##

  ## Config dir needs to be writable by uid/gid 1000
  ## This container sets the right permissions and exits
  init:
    image: busybox:latest
    command: chown -R 1000:1000 /prind/config
    volumes:
      - .:/prind
    labels:
      org.prind.service: init

  ## Loadbalancer/Proxy
  traefik:
    image: traefik:v2.11
    command:
      - "--accesslog"
      - "--providers.docker=true"
      - "--providers.docker.exposedbydefault=false"
      - "--entrypoints.web.address=:80"
    ports:
      - "80:80"
    restart: unless-stopped
    volumes:
      - "/var/run/docker.sock:/var/run/docker.sock:ro"
    labels:
      org.prind.service: traefik

volumes:
  run:
    driver_opts:
      type: tmpfs
      device: tmpfs
  gcode:
  octoprint:
  moonraker-db:
  log:
    driver_opts:
      type: tmpfs
      device: tmpfs
use profiles for deployment; rename moonraker db volume 2021-10-20 22:46:58 +02:00			`## Service Definitions`
klipper works in docker 2021-10-16 18:42:56 +02:00			`services:`
add moonraker and fluidd 2021-10-16 21:28:14 +02:00
use profiles for deployment; rename moonraker db volume 2021-10-20 22:46:58 +02:00			`## Klippy Services`
			`##`
klipper works in docker 2021-10-16 18:42:56 +02:00			`klipper:`
Always run klipper in privileged mode to allow device name change 2023-06-07 20:52:02 +02:00			`image: mkuf/klipper:latest`
			`restart: unless-stopped`
			`privileged: true`
			`logging:`
			`driver: none`
			`depends_on:`
			`init:`
			`condition: service_completed_successfully`
Add yamllint action (#110) 2024-02-08 22:41:50 +02:00			`command: >`
			`-I printer_data/run/klipper.tty`
			`-a printer_data/run/klipper.sock`
			`printer_data/config/printer.cfg`
			`-l printer_data/logs/klippy.log`
use profiles for deployment; rename moonraker db volume 2021-10-20 22:46:58 +02:00			`volumes:`
Always run klipper in privileged mode to allow device name change 2023-06-07 20:52:02 +02:00			`- /dev:/dev`
Add changes introduced in https://github.com/Arksine/moonraker/pull/491 to moonraker and klipper images. fixes #40 2022-10-18 18:46:05 +02:00			`- ./config:/opt/printer_data/config`
			`- run:/opt/printer_data/run`
			`- gcode:/opt/printer_data/gcodes`
			`- log:/opt/printer_data/logs`
Always run klipper in privileged mode to allow device name change 2023-06-07 20:52:02 +02:00			`labels:`
			`org.prind.service: klipper`
use profiles for deployment; rename moonraker db volume 2021-10-20 22:46:58 +02:00
			`## WebApi`
			`##`
			`moonraker:`
Use `latest` as docker tag to be compatible with docker defaults. Keeps the `nightly` tag for compatibility with previous versions of prind. 2022-07-07 21:50:40 +02:00			`image: mkuf/moonraker:latest`
klipper works in docker 2021-10-16 18:42:56 +02:00			`restart: unless-stopped`
moonraker: allow host control via systemd 2022-03-23 23:41:51 +01:00			`pid: host`
disable docker logs for moonraker and klipper in favor of logfiles 2021-11-29 19:45:54 +01:00			`logging:`
			`driver: none`
use profiles for deployment; rename moonraker db volume 2021-10-20 22:46:58 +02:00			`depends_on:`
rework service dependencies 2022-02-28 19:42:16 +01:00			`init:`
			`condition: service_completed_successfully`
			`klipper:`
			`condition: service_started`
klipper works in docker 2021-10-16 18:42:56 +02:00			`volumes:`
Create Dummy directories for Moonraker Fixes #14 2022-03-30 19:16:57 +02:00			`- /dev/null:/opt/klipper/config/null`
			`- /dev/null:/opt/klipper/docs/null`
moonraker: allow host control via systemd 2022-03-23 23:41:51 +01:00			`- /run/dbus:/run/dbus`
			`- /run/systemd:/run/systemd`
Add changes introduced in https://github.com/Arksine/moonraker/pull/491 to moonraker and klipper images. fixes #40 2022-10-18 18:46:05 +02:00			`- run:/opt/printer_data/run`
			`- gcode:/opt/printer_data/gcodes`
			`- log:/opt/printer_data/logs`
			`- moonraker-db:/opt/printer_data/database`
			`- ./config:/opt/printer_data/config`
use profiles for deployment; rename moonraker db volume 2021-10-20 22:46:58 +02:00			`profiles:`
			`- fluidd`
			`- mainsail`
add klipperscreen to profiles for klipper and moonraker 2022-04-18 21:10:02 +02:00			`- klipperscreen`
add moonraker-telegram-bot service 2022-12-12 18:18:49 +01:00			`- moonraker-telegram-bot`
profiles: add mobileraker_companion 2023-05-28 13:23:20 +02:00			`- mobileraker_companion`
proxy moonraker via traefik; rename klipper-octo to klipper-priv(ileged) 2021-10-21 20:42:30 +02:00			`labels:`
rework labels and add prind specific label to services 2022-12-18 13:58:08 +01:00			`org.prind.service: moonraker`
			`traefik.enable: true`
			`traefik.http.services.moonraker.loadbalancer.server.port: 7125`
moonraker: make router rule work with traefik 3.0-rc1 2024-03-10 01:01:43 +01:00			traefik.http.routers.moonraker.rule: PathPrefix(`/websocket`) \|\| PathPrefix(`/printer`) \|\| PathPrefix(`/api`) \|\| PathPrefix(`/access`) \|\| PathPrefix(`/machine`) \|\| PathPrefix(`/server`)
rework labels and add prind specific label to services 2022-12-18 13:58:08 +01:00			`traefik.http.routers.moonraker.entrypoints: web`
klipper works in docker 2021-10-16 18:42:56 +02:00
use profiles for deployment; rename moonraker db volume 2021-10-20 22:46:58 +02:00			`## Frontends`
			`##`
add octoprint; make klipper privileged; add dependencies 2021-10-19 22:44:20 +02:00			`octoprint:`
use correct octoprint image 2021-10-26 21:25:52 +02:00			`image: octoprint/octoprint:minimal`
add moonraker and fluidd 2021-10-16 21:28:14 +02:00			`restart: unless-stopped`
add octoprint; make klipper privileged; add dependencies 2021-10-19 22:44:20 +02:00			`depends_on:`
Fix dependency for octoprint service 2023-06-07 20:57:35 +02:00			`klipper:`
rework service dependencies 2022-02-28 19:42:16 +01:00			`condition: service_started`
add octoprint; make klipper privileged; add dependencies 2021-10-19 22:44:20 +02:00			`privileged: true`
add moonraker and fluidd 2021-10-16 21:28:14 +02:00			`volumes:`
add octoprint; make klipper privileged; add dependencies 2021-10-19 22:44:20 +02:00			`- /dev:/dev`
Add changes introduced in https://github.com/Arksine/moonraker/pull/491 to moonraker and klipper images. fixes #40 2022-10-18 18:46:05 +02:00			`- run:/opt/printer_data/run`
add octoprint; make klipper privileged; add dependencies 2021-10-19 22:44:20 +02:00			`- octoprint:/octoprint`
octoprint: add basic config * adds config/octoprint.yaml * sets the serial device for octoprint * sets the stream and snapshot urls for octoprint resolves #26 2022-06-13 21:27:44 +02:00			`- ./config/octoprint.yaml:/octoprint/octoprint/config.yaml`
use profiles for deployment; rename moonraker db volume 2021-10-20 22:46:58 +02:00			`profiles:`
			`- octoprint`
add traefik 2021-10-17 15:32:04 +02:00			`labels:`
rework labels and add prind specific label to services 2022-12-18 13:58:08 +01:00			`org.prind.service: octoprint`
			`traefik.enable: true`
			`traefik.http.services.octoprint.loadbalancer.server.port: 5000`
			traefik.http.routers.octoprint.rule: PathPrefix(`/`)
			`traefik.http.routers.octoprint.entrypoints: web`
add octoprint; make klipper privileged; add dependencies 2021-10-19 22:44:20 +02:00
use profiles for deployment; rename moonraker db volume 2021-10-20 22:46:58 +02:00			`fluidd:`
fluidd: use docker image from GHCR The latest official Fluidd Docker image is now only on GHCR 2023-05-14 15:46:01 +01:00			`image: ghcr.io/fluidd-core/fluidd:latest`
use profiles for deployment; rename moonraker db volume 2021-10-20 22:46:58 +02:00			`restart: unless-stopped`
			`profiles:`
			`- fluidd`
			`labels:`
rework labels and add prind specific label to services 2022-12-18 13:58:08 +01:00			`org.prind.service: fluidd`
			`traefik.enable: true`
			`traefik.http.services.fluidd.loadbalancer.server.port: 80`
			traefik.http.routers.fluidd.rule: PathPrefix(`/`)
			`traefik.http.routers.fluidd.entrypoints: web`
add octoprint; make klipper privileged; add dependencies 2021-10-19 22:44:20 +02:00
add mainsail dockerfile and service 2021-10-22 15:46:29 +02:00			`mainsail:`
switch to official mainsail docker image * update docs * update image in compose file * remove mainsail dockerfile * remove mainsail image workflow 2022-07-08 09:44:13 +02:00			`image: ghcr.io/mainsail-crew/mainsail:edge`
add mainsail dockerfile and service 2021-10-22 15:46:29 +02:00			`restart: unless-stopped`
			`profiles:`
			`- mainsail`
			`labels:`
rework labels and add prind specific label to services 2022-12-18 13:58:08 +01:00			`org.prind.service: mainsail`
			`traefik.enable: true`
			`traefik.http.services.mainsail.loadbalancer.server.port: 80`
			traefik.http.routers.mainsail.rule: PathPrefix(`/`)
			`traefik.http.routers.mainsail.entrypoints: web`
add mainsail dockerfile and service 2021-10-22 15:46:29 +02:00
add moonraker-telegram-bot service 2022-12-12 18:18:49 +01:00			`## additional Services`
			`##`
KlipperScreen initial setup * KlipperScreen Dockerfile * GitHub Workflow * klipperscreen.conf * klipperscreen service definition 2022-03-12 21:34:52 +01:00			`klipperscreen:`
Use `latest` as docker tag to be compatible with docker defaults. Keeps the `nightly` tag for compatibility with previous versions of prind. 2022-07-07 21:50:40 +02:00			`image: mkuf/klipperscreen:latest`
KlipperScreen initial setup * KlipperScreen Dockerfile * GitHub Workflow * klipperscreen.conf * klipperscreen service definition 2022-03-12 21:34:52 +01:00			`restart: unless-stopped`
			`network_mode: host`
klipperscreen: configure service to allow host shutdown 2023-04-10 00:11:26 +02:00			`pid: host`
KlipperScreen initial setup * KlipperScreen Dockerfile * GitHub Workflow * klipperscreen.conf * klipperscreen service definition 2022-03-12 21:34:52 +01:00			`profiles:`
			`- klipperscreen`
			`volumes:`
klipperscreen: mount host dbus into container 2023-09-19 18:29:17 +02:00			`- /run/dbus:/run/dbus`
klipperscreen: configure service to allow host shutdown 2023-04-10 00:11:26 +02:00			`- /run/systemd:/run/systemd`
klipperscreen: use hosts localtime 2022-03-25 17:06:11 +01:00			`- /etc/localtime:/etc/localtime:ro`
KlipperScreen initial setup * KlipperScreen Dockerfile * GitHub Workflow * klipperscreen.conf * klipperscreen service definition 2022-03-12 21:34:52 +01:00			`- /tmp/.X11-unix:/tmp/.X11-unix`
klipperscreen: use hosts localtime 2022-03-25 17:06:11 +01:00			`- ./config:/opt/cfg`
rework labels and add prind specific label to services 2022-12-18 13:58:08 +01:00			`labels:`
			`org.prind.service: klipperscreen`
KlipperScreen initial setup * KlipperScreen Dockerfile * GitHub Workflow * klipperscreen.conf * klipperscreen service definition 2022-03-12 21:34:52 +01:00
add moonraker-telegram-bot service 2022-12-12 18:18:49 +01:00			`moonraker-telegram-bot:`
			`image: lefskiy/moonraker-telegram-bot:development`
			`restart: unless-stopped`
			`logging:`
			`driver: none`
			`profiles:`
			`- moonraker-telegram-bot`
			`volumes:`
			`- gcode:/opt/printer_data/gcodes`
			`- log:/opt/printer_data/logs`
			`- ./config:/opt/printer_data/config`
moonraker-telegram-bot: add service label 2022-12-18 17:36:57 +01:00			`labels:`
			`org.prind.service: moonraker-telegram-bot`
add moonraker-telegram-bot service 2022-12-12 18:18:49 +01:00
profiles: add mobileraker_companion 2023-05-28 13:23:20 +02:00			`mobileraker_companion:`
			`image: ghcr.io/clon1998/mobileraker_companion:latest`
			`restart: unless-stopped`
			`profiles:`
			`- mobileraker_companion`
			`volumes:`
			`- ./config:/opt/printer_data/config`
			`labels:`
			`org.prind.service: mobileraker_companion`

Add hostmcu Workflow (#79) * klipper: rename the mcu target to tools * klipper: add hostmcu target * klipper: add klipper user to tty group * klipper: add build config for klipper_mcu * docs: add new targets to klipper image readme * docs: add hostmcu profile to additional profiles * add hostmcu profile 2023-06-17 12:48:52 +02:00			`hostmcu:`
			`image: mkuf/klipper:latest-hostmcu`
			`restart: unless-stopped`
			`privileged: true`
			`volumes:`
			`- /dev:/dev`
			`- run:/opt/printer_data/run`
			`profiles:`
			`- hostmcu`
			`labels:`
			`org.prind.service: hostmcu`

Add moonraker-obico service (#89) * add moonraker-obico service * config: add moonraker-obico basic config * docs: moonraker-obico profile * moonraker-obico: simplify linking process * moonraker-obico: use root when linking a new printer * docs: update docs for moonraker-obico profile * docs: update changelog 2023-08-20 19:13:27 +02:00			`moonraker-obico:`
			`image: ghcr.io/thespaghettidetective/moonraker-obico:latest`
			`restart: unless-stopped`
moonraker-obico: run in privileged mode 2023-09-23 16:52:38 +02:00			`privileged: true`
Add moonraker-obico service (#89) * add moonraker-obico service * config: add moonraker-obico basic config * docs: moonraker-obico profile * moonraker-obico: simplify linking process * moonraker-obico: use root when linking a new printer * docs: update docs for moonraker-obico profile * docs: update changelog 2023-08-20 19:13:27 +02:00			`volumes:`
			`- ./config:/opt/printer_data/config`
			`- log:/opt/printer_data/logs`
			`profiles:`
			`- moonraker-obico`
			`labels:`
			`org.prind.service: moonraker-obico`

use profiles for deployment; rename moonraker db volume 2021-10-20 22:46:58 +02:00			`## Accompanying Services/Infra`
			`##`
add moonraker and fluidd 2021-10-16 21:28:14 +02:00
add simulavr container for debugging (#12) * script: restructure build commands * klipper: add simulavr target * simulavr: add klipper config for simulavr; add compose file for simulavr * simulavr: set dependencies for klipper service * move ustreamer to override file; rearrange init service in main compose file; move config for simulavr to printer.cfg * move printer.cfg for simulavr to extra file * README: add debugging section * update docs 2022-03-09 22:36:54 +01:00			`## Config dir needs to be writable by uid/gid 1000`
			`## This container sets the right permissions and exits`
			`init:`
			`image: busybox:latest`
			`command: chown -R 1000:1000 /prind/config`
			`volumes:`
			`- .:/prind`
rework labels and add prind specific label to services 2022-12-18 13:58:08 +01:00			`labels:`
			`org.prind.service: init`
add traefik 2021-10-17 15:32:04 +02:00
use profiles for deployment; rename moonraker db volume 2021-10-20 22:46:58 +02:00			`## Loadbalancer/Proxy`
add traefik 2021-10-17 15:32:04 +02:00			`traefik:`
chore(deps): update traefik docker tag to v2.11 (#127) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> 2024-03-10 01:03:46 +01:00			`image: traefik:v2.11`
add traefik 2021-10-17 15:32:04 +02:00			`command:`
change how entrypoint and cmds work, so flags can be set at container creation 2021-10-20 23:18:43 +02:00			`- "--accesslog"`
			`- "--providers.docker=true"`
			`- "--providers.docker.exposedbydefault=false"`
			`- "--entrypoints.web.address=:80"`
add traefik 2021-10-17 15:32:04 +02:00			`ports:`
change how entrypoint and cmds work, so flags can be set at container creation 2021-10-20 23:18:43 +02:00			`- "80:80"`
add traefik 2021-10-17 15:32:04 +02:00			`restart: unless-stopped`
			`volumes:`
Add yamllint action (#110) 2024-02-08 22:41:50 +02:00			`- "/var/run/docker.sock:/var/run/docker.sock:ro"`
rework labels and add prind specific label to services 2022-12-18 13:58:08 +01:00			`labels:`
			`org.prind.service: traefik`
add ustreamer; tweak moonraker and klipper dockerfiles 2021-10-17 14:11:32 +02:00
klipper works in docker 2021-10-16 18:42:56 +02:00			`volumes:`
			`run:`
use tmpfs for volume "run" 2021-11-29 19:57:32 +01:00			`driver_opts:`
			`type: tmpfs`
			`device: tmpfs`
add moonraker and fluidd 2021-10-16 21:28:14 +02:00			`gcode:`
add octoprint; make klipper privileged; add dependencies 2021-10-19 22:44:20 +02:00			`octoprint:`
use profiles for deployment; rename moonraker db volume 2021-10-20 22:46:58 +02:00			`moonraker-db:`
configure services to write logs to tmpfs volume 2021-11-25 19:18:52 +01:00			`log:`
			`driver_opts:`
			`type: tmpfs`
			`device: tmpfs`