Files
komodo/compose/periphery.compose.yaml
2025-09-29 00:06:35 -07:00

67 lines
3.2 KiB
YAML

####################################
# 🦎 KOMODO COMPOSE - PERIPHERY 🦎 #
####################################
## This compose file will deploy:
## 1. Komodo Periphery
services:
periphery:
image: ghcr.io/moghtech/komodo-periphery:${COMPOSE_KOMODO_IMAGE_TAG:-latest}
labels:
komodo.skip: # Prevent Komodo from stopping with StopAllContainers
restart: unless-stopped
## https://komo.do/docs/connect-servers#configuration
environment:
### ==============================
### CORE -> PERIPHERY CONNECTION
### ==============================
## List of accepted Core public keys
PERIPHERY_CORE_PUBLIC_KEYS: sFIibtOSCFLQelO4b4x6VoYIddkRn9Tj1Nas2eR1ME0=
### ==============================
### PERIPHERY -> CORE CONNECTION
### ==============================
## The address of Komodo Core to connect to.
# PERIPHERY_CORE_ADDRESS: komodo.example.com
## The name of the Komodo Server to connect as.
## Must match existing server.
# PERIPHERY_CONNECT_AS: server-name
## Core must have matching public key configured to authenticate.
## Compute then public key using `km key compute <private-key>`.
# PERIPHERY_PRIVATE_KEY: default-periphery-pk
## Disable the inbound connection server.
# PERIPHERY_SERVER_ENABLED: false
### ================
### GENERAL CONFIG
### ================
## Specify the root directory used by Periphery agent.
## All your compose files and repos need to be inside this directory
## for Periphery to interact with them.
PERIPHERY_ROOT_DIRECTORY: ${PERIPHERY_ROOT_DIRECTORY:-/etc/komodo}
## Specify whether to disable the terminals feature
## and disallow remote shell access (inside the Periphery container).
PERIPHERY_DISABLE_TERMINALS: false
## Specify whether to disable the container exec feature
## and disallow remote container shell access.
PERIPHERY_DISABLE_CONTAINER_EXEC: false
## If the disk size is overreporting, can use one of these to
## whitelist / blacklist the disks to filter them, whichever is easier.
## Accepts comma separated list of paths.
## Usually whitelisting just /etc/hostname gives correct size for single root disk.
PERIPHERY_INCLUDE_DISK_MOUNTS: /etc/hostname
# PERIPHERY_EXCLUDE_DISK_MOUNTS: /snap,/etc/repos
volumes:
## Mount external docker socket
- /var/run/docker.sock:/var/run/docker.sock
## Allow Periphery to see processes outside of container
- /proc:/proc
## Specify the Periphery agent root directory.
## Must be the same inside and outside the container,
## or docker will get confused. See https://github.com/moghtech/komodo/discussions/180.
## Default: /etc/komodo.
- ${PERIPHERY_ROOT_DIRECTORY:-/etc/komodo}:${PERIPHERY_ROOT_DIRECTORY:-/etc/komodo}
## If periphery is being run remote from the core server, ports need to be exposed
# ports:
# - 8120:8120
## If you want to use a custom periphery config file, use command to pass it to periphery.
# command: periphery --config-path ${PERIPHERY_ROOT_DIRECTORY:-/etc/komodo}/periphery.config.toml