search

gitblit-org / gitblit

pure java git solution
http://gitblit.com
Apache License 2.0
2.28k stars 669 forks source link
git gitblit

readme

Gitblit

Gitblit is an open source, pure Java Git solution for managing, viewing, and serving Git repositories. It can serve repositories over the GIT, HTTP, and SSH transports; it can authenticate against multiple providers; and it allows you to get up-and-running with an attractive, capable Git server in less than 5 minutes.

More information about Gitblit can be found here.

download badge nightly docker badge License

License

Gitblit is distributed under the terms of the Apache Software Foundation license, version 2.0. The text of the license is included in the file LICENSE in the root of the project.

Java Runtime Requirement

Gitblit requires a Java 8 Runtime Environment (JRE) or a Java 8 Development Kit (JDK).

Getting help

Source Location
Documentation Gitblit website
Forums Google Groups
Twitter @gitblit or @jamesmoger

Contributing

GitHub pull requests are preferred. Any contributions must be distributed under the terms of the Apache Software Foundation license, version 2.0.

Please see the CONTRIBUTING file for suggestions and guidelines on contributing to Gitblit. Thank you!

tl;dr

  1. Fork (and then git clone https://github.com/gitblit-org/gitblit.git).
  2. Create a branch (git checkout -b branch_name).
  3. Commit your changes (git commit -a).
  4. Push to the branch (git push origin branch_name).
  5. Open a Pull Request.

Building Gitblit

Gitblit uses submodules. Make sure to clone using --recursive OR to execute git submodule update --init --recursive.

Eclipse is recommended for development as the project settings are preconfigured.

  1. Import the gitblit project into your Eclipse workspace. There will be lots of build errors.
  2. Using Ant, execute the build.xml script in the project root. This will download all necessary build dependencies and will also generate the Keys class for accessing settings.
  3. Select your gitblit project root and Refresh the project, this should correct all build problems.
  4. Using JUnit, execute the com.gitblit.tests.GitBlitSuite test suite. This will clone some repositories from the web and run through the unit tests.
  5. Execute the com.gitblit.GitBlitServer class to start Gitblit GO.

Building Tips & Tricks

  1. If you are running Ant from an ANSI-capable console, consider setting the MX_COLOR environment variable before executing Ant.
    set MX_COLOR=true
  2. The build script will honor your Maven proxy settings. If you need to fine-tune this, please review the settings.moxie documentation.