gitblit/README.markdown

Gitblit
=================

Gitblit is an open source, pure Java Git solution for managing, viewing, and serving [Git](http://git-scm.com) 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](http://gitblit.com).

<a href='https://github.com/gitblit-org/gitblit/releases/latest' title='Download'><img alt='download badge' src='https://img.shields.io/badge/dynamic/json?color=9cf&label=Download&query=%24.name&url=https%3A%2F%2Fapi.github.com%2Frepos%2Fgitblit-org%2Fgitblit%2Freleases%2Flatest'></a>
<a title='nightly docker' href='https://hub.docker.com/r/gitblit/gitblit/tags?page=1&name=nightly'><img alt='nightly docker badge' src='https://img.shields.io/badge/dynamic/json?color=2496ed&label=Nightly Docker&query=%24.tag_last_pushed&cacheSeconds=43200&url=https%3A%2F%2Fhub.docker.com%2Fv2%2Frepositories%2Fgitblit%2Fgitblit%2Ftags%2Fnightly'></a>
![License](https://img.shields.io/github/license/gitblit-org/gitblit?color=%23f29024)

License
-------

Gitblit is distributed under the terms of the [Apache Software Foundation license, version 2.0](http://www.apache.org/licenses/LICENSE-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](http://gitblit.com)                  |
| Forums        | [Google Groups](https://groups.google.com/forum/#!forum/gitblit) |
| 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](http://www.apache.org/licenses/LICENSE-2.0).

Please see the [CONTRIBUTING file](CONTRIBUTING.md) for suggestions and guidelines on contributing to Gitblit. Thank you!

### tl;dr
1.  [Fork](https://github.com/gitblit-org/gitblit/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](http://eclipse.org) 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.<pre>set MX_COLOR=true</pre>
2. The build script will honor your Maven proxy settings.  If you need to fine-tune this, please review the [settings.moxie](http://gitblit-org.github.io/moxie/settings.html) documentation.