A mouth full, aye? Well, this simple python bot is made to run as a docker container, to manage said docker containers in the same environment.
The currently supported actions are:
- Retrieving a list of all containers, optionally filtered by status and name
- Stopping, (re)starting, renaming or removing containers by name or id
- Retrieve logs of a container in txt format
- Run an image from Docker Hub with commands to execute
- Run your own or publicly available code hosted on Github as a container (cannot contain env variables, see Limitations.)
- A help menu that basically says what I'm writing here
The application is supposed to run as a docker container within the same environment as the containers you want to manage.
- Clone this project and make sure docker is running or available.
- Set up the .env file with the variables laid out in Environments.
- Execute
docker compose upin the terminal.
You can also use this in tools like portainer.
This app relies on a couple of environment variables:
- DISCORD_TOKEN ~ this is the token of your discord bot, as created in the discord developer portal
- ADMINS ~ A list of user id's that are allowed to use the bot. It is comma seperated.
- GUILDS ~ A list of guild (also known as a server) id's that the commands will be usable in. It is comma seperated.
See the example.env for.. well, examples.
So, as you can see this is all fairly easy to perform by using direct docker commands or using the docker desktop app. Why did I create this then? I am running most of my (docker container) services on my Raspberry Pi, and I don't want to open up a port to the internet. I still want to manage my services however, so what better way to do that then using a discord bot? Shhh. There is no better way. This is it.
As of the time of writing (AUG 2023), this bot can be used to manage already existing containers,
pull images from dockerhub and from you own/public coding projects on github with a docker-compose.yml file.
However, there is one big limitation. Because of Discord's security practises, users should not transmit any sensitive data like passwords, or environment variables. So, if your app needs environment variables to function, this bot cannot deploy it for you. You can of course still do this manually, and then manage the container through this bot.
If Discord changes their security practises (End-to-End Encryption for example), then this might change.