Skip to content

Commit cdfcca3

Browse files
committed
Merge pull request #27 from jleclanche/patch-1
Update readme.md with authentication/SASL instructions
2 parents 1d5063d + f53a757 commit cdfcca3

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

readme.md

+9
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,15 @@ The following options are optional:
2424

2525
Then start the bot with `npm start`, or if you install globally run `gitter-irc-bot`.
2626

27+
### Authentication
28+
29+
To authenticate to the IRC server, you will need to supply `password` in `GITTERBOT_IRC_OPTS`.
30+
For example: `GITTERBOT_IRC_OPTS='{"password": "hunter2"}'`.
31+
32+
Using SASL is recommended if the IRC server supports it. You can enable it by supplying
33+
`"sasl": true` and the appropriate `userName`.
34+
Example: `GITTERBOT_IRC_OPTS='{"userName": "gitter-example", "password": "hunter2", "sasl": true}'`
35+
2736
## Deploy on heroku
2837

2938
When deploying to heroku you need to set `HEROKU_URL` to the url of your heroku app.

0 commit comments

Comments
 (0)