We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
2 parents 1d5063d + f53a757 commit cdfcca3Copy full SHA for cdfcca3
readme.md
@@ -24,6 +24,15 @@ The following options are optional:
24
25
Then start the bot with `npm start`, or if you install globally run `gitter-irc-bot`.
26
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
36
## Deploy on heroku
37
38
When deploying to heroku you need to set `HEROKU_URL` to the url of your heroku app.
0 commit comments