feat: docs: support platform configuration

wip-payments
Aravinth Manivannan 2022-06-17 19:19:00 +05:30
parent 328b44e729
commit 3be96ed131
Signed by: realaravinth
GPG Key ID: AD9F0F08E855ED88
2 changed files with 26 additions and 2 deletions

View File

@ -138,8 +138,10 @@ HOSTEA = {
"INSTANCE_MAINTAINER_CONTACT": "contact@hostea.example.org",
"ACCOUNTS": {"MAX_VERIFICATION_TOLERANCE_PERIOD": 60 * 60 * 24}, # in seconds
"META": {
"GITEA_INSTANCE": "https://gitea.hostea.org",
"GITEA_ORG_NAME": "Hostea",
"GITEA_INSTANCE": "https://gitea.hostea.org", # meta Gitea insatnce
"GITEA_ORG_NAME": "Hostea", # Organisation name on Hostea meta instance
# Repository dedicated for handling support
# ref: https://gitea.hostea.org/Hostea/july-mvp/issues/17
"SUPPORT_REPOSITORY": "support",
},
}

View File

@ -20,3 +20,25 @@ HOSTEA = {
In future, the cronjob will be run as part of the Hostea/Dashbaord and
hence the current redundancy in configuration and cronjob duration.
## Support Platform Integration
Hostea Dashbaord delegates support to Hostea's meta Gitea instance, as
discussed [here](https://gitea.hostea.org/Hostea/july-mvp/issues/17).
To configure support platform integration , please set the following
attributes in `settings.py`:
```python
HOSTEA = {
# <--snip--->
"META": {
# <--snip--->
"GITEA_INSTANCE": "https://gitea.hostea.org", # meta Gitea insatnce
"GITEA_ORG_NAME": "Hostea", # Organisation name on Hostea meta instance
# Repository dedicated for handling support
# ref: https://gitea.hostea.org/Hostea/july-mvp/issues/17
"SUPPORT_REPOSITORY": "support",
},
}
```