https://github.com/prettymuchbryce/receiver

A simple and configurable deployment tool for github projects.
https://github.com/prettymuchbryce/receiver

Last synced: over 1 year ago
JSON representation

A simple and configurable deployment tool for github projects.

• Host: GitHub
• URL: https://github.com/prettymuchbryce/receiver
• Owner: prettymuchbryce
• Created: 2013-07-26T01:16:14.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2015-04-29T05:05:58.000Z (about 11 years ago)
• Last Synced: 2025-03-17T16:55:46.874Z (over 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 227 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
> A simple and configurable deployment tool for github projects.

![](http://i.imgur.com/3D1ou4b.jpg)

# Receiver

##What is it ?

Receiver is a simple application that runs continuously on your server. It responds to github post-receive hooks of your project(s). Receiver responds by pulling your project(s), and running shell commands of your choice afterwards. See config.json to get an idea of a simple configuration.

##Is this for me ?

- You are using github to store your code

- You have a server somewhere that hosts your project

- You would like to push to github to deploy code to your server

##Instructions using [forever](https://github.com/nodejitsu/forever)

1. ssh into your box

2. `sudo npm install -g forever`

3. `git clone git@github.com:you/yourapp.git`

	_note: If your repository is private, ensure you have associated your server's SSH key with your github account. See: https://help.github.com/articles/generating-ssh-keys_

4. `forever start yourapp/yourapp.js`

5. `git clone git@github.com:prettymuchbryce/receiver.git`

6. `cd receiver`

7. Edit receiver/config.json to specify the file system location of the git directories to pull.

8. `npm install`

9. `forever start receiver.js`

10. Specify receiver as a service hook in your github project. (Settings -> Service Hooks -> Webhook URLs)

	example: http://www.yourapp.com:3617/githook

11. Push to github to deploy.