woodburn-bot/README.md
Nathan Woodburn 2b0477aee2
All checks were successful
Build Docker / Build Docker (push) Successful in 20s
bot: Added easier install
2023-08-12 16:52:01 +10:00

866 B

Woodburn Bot

Discord bot for the Woodburn server. This bot adds some Handshake related commands to the server.

Commands

  • /shortlink <url> - Shorten a URL using Kutt.it (requires a Kutt API key) only allowed for specied user

Setup

Docker

The easiest way to run this bot is to use Docker. You can use the following command to run the bot:

docker run -d -e DISCORD_TOKEN=<YOUR-BOT-TOKEN> -e LINK_API_KEY=<KUTT-API-KEY> -e LINK_URL=<KUTT-URL> -e ADMIN=<your-discord-userid> -e LOG_CHANNEL=<DISCORD-CHANNEL-ID> git.woodburn.au/nathanwoodburn/woodburn-bot:latest

Manual

If you don't want to use Docker, you can run the bot manually.

git clone https://git.woodburn.au/nathanwoodburn/woodburn-bot.git
cd woodburn-bot
python3 -m pip install -r requirements.txt
cp .env.example .env
# Edit .env and fill in your info
python3 main.py