Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alex289/docker-discord-bot

An easy-to-use Discord bot to manage your Docker containers.
https://github.com/alex289/docker-discord-bot

bot discord docker

Last synced: about 6 hours ago
JSON representation

An easy-to-use Discord bot to manage your Docker containers.

Host: GitHub
URL: https://github.com/alex289/docker-discord-bot
Owner: alex289
License: mit
Created: 2024-03-20T21:35:58.000Z (8 months ago)
Default Branch: main
Last Pushed: 2024-11-16T11:22:11.000Z (about 15 hours ago)
Last Synced: 2024-11-16T12:23:33.651Z (about 14 hours ago)
Topics: bot, discord, docker
Language: C#
Homepage:
Size: 114 KB
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

        # Docker Discord Bot

![GitHub License](https://img.shields.io/github/license/alex289/docker-discord-bot)

![Docker Pulls](https://img.shields.io/docker/pulls/alexdev28/docker-discord-bot)

[![CodeFactor](https://www.codefactor.io/repository/github/alex289/docker-discord-bot/badge)](https://www.codefactor.io/repository/github/alex289/docker-discord-bot)

![Docker Image Size](https://img.shields.io/docker/image-size/alexdev28/docker-discord-bot)

An easy-to-use Discord bot to manage your Docker containers.

## Table of Contents

- [Commands](#commands)

- [Installation](#installation)

  - [Discord Bot Setup](#discord-bot-setup)

  - [Docker Setup](#docker-setup)

  - [Configuration](#configuration)

- [License](#license)

## Commands

| Command | Description |

| --- | --- |

| `!help` | Show all available commands |

| `!ping` | Check if the bot is online |

| `!dockerps` | List all running Docker containers |

| `!dockerstop ` | Stop a Docker container |

| `!dockerstart ` | Start a Docker container |

| `!dockerrestart ` | Restart a Docker container |

| `!dockerremove ` | Remove a Docker container |

| `!dockershow ` | Show information about a Docker container |

| `!dockercreate :/  ` | Create a new Docker container |

| `!dockerinfo` | Show information about the Docker host |

| `!dockerimages` | List all existing images |

| `!dockerpull :/` | Pull an image |

| `!dockerremoveimage ` | Remove an image |

## Installation

### Discord Bot Setup

1.  Create a new Discord bot at the [Discord Developer Portal](https://discord.com/developers/applications)

2.  Copy the bot token

3.  Invite the bot to your server using the following link: `https://discord.com/oauth2/authorize?client_id=YOUR_BOT_ID&permissions=8&scope=bot`

### Docker Setup

Run the following command to start the Docker container:

```bash

docker run \

    -d \

    --name docker-discord-bot \

    -u root \

    -e ApplicationSettings__DiscordToken=YOUR_DISCORD_BOT_TOKEN \

    -v /var/run/docker.sock:/var/run/docker.sock \

    alexdev28/docker-discord-bot:latest

```

Or with docker compose:

```yaml

version: '3.8'

services:

  docker-discord-bot:

    image: alexdev28/docker-discord-bot:latest

    container_name: docker-discord-bot

    restart: unless-stopped

    user: root

    environment:

      - ApplicationSettings__DiscordToken=YOUR_DISCORD_BOT_TOKEN

    volumes:

      - /var/run/docker.sock:/var/run/docker.sock

```

### Configuration

The bot can be configured using environment variables:

| Environment Variable | Description | Default Value | Required |

| --- | --- | --- | --- |

| `ApplicationSettings__DiscordToken` | Discord bot token | `null` | ✅ |

| `ApplicationSettings__AdminUser` | Discord admin username | `null` | ❌ |

| `ApplicationSettings__CommandPrefix` | Command prefix | `!` | ❌ |

| `ApplicationSettings__DockerRegistryUrl` | Private registry url | `null` | ❌ |

| `ApplicationSettings__DockerRegistryUsername` | Private registry username | `null` | ❌ |

| `ApplicationSettings__DockerRegistryPassword` | Private registry password | `null` | ❌ |

## License

© [Alexander Konietzko](https://alexanderkonietzko.com) 2024  

Released under the [MIT license](https://github.com/alex289/docker-discord-bot/blob/main/LICENSE)