summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorRichard van der Hoff <richard@matrix.org>2018-05-11 00:17:11 +0100
committerRichard van der Hoff <richard@matrix.org>2018-05-15 15:11:59 +0100
commit47815edcfae73c5b938f8354853a09c0b80ef27e (patch)
treea68e0f4ff14809f5a30b4446c3837aa1eb725957 /docs
parentMerge remote-tracking branch 'origin/master' into develop (diff)
downloadsynapse-47815edcfae73c5b938f8354853a09c0b80ef27e.tar.xz
ConsentResource to gather policy consent from users
Hopefully there are enough comments and docs in this that it makes sense on its
own.
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>