imip-agent

README.txt

102:7960e22f96a7
2014-10-31 Paul Boddie Added some documentation and a simple installation script.
     1 imip-agent
     2 ==========
     3 
     4 This software implements an agent that can interpret e-mail messages
     5 containing calendar information, maintain availability records for scheduling
     6 participants, act on behalf of resources and other entities that need to
     7 participate in scheduling, and support user interfaces for end-users whose
     8 e-mail programs do not understand calendar data.
     9 
    10 Getting Started
    11 ===============
    12 
    13 Eventually, this information should be incorporated into packages for various
    14 operating system distributions, and these instructions should be largely
    15 superfluous for most users.
    16 
    17 System User and Filesystem Access
    18 ---------------------------------
    19 
    20 A system user needs to be created and to belong to certain groups in order to
    21 deliver messages to mail stores and to publish resources on the Web:
    22 
    23   useradd -d /var/lib/imip-agent -m -U -G lmtp,www-data -r imip-agent
    24 
    25 If the lmtp group does not exist, it should be created and be employed for
    26 LMTP delivery to systems like Cyrus and Dovecot.
    27 
    28 Store details and published resources need to be accessible by the imip-agent
    29 and www-data users:
    30 
    31   mkdir /var/lib/imip-agent/store /var/www/imip-agent/static
    32   chown imip-agent /var/lib/imip-agent/store /var/www/imip-agent/static
    33   chgrp www-data /var/lib/imip-agent/store /var/www/imip-agent/static
    34   chmod g+s /var/lib/imip-agent/store /var/www/imip-agent/static
    35 
    36 Here, the setgid flag should ensure that new files and directories have the
    37 appropriate group associated with them.
    38 
    39 Fixing ownership can be done as follows:
    40 
    41   chown -R imip-agent /var/lib/imip-agent
    42   chgrp -R imip-agent /var/lib/imip-agent
    43   chown -R imip-agent /var/lib/imip-agent/store /var/www/imip-agent/static
    44   chgrp -R www-data /var/lib/imip-agent/store /var/www/imip-agent/static
    45   chmod -R g+w /var/lib/imip-agent/store /var/www/imip-agent/static
    46 
    47 Installing the Software
    48 -----------------------
    49 
    50 The tools/install.sh script should install the software in appropriate
    51 locations.
    52 
    53 Configuring Other Software
    54 --------------------------
    55 
    56 The conf directory contains subdirectories for different systems:
    57 
    58   apache        Apache 2 site configuration for publishing resources
    59   exim          Exim 4 routing and transport configuration
    60   postfix       Postfix routing and transport configuration
    61 
    62 Either Exim or Postfix can be chosen as a mail system supporting the agent.
    63 Both of these currently make use of LDAP to access user information.