summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorAndreas Maunz <andreas@maunz.de>2011-05-04 17:49:49 +0200
committerAndreas Maunz <andreas@maunz.de>2011-05-04 17:49:49 +0200
commita82e9b42f518c2d0e5ac12237fd8a3cc2e5633d7 (patch)
tree8475bdac38de236f5ebde612cc9497423852c62f /README
parent75f63a15daa01f02ee8c6ed797dbb44f2f90f948 (diff)
parent49bbb98c1e402a487bc9029ee247be4f8c306a2b (diff)
Updated README
Diffstat (limited to 'README')
-rw-r--r--README12
1 files changed, 4 insertions, 8 deletions
diff --git a/README b/README
index 039b227..8d26ed8 100644
--- a/README
+++ b/README
@@ -8,25 +8,21 @@ 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 a thing)
- 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)
Even if we officially support only *one* distro (currently Debian 6.0.1), I tested the installer successfully on various Ubuntus. In the 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 open a new shell, all environment variables will be adjusted.
-
-Edit ~/.opentox/config/production.yaml and change ": server: nil" to "server" (once).
+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):
sudo nohup ~/opentox-ruby/redis-2.2.2/src/redis-server ~/opentox-ruby/redis-2.2.2/redis.conf &
sudo nohup ~/opentox-ruby/nginx/sbin/nginx -c ~/opentox-ruby/nginx/conf/nginx.conf &
-To uninstall the system simply delete the link from the startup file: Done. I guarantee that no configuration remains. To save disc space delete directory OT_PREFIX.
-
-Anyone who wants 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 ~/opentox-ui.sh (only one installation may be activated at any time).
-
+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 ~/opentox-ui.sh (only one installation may be activated at any time).
Some useful scripts to put in your ~/.bashrc in case you are using bash (assuming OT_PREFIX is '~/opentox-ruby'):