eightball/PluralKit
1
0
Fork 0
mirror of https://github.com/PluralKit/PluralKit.git synced 2026-02-12 16:50:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: update docker-compose.yml for selfhost

Browse source
This commit is contained in:
alyssa 2025-04-13 22:05:14 +00:00
parent 437ea72ed4
commit 292c182eb2
9 changed files with 68 additions and 84 deletions
Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -6,7 +6,27 @@ PluralKit is a Discord bot meant for plural communities. It has features like me
PluralKit has a Discord server for support, feedback, and discussion: https://discord.gg/PczBt78
# Running
See [RUNNING.md](./RUNNING.md).
In production, we run PluralKit using Kubernetes (soon). The configuration can be found in the infra repo.
For self-hosting, it's simpler to use Docker, with the provided [docker-compose](./docker-compose.yml) file.
Create a `.env` file with the Discord client ID and bot token:
```
CLIENT_ID=198622483471925248
BOT_TOKEN=MTk4NjIyNDgzNDcxOTI1MjQ4.Cl2FMQ.ZnCjm1XVW7vRze4b7Cq4se7kKWs
```
If you want to use `pk;admin` commands (to raise member limits and such), set `ADMIN_ROLE` to a Discord role ID:
```
ADMIN_ROLE=682632767057428509
```
Run `docker compose build`, then `docker compose up -d`.
To view logs, use `docker compose logs`.
Postgres data is stored in a `pluralkit_data` [Docker volume](https://docs.docker.com/engine/storage/volumes/).
# Development
See [the dev-docs/ directory](./dev-docs/README.md)