[doc] Update README.md

README.md

@@ -54,29 +54,99 @@ nano /etc/ssowat/conf.json
 
 If you use YunoHost, you may want to edit the `/etc/ssowat/conf.json.persistent` file, since the `/etc/ssowat/conf.json` will often be overwritten.
 
-### Available parameters
+## Available parameters
 
-* `portal_domain`: Domain of the authentication portal. It has to be a domain, IP addresses will not work with SSOwat (**Required**)
+These are the SSOwat's available parameters. Only the first one is required, but it is recommended to know the others to fully understand what you can do with SSOwat.
-* `portal_path`: URI of the authentication portal (default: `/ssowat`)
+
-* `portal_port`: Web port of the authentication portal (default: 443)
+#### portal_domain
-* `portal_scheme`: Whether authentication should use secure connection or not (default: `https`)
+
-* `domains`: List of handle domains (default: portal_domain)
+Domain of the authentication portal. It has to be a domain, IP addresses will not work with SSOwat (**Required**)
-* `ldap_host`: LDAP server hostname (default: `localhost`)
+
-* `ldap_group`: LDAP group to search in (default: **`ou=users,dc=yunohost,dc=org`**)
+#### portal_path
-* `ldap_identifier`: LDAP user identifier (default: `uid`)
+
-* `ldap_attributes`: User's attributes to fetch from LDAP (default: `["uid", "givenname", "sn", "cn", "homedirectory", "mail", "maildrop"]`)
+URI of the authentication portal (**default**: `/ssowat`)
-* `allow_mail_authentication`: Whether users can authenticate with their mail address (default: `true`)
+
-* `login_arg`: URI argument to use for cross-domain authentication (default: `sso_login`)
+#### portal_port
-* `additional_headers`: Array of additionnal HTTP headers to set once user is authenticated (default: `{ "Remote-User": "uid" }`)
+
-* `session_timeout`: The session expiracy time limit in seconds, since the last connection (default: `86400` / one day)
+Web port of the authentication portal (**default**: `443`)
-* `session_max_timeout`: The session expiracy time limit in seconds (default: `604800` / one week)
+
-* `protected_urls`: List of priorily protected URLs and/or URIs (**by default, every URL is protected**)
+#### portal_scheme
-* `protected_regex`: List of regular expressions to be matched against URLs **and** URIs to protect them
+
-* `skipped_urls`: List of URLs and/or URIs that will not be affected by SSOwat
+Whether authentication should use secure connection or not (**default**: `https`)
-* `skipped_regex`: List of regular expressions to be matched against URLs **and** URIs to ignore them
+
-* `unprotected_urls`: List of URLs and/or URIs that will not be affected by SSOwat **unless user is authenticated**
+#### domains
-* `unprotected_regex`: List of regular expressions to be matched against URLs **and** URIs to ignore them **unless user is authenticated**
+
-* `redirected_urls`: Array of URLs and/or URIs to redirect and their redirect URI/URL (example: `{ "/", "example.org/subpath" }`)
+List of handle domains (**default**: similar to `portal_domain`)
-* `redirected_regex`: Array of regular expressions to be matched against URLS **and** URIs and their redirect URI/URL (example: `{ "example.org/megusta$", "example.org/subpath" }`)
+
-* `users`: 2-level array containing usernames and their allowed URLs along with an App name (example: `{ "kload": { "kload.fr/myapp/": "My App" } }`)
+#### ldap_host
+
+LDAP server hostname (**default**: `localhost`)
+
+#### ldap_group
+
+LDAP group to search in (**default**: `ou=users,dc=yunohost,dc=org`)
+
+#### ldap_identifier
+
+LDAP user identifier (**default**: `uid`)
+
+#### ldap_attributes
+
+User's attributes to fetch from LDAP (**default**: `["uid", "givenname", "sn", "cn", "homedirectory", "mail", "maildrop"]`)
+
+#### allow_mail_authentication
+
+Whether users can authenticate with their mail address (**default**: `true`)
+
+#### login_arg
+
+URI argument to use for cross-domain authentication (**default**: `sso_login`)
+
+#### additional_headers
+
+Array of additionnal HTTP headers to set once user is authenticated (**default**: `{ "Remote-User": "uid" }`)
+
+#### session_timeout
+
+The session expiracy time limit in seconds, since the last connection (**default**: `86400` / one day)
+
+#### session_max_timeout
+
+The session expiracy time limit in seconds (**default**: `604800` / one week)
+
+#### protected_urls
+
+List of priorily protected URLs and/or URIs (**by default, every URL is protected**)
+
+#### protected_regex
+
+List of regular expressions to be matched against URLs **and** URIs to protect them
+
+#### skipped_urls
+
+List of URLs and/or URIs that will not be affected by SSOwat
+
+#### skipped_regex
+
+List of regular expressions to be matched against URLs **and** URIs to ignore them
+
+#### unprotected_urls
+
+List of URLs and/or URIs that will not be affected by SSOwat **unless user is authenticated**
+
+#### unprotected_regex
+
+List of regular expressions to be matched against URLs **and** URIs to ignore them **unless user is authenticated**
+
+#### redirected_urls
+
+Array of URLs and/or URIs to redirect and their redirect URI/URL (**example**: `{ "/", "example.org/subpath" }`)
+
+#### redirected_regex
+
+Array of regular expressions to be matched against URLS **and** URIs and their redirect URI/URL (**example**: `{ "example.org/megusta$", "example.org/subpath" }`)
+
+#### users
+
+2-level array containing usernames and their allowed URLs along with an App name (**example**: `{ "kload": { "kload.fr/myapp/": "My App" } }`)