Bring supported distros up to date, warn about Java support
authordbs <dbs@9efc2488-bf62-4759-914b-345cdb29e865>
Mon, 23 Aug 2010 13:20:19 +0000 (13:20 +0000)
committerdbs <dbs@9efc2488-bf62-4759-914b-345cdb29e865>
Mon, 23 Aug 2010 13:20:19 +0000 (13:20 +0000)
git-svn-id: svn://svn.open-ils.org/OpenSRF/branches/rel_1_6@2012 9efc2488-bf62-4759-914b-345cdb29e865

README

diff --git a/README b/README
index 71a7375..2c619d7 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
-README for OpenSRF
+README for OpenSRF 1.6
 
 Installing prerequisites:
 ========================
@@ -16,14 +16,15 @@ aptitude install make
 make -f src/extras/Makefile.install <osname>
 
 Well-tested values for <osname> include:
-  * "debian-etch" for Debian 4.0
   * "debian-lenny" for Debian 5.0
+  * "debian-squeeze" for Debian 6.0
+  * "fedora13" for Fedora 13
   * "ubuntu-hardy" for Ubuntu 8.04
   * "ubuntu-karmic" for Ubuntu 9.10
 
 Less-tested values for <osname> include:
-  * "centos" for CentOS 5 and Red Hat Enterprise Linux 5
-  * "gentoo" for Gentoo
+  * "centos" for CentOS 5
+  * "rhel" for Red Hat Enterprise Linux 5
 
 Patches and suggestions for improvement from users of these distributions,
 or others, are welcome!
@@ -54,7 +55,10 @@ make
 
 By default, OpenSRF includes C, Perl, and JavaScript support.
 You can add the "--enable-python" option to the configure command
-to build Python support, and "--enable-java" for Java support.
+to build Python support.
+
+The "--enable-java" option offers Java support that is not currently
+maintained and which might break your install.
 
 Installation instructions:
 =========================
@@ -119,7 +123,7 @@ have to make a few changes to the default ejabberd.cfg file to make ejabberd
 work for OpenSRF. 
 
 1. Stop ejabberd before making any changes to its configuration by issuing the
-following command as root:
+following command on most Linux systems as root:
 
 # /etc/init.d/ejabberd stop
 
@@ -132,11 +136,12 @@ a. Define your public and private domains in the "hosts" directive. For
 {hosts, ["private.localhost", "public.localhost"]}
 
 b. Comment out the "mod_offline" directive
-c. Increase the "max_user_sessions" value to 1000
-d. Change all "max_stanza_size" values to 200000
+c. Increase the "max_user_sessions" value to 10000
+d. Change all "max_stanza_size" values to 2000000
 e. Change all "maxrate" values to 500000 
 
-3. Restart the ejabberd server to make the changes take effect:
+3. Restart the ejabberd server to make the changes take effect. On most
+Linux systems, you can issue the following command:
 
 # /etc/init.d/ejabberd start