From de3d9bb5c99be57b62f48e507c41bf7e0d78dbcf Mon Sep 17 00:00:00 2001
From: James Lu <GLolol@overdrivenetworks.com>
Date: Sat, 17 Dec 2016 16:10:09 -0800
Subject: [PATCH] example-conf: add a SASL login example

---
 example-conf.yml | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/example-conf.yml b/example-conf.yml
index 0f27d21..2834918 100644
--- a/example-conf.yml
+++ b/example-conf.yml
@@ -284,12 +284,20 @@ servers:
         pylink_nick: pybot
         #pylink_ident: pybot
 
-        # SSL options. Certfile and keyfile are optional but can be used for CertFP login if
-        # supported.
+        # SSL options. Certfile and keyfile are optional, but can be used for CertFP/SASL external
+        # if supported.
         ssl: true
         #ssl_certfile: mycert.pem
         #ssl_keyfile: mycert.pem
 
+        # SASL login: for mechanisms, only EXTERNAL (SSL cert) and PLAIN (username and password)
+        # are supported so far.
+        # SASL PLAIN requires the sasl_username and sasl_password options to be set, while
+        # SASL EXTERNAL requires ssl, ssl_certfile, and ssl_keyfile to work.
+        #sasl_mechanism: "PLAIN"
+        #sasl_username: "mIRCsKripterz"
+        #sasl_password: "DownLoaditn00b!!!"
+
         # Autoconnect works like usual.
         autoconnect: 30