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 == Configuring System Users == 13 14 The [[../SystemUsers|system users guide]] indicates the requirements for 15 system user and group configuration. 16 17 If you are comfortable configuring your mail system, you may decide to 18 choose the [[../MailIntegration/LocalSMTP|local SMTP delivery]] approach. 19 20 If you already use mail storage solutions that employ LMTP, you may decide 21 to choose the [[../MailIntegration/LMTP|LMTP delivery]] approach. 22 23 == Installing the Software == 24 25 Ideally, an operating system distribution package should be used to 26 install the software. As a result, the software should already be suitably 27 integrated and configured and guidance will be available to get everything 28 working. 29 30 1. In the absence of a suitable system package, the installation locations 31 and system user details must first be configured, as described above. 32 33 1. Then, the `tools/install.sh` script should install the software in 34 appropriate locations. You may need to be `root` or use `sudo` to 35 successfully use this script. 36 37 See the [[../Prerequisites|prerequisites]] for other software that will be 38 required for the software to function. 39 40 == Initialising the Software == 41 42 Once a suitable system user has been chosen, stored and published data is then 43 initialised using the `tools/init.sh` script. The script employs the setgid 44 flag on the directories initialised for stored and published data so that new 45 files and directories have the appropriate group associated with them. 46 47 It should be possible to omit all arguments to the `init.sh` script, but it is 48 also worth reading the help message: 49 50 {{{ 51 tools/init.sh --help 52 }}} 53 54 Fixing ownership can be done using the `tools/fix.sh` script, in case some form 55 of modification has altered the ownership or membership of the created files 56 and directories. 57 58 == Configuring Other Software == 59 60 The `conf` directory contains subdirectories for different systems: 61 62 || '''Directory''' || '''Description''' || 63 || `apache` || Apache 2 site configuration for publishing resources || 64 || `cron` || Cron command scheduling for free/busy updates || 65 || `exim` || Exim 4 routing and transport configuration || 66 || `ldap` || Some LDAP-related resources || 67 || `postfix` || Postfix routing and transport configuration || 68 69 The configuration activities associated with these directories are covered in 70 the following documents: 71 72 * [[../CronIntegration|Cron Task Scheduler Integration]] 73 * [[../MailIntegration|E-Mail Integration]] 74 * [[../WebServerIntegration|Web Server Integration]]