tos/README.md

# 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.

Add a new array key under `tos.terms` for all terms and conditions that you want to add.

`label` is the name you want to give the terms

`url` is the URL where the terms are located

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.

### Example

```yaml
tos:
    version: 1
    terms:
        - title: terms of service
          url: http://example.com/tos
        - title: privacy policy
          url: http://example.com/privacy
```