Asthowen / DiscordBotPihole

A Discord bot for get Pi-Hole stats written in Rust.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

DiscordBotPihole

A Discord bot for get Pi-Hole stats written in Rust.

Archive

I've archived this repository because I don't use Pi-Hole at all anymore, at the time I'm archiving it, the code is fully functional. In case you encounter a problem you can open an issue here, although I don't necessarily guarantee a quick fix.

Usage

To use this bot you must create a Discord application.

Create a Discord application:

  • Go to Discord Developers Applications page.
  • Click on "New Application".
  • Enter a name for your application in the "Name" field.
  • Click on "Create".

Create a bot user:

  • On the page for your application, click on menu "Bot" and then click on button "Add Bot".
  • Click "Yes, do it!" when popup appeared.
  • Now that your bot is created, click on button "Copy" under token section to copy your bot's token, keep this token.

Installation

Manually

Start by cloning the repo:

git clone https://github.com/Asthowen/DiscordBotPihole.git

For the next step you need to have Rust and cargo installed on your PC, for that follow the official documentation.

Now switch to project folder and compile a release:

cd DiscordBotPihole && cargo build --release

Your executable will be in the target/release/ folder, it is named discord_bot_pihole.

Docker

Start by cloning the repo:

git clone https://github.com/Asthowen/DiscordBotPihole.git

Now switch to project folder and build the container with docker-compose:

cd DiscordBotPihole && docker-compose -f ./docker/docker-compose.yml up -d --build

With release

This repo contains compiled bot executables for Windows and Linux, you can find them here.
You just need to download and launch it according to your operating system.

Configuration

To configure this bot, just use the example configuration: .env.example, you just have to rename it to .env and complete it.

Author

Asthowen

License

DiscordBotPihole | Mozilla Public License 2.0

About

A Discord bot for get Pi-Hole stats written in Rust.

License:Mozilla Public License 2.0


Languages

Language:Rust 97.6%Language:Dockerfile 2.0%Language:Shell 0.4%