From f52994e5029f4e5939e90afe56699c66678d0224 Mon Sep 17 00:00:00 2001 From: Survivalful Date: Mon, 23 Mar 2026 00:11:48 +0000 Subject: [PATCH] Upload files to "/" --- README (1).md | 110 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 110 insertions(+) create mode 100644 README (1).md diff --git a/README (1).md b/README (1).md new file mode 100644 index 0000000..7d27447 --- /dev/null +++ b/README (1).md @@ -0,0 +1,110 @@ +# 🐳 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: survivalful/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. + +--- + +## 🛠️ Support + +If you have any questions or run into issues, feel free to reach out: + +- 📧 Email: [team@survivalful.de](mailto:team@survivalful.de) +- 🐙 Git: [git.survivalful.de/Survivalful/discord-docker-bot](https://git.survivalful.de/Survivalful/discord-docker-bot) + +--- + +## 🤝 Contributing + +Contributions are welcome! Feel free to open an issue or submit a pull request on the [Git repository](https://git.survivalful.de/Survivalful/discord-docker-bot). + +--- + +## 📄 License + +This project is licensed under the **GNU General Public License v3.0 (GPL-3.0)**. + +This means: +- ✅ Free to use, modify and distribute +- ✅ Source code must remain open +- ✅ Changes must be released under the same license +- ❌ Cannot be used in closed-source projects + +See the full license: [GNU GPL v3.0](https://www.gnu.org/licenses/gpl-3.0.html)