Merge "Add built-in documentation." into stable-2.11
tree: c80571e08cd252ec5f6ba3580ba017ff99931323
  1. lib/
  2. src/
  3. .gitignore
  4. BUCK
  5. LICENSE
  6. pom.xml
  7. README.md
  8. ReleaseNotes-2.9.txt
README.md

GitBlit plugin

Overview

Purpose of this plugin is to use Gitblit as web-based viewer (i.e. GitWeb replacement) on top of Gerrit Code Review.

How to build

As pre-requisites you need to make a custom-build of Gitblit and Wicket: the standard JARs downloaded from a public Maven repository aren't enough as they are missing some specific build parameters and constraints (i.e. shaded-jar) that are needed for a Gerrit plugin to work properly.

Gitblit

You need to clone Gitblit from GitHub and build it locally using the installMaven ANT target.

$ git clone https://github.com/gitblit/gitblit.git
$ git checkout develop
$ ant -DresourceFolderPrefix=static installMaven

Gitblit plugin

You are ready now to clone and build the Gitblit plugin: the Wicket and Giblit dependencies will be taken from your local Maven repository.

$ mvn package

Configuration

In order to use GitBlit as GitWeb replacement, please apply the following configuration to your Gerrit config.

[gitweb]
    type = custom
    linkname = Gitblit
    url = plugins/gitblit/
    revision = commit/?r=${project}&h=${commit}
    project = summary/?r=${project}
    branch = log/?r=${project}&h=${branch}
    filehistory = history/?f=${file}&r=${project}&h=${branch}
    file = blob/?r=${project}&h=${commit}&f=${file}
    roottree = tree/?r=${project}&h=${commit}