Mirrors
/
synapse
mirror of https://github.com/element-hq/synapse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

consent_tracking: formatting etc

This commit is contained in:
Richard van der Hoff 2018-05-23 12:37:39 +01:00 committed by GitHub
parent 2574ea3dc8
commit 563606b8f2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/consent_tracking.md
View File

@ -31,9 +31,9 @@ Note that the templates must be stored under a name giving the language of the
template - currently this must always be `en` (for "English"); template - currently this must always be `en` (for "English");
internationalisation support is intended for the future. internationalisation support is intended for the future.
The template for the policy itself should be versioned - for example The template for the policy itself should be versioned and named according to
`1.0.html`. The version of the policy which the user has agreed to is stored in the version: for example `1.0.html`. The version of the policy which the user
the database. has agreed to is stored in the database.
Once the templates are in place, make the following changes to `homeserver.yaml`: Once the templates are in place, make the following changes to `homeserver.yaml`:
@ -66,7 +66,7 @@ Once the templates are in place, make the following changes to `homeserver.yaml`
3. Add `consent` wherever the `client` resource is currently enabled in the 3. Add `consent` wherever the `client` resource is currently enabled in the
`listeners` configuration. For example: `listeners` configuration. For example:
``` ```yaml
listeners: listeners:
- port: 8008 - port: 8008
resources: resources:
@ -85,8 +85,7 @@ Once this is complete, and the server has been restarted, try visiting
this should give an error "Missing string query parameter 'u'". It is now this should give an error "Missing string query parameter 'u'". It is now
possible to manually construct URIs where users can give their consent. possible to manually construct URIs where users can give their consent.
Constructing the consent URI ### Constructing the consent URI
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
It may be useful to manually construct the "consent URI" for a given user - for It may be useful to manually construct the "consent URI" for a given user - for
instance, in order to send them an email asking them to consent. To do this, instance, in order to send them an email asking them to consent. To do this,
@ -116,7 +115,7 @@ version of the policy. To do so:
* ensure that the consent resource is configured, as in the previous section * ensure that the consent resource is configured, as in the previous section
* ensure that server notices are configured, as in [server_notices.md]. * ensure that server notices are configured, as in [server_notices.md](server_notices.md).
* Add `server_notice_content` under `user_consent` in `homeserver.yaml`. For * Add `server_notice_content` under `user_consent` in `homeserver.yaml`. For
example: example:
@ -141,7 +140,7 @@ notices room is exempted from this).
To enable this, add `block_events_error` under `user_consent`. For example: To enable this, add `block_events_error` under `user_consent`. For example:
``` ```yaml
user_consent: user_consent:
block_events_error: >- block_events_error: >-
You can't send any messages until you consent to the privacy policy at You can't send any messages until you consent to the privacy policy at