| commit | author | age | ||
| f13c4c | 1 | Gitblit |
| JM | 2 | ================= |
| 3 | ||
| 74029c | 4 | 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. |
| JM | 5 | |
| 1f9dae | 6 | More information about Gitblit can be found [here](http://gitblit.com). |
| f13c4c | 7 | |
| b79824 | 8 | <a href='https://bintray.com/gitblit/releases/gitblit/_latestVersion'><img src='https://api.bintray.com/packages/gitblit/releases/gitblit/images/download.png'></a> |
| 69eeaa | 9 | |
| f13c4c | 10 | License |
| JM | 11 | ------- |
| 12 | ||
| 6c4be1 | 13 | Gitblit is distributed under the terms of the [Apache Software Foundation license, version 2.0](http://www.apache.org/licenses/LICENSE-2.0). |
| 233eb0 | 14 | The text of the license is included in the file LICENSE in the root of the project. |
| b79824 | 15 | |
| 1f15c8 | 16 | Java Runtime Requirement |
| JM | 17 | ------------------------------------ |
| 18 | ||
| 19 | Gitblit requires at Java 7 Runtime Environment (JRE) or a Java 7 Development Kit (JDK). | |
| 20 | ||
| 21 | Getting help | |
| 22 | ------------ | |
| 23 | ||
| 24 | | Source | Location | | |
| 25 | | ------------- |--------------------------------------------------------| | |
| 26 | | Documentation | [Gitblit website](http://gitblit.com) | | |
| 27 | | Forums | [Google Groups](https://groups.google.com/forum/#!forum/gitblit) | | |
| 28 | | Twitter | @gitblit or @jamesmoger | | |
| 29 | | Google+ | +gitblit or +jamesmoger | | |
| 30 | ||
| b79824 | 31 | Contributing |
| JM | 32 | ------------ |
| 33 | ||
| 3cbfeb | 34 | 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). |
| f13c4c | 35 | |
| JM | 36 | Building Gitblit |
| 37 | ---------------- | |
| b79824 | 38 | |
| JM | 39 | Gitblit uses submodules. |
| 40 | Make sure to clone using `--recursive` OR to execute `git submodule update --init --recursive`. | |
| 41 | ||
| f13c4c | 42 | [Eclipse](http://eclipse.org) is recommended for development as the project settings are preconfigured. |
| JM | 43 | |
| 6c4be1 | 44 | 1. Import the gitblit project into your Eclipse workspace. |
| f13c4c | 45 | *There will be lots of build errors.* |
| 6c4be1 | 46 | 2. Using Ant, execute the `build.xml` script in the project root. |
| f13c4c | 47 | *This will download all necessary build dependencies and will also generate the Keys class for accessing settings.* |
| JM | 48 | 3. Select your gitblit project root and **Refresh** the project, this should correct all build problems. |
| 6c4be1 | 49 | 4. Using JUnit, execute the `com.gitblit.tests.GitBlitSuite` test suite. |
| 1f9dae | 50 | *This will clone some repositories from the web and run through the unit tests.* |
| ea2c2a | 51 | 5. Execute the *com.gitblit.GitBlitServer* class to start Gitblit GO. |
| JM | 52 | |
| 53 | Building Tips & Tricks | |
| 54 | ---------------------- | |
| 6c4be1 | 55 | 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> |
| b79824 | 56 | 2. The build script will honor your Maven proxy settings. If you need to fine-tune this, please review the [settings.moxie](http://gitblit.github.io/moxie/settings.html) documentation. |
| 74029c | 57 | |
