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