Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
126 lines (69 sloc) 2.744 kb
Example
-------
For [freenode](https://freenode.net/):
- Server: `chat.freenode.net`
- Room: `#CHANNELNAME`
- Message without join: _yes_
- Notice: _yes_
- Active: _yes_
Remember to allow [external messages](#message-without-join) and [colors](#no-colors) in the channel:
```
/msg ChanServ set #CHANNELNAME mlock -nc
```
Usage
-----
### Server
IRC server address.
> For freenode, use `chat.freenode.net`
### Port
Port to use when connecting to the IRC server (optional).
Default ports are `6667` (no SSL), and `6697` (SSL).
> [freenode servers](https://freenode.net/irc_servers.shtml) listen on `6665`, `6666`, `6667`, `8000`, `8001`, and `8002` (no SSL and SSL), and `6697`, `7000`, and `7070` (SSL only).
### Room
IRC channel (or channels) to which messages will be sent.
Supports single or multiple channels (comma separated). Also supports channel passwords (`CHANNELNAME::PASSWORD`). Prefixing the channel name with `#` is optional.
### Nick
Nickname to use when sending messages (optional).
### Branches
Names of the git branches to monitor for events (comma-separated).
### Nickserv password
Password for the IRC server’s [NickServ](http://en.wikipedia.org/wiki/Internet_Relay_Chat_services) (optional).
> For freenode, see the [nickname setup instructions](https://freenode.net/faq.shtml#nicksetup).
### Password
Password for the IRC server (optional).
### Ssl
Enables connecting to the IRC server via SSL.
### Message without join
Enables sending messages to the channel without joining the channel first.
_Recommended_, as it decreases channel noise. Requires the IRC channel to allow external messages.
> On freenode, allow external messages to the channel by messaging [ChanServ](https://freenode.net/services.shtml):
>
> ```
> /msg ChanServ set #CHANNELNAME mlock -n
> ```
>
> On most other IRC networks, set the channel mode directly:
>
> ```
> /mode #CHANNELNAME -n
> ```
### No colors
Disables colors in messages.
_Enabling_ colors in messages may require the IRC channel to allow colors.
> On freenode, allow colors in the channel by messaging ChanServ:
>
> ```
> /msg ChanServ set #CHANNELNAME mlock -c
> ```
### Long url
Enables including full URLs in messages. When disabled, [git.io](http://git.io/) URLs will be used.
### Notice
Enables sending IRC notices instead of regular messages.
_Recommended_, as it decreases channel noise.
Troubleshooting
---------------
Diagnostic information can be retrieved from GitHub with an HTTP request.
Use your GitHub `USERNAME` and `PASSWORD` to authenticate, and specify the appropriate repository with `REPOUSER` and `REPONAME`.
```
curl -i -u 'USERNAME:PASSWORD' https://api.github.com/repos/REPOUSER/REPONAME/hooks
```
Jump to Line
Something went wrong with that request. Please try again.