imip-agent

Annotated README.txt

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