gitlab-workhorse

README

gitlab-git-http-server

This is a proof of concept for unloading Git HTTP traffic from the GitLab Rails app (Unicorn) to a separate daemon. All authentication and authorization logic is still handled by the GitLab Rails app.

Architecture: Git client -> NGINX -> gitlab-git-http-server (makes auth request to GitLab Rails app) -> git-upload-pack

Installation

To install into /usr/local/bin run make install.

make install

To install into /foo/bin run make install PREFIX=/foo.

Tests

make clean test

Try it out

You can try out the Git server without authentication as follows:

# Start a fake auth backend that allows everything/everybody
go run support/say-yes.go &
# Start gitlab-git-http-server
go build && ./gitlab-git-http-server /path/to/git-repos

Now if you have a Git repository in /path/to/git-repos/my-repo.git, you can push to and pull from it at the URL http://localhost:8181/my-repo.git.

Example request flow

• start POST repo.git/git-receive-pack to NGINX
• ..start POST repo.git/git-receive-pack to gitlab-git-http-server
• ....start POST repo.git/git-receive-pack to Unicorn for auth
• ....end POST to Unicorn for auth
• ....start git-receive-pack process from gitlab-git-http-server
• ......start POST /api/v3/internal/allowed to Unicorn from Git hook (check protected branches)
• ......end POST to Unicorn from Git hook
• ....end git-receive-pack process
• ..end POST to gitlab-git-http-server
• end POST to NGINX

License

This code is distributed under the MIT license, see the LICENSE file.

Documentation

Overview

gitlab-git-http-server handles 'smart' Git HTTP requests for GitLab

This HTTP server can service 'git clone', 'git push' etc. commands from Git clients that use the 'smart' Git HTTP protocol (git-upload-pack and git-receive-pack). It is intended to be deployed behind NGINX (for request routing and SSL termination) with access to a GitLab backend (for authentication and authorization) and local disk access to Git repositories managed by GitLab. In GitLab, this role was previously performed by gitlab-grack.

This file contains the main() function. Actual Git HTTP requests are handled by the gitHandler type, implemented in githandler.go.