From 8e754826492ed8b022ce216706039cf2b345ebc7 Mon Sep 17 00:00:00 2001 From: Lars Vierbergen Date: Mon, 21 May 2018 19:27:04 +0200 Subject: [PATCH] Add readme --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..be160db --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# Authserver: Terms of Service plugin + +This [Authserver](https://github.com/vierbergenlars/authserver) plugin that requires users to accept some terms of service before they can use their account. + +## Installation + +`./plugin.sh install vierbergenlars/authserver-tos-bundle` + +For more details, see the [Authserver plugin documentation](https://github.com/vierbergenlars/authserver/blob/master/documentation/plugins.md). + +## Configuration + +You can configure the bundle in the authserver `app/config/parameters.yml` file. + +Set `tos.url` to a link to your terms of service. +Set `tos.version` to the version of your terms of service. This number should be increased every time the terms of service change, so users get prompted to accept the new terms. The version of the latest accepted version is stored per user. If the stored number is lower than the configured version, the user is prompted.