summaryrefslogtreecommitdiff
path: root/README
blob: 15f4e936f3477092ca37854797e9eb052eea8773 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
POSIX compatible Installer for OpenTox IST/ALU Services
=======================================================

A) It is assumed that your system is configured for sudo to gain root privileges.
B) It is assumed that your system is configured for using non-free packages.

This is a POSIX-compliant  (not limited to a particular shell) Opentox installer. Please report bugs always via GitHub.

Here are some of my goals when writing the installer:
- Safe (existence of all the binaries will be checked before running, apart from GNU Core Utils)
- Idempotent (multiple execution does not change anything)
- Atomic (return value of each non-elemtary action is asserted to be TRUE)
- Encapsulated (everything is installed in a sub-directory in $HOME)
- Logged (all non-elemtary actions are logged)

Configure your system in config.sh.

Even if we officially support only *one* distro (currently Debian 6.0.1), I tested the installer successfully on various Ubuntus. In this README at the top are the requirements of the installer. By default, everything is installed to $HOME/opentox-ruby (OT_PREFIX).

After running the installer, configure the system by editing the startup file of your favorite shell (in my case, BASH with the file ~/.bashrc) to include ~/OT_PREFIX/.opentox-ui.sh (in my case with 'source ...'). OT_PREFIX is the only directory the installer creates. Thus, the system is fully configured: If you now open a new shell, all environment variables will be adjusted.

To uninstall the system simply delete the link from the startup file: Done. To save disc space delete also directory OT_PREFIX.

Anyone can run multiple Opentox versions on the same machine: Just install again, but to a different OT_PREFIX. The switch works manually: Include the opentox-ui.sh files from the desired OT_PREFIX (only one installation may be activated at a time).