Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tree: 31596ebd54
Fetching contributors…

Cannot retrieve contributors at this time

115 lines (76 sloc) 3.67 kb

gitreceive

A tool for creating a git user that creates respositories on the fly and let's you run scripts or hit HTTP endpoints when you push code to them.

Build your own Heroku. Push code anywhere.

It's just not a post-receive hook. It's a powerful wrapper around pre-receive giving you easy access to the code that was pushed while still being able to send output back to the git user.

Requirements

You need a Linux server with git and sshd installed.

Installing

On your server, run:

$ curl https://raw.github.com/progrium/gitreceive/master/installer | bash

This will install gitreceive into /usr/local/bin. Alternatively, clone this repo and put gitreceive wherever you want.

Using gitreceive

Set up a git user on the server

This automatically makes a user and home directory if it doesn't exist.

$ gitreceive init
Created receiver script in /home/git for user 'git'.

You can change the user by setting GITUSER=somethingelse in the environment before using gitreceive.

Modify the receiver script

As an example receiver script, it will POST all the data to a RequestBin:

$ cat /home/git/receiver
#!/bin/bash
URL=http://requestb.in/rlh4znrl
echo "----> Posting to $URL ..."
curl \
  -X 'POST' \
  -F "repository=$1" \
  -F "revision=$2" \
  -F "username=$3" \
  -F "fingerprint=$4" \
  -F contents=@- \
  --silent $URL

The username is just a name associated with a public key. The fingerprint of the key is sent so you can authenticate against the public key you might have for that user.

The repo contents are streamed into STDIN as an uncompressed archive (tar file). You can extract them into a directory on the server with a line like this in your receiver script:

mkdir -p /some/path && cat | tar -x -C /some/path

Create a user by uploading a public key from your laptop

We just pipe it into the gitreceive upload-key command via SSH:

$ cat ~/.ssh/id_rsa.pub | ssh you@yourserver.com "gitreceive upload-key progrium"

The username argument is just an arbitrary name associated with the key, mostly for use in your system for auth, etc.

Add a remote to a local repository

$ git remote add demo git@yourserver.com:example.git

The repository example.git will be created on the fly when you push.

Push!!

$ git push demo master
Counting objects: 5, done.
Delta compression using up to 4 threads.
Compressing objects: 100% (3/3), done.
Writing objects: 100% (3/3), 332 bytes, done.
Total 3 (delta 1), reused 0 (delta 0)
remote: ----> Receiving progrium/gitreceive.git ... 
remote: ----> Posting to http://requestb.in/rlh4znrl ...
remote: ok
To git@gittest:progrium/gitreceive.git
   59aa541..6eafb55  master -> master

The receiver script did not attempt to silence the output of curl, so the respones of "ok" from RequestBin is shown. Use this to your advantage! You can even use chunked-transfer encoding to stream back progress in realtime if you kept using HTTP. Alternatively, you can have the receiver script run any other script on the server.

So what?

You can use gitreceive not only to trigger code, but to provide feedback to the user and affect workflow. Use gitreceive to:

  • Deploy on any arbitrary platform
  • Run your build/test system as a separate remote
  • Integrate custom systems into your workflow
  • Build your own Heroku
  • Push code anywhere

Contribute

This whole system is contained in a single bash script less than 100 lines long. Let's keep it simple, but I'm definitely open to contribution!

License

MIT

Jump to Line
Something went wrong with that request. Please try again.