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