Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
git mirror the easy way
branch: master

README.md

gittig

About

gittig is a web application that manages local mirrors of remote git repositories. gittig can be configured to do cron-like updates, but also provides out-of-the-box hook support for 3 popular git hosting providers: GitHub, BitBucket and Beanstalk.

Local mirrors of remote git repositories are useful for several reasons:

  • backup
  • faster read-only remotes (network latency)
  • provide access to applications that require local git repositories (like Redmine)

Installation

gittig is a Java application and can be deployed in any Java servlet container, and it was tested with Tomcat. You can use the pre-compiled war file.

If you want to build from source, the application is written in Grails. Grails provides a complete web stack, built on top of proven Java technologies: Groovy, Spring and Hibernate. To create the war file just issue a 'grails war' command.

Configuration

The only required configuration is the base local directory that gittig will use to store the repositories. Create a file called '~/.gittig/gittig-config.properties' and define one or more than one of the configurations below:

Name Default Value Description
app.baseDir none (required) The base local directory for the repositoreis, must be writable.
app.locationResolver nameLocationResolver The strategy to resolve the local path of remote repositories. Valid values are 'nameLocationResolver', which is a flat structure, 'usernameLocationResolver', which is a 2-level structure using the repository username, and 'serviceLocationResolver', which is a 3-level structure which also uses the service name, like 'github' or 'bitbucket'. This is usefull if you are mirroring repositories from multiple users or hosting provider, so the local paths don't clash.
app.queueTimeout 60 The number of seconds to keep completed jobs in the queue.
app.gitWorkers 3 The maximum number of simultaneous git (clone or update) operations.
app.pollingInterval 0 (disabled) The polling interval for a cron-like update mode. Zero disables this mode.
app.password 'admin' The password of the 'admin' user.

If you will use the hook support you will also need to configure the property 'grails.serverURL' with the absolute URL of your application, which must be reachable from the internet.

Security

If you are using the hook support the application must be open to the internet, so you should change the password of the admin user. You can do this by setting the 'app.password' property in your configuration, as described in the configuration section.

gittig uses spring security for its authentication. As such it can be configured with a wide range of authentication methods, like LDAP.

The hook URLs cannot be password protected yet.

SSH Keys

gittig does not manage the authentication to the remote repositories, it follows the normal git authentication process. So you must have the ssh keys required to access the mirrored repositories. The keys must not use passphrases, because the update process must be headless.

Hook Setup

Each git hosting provider provides an instruction page about how to configure a hook. Gittig provides a hook URL for each supported provider. Your deployment must be open to the Internet, so the providers can reach your server.

GitHub

Go to your project admin page, click on 'Service Hooks', select 'Post-Receive URLs' and add the URL provided at the home page of your gittig application.

admin page hook page

For further instructions check GitHub documentation

BitBucket

Go to the Bitbucket Admin tab. Click Services in the Additional options/settings section on the right-hand side of the screen. Select the POST service from the dropdown list in the Services Administration section. Click Add service. Enter the URL provided at the home page of your gittig application.

For further instructions check Bitbucket documentation

Beanstalk

In your repository, click Setup -> Integration -> Web hooks Enter the URL provided at the home page of your gittig application.

For further instructions check Beanstalk documentation

Roadmap

  • Support more git providers
  • Restrict hook access

Changelog

1.0.2 (Apr 05, 2014)

  • Updating JGit library due to bug in clone operation

1.0.1 (Apr 05, 2014)

  • Fixing #15: Beanstalk url layout change

1.0 (May 14, 2012)

  • Initial public release

License

Copyright (c) 2014 Danilo Tuler

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.