diff --git a/docs/admin/01_config.rst b/docs/admin/01_config.rst index 089c4416b031f7cf78d92ef8a57e3d86084f9094..7b7b413a4d641b614bd463b5a6bfd27c715e4a0e 100644 --- a/docs/admin/01_config.rst +++ b/docs/admin/01_config.rst @@ -27,25 +27,21 @@ configuration by topic. A configuration file might look like this:: - [default] secret_key = "VerySecretKeyForSessionSecurity" - [default.http] allowed_hosts = [ "aleksis.myschool.example.com", "localhost" ] - [default.database] name = "aleksis" user = "aleksis" password = "SuperSecretPassword" - [default.caching] memcached = { enabled = true, address = "127.0.0.1" } The `secret_key` setting above defines a single value. The following `http` section defines a table (cf. a dictionary) in one way, and you can see the second form of such a table in the `memcached` setting (we could as well -have defined another section called `[default.caching.memcached]` and placed -`enabled` and `address` below it as scalars). +have defined another section and placed `enabled` and `address` below it +as scalars). This can be a bit confusing, so this documentation will explain how to configure AlekSIS on a per-feature basis. diff --git a/docs/admin/02_ldap.rst b/docs/admin/02_ldap.rst index 1239d43e1b45d255100b249c417b44bd5de67b51..7723ad8c2d14b3a02c78250dfac3c1a89ae94c4a 100644 --- a/docs/admin/02_ldap.rst +++ b/docs/admin/02_ldap.rst @@ -25,10 +25,8 @@ configuration file. For example, add something like the following to your configuration (normally in `/etc/aleksis`; you can either append to an existing file or add a new one):: - [default.ldap] uri = "ldaps://ldap.myschool.edu" bind = { dn = "cn=reader,dc=myschool,dc=edu", password = "secret" } - [default.ldap.users] search = { base = "ou=people,dc=myschool,dc=edu", filter = "(uid=%(user)s)" } map = { first_name = "givenName", last_name = "sn", email = "mail" } diff --git a/docs/admin/03_psql.rst b/docs/admin/03_psql.rst index 8c544041fdce1dc6ee83d3311526bb3561dcb487..657a482df77dfeb5fb08a42f3e3e6aba1e7282f7 100644 --- a/docs/admin/03_psql.rst +++ b/docs/admin/03_psql.rst @@ -32,7 +32,6 @@ Configure AlekSIS to use PostgreSQL Fill in the configuration under `/etc/aleksis/aleksis.toml` (or a file with any other name in this directory):: - [default.database] host = "localhost" name = "aleksis" username = "aleksis"