2022-10-27 01:55:23 +00:00
# Bird Bot
Bird Bot is a discord bot for managing and organizing events for a small discord community.
2024-03-04 00:42:06 +01:00
## Features
2022-10-27 01:55:23 +00:00
- Creating text channels for events
2024-03-04 00:42:06 +01:00
- Delete/archive text channels after events
2022-10-27 01:55:23 +00:00
- Notifying when events are created & cancelled
2023-04-01 01:23:37 -04:00
- Role selection
2024-03-04 00:42:06 +01:00
- Plugin support
2022-10-27 01:55:23 +00:00
## Usage
To get up and running, install go and you can run `make run` !
## Using Docker
2023-04-01 01:23:37 -04:00
The container is expecting the config file to be located at `/etc/birdbot/birdbot.yaml` . The easily solution here is to mount the config with a volume.
2022-10-27 01:55:23 +00:00
2024-03-04 00:42:06 +01:00
Example:
2022-10-27 01:55:23 +00:00
```bash
docker run -it -v `pwd` :/etc/birdbot yeslayla/birdbot:latest
```
2023-04-01 22:25:54 +00:00
In this example, your config is in the current directory and call `birdbot.yaml`
### Persistant Data
2023-04-02 05:13:12 +00:00
The default location for container data is `/var/lib/birdbot/` so you can mount it like:
2024-03-04 00:42:06 +01:00
Example:
2023-04-02 05:13:12 +00:00
```bash
docker run -it -v `pwd` :/var/lib/birdbot/ yeslayla/birdbot:latest
```
