liz/PluralKit
liz/PluralKit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat: add redis requirements to readme (#542)

Browse Source
This commit is contained in:
Bray 2023-03-24 11:05:25 -04:00 committed by GitHub
parent 37025bbeb3
commit 93bef6ea15
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
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
# Requirements # Requirements
Running the bot requires [.NET 5](https://dotnet.microsoft.com/download) and a PostgreSQL database. It should function on any system where the prerequisites are set up (including Windows). Running the bot requires [.NET 5](https://dotnet.microsoft.com/download), a PostgreSQL database and a Redis database. It should function on any system where the prerequisites are set up (including Windows).
Optionally, it can integrate with [Sentry](https://sentry.io/welcome/) for error reporting and [InfluxDB](https://www.influxdata.com/products/influxdb-overview/) for aggregate statistics. Optionally, it can integrate with [Sentry](https://sentry.io/welcome/) for error reporting and [InfluxDB](https://www.influxdata.com/products/influxdb-overview/) for aggregate statistics.

3
pluralkit.conf.example
View File

@ -4,6 +4,7 @@
"Token": "BOT_TOKEN_GOES_HERE", "Token": "BOT_TOKEN_GOES_HERE",
"ClientId": 466707357099884544, "ClientId": 466707357099884544,
}, },
"Database": "Host=localhost;Port=5432;Username=myusername;Password=mypassword;Database=mydatabasename" "Database": "Host=localhost;Port=5432;Username=myusername;Password=mypassword;Database=mydatabasename",
"RedisAddr": "host:port"
} }
} }