diff options
author | Travis Ralston <travpc@gmail.com> | 2018-10-12 17:53:14 -0600 |
---|---|---|
committer | Travis Ralston <travpc@gmail.com> | 2018-10-12 17:53:14 -0600 |
commit | 22a20044280d6c0a16ad9e94baf486046d536e5c (patch) | |
tree | a9470598f0c1640124950ef175a13241e476de8f /docs/consent_tracking.md | |
parent | Merge branch 'develop' into travis/login-terms (diff) | |
download | synapse-22a20044280d6c0a16ad9e94baf486046d536e5c.tar.xz |
Update documentation and templates for new consent
Diffstat (limited to 'docs/consent_tracking.md')
-rw-r--r-- | docs/consent_tracking.md | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/docs/consent_tracking.md b/docs/consent_tracking.md index 064eae82f7..3634d13d4f 100644 --- a/docs/consent_tracking.md +++ b/docs/consent_tracking.md @@ -31,7 +31,7 @@ Note that the templates must be stored under a name giving the language of the template - currently this must always be `en` (for "English"); internationalisation support is intended for the future. -The template for the policy itself should be versioned and named according to +The template for the policy itself should be versioned and named according to the version: for example `1.0.html`. The version of the policy which the user has agreed to is stored in the database. @@ -81,9 +81,9 @@ should be a matter of `pip install Jinja2`. On debian, try `apt-get install python-jinja2`. Once this is complete, and the server has been restarted, try visiting -`https://<server>/_matrix/consent`. If correctly configured, this should give -an error "Missing string query parameter 'u'". It is now possible to manually -construct URIs where users can give their consent. +`https://<server>/_matrix/consent`. If correctly configured, you should see a +default policy document. It is now possible to manually construct URIs where +users can give their consent. ### Constructing the consent URI @@ -106,6 +106,11 @@ query parameters: `https://<server>/_matrix/consent?u=<user>&h=68a152465a4d...`. +Note that not providing a `u` parameter will be interpreted as wanting to view +the document from an unauthenticated perspective, such as prior to registration. +Therefore, the `h` parameter is not required in this scenario. + + Sending users a server notice asking them to agree to the policy ---------------------------------------------------------------- |