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