1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/docs/wiki/GettingStarted Wed Oct 28 00:38:45 2015 +0100
1.3 @@ -0,0 +1,74 @@
1.4 += Getting Started =
1.5 +
1.6 +To get imip-agent running on your own system you will need the following:
1.7 +
1.8 + * The ability to install software and to configure the system
1.9 + * A working mail configuration
1.10 +
1.11 +It is possible to [[../Testing|test the agent programs]] without these
1.12 +abilities, but any difficulties in getting the software to work will be
1.13 +compounded by any problem or deficiency in either of these areas.
1.14 +
1.15 +== Configuring System Users ==
1.16 +
1.17 +The [[../SystemUsers|system users guide]] indicates the requirements for
1.18 +system user and group configuration.
1.19 +
1.20 +If you are comfortable configuring your mail system, you may decide to
1.21 +choose the [[../MailIntegration/LocalSMTP|local SMTP delivery]] approach.
1.22 +
1.23 +If you already use mail storage solutions that employ LMTP, you may decide
1.24 +to choose the [[../MailIntegration/LMTP|LMTP delivery]] approach.
1.25 +
1.26 +== Installing the Software ==
1.27 +
1.28 +Ideally, an operating system distribution package should be used to
1.29 +install the software. As a result, the software should already be suitably
1.30 +integrated and configured and guidance will be available to get everything
1.31 +working.
1.32 +
1.33 + 1. In the absence of a suitable system package, the installation locations
1.34 + and system user details must first be configured, as described above.
1.35 +
1.36 + 1. Then, the `tools/install.sh` script should install the software in
1.37 + appropriate locations. You may need to be `root` or use `sudo` to
1.38 + successfully use this script.
1.39 +
1.40 +See the [[../Prerequisites|prerequisites]] for other software that will be
1.41 +required for the software to function.
1.42 +
1.43 +== Initialising the Software ==
1.44 +
1.45 +Once a suitable system user has been chosen, stored and published data is then
1.46 +initialised using the `tools/init.sh` script. The script employs the setgid
1.47 +flag on the directories initialised for stored and published data so that new
1.48 +files and directories have the appropriate group associated with them.
1.49 +
1.50 +It should be possible to omit all arguments to the `init.sh` script, but it is
1.51 +also worth reading the help message:
1.52 +
1.53 +{{{
1.54 +tools/init.sh --help
1.55 +}}}
1.56 +
1.57 +Fixing ownership can be done using the `tools/fix.sh` script, in case some form
1.58 +of modification has altered the ownership or membership of the created files
1.59 +and directories.
1.60 +
1.61 +== Configuring Other Software ==
1.62 +
1.63 +The `conf` directory contains subdirectories for different systems:
1.64 +
1.65 +|| '''Directory''' || '''Description''' ||
1.66 +|| `apache` || Apache 2 site configuration for publishing resources ||
1.67 +|| `cron` || Cron command scheduling for free/busy updates ||
1.68 +|| `exim` || Exim 4 routing and transport configuration ||
1.69 +|| `ldap` || Some LDAP-related resources ||
1.70 +|| `postfix` || Postfix routing and transport configuration ||
1.71 +
1.72 +The configuration activities associated with these directories are covered in
1.73 +the following documents:
1.74 +
1.75 + * [[../CronIntegration|Cron Task Scheduler Integration]]
1.76 + * [[../MailIntegration|E-Mail Integration]]
1.77 + * [[../WebServerIntegration|Web Server Integration]]