lib.itmens/doc/configuration.md

24 lines
1.1 KiB
Markdown
Raw Normal View History

2022-12-13 16:33:58 -05:00
Configuration
=============
Settings you may want to change
-------------------------------
2022-12-14 01:42:52 -05:00
most settings resides in `settings.py`, a few notable ones:
2022-12-13 16:33:58 -05:00
- `SECRET_KEY` back it up well somewhere
- `SITE_INFO['site_name']` change by you need
2022-12-13 16:38:54 -05:00
- `CLIENT_NAME` site name shown in Mastodon app page
2022-12-13 16:33:58 -05:00
- `APP_WEBSITE` external root url for your side
2022-12-13 16:38:54 -05:00
- `REDIRECT_URIS` this should be `APP_WEBSITE + "/users/OAuth2_login/"` . It can be multiple urls separated by `\n` , but not all Fediverse software support it well. Also note changing this later may invalidate app token granted previously
2022-12-13 16:33:58 -05:00
- `MASTODON_ALLOW_ANY_SITE` set to `True` so that user can login via any Mastodon API compatible sites (e.g. Mastodon/Pleroma)
- `MASTODON_CLIENT_SCOPE` change it later may invalidate app token granted previously
- `ADMIN_URL` admin page url, keep it private
2022-12-13 16:38:54 -05:00
- `SEARCH_BACKEND` should be either `TYPESENSE` or `MEILISEARCH` so that search and index can function. `None` will use default database search, which is for development only and may gets deprecated soon.
2022-12-13 16:33:58 -05:00
Settings for Scrapers
---------------------
TBA