aboutsummaryrefslogtreecommitdiff
path: root/modules
diff options
context:
space:
mode:
authorGravatar jesopo2019-02-14 12:28:36 +0000
committerGravatar jesopo2019-02-14 12:28:36 +0000
commitec3096fb50957e4e248c8b0e307f3770bbcbc9bd (patch)
tree8de1712f379ce10f7f63ac6ff701b4c97d53cab2 /modules
parentSupport a `USERPASS` sasl mechanism that picks the best user:pass mech (sasl) (diff)
signature
Put information about `USERPASS` in sasl/README.md
Diffstat (limited to 'modules')
-rw-r--r--modules/sasl/README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/modules/sasl/README.md b/modules/sasl/README.md
index 895bd81d..30a51e08 100644
--- a/modules/sasl/README.md
+++ b/modules/sasl/README.md
@@ -2,10 +2,18 @@
You can either configure SASL through `!serverset sasl` from an registered and identified admin account or directly through sqlite.
+## USERPASS Mechanism
+
+BitBot supports a special SASL mechanism name: `USERPASS`. This internally
+represents "pick the strongest username:password algorithm"
+
## !serverset sasl
These commands are to be executed from a registered admin account
+#### USERPASS
+> !serverset sasl userpass <username>:<password>
+
#### PLAIN
> !serverset sasl plain <username>:<password>
@@ -22,6 +30,9 @@ These commands are to be executed from a registered admin account
Execute these against the current bot database file (e.g. `$ sqlite3 databases/bot.db`)
+#### USERPASS
+> INSERT INTO server_settings (<serverid>, 'sasl', '{"mechanism": "userpass", "args": "<username>:<password>"}');
+
#### PLAIN
> INSERT INTO server_settings (<serverid>, 'sasl', '{"mechanism": "plain", "args": "<username>:<password>"}');