From a75a1819f4c7fa5080ddb47545fe9012a842e5b3 Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Wed, 20 Jul 2011 21:08:57 -0400
Subject: [PATCH] Misc fixes.
---
docs/00_index.mkd | 151 +++++++++++--------------------------------------
1 files changed, 35 insertions(+), 116 deletions(-)
diff --git a/docs/00_index.mkd b/docs/00_index.mkd
index 6fdc0a1..62631bc 100644
--- a/docs/00_index.mkd
+++ b/docs/00_index.mkd
@@ -1,127 +1,46 @@
## Overview
-Git:Blit is an open-source, integrated pure Java stack for managing, viewing, and serving [Git][git] repositories.
-Its designed primarily as a tool for small workgroups who want to host [Git][git] repositories on a Windows machine.
+<a href="screenshots.html" title="Screenshots"><img class="overview" src="thumbs/00.png" alt="Screenshots" /></a>
-Of course, since its pure Java it should run with any JVM on any platform, but there are already [many compelling Git solutions](https://git.wiki.kernel.org/index.php/InterfacesFrontendsAndTools) for non-Windows environments.
+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 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>
+
+### Java Runtime Requirement
+
+Gitblit requires a Java 6 Runtime Environment (JRE) or a Java 6 Development Kit (JDK).
-### Current Version
+### Current Release
-[{0}](http://gitblit.com/{1}) based on [{2}][jgit] (*{3}*)
+**%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%*
+- fixed: bare-cloned repositories were listed as (empty) and were not clickable (issue 13)
+- fixed: default port for Gitblit GO is now 8443 to be more linux/os x friendly (issue 12)
+- fixed: forward-slashes ('/', %2F) can be encoded using a custom character to workaround some servlet container default security measures for proxy servers<br/>**New:** *web.forwardSlashCharacter = /* (issue 11)
+- fixed: users can now change their passwords (issue 1)
+- fixed: always show root repository group first, i.e. don't sort root group with other groups
+- fixed: tone-down repository group header color
+- added: optionally display repository on-disk size on repositories page<br/>**New:** *web.showRepositorySizes = true*
+- updated: MarkdownPapers 1.1.0
+- updated: Jetty 7.4.4
+
+issues & binaries @ [Google Code][googlecode]<br/>
sources @ [Github][gitbltsrc]
-### Design Principles
-1. [KISS](http://en.wikipedia.org/wiki/KISS_principle)
-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.<br/>This is to ensure authenticity of dependencies and to keep the Git:Blit distribution svelte.
-
-### Features
-- Out-of-the-box integrated stack requiring minimal configuration
-- JGit SmartHTTP servlet
-- Browser and git client authentication
-- Four repository access control configurations and a Read-Only flag
- <ul class='noBullets'>
- <li> *Anonymous View, Clone & Push*</li>
- <li> *Authenticated Push*</li>
- <li> *Authenticated Clone & Push*</li>
- <li> *Authenticated View, Clone & Push*</li>
- <li> Freeze repository (i.e. deny push, make read-only)
- </ul>
-- Gitweb inspired UI
-- Administrators may create, edit, rename, or delete repositories through the web UI
-- Administrators may create, edit, rename, or delete users through the web UI
-- Repository Owners may edit repositories through the web UI
-- Automatically generates a self-signed certificate for https communications
-- Dates can optionally be displayed using the browser''s reported timezone
-- Author and Committer email address display can be controlled
-- Markdown view support
-- Syntax highlighting
-- Customizable regular expression handling for commit messages
-- Single text file for server configuration
-- Single text file for users configuration
-- Simple repository stats and activity graph (uses Google Charts)
-- Optional utility pages
- <ul class='noBullets'>
- <li> Docs page which enumerates all Markdown files within a repository</li>
- <li> Ticgit ticket pages *(based on last MIT release bf57b032 2009-01-27)*</li>
- </ul>
-
-### Limitations
-- HTTP/HTTPS are the only supported protocols
-- Access controls are not path-based, they are repository-based
-- Only Administrators can create, rename or delete repositories
-- Git:Blit is an integrated, full-stack solution. There is no WAR build at this time.
-
-### Todo List
-- Manual certificate generation with BouncyCastle
-- User list with edit and delete links
-- Review spots where Git:Blit can cache data instead of abusing the disk
- - stats
- - users.properties access
- - available repositories
- - etc
-- Download zip feature
-- Site documentation
-- Code documentation
-- Unit testing
-
-### Idea List
-- Ticgit activity/timeline
-- Ticgit query feature with paging support
-- Ticgit ticket change history
-- View images on Blob page
-- View other binary files on Blob page
-- Markdown editing feature
-- Blame feature (waiting for the [JGit][jgit] team to do the hard part)
-
### License
-TBD
-
-### Inspirations
-- [Gitweb](http://www.git-scm.com)
-- [Fossil](http://www.fossil-scm.org)
-
-## Architecture
-
-
-
-### Bundled Dependencies
-The following dependencies are bundled with the Git:Blit zip distribution file.
-
-- [google-code-prettify](http://code.google.com/p/google-code-prettify) (Apache 2.0)
-- [JavaService](http://forge.ow2.org/projects/javaservice) (BSD and LGPL)
-- icons courtesy of [FatCow Hosting](http://www.fatcow.com/free-icons) (Creative Commons CC-BY)
-- magnifying glass search icon courtesy of [Gnome](http://gnome.org) (Creative Commons CC-BY)
-
-### Downloaded Dependencies
-The following dependencies are automatically downloaded from the Apache Maven repository and from the Eclipse Maven repository when Git:Blit is launched for the first time.
-
-- [JGit][jgit] (EDL 1.0)
-- [Wicket](http://wicket.apache.org) (Apache 2.0)
-- [WicketStuff GoogleCharts](https://github.com/wicketstuff/core/wiki/GoogleCharts) (Apache 2.0)
-- [MarkdownPapers](http://markdown.tautua.org) (Apache 2.0)
-- [Jetty](http://eclipse.org/jetty) (Apache 2.0, EPL 1.0)
-- [SLF4J](http://www.slf4j.org) (MIT/X11)
-- [Log4j](http://logging.apache.org/log4j) (Apache 2.0)
-- [JCommander](http://jcommander.org) (Apache 2.0)
-- [BouncyCastle](http://www.bouncycastle.org) (MIT/X11)
-
-### Other Build Dependencies
-- [Fancybox image viewer](http://fancybox.net) (MIT and GPL dual-licensed)
-
-## Building
-[Eclipse](http://eclipse.org) is recommended for development as the project settings are preconfigured.
-
-1. Clone the git repository from [Github][gitbltsrc].
-2. Import the gitblit project into your Eclipse workspace.<br/>
-*There will be lots of build errors.*
-3. Using Ant, execute the `build.xml` script in the project root.<br/>
-*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. Review the settings in `gitblit.properties` in your project root.<br/>
-Make sure you set an appropriate value for *git.repositoriesFolder*.
-6. Execute the *com.gitblit.Launcher* class to start Git:Blit.
+Gitblit is distributed under the terms of the [Apache Software Foundation license, version 2.0][apachelicense]
[jgit]: http://eclipse.org/jgit "Eclipse JGit Site"
[git]: http://git-scm.com "Official Git Site"
-[gitbltsrc]: http://somewhere.com "gitblit git repository"
\ No newline at end of file
+[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
--
Gitblit v1.9.1