From 56c549e384b1a648c77bbd09a2cc77976e8a64de Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Tue, 24 May 2011 17:39:55 -0400
Subject: [PATCH] Documentation.
---
docs/01_faq.mkd | 9 +++++++--
docs/00_index.mkd | 10 +++++-----
docs/00_setup.mkd | 2 +-
3 files changed, 13 insertions(+), 8 deletions(-)
diff --git a/docs/00_index.mkd b/docs/00_index.mkd
index a43ffdc..b5a0416 100644
--- a/docs/00_index.mkd
+++ b/docs/00_index.mkd
@@ -2,7 +2,7 @@
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. Having said that, it works equally well on any standard Linux distribution.
-### Current Version
+### Current Release
[%VERSION%](http://gitblit.com/%DISTRIBUTION%) based on [%JGIT%][jgit] (*%BUILDDATE%*)
@@ -27,11 +27,12 @@
</ul>
- Gitweb inspired UI
- Administrators may create, edit, rename, or delete repositories through the web UI
-- Administrators may create, edit, or delete users 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
+- Dates can optionally be displayed using the browser's reported timezone
- Author and Committer email address display can be controlled
+- Realtime zip downloads feature
- Markdown view support
- Syntax highlighting
- Customizable regular expression handling for commit messages
@@ -56,7 +57,6 @@
- users.properties access
- available repositories
- etc
-- Download zip feature
- Site documentation
- Code documentation
- Unit testing
@@ -68,7 +68,7 @@
- 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)
+- Blame (waiting for the [JGit][jgit] team to do the hard part)
### License
TBD
diff --git a/docs/00_setup.mkd b/docs/00_setup.mkd
index a590b59..8d7da67 100644
--- a/docs/00_setup.mkd
+++ b/docs/00_setup.mkd
@@ -48,7 +48,7 @@
Whitespace is illegal.
#### Passwords
-User passwords are CASE-SENSITIVE and may be *plain*, *md5*, or *crypt* formatted (see `gitblit.properties` -> *realm.passwordStorage*).
+User passwords are CASE-SENSITIVE and may be *plain* or *md5* formatted (see `gitblit.properties` -> *realm.passwordStorage*).
#### User Roles
There is only one actual *role* in Git:Blit and that is *#admin* which grants administrative powers to that user. Administrators automatically have access to all repositories. All other *roles* are repository names. If a repository is access-restricted, the user must have the repository's name within his/her roles to bypass the access restriction. This is how users are granted access to a restricted repository.
diff --git a/docs/01_faq.mkd b/docs/01_faq.mkd
index 23ee2b2..f76cf6e 100644
--- a/docs/01_faq.mkd
+++ b/docs/01_faq.mkd
@@ -16,9 +16,14 @@
### I want to deploy Git:Blit into my own servlet container. Where is the WAR?
At this time there is no WAR build available.
+### Can I restrict access to paths within a repository?
+No. Access restrictions apply to the repository as a whole.
+
+Git:Blit's simple authentication and authorization mechanism can be used to facilitate one or more of the [workflows outlined here](http://progit.org/book/ch5-1.html). Should you require more fine-grained access controls you might consider using [gitolite](https://github.com/sitaramc/gitolite).
+
### Why doesn't Git:Blit support SSH?
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.
+SSH support requires creating, exchanging, and managing SSH keys. While this is possible, JGit's SmartHTTP implementation is a simpler and cleaner transport mechanism.
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).
@@ -34,7 +39,7 @@
### How do I run Git:Blit on port 80 or 443 in Linux?
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).
+Run the server as *root* (security concern) or change the ports you are serving to 8080 (http) and/or 8443 (https).
[bitblt]: http://en.wikipedia.org/wiki/Bit_blit "Wikipedia Bitblt"
[jgit]: http://eclipse.org/jgit "Eclipse JGit Site"
--
Gitblit v1.9.1