1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
= Getting Started =
To get imip-agent running on your own system you will need the following:
* The ability to install software and to configure the system
* A working mail configuration
It is possible to [[../Testing|test the agent programs]] without these
abilities, but any difficulties in getting the software to work will be
compounded by any problem or deficiency in either of these areas.
<<TableOfContents(2,2)>>
== Obtaining the Software ==
To get started, the imip-agent software must be [[../Downloads|downloaded]]
and any [[../Prerequisites|prerequisites]] installed, the latter being
software that imip-agent needs to work with. The choice of prerequisites
will influence some of the activities described below.
== Configuring System Users ==
The [[../SystemUsers|system users guide]] indicates the requirements for
system user and group configuration.
If you are comfortable configuring your mail system, you may decide to
choose the [[../MailIntegration/LocalSMTP|local SMTP delivery]] approach.
If you already use mail storage solutions that employ LMTP, you may decide
to choose the [[../MailIntegration/LMTP|LMTP delivery]] approach.
Once you have decided which approach is the most preferable, you will be
able to use this choice to influence the configuration process mentioned
below.
== Installing the Software ==
Ideally, an operating system distribution package should be used to
install the software. As a result, the software should already be suitably
integrated and configured and guidance will be available to get everything
working.
1. In the absence of a suitable system package, the installation locations
and system user details must first be configured, as described above.
1. Then, the `tools/install.sh` script should install the software in
appropriate locations. You may need to be `root` or use `sudo` to
successfully use this script.
{{{
tools/install.sh
}}}
See the [[../Prerequisites|prerequisites]] for other software that will be
required for the software to function.
== Initialising the Software ==
Once a suitable system user has been chosen, stored and published data is then
initialised using the `tools/init.sh` script. The script employs the setgid
flag on the directories initialised for stored and published data so that new
files and directories have the appropriate group associated with them.
It should be possible to omit all arguments to the `init.sh` script, but it is
also worth reading the help message:
{{{
tools/init.sh --help
}}}
Fixing ownership can be done using the `tools/fix.sh` script, as described in
the [[../Administration|administration guide]] in case some form of modification
has altered the ownership or membership of the created files and directories.
== Integrating with Other Software ==
The `conf` directory in the imip-agent source code distribution contains
subdirectories for different systems:
{{{#!table
'''Directory''' || '''Description''' || '''Guide'''
==
`apache`
|| Apache 2 site configuration for publishing resources
|| [[../WebServerIntegration|Web Server Integration]]
==
`cron`
|| Cron command scheduling for free/busy updates
|| [[../CronIntegration|Cron Task Scheduler Integration]]
==
`exim`
|| Exim 4 routing and transport configuration
|| [[../MailIntegration|E-Mail Integration]] and
.. [[../MailboxIntegration|Mailbox Integration]]
==
`ldap`
|| Some LDAP-related resources
||
==
`postfix`
|| Postfix routing and transport configuration
|| [[../MailIntegration|E-Mail Integration]] and
.. [[../MailboxIntegration|Mailbox Integration]]
==
`postgresql`
|| PostgreSQL configuration
|| [[../DatabaseStore|Database Store]]
}}}
In addition, a `tools` directory provides a configuration helper tool
that can be used to quickly customise the above resources and produce
files that, after review, may be deployed.
{{{
conf/tools/configure.sh --help
}}}
Use of this tool is covered in the [[../Configuration|configuration guide]].
== Configuring the Software ==
The behaviour of the imip-agent software itself can be configured using
mechanisms described in the [[../Configuration|configuration guide]].
== Administering the Software ==
With the basic configuration performed, all that remains is to perform
any necessary [[../Administration|administration tasks]] to set the
software up for certain kinds of users or participants.
== Using the Software ==
With configuration and administration performed, it should be possible
to get started using the software. See the [[../Usage|usage guide]]
for details.
|
