From 85c2e6eb34215e2242e388a8f8b7173a14b96ad3 Mon Sep 17 00:00:00 2001 From: James Moger <james.moger@gitblit.com> Date: Sat, 25 Jun 2011 08:57:29 -0400 Subject: [PATCH] Big push for first release. --- docs/02_faq.mkd | 27 ++++++++++++++++++++------- 1 files changed, 20 insertions(+), 7 deletions(-) diff --git a/docs/01_faq.mkd b/docs/02_faq.mkd similarity index 78% rename from docs/01_faq.mkd rename to docs/02_faq.mkd index 552c89d..7958f30 100644 --- a/docs/01_faq.mkd +++ b/docs/02_faq.mkd @@ -12,12 +12,23 @@ 3. The repository is clone-restricted and your password changed. 4. A regression in Gitblit. :( -### Why can't I access Gitblit-Go from another machine? -Please check *server.httpBindInterface* and *server.httpsBindInterface* in `gitblit.properties`. +### Why can't I access Gitblit GO from another machine? +Please check *server.httpBindInterface* and *server.httpsBindInterface* in `gitblit.properties`, you may be binding only to localhost. -### How do I run Gitblit-Go on port 80 or 443 in Linux? +And of course ensure that any firewall you may have running either has an exception for your ports or for the running process. + +### How do I run Gitblit GO 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). + +### Gitblit GO does not list my repositories?! +Confirm that the value *git.repositoriesFolder* in `gitblit.properties` actually points to your repositories folder. + +### Gitblit WAR does not list my repositories?! +Confirm that the <context-param> *git.repositoriesFolder* value in your `web.xml` file actually points to your repositories folder. + +### Gitblit WAR will not authenticate any users?! +Confirm that the <context-param> *realm.userService* value in your `web.xml` file actually points to a `users.properties` file. ## General Interest Questions @@ -32,7 +43,7 @@ Gitblit is not meant to be a social coding resource like [Github](http://github.com) or [Bitbucket](http://bitbucket.com) with 100s or 1000s of users. Gitblit is designed to fulfill the same function as your centralized Subversion or CVS server. -### Why does Gitblit exist? +### Why does Gitblit exist when there is Git and Gitweb? As a Java developer I prefer that as much of my tooling as possible is Java.<br/> Originally, I was going to use [Mercurial](http://mercurial.selenic.com) but... @@ -43,9 +54,11 @@ Gitblit eliminates all that complication with its 100% Java stack and simple single configuration file. +Additionally, Git and Gitweb do not offer repository creation or user management. + ### Do I need real Git? 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. +Everything you need for Gitblit (except Java) is either bundled in the distribution file or automatically downloaded on execution. ### Can I run Gitblit in conjunction with my existing Git tooling? Yes. @@ -59,7 +72,7 @@ ### 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. +*NOTE:* Care must be taken to preserve the relationship between user roles and repository names.<br/>Please see the *User Roles* section of 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. @@ -67,7 +80,7 @@ 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). ### Can I authenticate users against XYZ? -Yes. The login service is pluggable. You may write your own authentication module by implementing the *ILoginService* interface. Set the fully qualified classname as the *realm.realmFile* property. +Yes. The user service is pluggable. You may write your own user service by implementing the *com.gitblit.IUserService* interface. Set the fully qualified classname as the *realm.userService* property. ### 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/> -- Gitblit v1.9.1