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

chore: update dev-docs for Serilog submodule

Browse source
This commit is contained in:
asleepyskye 2025-05-26 20:20:37 +00:00 • committed by alyssa
parent 0c342472b1
commit 0406c32f6b
2 changed files with 4 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -6,7 +6,7 @@ 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 PluralKit has a Discord server for support, feedback, and discussion: https://discord.gg/PczBt78
# Running # Running
In production, we run PluralKit using Kubernetes (soon). The configuration can be found in the infra repo. In production, we run PluralKit using Kubernetes. 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. For self-hosting, it's simpler to use Docker, with the provided [docker-compose](./docker-compose.yml) file.
@ -22,6 +22,7 @@ If you want to use `pk;admin` commands (to raise member limits and such), set `
ADMIN_ROLE=682632767057428509 ADMIN_ROLE=682632767057428509
``` ```
*If you didn't clone the repository with submodules, run `git submodule update --init` first to pull the required submodules.*
Run `docker compose build`, then `docker compose up -d`. Run `docker compose build`, then `docker compose up -d`.
To view logs, use `docker compose logs`. To view logs, use `docker compose logs`.

4
dev-docs/README.md
View file

@ -49,14 +49,14 @@ PluralKit__Bot__HttpListenerAddr="127.0.0.1"
PluralKit__Bot__HttpCacheUrl="localhost:5000" PluralKit__Bot__HttpCacheUrl="localhost:5000"
``` ```
1. Clone the repository: `git clone https://github.com/PluralKit/PluralKit` 1. Clone the repository: `git clone --recurse-submodules https://github.com/PluralKit/PluralKit`
2. Create a `.env` configuration file in the `PluralKit` directory *(see above)* 2. Create a `.env` configuration file in the `PluralKit` directory *(see above)*
3. Build and run: `nix run .#dev` 3. Build and run: `nix run .#dev`
- This will download the dependencies, build, and run PluralKit - This will download the dependencies, build, and run PluralKit
- If Nix is not setup to allow flakes, you may need to add `--extra-experimental-features nix-command --extra-experimental-features flakes` to the command - If Nix is not setup to allow flakes, you may need to add `--extra-experimental-features nix-command --extra-experimental-features flakes` to the command
- If the `pluralkit-bot` process fails to run, you can restart it by selecting it and pressing `Ctrl-R` - If the `pluralkit-bot` process fails to run, you can restart it by selecting it and pressing `Ctrl-R`
``` ```
[nix-shell:~]$ git clone https://github.com/PluralKit/PluralKit [nix-shell:~]$ git clone --recurse-submodules https://github.com/PluralKit/PluralKit
[nix-shell:~]$ cd PluralKit [nix-shell:~]$ cd PluralKit
[nix-shell:~/PluralKit]$ nano .env [nix-shell:~/PluralKit]$ nano .env
[nix-shell:~/PluralKit]$ nix run .#dev [nix-shell:~/PluralKit]$ nix run .#dev