summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorRichard van der Hoff <1389908+richvdh@users.noreply.github.com>2018-05-16 07:19:18 +0100
committerGitHub <noreply@github.com>2018-05-16 07:19:18 +0100
commit8030a825c8ea375652a856929d29d7ae28096cc1 (patch)
treefd1a3c6d59b793fb5ceca6d08187e12753bcaac1 /docs
parentMerge pull request #3201 from matrix-org/dbkr/leave_rooms_on_deactivate (diff)
parentConsentResource to gather policy consent from users (diff)
downloadsynapse-8030a825c8ea375652a856929d29d7ae28096cc1.tar.xz
Merge pull request #3213 from matrix-org/rav/consent_handler
ConsentResource to gather policy consent from users
Diffstat (limited to 'docs')
-rw-r--r--docs/privacy_policy_templates/README.md23
-rw-r--r--docs/privacy_policy_templates/en/1.0.html17
-rw-r--r--docs/privacy_policy_templates/en/success.html11
3 files changed, 51 insertions, 0 deletions
diff --git a/docs/privacy_policy_templates/README.md b/docs/privacy_policy_templates/README.md
new file mode 100644

index 0000000000..8e91c516b3 --- /dev/null +++ b/docs/privacy_policy_templates/README.md
@@ -0,0 +1,23 @@ +If enabling the 'consent' resource in synapse, you will need some templates +for the HTML to be served to the user. This directory contains very simple +examples of the sort of thing that can be done. + +You'll need to add this sort of thing to your homeserver.yaml: + +``` +form_secret: <unique but arbitrary secret> + +user_consent: + template_dir: docs/privacy_policy_templates + default_version: 1.0 +``` + +You should then be able to enable the `consent` resource under a `listener` +entry. For example: + +``` +listeners: + - port: 8008 + resources: + - names: [client, consent] +``` diff --git a/docs/privacy_policy_templates/en/1.0.html b/docs/privacy_policy_templates/en/1.0.html new file mode 100644
index 0000000000..ab8666f0c3 --- /dev/null +++ b/docs/privacy_policy_templates/en/1.0.html
@@ -0,0 +1,17 @@ +<!doctype html> +<html lang="en"> + <head> + <title>Matrix.org Privacy policy</title> + </head> + <body> + <p> + All your base are belong to us. + </p> + <form method="post" action="consent"> + <input type="hidden" name="v" value="{{version}}"/> + <input type="hidden" name="u" value="{{user}}"/> + <input type="hidden" name="h" value="{{userhmac}}"/> + <input type="submit" value="Sure thing!"/> + </form> + </body> +</html> diff --git a/docs/privacy_policy_templates/en/success.html b/docs/privacy_policy_templates/en/success.html new file mode 100644
index 0000000000..d55e90c94f --- /dev/null +++ b/docs/privacy_policy_templates/en/success.html
@@ -0,0 +1,11 @@ +<!doctype html> +<html lang="en"> + <head> + <title>Matrix.org Privacy policy</title> + </head> + <body> + <p> + Sweet. + </p> + </body> +</html>