Firepup650/bitbot-3.11-fork
2
0
Fork 0
Code Issues Pull requests Activity Actions

Put information about USERPASS in sasl/README.md

Browse source
This commit is contained in:
jesopo 2019-02-14 12:28:36 +00:00
parent d0ad43b027
commit ec3096fb50
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
modules/sasl/README.md
View file

@ -2,10 +2,18 @@
You can either configure SASL through `!serverset sasl` from an registered and identified admin account or directly through sqlite. 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 ## !serverset sasl
These commands are to be executed from a registered admin account These commands are to be executed from a registered admin account
#### USERPASS
> !serverset sasl userpass <username>:<password>
#### PLAIN #### PLAIN
> !serverset sasl plain <username>:<password> > !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`) 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 #### PLAIN
> INSERT INTO server_settings (<serverid>, 'sasl', '{"mechanism": "plain", "args": "<username>:<password>"}'); > INSERT INTO server_settings (<serverid>, 'sasl', '{"mechanism": "plain", "args": "<username>:<password>"}');