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

docs: clarify redis address in pk.conf needs changed to match .env

Browse source
This commit is contained in:
rladenson 2025-04-27 20:48:22 -06:00
parent dfd9ea553a
commit 35090babd4
1 changed files with 3 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

4
dev-docs/RUNNING.md
View file

@ -47,13 +47,15 @@ pluralkit__discord__bot_token="BOT_TOKEN_GOES_HERE"
pluralkit__discord__client_id="BOT_CLIENT_ID_GOES_HERE" pluralkit__discord__client_id="BOT_CLIENT_ID_GOES_HERE"
pluralkit__discord__client_secret=1 pluralkit__discord__client_secret=1
pluralkit__discord__max_concurrency=1 pluralkit__discord__max_concurrency=1
pluralkit__runtime_config_key="gateway"
``` ```
**(This should match the username/password/database specified in the flake file and the configuration file)** **(This should match the username/password/database specified in the flake file and the configuration file AND the redis address in the configuration file should be changed to match this)**
*(assuming you already have Git installed, if not, you can start a shell with git by running `nix-shell -p git`)* *(assuming you already have Git installed, if not, you can start a shell with git by running `nix-shell -p git`)*
1. Clone the repository: `git clone https://github.com/PluralKit/PluralKit` 1. Clone the repository: `git clone https://github.com/PluralKit/PluralKit`
2. Create a `pluralkit.conf` configuration file in the `PluralKit` directory 2. Create a `pluralkit.conf` configuration file in the `PluralKit` directory
- Again, the DB URI parameters must match what's in the `flake.nix` file - Again, the DB URI parameters must match what's in the `flake.nix` file
- Also again, the Redis address must match what is in the .env file created next
3. Create a `.env` configuration file in the `PluralKit` directory *(see above)* 3. Create a `.env` configuration file in the `PluralKit` directory *(see above)*
4. Build and run: `nix run .#dev` 4. Build and run: `nix run .#dev`
- This will download the dependencies, build, and run PluralKit - This will download the dependencies, build, and run PluralKit