summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Maunz <andreas@maunz.de>2012-03-22 16:11:05 +0100
committerAndreas Maunz <andreas@maunz.de>2012-03-22 16:11:05 +0100
commit1eb0a84cbbec91521ec16d7b2bef3b4c15e89b0c (patch)
tree4eb8166b8319ad92dc6523ec31922451e95d6f1b
parent49965514b0975ae515df9cc0e4a2020e9af88911 (diff)
Updated README
-rw-r--r--README13
1 files changed, 4 insertions, 9 deletions
diff --git a/README b/README
index 7828109..e356b2a 100644
--- a/README
+++ b/README
@@ -8,23 +8,18 @@ This is a POSIX-compliant (not limited to a particular shell) Opentox installer
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 a thing)
+- 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. NOTE for variable NGINX_PORT: leave this empty or set to ":80" to use port 80. If you do this, use the ot-scripts in "ot-tools-root.sh". Otherwise, if NGINX_PORT >1024, use ot-scripts in "ot-tools-user.sh".
+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). The configs go to OT_PREFIX/.sh_<Package>_ot.sh for each package.
-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 ~/.opentox-ui.sh (in my case with 'source ...'). This file is the only one that the installer creates outside OT_PREFIX. Thus, the system is fully configured: If you now open a new shell, all environment variables will be adjusted.
+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 ~/.opentox-ui.sh (in my case with 'source ...'). This file is the only one that the installer creates outside OT_PREFIX. Thus, the system is fully configured: If you now open a new shell, all environment variables will be adjusted.
-To start the system I run the following (but that is not part of the installer):
-nohup $HOME/opentox-ruby/redis-2.2.2/src/redis-server $HOME/opentox-ruby/redis-2.2.2/redis.conf &
-nohup $HOME/opentox-ruby/nginx/sbin/nginx -c $HOME/opentox-ruby/nginx/conf/nginx.conf &
+To uninstall the system simply delete the link from the startup file: Done. To save disc space delete also directory OT_PREFIX and possibly the configuration in .opentox.
-To uninstall the system simply delete the link from the startup file: Done. To save disc space delete 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 sh_<Package>_ot.sh files from the desired OT_PREFIX in $HOME/opentox-ui.sh (only one installation may be activated at any time).
-