gitblit/src/site/design.mkd

Design Principles

1. Keep It Simple, Stupid
2. Offer useful features for serving Git repositories. If feature is complex, refer to #1.
3. All dependencies must be retrievable from a publicly accessible Maven repository.
   This is to ensure authenticity of dependencies and to automate the setup of developer environments.

Architecture

Bundled Dependencies

The following dependencies are bundled with Gitblit.

• Bootstrap (Apache 2.0)
• GLYPHICONS (Creative Commons CC-BY)
• Iconic (Creative Commons Share Alike 3.0)
• AngularJS (MIT)
• Clippy (MIT)
• google-code-prettify (Apache 2.0)
• Commons Daemon (Apache 2.0)
• jQuery (MIT)
• flotr2 (BSD)
• magnifying glass search icon courtesy of Gnome (Creative Commons CC-BY)
• Git logo originally designed by Jason Long
• modified Git logo originally designed by Henrik Nyh
• fork icon courtesy of Ember.js
• other icons courtesy of FatCow Hosting (Creative Commons CC-BY)

Downloaded Dependencies

The following dependencies are automatically downloaded by Gitblit GO (or already bundled with the WAR) from the Apache Maven repository and from the Eclipse Maven repository when Gitblit is launched for the first time.

• JGit (EDL 1.0)
• Wicket (Apache 2.0)
• Jetty (Apache 2.0, EPL 1.0)
• SLF4J (MIT/X11)
• Log4j (Apache 2.0)
• args4j (Apache 2.0)
• BouncyCastle (MIT/X11)
• JSch - Java Secure Channel (BSD)
• Rome (Apache 1.1)
• jdom (Apache-style JDOM license)
• google-gson (Apache 2.0)
• javamail (CDDL-1.0, BSD, GPL-2.0, GNU-Classpath)
• Groovy (Apache 2.0)
• Lucene (Apache 2.0)
• UnboundID (LGPL 2.1)
• Ivy (Apache 2.0)
• JCalendar (LGPL 2.1)
• Commons-Compress (Apache 2.0)
• XZ for Java (Public Domain)
• FreeMarker (modified BSD)
• Waffle (EPL 1.0)
• JNA (LGPL 2.1)
• Guava (Apache 2.0)
• libpam4j (MIT)
• commons-codec (Apache 2.0)
• pegdown (Apache 2.0)
• jedis (MIT)
• Mina SSHD (Apache 2.0)
• pf4j (Apache 2.0)
• google-guice (Apache 2.0)

Other Build Dependencies

• Fancybox image viewer (MIT and GPL dual-licensed)
• JUnit (Common Public License)
• Moxie (Apache 2.0)

Building from Source

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

Additionally, Google CodePro AnalytiX, eclipse-cs, FindBugs, and EclEmma are recommended development tools.

1. Clone the git repository from Github.
2. Import the gitblit project into your Eclipse workspace. There will be lots of build errors.
3. 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.
4. Select your gitblit project root and Refresh the project, this should correct all build problems.
5. Using JUnit, execute the com.gitblit.tests.GitBlitSuite test suite. This will clone some repositories from the web and run through the unit tests.
6. Execute the com.gitblit.GitBlitServer class to start Gitblit.

Contributing

Pull requests are preferred. Patches are welcome.

Contributions must be your own original work and must licensed under the Apache License, Version 2.0, the same license used by Gitblit.