diff --git a/dashboard/settings.py b/dashboard/settings.py index 229089b..bd25088 100644 --- a/dashboard/settings.py +++ b/dashboard/settings.py @@ -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", }, } diff --git a/docs/INSTALL.md b/docs/INSTALL.md index 03afaf0..58e8633 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -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", + }, +} +```