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

feat: add note about scheduled tasks worker to README

Browse Source
This commit is contained in:
spiral 2021-11-01 01:47:10 -04:00
parent c660ee2dae
commit 235d3c3c86
No known key found for this signature in database
GPG Key ID: A6059F0CA0E1BD31
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -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).