1.1 --- a/docs/wiki/WebServerIntegration Mon Nov 02 00:03:42 2015 +0100
1.2 +++ b/docs/wiki/WebServerIntegration Mon Nov 02 00:06:26 2015 +0100
1.3 @@ -48,6 +48,54 @@
1.4 `conf/apache/imip-manager.conf` file provides a configuration file for
1.5 deployment with the Apache Web server software that enables this interface.
1.6
1.7 +=== Configuring the Management Interface ===
1.8 +
1.9 +The `config.py` file described in the [[../Configuration|configuration guide]]
1.10 +provides some settings that can be adjusted to configure the management
1.11 +interface.
1.12 +
1.13 +{{{{#!table
1.14 +'''Setting''' || '''Result'''
1.15 +==
1.16 +`MANAGER_INTERFACE`
1.17 +|| If set to `True`, causes links to the interface to be included in
1.18 +.. notification messages sent by imip-agent. If set to `False`, such links
1.19 +.. will be omitted.
1.20 +==
1.21 +`MANAGER_URL`
1.22 +|| The deployment URL of the management interface. Together with the
1.23 +.. `MANAGER_PATH` described below, this forms the basis of the links
1.24 +.. described above. Some examples:
1.25 +{{{
1.26 +http://webserver.example.com/
1.27 +http://webserver.example.com/webapps/
1.28 +}}}
1.29 +It can be left as `None` and a default URL will be built using the
1.30 +hostname of the system running the software.
1.31 +==
1.32 +`MANAGER_URL_SCHEME`
1.33 +|| The URL scheme or protocol employed if a default URL is being constructed
1.34 +.. instead of `MANAGER_URL` providing a value. Some examples:
1.35 +{{{
1.36 +http://
1.37 +https://
1.38 +}}}
1.39 +Since the manager is only likely to be available via common Web protocols,
1.40 +other values may not make much sense.
1.41 +==
1.42 +`MANAGER_PATH`
1.43 +|| The "path info" added to the `MANAGER_URL` that locates the management
1.44 +.. interface in its deployment location. Some examples:
1.45 +{{{
1.46 +/
1.47 +/imip-agent
1.48 +}}}
1.49 +This setting affects the `imip-manager.conf` file, whose `Alias`, `ScriptAlias`
1.50 +and `Location` directives should be changed if this setting is changed.
1.51 +}}}}
1.52 +
1.53 +=== Deploying the Configuration ===
1.54 +
1.55 On Debian, to enable the management interface, copy the configuration file to
1.56 the Apache configuration and enable it as follows:
1.57
1.58 @@ -73,3 +121,31 @@
1.59 {{{
1.60 a2enmod authnz_ldap
1.61 }}}
1.62 +
1.63 +=== Authenticating Users ===
1.64 +
1.65 +The `imip-manager.conf` file contains example directives for accessing
1.66 +authentication services or data.
1.67 +
1.68 +Where LDAP authentication is to be used, the appropriate LDAP URL needs to be
1.69 +specified using a directive. For example:
1.70 +
1.71 +{{{
1.72 +AuthLDAPUrl "ldap://localhost/ou=People,dc=example,dc=com?mail?sub"
1.73 +}}}
1.74 +
1.75 +Here, the `mail` attribute is used to match the username provided in the
1.76 +authentication dialogue. Configuration changes may be required within the LDAP
1.77 +infrastructure to allow this mechanism to function, but this is not described
1.78 +here.
1.79 +
1.80 +Meanwhile, particularly where [[../MailIntegration/Simple|simple integration]]
1.81 +strategies have been chosen, a plain text user file can be employed to
1.82 +authenticate users. For example:
1.83 +
1.84 +{{{
1.85 +AuthUserFile /var/www/imip-agent/users
1.86 +}}}
1.87 +
1.88 +Such a file should be created using the usual tools provided by the Apache Web
1.89 +server distribution.