Sign inSign up

mitcdh/gitlab-irc

By mitcdh

Updated about 9 years ago

IRC bot for gitlab notifications, fork of chkelly/gitlab-irc.

Image
0

453

mitcdh/gitlab-irc repository overview

gitlab-irc

Summary

A lightweight gitlab irc bot that announces gitlab project notifications via webhooks.

Supports

  • Connecting to an IRC server over SSL
  • Authing with Nickserv
  • Support for announcing Commits, Merge Requests, Tags, and Issues.

Requirements

  • Tested on Ruby 2.3.0
  • Tested with Gitlab CE 8.5

Configuration

The following parameters can be set either in the config.yml file or via environment variables.

OptionExample ValueDescriptionRequired?Default
IRC_HOSTirc.freenode.comIRC Server HostnameYes
IRC_PORT6667IRC Server Port6667
IRC_PASSWORDsample_passwordServer Password
SSLtrueif true, allows connection to irc server over sslfalse
IRC_CHANNELS['#dev','#all']Array of channels to joinYes['#gitlab-irc']
IRC_NICKGitLabBot NameGitLab
IRC_REALNAMEGitLabBotReal NameGitLabBot
IRC_USER_NAMEgitlab-ircUsername for authing with nickserv
IRC_USER_PASSWORDuser_passwordPassword for authing with nickserv
GITLAB_TOKENsample_tokenSecret X-Gitlab-Token header used to authenticate requests
DEBUGtruefalse

Installation

Docker

Start the gitlab-irc server with at least IRC_HOST and IRC_CHANNELS environment variables set:

docker run -e IRC_HOST=irc.freenode.com -e "IRC_CHANNELS=['#gitlab-irc']" -e IRC_NICK=gitlab-9875 -d -p 5000:5000 --restart=always --name gitlab-irc chkelly/gitlab-irc:v1.0.5
Configure Projects within Gitlab

Within Gitlab CE, select a project, then go to Settings -> Hooks, and enter in the below. Check all the boxes. Adjust the below host and port to point to the ip:port that the gitlab-irc service is running on.

http://localhost:5000

Tag summary

Content type

Image

Digest

Size

279.9 MB

Last updated

about 9 years ago

docker pull mitcdh/gitlab-irc