1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/README.txt Fri Oct 31 00:33:39 2014 +0100
1.3 @@ -0,0 +1,63 @@
1.4 +imip-agent
1.5 +==========
1.6 +
1.7 +This software implements an agent that can interpret e-mail messages
1.8 +containing calendar information, maintain availability records for scheduling
1.9 +participants, act on behalf of resources and other entities that need to
1.10 +participate in scheduling, and support user interfaces for end-users whose
1.11 +e-mail programs do not understand calendar data.
1.12 +
1.13 +Getting Started
1.14 +===============
1.15 +
1.16 +Eventually, this information should be incorporated into packages for various
1.17 +operating system distributions, and these instructions should be largely
1.18 +superfluous for most users.
1.19 +
1.20 +System User and Filesystem Access
1.21 +---------------------------------
1.22 +
1.23 +A system user needs to be created and to belong to certain groups in order to
1.24 +deliver messages to mail stores and to publish resources on the Web:
1.25 +
1.26 + useradd -d /var/lib/imip-agent -m -U -G lmtp,www-data -r imip-agent
1.27 +
1.28 +If the lmtp group does not exist, it should be created and be employed for
1.29 +LMTP delivery to systems like Cyrus and Dovecot.
1.30 +
1.31 +Store details and published resources need to be accessible by the imip-agent
1.32 +and www-data users:
1.33 +
1.34 + mkdir /var/lib/imip-agent/store /var/www/imip-agent/static
1.35 + chown imip-agent /var/lib/imip-agent/store /var/www/imip-agent/static
1.36 + chgrp www-data /var/lib/imip-agent/store /var/www/imip-agent/static
1.37 + chmod g+s /var/lib/imip-agent/store /var/www/imip-agent/static
1.38 +
1.39 +Here, the setgid flag should ensure that new files and directories have the
1.40 +appropriate group associated with them.
1.41 +
1.42 +Fixing ownership can be done as follows:
1.43 +
1.44 + chown -R imip-agent /var/lib/imip-agent
1.45 + chgrp -R imip-agent /var/lib/imip-agent
1.46 + chown -R imip-agent /var/lib/imip-agent/store /var/www/imip-agent/static
1.47 + chgrp -R www-data /var/lib/imip-agent/store /var/www/imip-agent/static
1.48 + chmod -R g+w /var/lib/imip-agent/store /var/www/imip-agent/static
1.49 +
1.50 +Installing the Software
1.51 +-----------------------
1.52 +
1.53 +The tools/install.sh script should install the software in appropriate
1.54 +locations.
1.55 +
1.56 +Configuring Other Software
1.57 +--------------------------
1.58 +
1.59 +The conf directory contains subdirectories for different systems:
1.60 +
1.61 + apache Apache 2 site configuration for publishing resources
1.62 + exim Exim 4 routing and transport configuration
1.63 + postfix Postfix routing and transport configuration
1.64 +
1.65 +Either Exim or Postfix can be chosen as a mail system supporting the agent.
1.66 +Both of these currently make use of LDAP to access user information.