diff options
| author |  jesopo | 2019-12-10 05:27:35 +0000 |
|---|---|---|
| committer | jesopo | 2019-12-10 05:27:35 +0000 |
| commit | 638eee0d685c06d258cb55287204ca97bca7c344 (patch) | |
| tree | 33442439317ae2846f1efb7674b7a3758c8990a1 /modules/ircv3_sasl/README.md | |
| parent | move sys.exit() codes to an enum in utils.consts (diff) | |
move core modules to src/core_modules, make them uneffected by white/black list
Diffstat (limited to 'modules/ircv3_sasl/README.md')
| -rw-r--r-- | modules/ircv3_sasl/README.md | 46 |
1 files changed, 0 insertions, 46 deletions
diff --git a/modules/ircv3_sasl/README.md b/modules/ircv3_sasl/README.md deleted file mode 100644 index 30a51e08..00000000 --- a/modules/ircv3_sasl/README.md +++ /dev/null @@ -1,46 +0,0 @@ -# Configuring SASL - -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> - -#### 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`) - -#### USERPASS -> INSERT INTO server_settings (<serverid>, 'sasl', '{"mechanism": "userpass", "args": "<username>:<password>"}'); - -#### 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"}'); |