diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 31 |
1 files changed, 13 insertions, 18 deletions
@@ -2,27 +2,22 @@ POSIX compatible Installer for OpenTox IST/ALU Services ======================================================= Author: Andreas Maunz -This is a POSIX-compliant (not limited to a particular shell) Opentox installer. Please report bugs via GitHub. - -Requirements: -A) Debian or compatible (only 'base-install.sh') -B) Your system is configured for 'sudo'. +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 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) - -Usage: -Configure your system in config.sh. Then run 'install' +- 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) -Even if officially only *one* distro (currently Debian 6.0.1) is supported, I tested the installer successfully on various Ubuntus. Find the requirements at the top of this file. 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. +Requirements: +A) Debian or compatible (tested on Ubuntu 11.10). +B) Users may gain root privileges using 'sudo'. -To uninstall the system simply delete the link from the startup file: Done. To save disc space delete also directory OT_PREFIX. +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. -You can run multiple Opentox versions on the same machine: Just install again, but to a different OT_PREFIX. The switch: Include the opentox-ui.sh files from the desired OT_PREFIX (only one installation may be activated at a time). +You can run multiple Opentox versions on the same machine: Just install again as a different user. |