From 0406c32f6b6df0ac7dbec0adc827267021e8f1bd Mon Sep 17 00:00:00 2001 From: asleepyskye Date: Mon, 26 May 2025 20:20:37 +0000 Subject: [PATCH] chore: update dev-docs for Serilog submodule --- README.md | 3 ++- dev-docs/README.md | 4 ++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 84cc3f56..26b96c6d 100644 --- a/README.md +++ b/README.md @@ -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 # 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. @@ -22,6 +22,7 @@ If you want to use `pk;admin` commands (to raise member limits and such), set ` 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`. To view logs, use `docker compose logs`. diff --git a/dev-docs/README.md b/dev-docs/README.md index 02c18d46..76199e09 100644 --- a/dev-docs/README.md +++ b/dev-docs/README.md @@ -49,14 +49,14 @@ PluralKit__Bot__HttpListenerAddr="127.0.0.1" 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)* 3. Build and run: `nix run .#dev` - 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 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:~/PluralKit]$ nano .env [nix-shell:~/PluralKit]$ nix run .#dev