# HG changeset patch # User Paul Boddie # Date 1445862715 -3600 # Node ID 675d1e7f85101e81c02e9da0bae0f09671edb599 # Parent d18ac1d27b581442d29a9a8af3ef63f0849b44a2 Reformatted the documentation somewhat. diff -r d18ac1d27b58 -r 675d1e7f8510 README.txt --- a/README.txt Sun Oct 25 23:41:59 2015 +0100 +++ b/README.txt Mon Oct 26 13:31:55 2015 +0100 @@ -89,6 +89,10 @@ If already installed, the /etc/imip-agent/config.sh script should be edited instead. +With local SMTP delivery, the mail system will need to be configured to route +messages for local recipients. See the description of mail configuration for +more information. + Configuring Other Software ========================== @@ -103,7 +107,7 @@ Either Exim or Postfix can be chosen as a mail system supporting the agent. Configuring Mail Systems for the Agent --------------------------------------- +====================================== The essential aspect of mail system configuration involves mail transports and the integration of agent programs into the mail processing pipeline. Thus, the @@ -127,20 +131,28 @@ If local SMTP delivery is being used, the 30_exim4-config_people file (in conf/exim) or the master.cf.items file (in conf/postfix) will need adjusting. -Where LMTP_SOCKET is employed, a suitable filesystem path is required; where -the lmtp system group is employed, it may be replaced with a different group. -See below for a discussion of LMTP and mail delivery. + +If LMTP is being used, instances of LMTP_SOCKET in the example configuration +files will need to be replaced with a suitable filesystem path. Where the lmtp +system group is employed, it may be replaced with a different group. See +below for a discussion of LMTP and mail delivery. Configuring Mail Systems for Mail Recipients --------------------------------------------- +============================================ The software should operate independently of the way mail recipients are identified in any given mail system, and thus does not dictate things such as routing or account querying. However, example configuration files are provided -that demonstrate the use of LDAP to identify mail recipients: +that demonstrate the use of various techniques to identify mail recipients. +Naturally, these recipient identification configuration examples can be +disregarded in favour of other ways of defining mail recipients, subject to +the needs of any given environment. -For Exim with LDAP (in conf/exim/ldap)... +Using LDAP with Exim +-------------------- + +For Exim (in conf/exim/ldap)... 010_exim4-config_ldap_people_outgoing Defines recipients and outgoing mail routing @@ -148,8 +160,10 @@ 020_exim4-config_ldap_resources ... 020_exim4-config_ldap_people_outgoing_recipients +Using LDAP with Postfix +----------------------- -For Postfix with LDAP (in conf/postfix/ldap)... +For Postfix (in conf/postfix/ldap)... main.cf.example Defines recipients and outgoing mail routing (for inclusion in @@ -159,6 +173,8 @@ virtual_alias_maps_people_outgoing.cf mail routing virtual_alias_maps_resources.cf ... +Using Lists of Identities +------------------------- Since the use of LDAP can be somewhat challenging and also excessive in some situations, examples of maintaining recipient information using a simpler @@ -168,8 +184,10 @@ virtual identity files, but this permits a very transparent way of administering the system. +Using Lists with Exim +--------------------- -For Exim without LDAP (in conf/exim/simple)... +For Exim (in conf/exim/simple)... 010_exim4-config_people_outgoing Defines recipients and outgoing mail routing @@ -193,8 +211,10 @@ aliases.example Routes calendar to root +Using Lists with Postfix +------------------------ -For Postfix without LDAP (in conf/postfix/simple)... +For Postfix (in conf/postfix/simple)... main.cf.example Defines recipients and outgoing mail routing (for inclusion in @@ -208,11 +228,6 @@ virtual_alias_maps_local Defines recipients and local users - -Naturally, the above recipient identification configuration examples can be -disregarded in favour of other ways of defining mail recipients, subject to -the needs of any given environment. - LDAP Representations for Mail Recipients ---------------------------------------- @@ -244,7 +259,7 @@ mailRecipient object class is employed by resources in Kolab. Configuring Mail Systems for Mail Delivery ------------------------------------------- +========================================== The agent software assumes that delivery of mail to recipients may be performed either using local SMTP or by using LMTP to a suitable mailbox @@ -282,7 +297,7 @@ cyrus lmtp 750 /var/run/cyrus/socket Configuring Cron for Free/Busy Updates --------------------------------------- +====================================== The periods occupied by recurring events are not expanded beyond a certain window of time by imip-agent. As a consequence, free/busy collections need to @@ -299,7 +314,7 @@ crontab entry of the appropriate format is required instead. Configuring Web Servers for Free/Busy Publishing ------------------------------------------------- +================================================ Each user may request the publishing of their free/busy information by configuring certain settings. The conf/apache/imip-agent.conf file provides a @@ -315,7 +330,7 @@ network-specific access constraints. Configuring Web Servers for the Calendar Management Interface -------------------------------------------------------------- +============================================================= A calendar management interface is provided to allow users to view and interact with their calendars through the Web. The