LP1940146: Update documentation
authorJason Boyer <JBoyer@equinoxOLI.org>
Tue, 17 Aug 2021 18:00:20 +0000 (14:00 -0400)
committerChris Sharp <csharp@georgialibraries.org>
Fri, 24 Sep 2021 18:11:39 +0000 (14:11 -0400)
Signed-off-by: Jason Boyer <JBoyer@equinoxOLI.org>
Signed-off-by: Jason Stephenson <jason@sigio.com>
Signed-off-by: Chris Sharp <csharp@georgialibraries.org>
README

diff --git a/README b/README
index ffd6aef..456d519 100644 (file)
--- a/README
+++ b/README
@@ -64,9 +64,9 @@ make -f src/extras/Makefile.install <osname>
 
 Well-tested values for <osname> include:
 
+  * `debian-bullseye` for Debian 11
   * `debian-buster` for Debian 10
   * `debian-stretch` for Debian 9
-  * `debian-jessie` for Debian 8
   * `ubuntu-bionic` for Ubuntu 18.04
   * `ubuntu-focal` for Ubuntu 20.04
 
@@ -205,7 +205,7 @@ work for OpenSRF.
 1. Stop ejabberd before making any changes to its configuration by issuing the
    following command as the *root* Linux account:
 +
-.(Debian / Ubuntu Bionic / Ubuntu Focal) Stopping ejabberd
+.Stopping ejabberd
 [source, bash]
 ---------------------------------------------------------------------------
 systemctl stop ejabberd.service
@@ -213,7 +213,7 @@ systemctl stop ejabberd.service
 +
 2. Edit the ejabberd config file.
 +
-(Debian Jessie) Ejabberd 13.x and 14.x::
+(Debian Stretch) Ejabberd 16.x::
 Open `/etc/ejabberd/ejabberd.yml` and make the following
 changes:
   a. Define your public and private domains in the `hosts` directive. For
@@ -227,16 +227,17 @@ hosts:
   - "public.localhost"
 ---------------------------------------------------------------------------
 +
-  b. Change `shaper:` `normal` and `fast` values to 500000
-  c. Increase the `max_user_sessions:` `all:` value to 10000
-  d. Comment out the `mod_offline` directive
+  b. Change `auth_password_format` to plain
+  c. Change `shaper:` `normal` and `fast` values to 500000
+  d. Increase the `max_user_sessions:` `all:` value to 10000
+  e. Comment out the `mod_offline` directive
 +
 -----------------------
 ##mod_offline:
     ##access_max_user_messages: max_user_offline_messages
 -----------------------
 +
-(Debian Stretch) Ejabberd 16.x::
+(Debian Buster / Ubuntu Bionic / Ubuntu Focal) Ejabberd 18.x::
 Open `/etc/ejabberd/ejabberd.yml` and make the following
 changes:
   a. Define your public and private domains in the `hosts` directive. For
@@ -250,17 +251,24 @@ hosts:
   - "public.localhost"
 ---------------------------------------------------------------------------
 +
-  b. Change `auth_password_format` to plain
-  c. Change `shaper:` `normal` and `fast` values to 500000
-  d. Increase the `max_user_sessions:` `all:` value to 10000
-  e. Comment out the `mod_offline` directive
+  b. Change `starttls_required` to false
+  c. Change `auth_password_format` to plain
+  d. Change `shaper:` `normal` and `fast` values to 500000
+  e. Increase the `max_user_sessions:` `all:` value to 10000
+  f. Comment out the `mod_offline` directive
 +
 -----------------------
 ##mod_offline:
     ##access_max_user_messages: max_user_offline_messages
 -----------------------
 +
-(Debian Buster / Ubuntu Bionic / Ubuntu Focal) Ejabberd 18.x::
+  g. Uncomment or add the `mod_legacy_auth` directive under the `modules:` section
++
+-----------------------
+mod_legacy_auth: {}
+-----------------------
++
+(Debian Bullseye) Ejabberd 21.x::
 Open `/etc/ejabberd/ejabberd.yml` and make the following
 changes:
   a. Define your public and private domains in the `hosts` directive. For
@@ -269,23 +277,31 @@ changes:
 [source, bash]
 ---------------------------------------------------------------------------
 hosts:
-  - "localhost"
-  - "private.localhost"
-  - "public.localhost"
+  - localhost
+  - private.localhost
+  - public.localhost
 ---------------------------------------------------------------------------
 +
   b. Change `starttls_required` to false
   c. Change `auth_password_format` to plain
-  d. Change `shaper:` `normal` and `fast` values to 500000
+  d. Change all `shaper:` `normal` and `fast` values to 500000
   e. Increase the `max_user_sessions:` `all:` value to 10000
-  f. Comment out the `mod_offline` directive
+  f. Comment out the `max_user_offline_messages:` values
++
+-----------------------
+##max_user_offline_messages:
+  ##5000: admin
+  ##100: all
+-----------------------
++
+  g. Comment out the `mod_offline` directive
 +
 -----------------------
 ##mod_offline:
     ##access_max_user_messages: max_user_offline_messages
 -----------------------
 +
-  g. Uncomment or add the `mod_legacy_auth` directive under the `modules:` section
+  h. Add the `mod_legacy_auth` directive under the `modules:` section
 +
 -----------------------
 mod_legacy_auth: {}
@@ -293,7 +309,7 @@ mod_legacy_auth: {}
 +
 3. Restart the ejabberd server to make the changes take effect:
 +
-.(Debian / Ubuntu Bionic / Ubuntu Focal) Starting ejabberd
+.Starting ejabberd
 [source, bash]
 ---------------------------------------------------------------------------
 systemctl start ejabberd.service