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

Update documentation and templates for new consent

This commit is contained in:
Travis Ralston 2018-10-12 17:53:14 -06:00
parent 7ede650956
commit 22a2004428
2 changed files with 18 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/consent_tracking.md
View File

@ -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"); 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 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 the version: for example `1.0.html`. The version of the policy which the user
has agreed to is stored in the database. 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`. python-jinja2`.
Once this is complete, and the server has been restarted, try visiting Once this is complete, and the server has been restarted, try visiting
`https://<server>/_matrix/consent`. If correctly configured, this should give `https://<server>/_matrix/consent`. If correctly configured, you should see a
an error "Missing string query parameter 'u'". It is now possible to manually default policy document. It is now possible to manually construct URIs where
construct URIs where users can give their consent. users can give their consent.
### Constructing the consent URI ### Constructing the consent URI
@ -106,6 +106,11 @@ query parameters:
`https://<server>/_matrix/consent?u=<user>&h=68a152465a4d...`. `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 Sending users a server notice asking them to agree to the policy
---------------------------------------------------------------- ----------------------------------------------------------------

15
docs/privacy_policy_templates/en/1.0.html
View File

@ -12,12 +12,15 @@
<p> <p>
All your base are belong to us. All your base are belong to us.
</p> </p>
<form method="post" action="consent"> {% if not public_version %}
<input type="hidden" name="v" value="{{version}}"/> <!-- The variables used here are only provided when the 'u' param is given to the homeserver -->
<input type="hidden" name="u" value="{{user}}"/> <form method="post" action="consent">
<input type="hidden" name="h" value="{{userhmac}}"/> <input type="hidden" name="v" value="{{version}}"/>
<input type="submit" value="Sure thing!"/> <input type="hidden" name="u" value="{{user}}"/>
</form> <input type="hidden" name="h" value="{{userhmac}}"/>
<input type="submit" value="Sure thing!"/>
</form>
{% endif %}
{% endif %} {% endif %}
</body> </body>
</html> </html>