From 4ef60d7a963fdadaa69db98df7844314c2ceb693 Mon Sep 17 00:00:00 2001 From: James Moger <james.moger@gitblit.com> Date: Sat, 12 Nov 2011 09:01:25 -0500 Subject: [PATCH] Documentation. --- docs/00_index.mkd | 94 +++++++++++++++++++++++++++++----------------- 1 files changed, 59 insertions(+), 35 deletions(-) diff --git a/docs/00_index.mkd b/docs/00_index.mkd index 5338634..4e6645e 100644 --- a/docs/00_index.mkd +++ b/docs/00_index.mkd @@ -1,43 +1,67 @@ -## Overview -<a href="screenshots.html" title="Screenshots"><img class="overview" src="thumbs/00.png" alt="Screenshots" /></a> +## What is Gitblit? +<div class="well" style="float:right;padding: 14px 14px;"> +<b>Current Release %VERSION% (%BUILDDATE%)</b> <a href="releases.html">changelog</a> +<div style="padding:5px;"><a style="text-decoration:none;" class="btn success" href="http://code.google.com/p/gitblit/downloads/detail?name=%GO%">Download Gitblit GO</a></div> +<div style="padding:5px;"><a style="text-decoration:none;" class="btn danger" href="http://code.google.com/p/gitblit/downloads/detail?name=%WAR%">Download Gitblit WAR</a></div> +<div style="padding:5px;"><a style="text-decoration:none;" class="btn primary" href="http://code.google.com/p/gitblit/downloads/detail?name=%MANAGER%">Download Gitblit Manager</a></div> + <div style="text-align:center;"> + <a href="http://code.google.com/p/gitblit/downloads/detail?name=%API%">Gitblit API</a> | <a href="http://code.google.com/p/gitblit/downloads/detail?name=%FEDCLIENT%">Gitblit Federation Client</a> + <br/> + <a href="screenshots.html" title="Screenshots"><img style="margin-top:5px;border:1px solid #ccc;" src="thumbs/00.png" alt="Screenshots" /></a> + </div> +</div> -Gitblit is an open-source, pure Java stack for managing, viewing, and serving [Git][git] repositories.<br/> -Its designed primarily as a tool for small workgroups who want to host centralized repositories. +Gitblit is an open-source, pure Java stack for managing, viewing, and serving [Git][git] repositories. +It's designed primarily as a tool for small workgroups who want to host centralized repositories. -Gitblit is available in two variations: -<ul class='noBullets'> -<li>*Gitblit GO* - a complete & integrated pure Java stack<p> - This is what you should download if you want to go from zero to Git in less than 5 mins.<br/> - Gitblit GO is like a mashup of Apache httpd, [Git][git], and Gitweb with simplified configuration and maintenance.<br/> - All dependencies are downloaded on first execution.<p> -<li>*Gitblit WAR* - a traditional WAR distribution<p> - This is what you should download if you want to deploy Gitblit into your own servlet container (e.g. Tomcat, Jetty, etc).<br/> - All dependencies are bundled. -</ul> +### GO: Single-Stack Solution + +*Gitblit GO* is an integrated, single-stack solution based on Jetty. + +You do not need Apache httpd, Perl, Git, or Gitweb. Should you want to use some or all of those, you still can; Gitblit plays nice with the other kids on the block. + +This is what you should download if you want to go from zero to Git in less than 5 mins. + +All dependencies are downloaded on first execution. + +### WAR: For Your Servlet Container +*Gitblit WAR* is what you should download if you already have a servlet container available that you wish to use. +Jetty 6/7/8 and Tomcat 6/7 are known to work. Generally, any Servlet 2.5 or Servlet 3.0 container should work. + +All dependencies are bundled. + +### You decide how to use Gitblit + +Gitblit can be used as a dumb repository viewer with no administrative controls or user accounts. +Gitblit can be used as a complete Git stack for cloning, pushing, and repository access control. +Gitblit can be used without any other Git tooling (including actual Git) or it can cooperate with your established tools. + +### Easy Web Management + +Administrators can create and manage all repositories & user accounts from the *Web UI*. +Administrators can create and manage all repositories & user accounts from the *JSON RPC interface* using the [Gitblit Manager](http://code.google.com/p/gitblit/downloads/detail?name=%MANAGER%) or your own custom tooling. + +### Integration and Mining + +- Pluggable user service mechanism for custom authentication, authorization, and user management +- Rich RSS feeds +- JSON-based RPC mechanism +- [Java Client API library](http://code.google.com/p/gitblit/downloads/detail?name=%API%) for custom integration + +### Backup Strategy + +Gitblit includes a backup mechanism (*federation*) which can be used to backup repositories and, optionally, user accounts & server settings from your Gitblit instance to another Gitblit instance or to a [Gitblit Federation Client](http://code.google.com/p/gitblit/downloads/detail?name=%FEDCLIENT%). Similarly, you can use the federation mechanism to aggregate individual workspace Gitblit instances to a common, centralized server. + +### Project Management and Community + +issues, binaries, and sources @ [Google Code][googlecode] +sources @ [Github][gitbltsrc] +group discussion @ the [Gitblit Discussion Group](http://groups.google.com/group/gitblit) +follow Gitblit @ [google+](https://plus.google.com/114464678392593421684) ### Java Runtime Requirement Gitblit requires a Java 6 Runtime Environment (JRE) or a Java 6 Development Kit (JDK). - -### Current Release - -**%VERSION%** ([go](http://code.google.com/p/gitblit/downloads/detail?name=%GO%)|[war](http://code.google.com/p/gitblit/downloads/detail?name=%WAR%)) based on [%JGIT%][jgit] *released %BUILDDATE%* - -- added: federation feature to allow gitblit instances to pull repositories and, optionally, settings and accounts from other gitblit instances.<br/> -This is something like svn-sync for gitblit. -<br/>**New:** *federation.name =* -<br/>**New:** *federation.passphrase =* -<br/>**New:** *federation.allowProposals = false* -<br/>**New:** *federation.proposalsFolder = proposals* -<br/>**New:** *federation.defaultFrequency = 60 mins* -<br/>**New:** *mail.* settings for sending emails -<br/>**New:** user role *#notfederated* to prevent a user account from being pulled by a federated Gitblit instance -- added: google-gson dependency -- added: javamail dependency -- updated: MarkdownPapers 1.1.1 - -issues, binaries, and sources @ [Google Code][googlecode]<br/> -sources @ [Github][gitbltsrc] ### License Gitblit is distributed under the terms of the [Apache Software Foundation license, version 2.0][apachelicense] @@ -46,4 +70,4 @@ [git]: http://git-scm.com "Official Git Site" [gitbltsrc]: http://github.com/gitblit "gitblit git repository" [googlecode]: http://code.google.com/p/gitblit "gitblit project management" -[apachelicense]: http://www.apache.org/licenses/LICENSE-2.0 "Apache License, Version 2.0" \ No newline at end of file +[apachelicense]: http://www.apache.org/licenses/LICENSE-2.0 "Apache License, Version 2.0" -- Gitblit v1.9.1