Komodo Docker Manager

Back

Deploy Komodo Core

Lets get straight to it. Create a folder in your home directory called Komodo and place these two files into it.

yaml

compose.yaml

dotenv

.env

Make sure to read all the options and replace all <redacted> with proper values. When its all done we have to first deploy another thing onto the server first.

Deploy Komodo Periphery

The periphery will be deployed on every server which shall be managed by your Komodo instance. I always choose to use the systemd version since I feel that makes the most sense. You can of course also deploy the docker version instead.

Komodo provides a really easy to use shell command for deploying a periphery agent to your server. Run this script as root user. Make sure you have Python3 installed as well.

shell

Deploy a agent

This will also create a systemd service called periphery.service you can easily inspect it running with

shell

Inspect Agent status

All the files the periphery creates like stacks, repos and so on will be put into /etc/komodo. This is also the place where the config file (periphery.config.toml) is located. This config file will be used by the systemd service. Now we need this very config file and edit it soooo

shell

Edit Agent config

In there locate a line like passkeys = []. Here we have to add the passkey which we set in the .env file when deploying Komodo Core. Add it like this ... the "..." are also important

toml

Added passkey

Now restart the service for the changes to take effect

shell

Restart Agent

Finally Spin up Core

Now that we have that out of the way we can spin up Komodo Core. Change back to the directory where the compose.yaml from the start is located. And enter a quick docker compose up -d.

Once everything is settled your new instance will be at http://YourIp:9120. There you will be greeted with a login using the first login creds from the .env file.

Profit

Now you have unlimited power of your docker instances!

Komodo Dashboard Image

Add a new Server

First just repeat the steps from Deploy Komodo Periphery. Then open up your Komodo Core Interface and follow my lead.

First Step Server
  • Navigate to Servers on the left side
  • Click on Create new Server
  • Give the Server a Nice Name
  • Click Create
Second Step Server
  • Replace the two indicated parts with the ip of your new server
  • Its important to use https and the port for the first one
  • Enable the server at the very top
  • Press Save

Congrats, you just added your first server. You should now be able to view all kinds of stats for it and also use it.

Deploy a Stack

This will most likely be the most important workflow for users tbh.

First Step Stack
  • Navigate to Stacks on the left side
  • Click on Create new Stack
  • Give the Stack a Nice Name
  • Click Create
Second Step Stack
  • Select the Server where you want your docker stack to run
  • For the Mode we can choose UI Defined
  • There will already be a nice example hello world provided
  • Press save at the top
  • Now we can press deploy at the top to get the ball rolling

If everything worked you should see some logging output in the Log Tab which should look something like this.

Hello World Output

There are a lot more options when editing a Stack but they are relatively self explainatory.