Skip to content
This repository has been archived by the owner on Jan 29, 2022. It is now read-only.

Commit

Permalink
Merge pull request #27 from jleclanche/patch-1
Browse files Browse the repository at this point in the history
Update readme.md with authentication/SASL instructions
  • Loading branch information
finnp committed Mar 29, 2016
2 parents 1d5063d + f53a757 commit cdfcca3
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,15 @@ The following options are optional:

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

### Authentication

To authenticate to the IRC server, you will need to supply `password` in `GITTERBOT_IRC_OPTS`.
For example: `GITTERBOT_IRC_OPTS='{"password": "hunter2"}'`.

Using SASL is recommended if the IRC server supports it. You can enable it by supplying
`"sasl": true` and the appropriate `userName`.
Example: `GITTERBOT_IRC_OPTS='{"userName": "gitter-example", "password": "hunter2", "sasl": true}'`

## Deploy on heroku

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

0 comments on commit cdfcca3

Please sign in to comment.