feat(dashboard): add tos/privacy/about pages, add delete all data page + endpoint
This commit is contained in:
parent
ac54b78a13
commit
31b6ac2cac
21 changed files with 527 additions and 28 deletions
21
README.md
21
README.md
|
|
@ -17,6 +17,24 @@ Add these with `dotnet nuget add source --username <githubUsername> --password <
|
|||
|
||||
You must generate a personal access token (classic) [here](personal-access-token). 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][dotnet-publish])
|
||||
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)
|
||||
|
|
@ -37,4 +55,5 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|||
[old-repo]: https://github.com/starshine-sys/catalogger/tree/main
|
||||
[husky]: https://github.com/alirezanet/Husky.Net
|
||||
[csharpier]: https://csharpier.com/
|
||||
[personal-access-token]: https://github.com/settings/tokens
|
||||
[personal-access-token]: https://github.com/settings/tokens
|
||||
[dotnet-publish]: https://learn.microsoft.com/en-us/dotnet/core/deploying/
|
||||
Loading…
Add table
Add a link
Reference in a new issue