From 4f6895e7f2a3b56bea91e907147e01b9b946a37c Mon Sep 17 00:00:00 2001 From: IGuessItsBray <97918955+IGuessItsBray@users.noreply.github.com> Date: Fri, 24 Mar 2023 10:58:11 -0400 Subject: [PATCH] Add redis requirements to docs Co-Authored-By: spiral --- README.md | 2 +- pluralkit.conf.example | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 81b05557..c643ff59 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 # 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 server. 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. diff --git a/pluralkit.conf.example b/pluralkit.conf.example index 06e3fc05..475ac2d2 100644 --- a/pluralkit.conf.example +++ b/pluralkit.conf.example @@ -5,5 +5,6 @@ "ClientId": 466707357099884544, }, "Database": "Host=localhost;Port=5432;Username=myusername;Password=mypassword;Database=mydatabasename" + "RedisAddr": "host:port" } } \ No newline at end of file