komodo
This commit is contained in:
James Turland
parent
a64aeefc43
commit
f13ddaffe9
|
|
@ -0,0 +1,130 @@
|
||||||
|
####################################
|
||||||
|
# 🦎 KOMODO COMPOSE - VARIABLES 🦎 #
|
||||||
|
####################################
|
||||||
|
|
||||||
|
## These compose variables can be used with all Komodo deployment options.
|
||||||
|
## Pass these variables to the compose up command using `--env-file komodo/compose.env`.
|
||||||
|
## Additionally, they are passed to both Komodo Core and Komodo Periphery with `env_file: ./compose.env`,
|
||||||
|
## so you can pass any additional environment variables to Core / Periphery directly in this file as well.
|
||||||
|
|
||||||
|
## Stick to a specific version, or use `latest`
|
||||||
|
COMPOSE_KOMODO_IMAGE_TAG=latest
|
||||||
|
|
||||||
|
## Note: 🚨 Podman does NOT support local logging driver 🚨. See Podman options here:
|
||||||
|
## `https://docs.podman.io/en/v4.6.1/markdown/podman-run.1.html#log-driver-driver`
|
||||||
|
COMPOSE_LOGGING_DRIVER=local # Enable log rotation with the local driver.
|
||||||
|
|
||||||
|
## DB credentials - Ignored for Sqlite
|
||||||
|
DB_USERNAME=admin
|
||||||
|
DB_PASSWORD=admin
|
||||||
|
|
||||||
|
## Configure a secure passkey to authenticate between Core / Periphery.
|
||||||
|
PASSKEY=a_random_passkey
|
||||||
|
|
||||||
|
#=-------------------------=#
|
||||||
|
#= Komodo Core Environment =#
|
||||||
|
#=-------------------------=#
|
||||||
|
|
||||||
|
## Full variable list + descriptions are available here:
|
||||||
|
## 🦎 https://github.com/mbecker20/komodo/blob/main/config/core.config.toml 🦎
|
||||||
|
|
||||||
|
## Note. Secret variables also support `${VARIABLE}_FILE` syntax to pass docker compose secrets.
|
||||||
|
## Docs: https://docs.docker.com/compose/how-tos/use-secrets/#examples
|
||||||
|
|
||||||
|
## Used for Oauth / Webhook url suggestion / Caddy reverse proxy.
|
||||||
|
KOMODO_HOST=https://demo.komo.do
|
||||||
|
## Displayed in the browser tab.
|
||||||
|
KOMODO_TITLE=Komodo
|
||||||
|
## Create a server matching this address as the "first server".
|
||||||
|
## Use `https://host.docker.internal:8120` when using systemd-managed Periphery.
|
||||||
|
KOMODO_FIRST_SERVER=https://periphery:8120
|
||||||
|
## Make all buttons just double-click, rather than the full confirmation dialog.
|
||||||
|
KOMODO_DISABLE_CONFIRM_DIALOG=false
|
||||||
|
|
||||||
|
## Rate Komodo polls your servers for
|
||||||
|
## status / container status / system stats / alerting.
|
||||||
|
## Options: 1-sec, 5-sec, 15-sec, 1-min, 5-min.
|
||||||
|
## Default: 15-sec
|
||||||
|
KOMODO_MONITORING_INTERVAL="15-sec"
|
||||||
|
## Rate Komodo polls Resources for updates,
|
||||||
|
## like outdated commit hash.
|
||||||
|
## Options: 1-min, 5-min, 15-min, 30-min, 1-hr.
|
||||||
|
## Default: 5-min
|
||||||
|
KOMODO_RESOURCE_POLL_INTERVAL="5-min"
|
||||||
|
|
||||||
|
## Used to auth against periphery. Alt: KOMODO_PASSKEY_FILE
|
||||||
|
KOMODO_PASSKEY=${PASSKEY}
|
||||||
|
## Used to auth incoming webhooks. Alt: KOMODO_WEBHOOK_SECRET_FILE
|
||||||
|
KOMODO_WEBHOOK_SECRET=a_random_secret
|
||||||
|
## Used to generate jwt. Alt: KOMODO_JWT_SECRET_FILE
|
||||||
|
KOMODO_JWT_SECRET=a_random_jwt_secret
|
||||||
|
|
||||||
|
## Enable login with username + password.
|
||||||
|
KOMODO_LOCAL_AUTH=true
|
||||||
|
## Disable new user signups.
|
||||||
|
KOMODO_DISABLE_USER_REGISTRATION=false
|
||||||
|
## All new logins are auto enabled
|
||||||
|
KOMODO_ENABLE_NEW_USERS=false
|
||||||
|
## Disable non-admins from creating new resources.
|
||||||
|
KOMODO_DISABLE_NON_ADMIN_CREATE=false
|
||||||
|
## Allows all users to have Read level access to all resources.
|
||||||
|
KOMODO_TRANSPARENT_MODE=false
|
||||||
|
|
||||||
|
## Time to live for jwt tokens.
|
||||||
|
## Options: 1-hr, 12-hr, 1-day, 3-day, 1-wk, 2-wk
|
||||||
|
KOMODO_JWT_TTL="1-day"
|
||||||
|
|
||||||
|
## OIDC Login
|
||||||
|
KOMODO_OIDC_ENABLED=false
|
||||||
|
## Must reachable from Komodo Core container
|
||||||
|
# KOMODO_OIDC_PROVIDER=https://oidc.provider.internal/application/o/komodo
|
||||||
|
## Change the host to one reachable be reachable by users (optional if it is the same as above).
|
||||||
|
## DO NOT include the `path` part of the URL.
|
||||||
|
# KOMODO_OIDC_REDIRECT_HOST=https://oidc.provider.external
|
||||||
|
## Your client credentials
|
||||||
|
# KOMODO_OIDC_CLIENT_ID= # Alt: KOMODO_OIDC_CLIENT_ID_FILE
|
||||||
|
# KOMODO_OIDC_CLIENT_SECRET= # Alt: KOMODO_OIDC_CLIENT_SECRET_FILE
|
||||||
|
## Make usernames the full email.
|
||||||
|
# KOMODO_OIDC_USE_FULL_EMAIL=true
|
||||||
|
## Add additional trusted audiences for token claims verification.
|
||||||
|
## Supports comma separated list, and passing with _FILE (for compose secrets).
|
||||||
|
# KOMODO_OIDC_ADDITIONAL_AUDIENCES=abc,123 # Alt: KOMODO_OIDC_ADDITIONAL_AUDIENCES_FILE
|
||||||
|
|
||||||
|
## Github Oauth
|
||||||
|
KOMODO_GITHUB_OAUTH_ENABLED=false
|
||||||
|
# KOMODO_GITHUB_OAUTH_ID= # Alt: KOMODO_GITHUB_OAUTH_ID_FILE
|
||||||
|
# KOMODO_GITHUB_OAUTH_SECRET= # Alt: KOMODO_GITHUB_OAUTH_SECRET_FILE
|
||||||
|
|
||||||
|
## Google Oauth
|
||||||
|
KOMODO_GOOGLE_OAUTH_ENABLED=false
|
||||||
|
# KOMODO_GOOGLE_OAUTH_ID= # Alt: KOMODO_GOOGLE_OAUTH_ID_FILE
|
||||||
|
# KOMODO_GOOGLE_OAUTH_SECRET= # Alt: KOMODO_GOOGLE_OAUTH_SECRET_FILE
|
||||||
|
|
||||||
|
## Aws - Used to launch Builder instances and ServerTemplate instances.
|
||||||
|
KOMODO_AWS_ACCESS_KEY_ID= # Alt: KOMODO_AWS_ACCESS_KEY_ID_FILE
|
||||||
|
KOMODO_AWS_SECRET_ACCESS_KEY= # Alt: KOMODO_AWS_SECRET_ACCESS_KEY_FILE
|
||||||
|
|
||||||
|
## Hetzner - Used to launch ServerTemplate instances
|
||||||
|
## Hetzner Builder not supported due to Hetzner pay-by-the-hour pricing model
|
||||||
|
KOMODO_HETZNER_TOKEN= # Alt: KOMODO_HETZNER_TOKEN_FILE
|
||||||
|
|
||||||
|
#=------------------------------=#
|
||||||
|
#= Komodo Periphery Environment =#
|
||||||
|
#=------------------------------=#
|
||||||
|
|
||||||
|
## Full variable list + descriptions are available here:
|
||||||
|
## 🦎 https://github.com/mbecker20/komodo/blob/main/config/periphery.config.toml 🦎
|
||||||
|
|
||||||
|
## Periphery passkeys must include KOMODO_PASSKEY to authenticate
|
||||||
|
PERIPHERY_PASSKEYS=${PASSKEY}
|
||||||
|
|
||||||
|
## Enable SSL using self signed certificates.
|
||||||
|
## Connect to Periphery at https://address:8120.
|
||||||
|
PERIPHERY_SSL_ENABLED=true
|
||||||
|
|
||||||
|
## 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.
|
||||||
|
PERIPHERY_INCLUDE_DISK_MOUNTS=/etc/hostname
|
||||||
|
# PERIPHERY_EXCLUDE_DISK_MOUNTS=/snap,/etc/repos
|
||||||
|
|
@ -0,0 +1,102 @@
|
||||||
|
################################
|
||||||
|
# 🦎 KOMODO COMPOSE - MONGO 🦎 #
|
||||||
|
################################
|
||||||
|
|
||||||
|
## This compose file will deploy:
|
||||||
|
## 1. MongoDB
|
||||||
|
## 2. Komodo Core
|
||||||
|
## 3. Komodo Periphery
|
||||||
|
|
||||||
|
services:
|
||||||
|
mongo:
|
||||||
|
image: mongo
|
||||||
|
labels:
|
||||||
|
komodo.skip: # Prevent Komodo from stopping with StopAllContainers
|
||||||
|
command: --quiet --wiredTigerCacheSizeGB 0.25
|
||||||
|
restart: unless-stopped
|
||||||
|
logging:
|
||||||
|
driver: ${COMPOSE_LOGGING_DRIVER:-local}
|
||||||
|
networks:
|
||||||
|
- default
|
||||||
|
# ports:
|
||||||
|
# - 27017:27017
|
||||||
|
volumes:
|
||||||
|
- mongo-data:/data/db
|
||||||
|
- mongo-config:/data/configdb
|
||||||
|
environment:
|
||||||
|
MONGO_INITDB_ROOT_USERNAME: ${DB_USERNAME}
|
||||||
|
MONGO_INITDB_ROOT_PASSWORD: ${DB_PASSWORD}
|
||||||
|
|
||||||
|
core:
|
||||||
|
image: ghcr.io/mbecker20/komodo:${COMPOSE_KOMODO_IMAGE_TAG:-latest}
|
||||||
|
labels:
|
||||||
|
komodo.skip: # Prevent Komodo from stopping with StopAllContainers
|
||||||
|
restart: unless-stopped
|
||||||
|
depends_on:
|
||||||
|
- mongo
|
||||||
|
logging:
|
||||||
|
driver: ${COMPOSE_LOGGING_DRIVER:-local}
|
||||||
|
networks:
|
||||||
|
- default
|
||||||
|
ports:
|
||||||
|
- 9120:9120
|
||||||
|
env_file: .env
|
||||||
|
environment:
|
||||||
|
KOMODO_DATABASE_ADDRESS: mongo:27017
|
||||||
|
KOMODO_DATABASE_USERNAME: ${DB_USERNAME}
|
||||||
|
KOMODO_DATABASE_PASSWORD: ${DB_PASSWORD}
|
||||||
|
volumes:
|
||||||
|
## Core cache for repos for latest commit hash / contents
|
||||||
|
- repo-cache:/repo-cache
|
||||||
|
## Store sync files on server
|
||||||
|
# - /path/to/syncs:/syncs
|
||||||
|
## Optionally mount a custom core.config.toml
|
||||||
|
# - /path/to/core.config.toml:/config/config.toml
|
||||||
|
## Allows for systemd Periphery connection at
|
||||||
|
## "http://host.docker.internal:8120"
|
||||||
|
# extra_hosts:
|
||||||
|
# - host.docker.internal:host-gateway
|
||||||
|
|
||||||
|
## Deploy Periphery container using this block,
|
||||||
|
## or deploy the Periphery binary with systemd using
|
||||||
|
## https://github.com/mbecker20/komodo/tree/main/scripts
|
||||||
|
periphery:
|
||||||
|
image: ghcr.io/mbecker20/periphery:${COMPOSE_KOMODO_IMAGE_TAG:-latest}
|
||||||
|
labels:
|
||||||
|
komodo.skip: # Prevent Komodo from stopping with StopAllContainers
|
||||||
|
restart: unless-stopped
|
||||||
|
logging:
|
||||||
|
driver: ${COMPOSE_LOGGING_DRIVER:-local}
|
||||||
|
networks:
|
||||||
|
- default
|
||||||
|
env_file: .env
|
||||||
|
volumes:
|
||||||
|
## Mount external docker socket
|
||||||
|
- /var/run/docker.sock:/var/run/docker.sock
|
||||||
|
## Allow Periphery to see processes outside of container
|
||||||
|
- /proc:/proc
|
||||||
|
## use self signed certs in docker volume,
|
||||||
|
## or mount your own signed certs.
|
||||||
|
- ssl-certs:/etc/komodo/ssl
|
||||||
|
## manage repos in a docker volume,
|
||||||
|
## or change it to an accessible host directory.
|
||||||
|
- repos:/etc/komodo/repos
|
||||||
|
## manage stack files in a docker volume,
|
||||||
|
## or change it to an accessible host directory.
|
||||||
|
- stacks:/etc/komodo/stacks
|
||||||
|
## Optionally mount a path to store compose files
|
||||||
|
# - /path/to/compose:/host/compose
|
||||||
|
|
||||||
|
volumes:
|
||||||
|
# Mongo
|
||||||
|
mongo-data:
|
||||||
|
mongo-config:
|
||||||
|
# Core
|
||||||
|
repo-cache:
|
||||||
|
# Periphery
|
||||||
|
ssl-certs:
|
||||||
|
repos:
|
||||||
|
stacks:
|
||||||
|
|
||||||
|
networks:
|
||||||
|
default: {}
|
||||||
Loading…
Reference in New Issue