summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJames Moger <james.moger@gitblit.com>2011-05-23 16:46:09 -0400
committerJames Moger <james.moger@gitblit.com>2011-05-23 16:46:09 -0400
commita4d2498b7f94012cfdf481fcf151f8cfd7537a42 (patch)
treea5ad4a3d883d80ac76992799510544a43c7c124a /docs
parenta9299738a991014788b72db7c9afc946633590e2 (diff)
downloadgitblit-a4d2498b7f94012cfdf481fcf151f8cfd7537a42.tar.gz
gitblit-a4d2498b7f94012cfdf481fcf151f8cfd7537a42.zip
User list. Revised home page. Updated Jetty. Secure cookies. Docs.
Diffstat (limited to 'docs')
-rw-r--r--docs/00_index.mkd15
-rw-r--r--docs/00_setup.mkd2
-rw-r--r--docs/01_faq.mkd16
-rw-r--r--docs/01_screenshots.mkd4
-rw-r--r--docs/screenshots/00.pngbin69136 -> 79888 bytes
-rw-r--r--docs/screenshots/raw/00.pngbin105237 -> 148301 bytes
-rw-r--r--docs/screenshots/thumbs/00.pngbin18333 -> 38921 bytes
7 files changed, 21 insertions, 16 deletions
diff --git a/docs/00_index.mkd b/docs/00_index.mkd
index 6fdc0a1d..a43ffdcb 100644
--- a/docs/00_index.mkd
+++ b/docs/00_index.mkd
@@ -1,19 +1,17 @@
## 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.
-
-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.
+Its designed primarily as a tool for small workgroups who want to host [Git][git] repositories on a Windows machine. Having said that, it works equally well on any standard Linux distribution.
### Current Version
-[{0}](http://gitblit.com/{1}) based on [{2}][jgit] &nbsp; (*{3}*)
+[%VERSION%](http://gitblit.com/%DISTRIBUTION%) based on [%JGIT%][jgit] &nbsp; (*%BUILDDATE%*)
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.
+3. All dependencies must be retrievable from a publicly accessible [Maven](http://maven.apache.org) 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
@@ -29,7 +27,7 @@ sources @ [Github][gitbltsrc]
</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
+- Administrators may create, edit, 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
@@ -53,8 +51,6 @@ sources @ [Github][gitbltsrc]
- 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
@@ -90,8 +86,9 @@ 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)
+- modified Git logo originally designed by [Henrik Nyh](http://henrik.nyh.se/2007/06/alternative-git-logo-and-favicon)
+- other icons courtesy of [FatCow Hosting](http://www.fatcow.com/free-icons) (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.
diff --git a/docs/00_setup.mkd b/docs/00_setup.mkd
index 415ad474..a590b59a 100644
--- a/docs/00_setup.mkd
+++ b/docs/00_setup.mkd
@@ -1,6 +1,6 @@
## Setup and Configuration
-1. Download and unzip Git:Blit.<br/>
+1. Download and unzip [%VERSION%](http://gitblit.com/%DISTRIBUTION%).<br/>
*Its best to eliminate spaces in the path name as that can cause troubleshooting headaches.*
2. The server itself is configured through a simple text file.<br/>
Open `gitblit.properties` in your favorite text editor and make sure to review and set:
diff --git a/docs/01_faq.mkd b/docs/01_faq.mkd
index 94c6dbf4..23ee2b27 100644
--- a/docs/01_faq.mkd
+++ b/docs/01_faq.mkd
@@ -10,10 +10,17 @@ Its small. Its portable. Its easy to manage.
No. Git:Blit is based on [JGit][jgit] which is a pure Java implementation of the [Git version control system][git].<br/>
Everything you need for Git:Blit is either in the zip distribution file or automatically downloaded on execution.
+### Does Git:Blit use a database to store its data?
+No. Git:Blit stores its repository configuration information within the `.git/config` file and its user information in `users.properties` or whatever filename is configured in `gitblit.properties`.
+
+### I want to deploy Git:Blit into my own servlet container. Where is the WAR?
+At this time there is no WAR build available.
+
### Why doesn't Git:Blit support SSH?
-Git:Blit could integrate [Apache Mina](http://mina.apache.org) to provide SSH access. However, doing so violates design principle #1: KISS. SSH supports requires creating, exchanging, and managing SSH keys. While this is doable, its not simple like JGit's SmartHTTP implementation.
+Git:Blit could integrate [Apache Mina][mina] to provide SSH access. However, doing so violates Git:Blit's first design principle: [KISS](http://en.wikipedia.org/wiki/KISS_principle).<br/>
+SSH supports requires creating, exchanging, and managing SSH keys. While this is doable, its not simple like JGit's SmartHTTP implementation.
-You might consider [Gerrit](http://gerrit.googlecode.org) which supports SSH.
+You might consider running [Gerrit](http://gerrit.googlecode.org) which does integrate [Apache Mina][mina] and supports SSH or you might consider serving [Git][git] on Linux which would offer real SSH support and also allow use of [many other compelling Git solutions](https://git.wiki.kernel.org/index.php/InterfacesFrontendsAndTools).
### What types of Search does Git:Blit support?
Git:Blit supports case-insensitive searches of *commit message* (default), *author*, and *committer*.<br/>
@@ -26,9 +33,10 @@ To search by *author* or *committer* use the following syntax in the search box:
Alternatively, you could enable the search type dropdown list in your `gitblit.properties` file.
### How do I run Git:Blit on port 80 or 443 in Linux?
-Tricky. Linux requires root permissions to serve on ports < 1024.<br/>
+Linux requires root permissions to serve on ports < 1024.<br/>
Run the server as *root* (security concern) or change the ports you are serving to 8080 (http) or 8443 (https).
[bitblt]: http://en.wikipedia.org/wiki/Bit_blit "Wikipedia Bitblt"
[jgit]: http://eclipse.org/jgit "Eclipse JGit Site"
-[git]: http://git-scm.com "Official Git Site" \ No newline at end of file
+[git]: http://git-scm.com "Official Git Site"
+[mina]: http://mina.apache.org " Apache Mina" \ No newline at end of file
diff --git a/docs/01_screenshots.mkd b/docs/01_screenshots.mkd
index 3d2061e9..14ec1793 100644
--- a/docs/01_screenshots.mkd
+++ b/docs/01_screenshots.mkd
@@ -1,8 +1,8 @@
## Screenshots
<table class="screenshots">
<tr><td>
- <a rel="screenshots_group" href="screenshots/00.png" title="Repository List">![Repositories](thumbs/00.png)</a>
- <br/>Repository List
+ <a rel="screenshots_group" href="screenshots/00.png" title="Repository & User List">![Repositories](thumbs/00.png)</a>
+ <br/>Repository & User List
</td><td>
<a rel="screenshots_group" href="screenshots/01.png" title="New User">![New User](thumbs/01.png)</a>
<br/>New User
diff --git a/docs/screenshots/00.png b/docs/screenshots/00.png
index 616b31c9..c9653f14 100644
--- a/docs/screenshots/00.png
+++ b/docs/screenshots/00.png
Binary files differ
diff --git a/docs/screenshots/raw/00.png b/docs/screenshots/raw/00.png
index 314f521c..eb501496 100644
--- a/docs/screenshots/raw/00.png
+++ b/docs/screenshots/raw/00.png
Binary files differ
diff --git a/docs/screenshots/thumbs/00.png b/docs/screenshots/thumbs/00.png
index 6aea6930..636631ff 100644
--- a/docs/screenshots/thumbs/00.png
+++ b/docs/screenshots/thumbs/00.png
Binary files differ