383 lines
10 KiB
Markdown
383 lines
10 KiB
Markdown
---
|
|
tags:
|
|
- Docker
|
|
- Manager
|
|
---
|
|
https://komo.do/docs/intro
|
|
# FerretDB
|
|
|
|
|
|
- If you setup Komodo using **Postgres** or **Sqlite** options prior to [**Komodo v1.18.0**](https://github.com/moghtech/komodo/releases/tag/v1.18.0), you are using **FerretDB v1**.
|
|
- Komodo now uses **FerretDB v2**. For existing users, [**upgrading requires a migration**](https://github.com/moghtech/komodo/blob/main/bin/util/docs/copy-database.md#ferretdb-v2-update-guide).
|
|
|
|
[**FerretDB**](https://www.ferretdb.com) is a MongoDB-compatible database backed by [Postgres + DocumentDB extension](https://github.com/microsoft/documentdb). It is a solid option with performance comparable to MongoDB, and can also be run on some systems which [do not support MongoDB](https://github.com/moghtech/komodo/issues/59).
|
|
|
|
1. Copy `komodo/ferretdb.compose.yaml` and `komodo/compose.env` to your host:
|
|
|
|
```
|
|
wget -P komodo https://raw.githubusercontent.com/moghtech/komodo/main/compose/ferretdb.compose.yaml && \ wget -P komodo https://raw.githubusercontent.com/moghtech/komodo/main/compose/compose.env
|
|
```
|
|
|
|
2. Edit the variables in `komodo/compose.env`.
|
|
3. Deploy:
|
|
|
|
```
|
|
###################################
|
|
|
|
# 🦎 KOMODO COMPOSE - FERRETDB 🦎 #
|
|
|
|
###################################
|
|
|
|
|
|
|
|
## This compose file will deploy:
|
|
|
|
## 1. Postgres + FerretDB Mongo adapter (https://www.ferretdb.com)
|
|
|
|
## 2. Komodo Core
|
|
|
|
## 3. Komodo Periphery
|
|
|
|
|
|
|
|
services:
|
|
|
|
postgres:
|
|
|
|
# Recommended: Pin to a specific version
|
|
|
|
# https://github.com/FerretDB/documentdb/pkgs/container/postgres-documentdb
|
|
|
|
image: ghcr.io/ferretdb/postgres-documentdb
|
|
|
|
labels:
|
|
|
|
komodo.skip: # Prevent Komodo from stopping with StopAllContainers
|
|
|
|
restart: unless-stopped
|
|
|
|
# ports:
|
|
|
|
# - 5432:5432
|
|
|
|
volumes:
|
|
|
|
- postgres-data:/var/lib/postgresql/data
|
|
|
|
environment:
|
|
|
|
POSTGRES_USER: ${KOMODO_DB_USERNAME}
|
|
|
|
POSTGRES_PASSWORD: ${KOMODO_DB_PASSWORD}
|
|
|
|
POSTGRES_DB: postgres
|
|
|
|
|
|
|
|
ferretdb:
|
|
|
|
# Recommended: Pin to a specific version
|
|
|
|
# https://github.com/FerretDB/FerretDB/pkgs/container/ferretdb
|
|
|
|
image: ghcr.io/ferretdb/ferretdb
|
|
|
|
labels:
|
|
|
|
komodo.skip: # Prevent Komodo from stopping with StopAllContainers
|
|
|
|
restart: unless-stopped
|
|
|
|
depends_on:
|
|
|
|
- postgres
|
|
|
|
# ports:
|
|
|
|
# - 27017:27017
|
|
|
|
volumes:
|
|
|
|
- ferretdb-state:/state
|
|
|
|
environment:
|
|
|
|
FERRETDB_POSTGRESQL_URL: postgres://${KOMODO_DB_USERNAME}:${KOMODO_DB_PASSWORD}@postgres:5432/postgres
|
|
|
|
core:
|
|
|
|
image: ghcr.io/moghtech/komodo-core:${COMPOSE_KOMODO_IMAGE_TAG:-latest}
|
|
|
|
labels:
|
|
|
|
komodo.skip: # Prevent Komodo from stopping with StopAllContainers
|
|
|
|
restart: unless-stopped
|
|
|
|
depends_on:
|
|
|
|
- ferretdb
|
|
|
|
ports:
|
|
|
|
- 9120:9120
|
|
|
|
env_file: ./compose.env
|
|
|
|
environment:
|
|
|
|
KOMODO_DATABASE_ADDRESS: ferretdb:27017
|
|
|
|
KOMODO_DATABASE_USERNAME: ${KOMODO_DB_USERNAME}
|
|
|
|
KOMODO_DATABASE_PASSWORD: ${KOMODO_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/moghtech/komodo/tree/main/scripts
|
|
|
|
periphery:
|
|
|
|
image: ghcr.io/moghtech/komodo-periphery:${COMPOSE_KOMODO_IMAGE_TAG:-latest}
|
|
|
|
labels:
|
|
|
|
komodo.skip: # Prevent Komodo from stopping with StopAllContainers
|
|
|
|
restart: unless-stopped
|
|
|
|
env_file: ./compose.env
|
|
|
|
# Need to make sure you add this or deploying agents will be a pain.
|
|
|
|
ports:
|
|
|
|
- 8120:8120
|
|
|
|
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}
|
|
|
|
|
|
|
|
volumes:
|
|
|
|
# Postgres
|
|
|
|
postgres-data:
|
|
|
|
# FerretDB
|
|
|
|
ferretdb-state:
|
|
|
|
# Core
|
|
|
|
repo-cache:
|
|
|
|
|
|
|
|
# To start up - Run
|
|
|
|
# docker compose -p komodo -f komodo/ferretdb.compose.yaml --env-file komodo/compose.env up -d
|
|
|
|
|
|
|
|
# To stop up - Run
|
|
|
|
# docker compose -p komodo -f komodo/ferretdb.compose.yaml --env-file komodo/compose.env up -d
|
|
|
|
|
|
|
|
|
|
ENV File
|
|
####################################
|
|
# 🦎 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
|
|
|
|
## DB credentials
|
|
KOMODO_DB_USERNAME=admin
|
|
KOMODO_DB_PASSWORD=PCjFCsX0yC0G44
|
|
|
|
## Configure a secure passkey to authenticate between Core / Periphery.
|
|
KOMODO_PASSKEY=HModV9yPmOBD4P
|
|
|
|
## Set your time zone for schedules
|
|
## https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
|
TZ=America/New_York
|
|
|
|
#=-------------------------=#
|
|
#= Komodo Core Environment =#
|
|
#=-------------------------=#
|
|
|
|
## Full variable list + descriptions are available here:
|
|
## 🦎 https://github.com/moghtech/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://192.168.2.5:8120
|
|
## Make all buttons just double-click, rather than the full confirmation dialog.
|
|
KOMODO_DISABLE_CONFIRM_DIALOG=true
|
|
|
|
## Rate Komodo polls your servers for
|
|
## status / container status / system stats / alerting.
|
|
## Options: 1-sec, 5-sec, 15-sec, 1-min, 5-min, 15-min
|
|
## Default: 15-sec
|
|
KOMODO_MONITORING_INTERVAL="15-sec"
|
|
## Interval at which to poll Resources for any updates / automated actions.
|
|
## Options: 15-min, 1-hr, 2-hr, 6-hr, 12-hr, 1-day
|
|
## Default: 1-hr
|
|
KOMODO_RESOURCE_POLL_INTERVAL="15-min"
|
|
|
|
## Used to auth incoming webhooks. Alt: KOMODO_WEBHOOK_SECRET_FILE
|
|
KOMODO_WEBHOOK_SECRET=oop28TaGucFUTh
|
|
## Used to generate jwt. Alt: KOMODO_JWT_SECRET_FILE
|
|
KOMODO_JWT_SECRET=rm4O312hzsl6Pt
|
|
## Time to live for jwt tokens.
|
|
## Options: 1-hr, 12-hr, 1-day, 3-day, 1-wk, 2-wk
|
|
KOMODO_JWT_TTL="1-day"
|
|
|
|
## Enable login with username + password.
|
|
KOMODO_LOCAL_AUTH=true
|
|
## Disable new user signups.
|
|
KOMODO_DISABLE_USER_REGISTRATION=true
|
|
## 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
|
|
|
|
## Prettier logging with empty lines between logs
|
|
KOMODO_LOGGING_PRETTY=false
|
|
## More human readable logging of startup config (multi-line)
|
|
KOMODO_PRETTY_STARTUP_CONFIG=false
|
|
|
|
## 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 OIDC client id
|
|
# KOMODO_OIDC_CLIENT_ID= # Alt: KOMODO_OIDC_CLIENT_ID_FILE
|
|
## Your OIDC client secret.
|
|
## If your provider supports PKCE flow, this can be ommitted.
|
|
# KOMODO_OIDC_CLIENT_SECRET= # Alt: KOMODO_OIDC_CLIENT_SECRET_FILE
|
|
## Make usernames the full email.
|
|
## Note. This does not work for all OIDC providers.
|
|
# 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.
|
|
KOMODO_AWS_ACCESS_KEY_ID= # Alt: KOMODO_AWS_ACCESS_KEY_ID_FILE
|
|
KOMODO_AWS_SECRET_ACCESS_KEY= # Alt: KOMODO_AWS_SECRET_ACCESS_KEY_FILE
|
|
|
|
#=------------------------------=#
|
|
#= Komodo Periphery Environment =#
|
|
#=------------------------------=#
|
|
|
|
## Full variable list + descriptions are available here:
|
|
## 🦎 https://github.com/moghtech/komodo/blob/main/config/periphery.config.toml 🦎
|
|
|
|
## Specify the root directory used by Periphery agent.
|
|
PERIPHERY_ROOT_DIRECTORY=/etc/komodo
|
|
|
|
## Periphery passkeys must include KOMODO_PASSKEY to authenticate.
|
|
PERIPHERY_PASSKEYS=${KOMODO_PASSKEY}
|
|
|
|
## Specify whether to disable the terminals feature
|
|
## and disallow remote shell access (inside the Periphery container).
|
|
PERIPHERY_DISABLE_TERMINALS=false
|
|
|
|
## 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
|
|
|
|
## Prettier logging with empty lines between logs
|
|
PERIPHERY_LOGGING_PRETTY=false
|
|
## More human readable logging of startup config (multi-line)
|
|
PERIPHERY_PRETTY_STARTUP_CONFIG=false
|
|
|
|
```
|
|
|
|
|
|
## See my compose.env & ferretdb.compose.yml files
|
|
|