From db653ae29c54163c7ca2dd6d2b5063d4623c3a8c Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Sun, 29 May 2011 14:04:38 -0400
Subject: [PATCH] Unit testing.
---
docs/01_faq.mkd | 72 +++++++++++++++++++++++++++++------
1 files changed, 59 insertions(+), 13 deletions(-)
diff --git a/docs/01_faq.mkd b/docs/01_faq.mkd
index 343803d..5068e79 100644
--- a/docs/01_faq.mkd
+++ b/docs/01_faq.mkd
@@ -1,22 +1,63 @@
-## Frequently Asked Questions
+## Troubleshooting
-### Git:Blit? What kind of name is that?
-Its a phonetic play on [bitblt][bitblt] which is an image processing operation meaning *bit-block transfer*.
+### Eclipse/Egit/Git complains that it "can't open upload pack"?
+There are a few ways this can occur:
-### Why use Git:Blit?
-Its small. Its portable. Its easy to manage.
+1. You are using https with a self-signed certificate and you **did not** configure *http.sslVerify=false*
+ 1. Window->Preferences->Team->Git->Configuration
+ 2. Click the *New Entry* button
+ 3. <pre>Key = *http.sslVerify*
+ Value = *false*</pre>
+2. The repository is clone-restricted and you don't have access.
+3. The repository is clone-restricted and your password changed.
+4. A regression in Gitblit. :(
+
+### Why can't I access Gitblit from another machine?
+Please check *server.httpBindInterface* and *server.httpsBindInterface* in `gitblit.properties`.
+
+### How do I run Gitblit 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) and/or 8443 (https).
+
+## General Interest Questions
+
+### Gitblit? What kind of name is that?
+It's a phonetic play on [bitblt][bitblt] which is an image processing operation meaning *bit-block transfer*.
+
+### Why use Gitblit?
+It's a small tool that allows you to easily manage shared repositories and doesn't require alot of setup or git kung-foo.
### Do I need real Git?
-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.
+No. Gitblit is based on [JGit][jgit] which is a pure Java implementation of the [Git version control system][git].<br/>
+Everything you need for Gitblit is either in the zip distribution file or automatically downloaded on execution.
-### 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.
+### Do I need a JDK or can I use a JRE?
+Gitblit will run just fine with a JRE. Gitblit can optionally use `keytool` from the JDK to generate self-signed certificates, but normally Gitblit uses [BouncyCastle][bouncycastle] for that need.
-You might consider [Gerrit](http://gerrit.googlecode.org) which supports SSH.
+### I want to deploy Gitblit into my own servlet container. Where is the WAR?
+At this time there is no WAR build available.
-### What types of Search does Git:Blit support?
-Git:Blit supports case-insensitive searches of *commit message* (default), *author*, and *committer*.<br/>
+### Does Gitblit use a database to store its data?
+No. Gitblit 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`.
+
+### Can I manually edit users.properties, gitblit.properties, or .git/config?
+Yes. You can manually manipulate all of them and (most) changes will be immediately available to Gitblit.<br/>Exceptions to this are noted in `gitblit.properties`.
+
+*NOTE:* Care must be taken to preserve the relationship between user roles and repository names.<br/>Please see the [setup](/setup.html) page for details.
+
+### Can I restrict access to paths within a repository?
+No. Access restrictions apply to the repository as a whole.
+
+Gitblit'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 Gitblit support SSH?
+Gitblit could integrate [Apache Mina][mina] to provide SSH access. However, doing so violates Gitblit's first design principle: [KISS](http://en.wikipedia.org/wiki/KISS_principle).<br/>
+SSH support requires creating, exchanging, and managing SSH keys. While this is possible, JGit's SmartHTTP implementation is a simpler and universal 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).
+
+### What types of Search does Gitblit support?
+Gitblit supports case-insensitive searches of *commit message* (default), *author*, and *committer*.<br/>
To search by *author* or *committer* use the following syntax in the search box:
@@ -25,6 +66,11 @@
Alternatively, you could enable the search type dropdown list in your `gitblit.properties` file.
+### I see a disabled "blame" link. How do I enable it?
+Currently blame is not implemented. Those links are placeholders to remind me where Gitweb offers blame.
+
[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"
+[bouncycastle]: http://bouncycastle.org "The Legion of the Bouncy Castle"
\ No newline at end of file
--
Gitblit v1.9.1