Setup Komodo Core
To run Komodo, you will need Docker. See the docker install docs.
Deploy with Docker Compose
Some systems do not support running the latest MongoDB versions. Users with these systems should use FerretDB instead.
FerretDB v1 users: There is an upgrade guide for FerretDB v2 available here.
📄️ MongoDB
MongoDB is the recommended database for Komodo. It stores all resource configuration, user accounts, audit logs, and system state. Komodo Core communicates with it directly using the MongoDB driver.
📄️ FerretDB
- If you setup Komodo using Postgres or Sqlite options prior to Komodo v1.18.0, you are using FerretDB v1.
📄️ Advanced Setup
Additional configuration options for Komodo Core and Periphery, including custom certificate authorities, OAuth/OIDC providers, and mounted config files.
📄️ Connect More Servers
Every server you want to manage with Komodo needs the Periphery agent installed.
📄️ Backup and Restore
Komodo can automatically back up its database on a schedule and restore from any previous snapshot. Backups are gzip-compressed and stored on disk or a remote server, and by default the most recent 14 backups are stored. The backup and restore operations are handled by the Komodo CLI, which is packaged in the Core image for convenience.