From 8c79d7896c13ca03d69b512d1de7be6c170e4a60 Mon Sep 17 00:00:00 2001 From: Survivalful Date: Mon, 23 Mar 2026 00:03:51 +0000 Subject: [PATCH] Upload files to "/" --- README.md | 87 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 87 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..5485011 --- /dev/null +++ b/README.md @@ -0,0 +1,87 @@ +# 🐳 Discord Docker Monitor Bot + +A Discord bot that monitors your Docker containers and displays their status in dedicated channels — updated automatically every 30 seconds. + +--- + +## ✨ Features + +- 📋 List all Docker containers on your host +- 📁 Create groups of containers with dedicated Discord channels +- 🔄 Automatic status updates every 30 seconds +- 🟢 Live status indicators (running, exited, paused, created) +- 🔒 Channels are read-only for regular users + +--- + +## 🚀 Quick Start + +### 1. Create your `.env` file + +```env +BOT_TOKEN=your_discord_bot_token +DOCKER_HOST=tcp://your-docker-host:2375 +GUILD_ID=your_discord_server_id +dc_kategorie=Docker Status +``` + +### 2. Start with Docker Compose + +```yaml +services: + discord-bot: + image: yourusername/discord-docker-bot:latest + restart: unless-stopped + env_file: + - .env +``` + +```bash +docker compose up -d +``` + +That's it! 🎉 + +--- + +## 🤖 Commands + +| Command | Description | +|--------|-------------| +| `!info` | Shows all available commands | +| `!container_list` | Lists all containers on the host | +| `!group_create ...` | Creates a group with a dedicated channel | +| `!group_remove ` | Deletes a group and its channel | +| `!group_list` | Shows all existing groups | + +--- + +## 📊 Status Indicators + +| Symbol | Status | +|--------|--------| +| 🟢 | Running | +| 🔴 | Exited | +| 🟡 | Paused | +| ⚪ | Created | +| ❓ | Unknown | + +--- + +## ⚙️ Requirements + +- Docker & Docker Compose installed on the host +- Docker remote API enabled (`tcp://host:2375`) +- A Discord Bot Token ([create one here](https://discord.com/developers/applications)) + +--- + +## 🔒 Security Note + +Never share your `.env` file — it contains sensitive tokens and credentials. The `.env` file is not included in the Docker image. + +--- + +## 📄 License + +MIT License — free to use and modify.