- git (>= 1.7.12)
- Ruby (>= v1.9)
gem install sinatra
- git-notifier (master branch required)
cp gitdub /path/to/dir/in/$PATH
cp config.yml.example config.yml
Integration with github
- Navigate to a repository you own, e.g.,
- Click on Settings in the right sidebar
- Click on Webhooks & Services in the left sidebar
- Click on Add Webhook
- Enter the URL to reach gitdub, e.g.,
- Set the content type to
- Select the radio button Just the
- Click on the green Add Webhook button
The YAML configuration file contains the list of
repositories that gitdub tracks. The first section (
gitdub:) specifies global
options, such as the interfaces gitdub should bind to and ports to listen on.
Moreover, you can control the behavior of the first chunk of data. When setting
silent_init: to true, gitdub will only fast-forward to the current commit and
begin mailing diffs after the next push (or after hitting the Test Hook
button). Otherwise gitdub sends exactly one email per commit since the first
commit in the repository.
The second section (
notifier:) describes the behavior of git-notifier. Here you
can the configure a global sender of the emails (
from:), the receivers
to:), and the prefix of the email subject (
The third section (
github:) contains a list of github repository entries,
where each entry must at least contain an
id field. If an item does not
contain any further options, the globals from the
notifier section apply.
However, in most cases it makes sense to override the globals with
repository-specific information, e.g.:
notifier: # The email sender. (Can be overriden for each repository.) from: 'Sam Sender <email@example.com>' # The email subject prefix. (Can be overriden for each repository.) subject: '[git]' github: - id: mavam/gitdub subject: '[git/gitdub]' # Overrides global '[git]' subject prefix. from: firstname.lastname@example.org # Overrides global sender. to: [email@example.com] # Overrides global receivers. - id: mavam/.* from: mavam # Overrides global sender.
Note the regular expression in the second entry. This enables the configuration
of entire sets of repositories. Since gitdub processes the list sequentially in
order of definition, only settings from the first match apply. For example,
appending an entry for
mavam/foo would never match.
To prevent unauthorized access to the service, you can restrict the set of allowed source IP addresses to github addresses, e.g., via iptables:
iptables -A INPUT -m state --state NEW -m tcp -p tcp \ -s 188.8.131.52/22,184.108.40.206/22,220.127.116.11/20 --dport 42042 -j ACCEPT
If that's not an option on your machine, you can also perform application-layer filtering in gitdub by setting the following configuration option:
allowed_sources: [18.104.22.168/22, 22.214.171.124/22, 126.96.36.199/20]
For an up-to-date listing of the github ip ranges, check the hooks section under https://api.github.com/meta.
Installation as a service on Linux
Once you have gitdub working, you probably will want to make it into a service, so that it'll automatically start on reboot.
You can either write your own script or you can use a pre-made script from this repository. You just need to make a few minor tweaks to make it workable. Here is the instructions page with general details for this repository.
If you are on a Ubuntu or a similar system that supports the
rc.d system you
can use debian rc.d
wget https://raw.github.com/frdmn/service-daemons/master/debian -O /etc/init.d/gitdub
/etc/init.d/gitdub and change the example settings to:
# The following assumes gitdub is setup under /var/gitdub/ NAME="gitdub" PATH="/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin:/var/gitdub" APPDIR="/var/gitdub" APPBIN="/var/gitdub/gitdub" APPARGS="config.yml" USER="nobody" GROUP="nobody"
Depending on the user/group you are going to run it under, you may have to
GROUP settings as well.
Make sure the script is executable:
chmod +x /etc/init.d/gitdub
Enable the daemon with:
update-rc.d gitdub defaults
Start the service with:
service gitdub start
Stop the service with:
service gitdub stop
If your system doesn't support the
rc.d approach, check the
service-daemons repository for
Gitdub comes with a BSD license, please see COPYING for details.