Skip to content
Snippets Groups Projects
Commit 93862718 authored by Maxime Besson's avatar Maxime Besson
Browse files

Improve restconfig documentation

parent 7a2424fb
No related branches found
No related tags found
No related merge requests found
......@@ -80,5 +80,6 @@ You can also add some other parameters
`user`, `password` and `realm` parameters are only used if the entry point
`index.fcgi/config` is protected by a basic authentication. Thus, handlers will
make requests to the portal using these parameters. `realm` must match the
`auth_basic` (Nginx) or `AuthType` (Apache) setting in your web server.
make requests to the portal using these parameters. `realm` is mandatory if
basic authentication is used, and it must match the `auth_basic` (Nginx) or
`AuthType` (Apache) setting in your web server.
......@@ -75,8 +75,9 @@ Name Comment Example
`user`, `password` and `realm` parameters are only used if the entry point `index.fcgi/sessions/global`
is protected by a basic authentication. Thus, handlers will make requests to the Portal
using these parameters. `realm` must match the `auth_basic` (Nginx) or
`AuthType` (Apache) setting in your web server.
using these parameters. `realm` is mandatory if basic authentication is used,
and it must match the `auth_basic` (Nginx) or `AuthType` (Apache) setting in
your web server.
.. attention::
......
......@@ -131,19 +131,9 @@ checkTime = 1
; type = REST
; baseUrl = https://auth.example.com/config
; proxyOptions = { timeout => 5 }
; User = lemonldap
; Password = mypassword
;
; * SOAP: SOAP configuration access is a sort of proxy: the portal is
; configured to use the real session storage type (DBI or File for
; example).
; You have to set 'proxy' parameter. Example:
;
; type = SOAP
; proxy = https://auth.example.com/config
; proxyOptions = { timeout => 5 }
; User = lemonldap
; Password = mypassword
; user = lemonldap
; password = mypassword
; realm = myrealm
;
; * LDAP: you have to set ldapServer, ldapConfBase, ldapBindDN and ldapBindPassword.
;
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment