jasima/majuna
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: add docs about static origins

Browse source
This commit is contained in:
Iain Learmonth 2023-03-30 13:32:16 +01:00
parent 2bff52edb4
commit c72e617c00
1 changed files with 47 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

48
docs/user/proxies.rst
View file

@ -117,7 +117,53 @@ Static Origins
Static origins can be used to host static content at a cloud provider, and then have mirrors generated for that content
rather than proxying to an external web server.
Once created a static origin will provide you with details on where to upload the web content.
Once created a static origin will provide you with details on where and how to upload the web content.
Static origins can also be extended with additional resources:
* `Keanu Convene <https://letsconvene.im/>`_ - A matrix-based chat platform that supports sharing of any kind. Rooms are
private and encrypted by default. No software is required to join a room other than a web browser, and participants
can be invited via a link.
* `Clean Insights <https://cleaninsights.org/>`_ - A private measurement platform. It is focused on assisting in
answering key questions about app usage patterns, and not on enabling invasive surveillance of all user habits.
These resources can be added/removed after the creation of the static origin without having to change the static storage
location or access credentials.
New Static Origin
^^^^^^^^^^^^^^^^^
Description
"""""""""""
Enter a brief description of the static website that you are creating in this field. This is also a required field.
Group
"""""
Select the group that you want the origin to belong to from the drop-down menu in this field. This is a required field.
Auto-Rotate
"""""""""""
Select this field if you want to enable auto-rotation for the mirror. This means that the mirror will automatically
redeploy with a new domain name if it is detected to be blocked. This field is optional and is enabled by default.
Matrix Homeserver
"""""""""""""""""
Select the Matrix homeserver from the drop-down box to enable Keanu Convene on mirrors of this static origin.
Keanu Convene Path
""""""""""""""""""
Enter the subdirectory to present the Keanu Convene application at on the mirror. This defaults to "talk".
Enable Clean Insights
"""""""""""""""""""""
When enabled, a Clean Insights Measurement Proxy endpoint is deployed on the mirror to allow for submission of results
from any of the supported Clean Insights SDKs.
Web Proxies
-----------