sam/Catalogger.NET
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Discord logging bot https://catalogger.app
84 commits 2 branches 13 tags 2.6 MiB
Find a file
sam be8bc9b199
feat(dashboard): favicon
2024-10-29 14:50:48 +01:00
.config add husky and csharpier 2024-10-09 17:11:05 +02:00
.husky fix: *actually* add a pre-commit hook for husky 2024-10-09 17:34:56 +02:00
.idea/.idea.catalogger/.idea excise entity framework from all remaining code 2024-10-28 14:04:55 +01:00
Catalogger.Backend feat(dashboard): add key roles 2024-10-29 14:19:18 +01:00
Catalogger.Frontend feat(dashboard): favicon 2024-10-29 14:50:48 +01:00
Catalogger.GoImporter feat: import messages from go version 2024-10-28 23:42:57 +01:00
go-exporter feat: import messages from go version 2024-10-28 23:42:57 +01:00
.editorconfig feat: start dashboard 2024-10-18 22:13:23 +02:00
.gitignore update gitignore 2024-08-19 16:12:46 +02:00
catalogger.sln feat: export guilds from old bot and import into new one 2024-10-24 23:35:44 +02:00
catalogger.sln.DotSettings move classes around, name caches more consistently, add more caches 2024-08-19 16:12:28 +02:00
global.json feat: role delete logging, used invite logging, also some random changes 2024-10-09 22:31:58 +02:00
LICENSE add LICENSE 2024-08-19 16:13:42 +02:00
README.md feat(dashboard): add tos/privacy/about pages, add delete all data page + endpoint 2024-10-24 15:53:27 +02:00

README.md

Catalogger.NET

C# rewrite of Catalogger.

Development

Command-line tools for this project can be installed with dotnet tool restore.

  • We use Husky.Net for Git hooks, install it with dotnet husky install.
  • We use CSharpier for formatting .NET code. It can be called with dotnet csharpier ., but is automatically run by Husky pre-commit.

Nuget

We currently use Remora's GitHub packages as the releases on nuget.org are missing some key features. Add these with dotnet nuget add source --username <githubUsername> --password <githubToken> --store-password-in-clear-text --name Remora "https://nuget.pkg.github.com/Remora/index.json"

You must generate a personal access token (classic) here. Only give it the read:packages permission.

Deploying Catalogger yourself

The bot itself should run on any server with .NET 8 and PostgreSQL 15 or later. A Redis-compatible database is not a hard dependency for the bot, but may be used for faster restarts (when Redis is used, certain data will be cached there instead of in memory).

The dashboard isn't made for self-hosting. While it should work, the about/contact/ToS/privacy policy pages are hardcoded for our own convenience.

For now, you'll also have to follow the instructions in the "Nuget" section above.

Steps to build and run the bot:

  1. Clone the repository
  2. Run dotnet publish (documentation)
  3. Change directory into Catalogger.Backend/
  4. Copy config.example.ini to config.ini and fill it out.
  5. Run the bot by executing bin/Release/net8.0/Catalogger.Backend (or net9.0 if you're using that version)

License

Copyright (C) 2021-present sam (https://starshines.gay)

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.