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

Add SASL README.md

Browse source
This commit is contained in:
jesopo 2019-02-07 13:51:08 +00:00
parent 76fd67235a
commit 35ad1c7c7b
1 changed files with 35 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
modules/sasl/README.md Normal file
View file

@ -0,0 +1,35 @@
# Configuring SASL
You can either configure SASL through `!serverset sasl` from an registered and identified admin account or directly through sqlite.
## !serverset sasl
These commands are to be executed from a registered admin account
#### PLAIN
> !serverset sasl plain <username>:<password>
#### SCRAM-SHA-1
> !serverset sasl scram-sha-1 <username>:<password>
#### SCRAM-SHA-256
> !serverset sasl scram-sha-256 <username>:<password>
#### EXTERNAL
> !serverset sasl external
## sqlite
Execute these against the current bot database file (e.g. `$ sqlite3 databases/bot.db`)
#### PLAIN
> INSERT INTO server_settings (<serverid>, 'sasl', '{"mechanism": "plain", "args": "<username>:<password>"}');
#### SCRAM-SHA-1
> INSERT INTO server_settings (<serverid>, 'sasl', '{"mechanism": "scram-sha-1", "args": "<username>:<password>"}');
#### SCRAM-SHA-256
> INSERT INTO server_settings (<serverid>, 'sasl', '{"mechanism": "scram-sha-256", "args": "<username>:<password>"}');
#### external
> INSERT INTO server_settings (<serverid>, 'sasl', '{"mechanism": "external"}');