Giter Club home page Giter Club logo

git-push-server's Introduction

GIT-Push Server

This node module makes it easy to build an HTTP stateless git-push server, to build stuff like Heroku or GitBook.io without keeping the repositories content.

Installation

$ npm install git-push-server

Example

var GitPush = require("git-push-server");
var express = require("express");
var path = require("path");

// Create the http application
var app = express();

// Create the git-push server
var git = new GitPush();

// Create a router for the git-push server
var router = express.Router();

// Start the git server on the router
git.start(router);

// Bind the router to the app
app.use('/:author/:repo.git', function(req, res, next) {
    // Needed to identify the repository
    req.repoId = [req.params.author, req.params.repo].join("/");
    next();
});
app.use('/:author/:repo.git', router);

// Start the http server
var server = app.listen(3000, function() {
    console.log('Listening on port %d', server.address().port);
});

You can now run from a git repository:

$ git push http://localhost:3000/test/test.git master

Run an operation on each push

If you need to run an operation on the folder resulting from the push, you need to override push. For async operaiton, this method can return a promise.

git.push = function(pushInfos) {
    // pushInfos.repoId
    // pushInfos.auth.username
    // pushInfos.auth.password
    // pushInfos.content
    // pushInfos.bare

    // do some build or deployment operation
};

Authentication

You need to override authenticate to make authentication work. It should return a boolean or a promise for async authentication.

git.authenticate = function(infos) {
    // infos.repoId -> repository id set with in req.repoID
    // infos.username
    // infos.password

    return doSomethingWithDatabase(infos.username, infos.password, infos.repoId);
};

Options

var git = new GitPush(options);

options.debug: enable log messages (default false) options.root: root directory for the repositories (default os.tmpdir)

git-push-server's People

Contributors

samypesse avatar

Watchers

Jason Miller avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.