From 235d3c3c8693c36c1490fb1bb4117a027d65f242 Mon Sep 17 00:00:00 2001 From: spiral Date: Mon, 1 Nov 2021 01:47:10 -0400 Subject: [PATCH] feat: add note about scheduled tasks worker to README --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index cf2935bc..a6f81e6a 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,18 @@ $ docker-compose up -d (tip: use `scripts/run-test-db.sh` to run a temporary PostgreSQL database on your local system. Requires Docker.) +## Scheduled Tasks worker + +There is a scheduled tasks worker that needs to be ran separately from the bot. This handles cleaning up the database, and updating statistics (system/member/etc counts, shown in the `pk;stats` embed). + +Note: This worker is *not required*, and the bot will function correctly without it. + +If you are running the bot via docker-compose, this is set up automatically. + +If you run the bot manually you can run the worker as such: +* `dotnet run --project PluralKit.ScheduledTasks` +* or if you used `dotnet build` rather than `dotnet run` to run the bot: `dotnet build/PluralKit.ScheduledTasks.dll` + # Upgrading database from legacy version If you have an instance of the Python version of the bot (from the `legacy` branch), you may need to take extra database migration steps. For more information, see [LEGACYMIGRATE.md](./LEGACYMIGRATE.md).