summaryrefslogtreecommitdiff
path: root/README
blob: e12583e265d07b0b96ac1b172bb20b94bc062743 (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
26
POSIX compatible Installer for OpenTox IST/ALU Services
=======================================================

Author: Andreas Maunz
This is a POSIX-compliant (not limited to a particular shell) OpenTox required packages installer for Debian. It also prepares the base directory (referred to as OT_PREFIX) for OpenTox REST services and provides libraries for the installation and shell integration of those services. 
Please report bugs via GitHub at http://github.com/opentox/install.

Here are some of my goals when writing the installer:
- Safe (existence of all binaries will be checked before running, apart from GNU Core Utils)
- Idempotent (multiple execution incurs no changes to the system)
- Atomic (return value of non-elementary actions asserted to be TRUE)
- Encapsulated (everything installed in OT_PREFIX; applies to services)
- Logged (all non-elementary actions are logged)

Requirements:
A) Debian or compatible (tested on Debian 6.0.5).
B) Users may gain root privileges using 'sudo'.

Usage:
Configure the installer in config.sh, then run 'install'. Then configure your system by adding a line to the startup file of your favorite shell (e.g. BASH with the file '~/.bashrc') to read in '~/.opentox/opentox-ui.sh' (e.g. with 'source ~/.opentox/opentox-ui.sh'), so any newly started shell will be completely configured. To uninstall, simply remove the line from the startup file. To save disc space also remove directory OT_PREFIX. To remove also your configuration, remove $HOME/.opentox.

Detailed installation instructions for developers can be found here: 
http://opentox.github.com/development/2012/08/09/install-opentox-development-environment/

You can run multiple Opentox versions on the same machine: Just install again as a different user.