Documentation

Author: gitblit

build.xml

@@ -673,18 +673,24 @@
 					<page name="screenshots" src="screenshots.mkd" />
 				</menu>
 				<menu name="documentation" pager="true" pagerPlacement="bottom" pagerLayout="justified">
-					<page name="setup GO" src="setup_go.mkd" />
-					<page name="upgrade GO" src="upgrade_go.mkd" />
+					<menu name="Gitblit GO" pager="true" pagerPlacement="bottom" pagerLayout="justified">
+						<page name="setup GO" src="setup_go.mkd" />
+						<page name="upgrade GO" src="upgrade_go.mkd" />
+					</menu>
 					<divider />
-					<page name="setup WAR" src="setup_war.mkd" />
-					<page name="upgrade WAR" src="upgrade_war.mkd" />
+					<menu name="Gitblit WAR" pager="true" pagerPlacement="bottom" pagerLayout="justified">
+						<page name="setup WAR" src="setup_war.mkd" />
+						<page name="upgrade WAR" src="upgrade_war.mkd" />
+					</menu>
 					<divider />
-					<page name="administration" src="setup.mkd" />
+					<page name="administration" src="administration.mkd" />
 					<page name="authentication" src="setup_authentication.mkd" />
 					<page name="push hooks" src="setup_hooks.mkd" />
 					<page name="lucene indexing" src="setup_lucene.mkd" />
 					<page name="reverse proxies" src="setup_proxy.mkd" />
 					<divider />
+					<page name="Gitblit as a viewer" src="setup_viewer.mkd" />
+					<divider />
 					<page name="git client setup" src="setup_client.mkd" />
 					<divider />
 					<page name="federation" src="federation.mkd" />
@@ -923,11 +929,30 @@
 						<page name="features" src="features.mkd" />
 					</menu>
 					<menu name="documentation">
-						<page name="setup" src="setup.mkd" />
+						<menu name="Gitblit GO" pager="true" pagerPlacement="bottom" pagerLayout="justified">
+							<page name="setup GO" src="setup_go.mkd" />
+							<page name="upgrade GO" src="upgrade_go.mkd" />
+						</menu>
+						<divider />
+						<menu name="Gitblit WAR" pager="true" pagerPlacement="bottom" pagerLayout="justified">
+							<page name="setup WAR" src="setup_war.mkd" />
+							<page name="upgrade WAR" src="upgrade_war.mkd" />
+						</menu>
+						<divider />
+						<page name="administration" src="administration.mkd" />
+						<page name="authentication" src="setup_authentication.mkd" />
+						<page name="push hooks" src="setup_hooks.mkd" />
+						<page name="lucene indexing" src="setup_lucene.mkd" />
+						<page name="reverse proxies" src="setup_proxy.mkd" />
+						<divider />
+						<page name="Gitblit as a viewer" src="setup_viewer.mkd" />
+						<divider />
+						<page name="git client setup" src="setup_client.mkd" />
+						<divider />
 						<page name="federation" src="federation.mkd" />
 						<divider />
-						<page name="faq" src="faq.mkd" />
 						<page name="settings" src="properties.mkd" />
+						<page name="faq" src="faq.mkd" />
 						<divider />
 						<page name="design" src="design.mkd" />
 						<page name="rpc" src="rpc.mkd" />

src/site/setup.mkd renamed to src/site/administration.mkd

@@ -48,6 +48,14 @@ These permission codes are combined with the repository path to create a user pe
 
     RW:mygroup/myrepo.git
 
+**NOTE:**  
+The following repository permissions are equivalent:
+
+- myrepo.git
+- RW+:myrepo.git
+
+This is to preserve backwards-compatibility with Gitblit <= 1.1.0 which granted rewind power to all access-permitted users.
+
 #### Discrete Permissions with Regex Matching (Gitblit v1.2.0+)
 
 Gitblit also supports *case-insensitive* regex matching for repository permissions.  The following permission grants push privileges to all repositories in the *mygroup* folder.
@@ -171,14 +179,6 @@ There are four actual *roles* in Gitblit:
 - *#create*, which allows the user the power to create personal repositories
 - *#fork*, which allows the user to create a personal fork of an existing Gitblit-hosted repository
 
-**NOTE:**  
-The following repository permissions are equivalent:
-
-- myrepo.git
-- RW+:myrepo.git
-
-This is to preserve backwards-compatibility with Gitblit <= 1.1.0 which granted rewind power to all access-permitted users.
-
 ### Personal Repositories & Forks
 
 Personal Repositories and Forks are related but are controlled individually.

src/site/faq.mkd

@@ -21,7 +21,7 @@ Value = <em>false</em></pre>
 
 This is a long-standing, known bug in the native Git for Windows implementation.
 
-https://groups.google.com/d/topic/msysgit/at8D7J-h7mw/discussion
+Please see [this thread](https://groups.google.com/d/topic/msysgit/at8D7J-h7mw/discussion) for details.
 
 ### Why can't I access Gitblit GO from another machine?
 1. Please check *server.httpBindInterface* and *server.httpsBindInterface* in `gitblit.properties`, you may be only be serving on *localhost*.
@@ -41,7 +41,7 @@ Run the server as *root* (security concern) or change the ports you are serving
 2. Confirm that the servlet container process has full read-write-execute permissions to your *git.repositoriesFolder*.
 
 ### Gitblit WAR will not authenticate any users?!
-Confirm that the &lt;context-param&gt; *realm.userService* value in your `web.xml` file actually points to a `users.conf` or `users.properties` file.
+Confirm that the &lt;context-param&gt; *realm.userService* value in your `web.xml` file actually points to a `users.conf` file.
 
 ### Gitblit won't open my grouped repository (/group/myrepo.git) or browse my log/branch/tag/ref?!
 This is likely an url encoding/decoding problem with forward slashes:
@@ -125,9 +125,9 @@ Yes.
 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.
 
 ### 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.conf`, `users.properties`, or whatever filename is configured in `gitblit.properties`.
+No.  Gitblit stores its repository configuration information within the `.git/config` file and its user information in `users.conf` or whatever filename is configured in `gitblit.properties`.
 
-### Can I manually edit users.conf, users.properties, gitblit.properties, or .git/config?
+### Can I manually edit users.conf, 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:**  
@@ -176,4 +176,4 @@ Yes.  Most messages are localized to a standard Java properties file.
 [jgit]: http://eclipse.org/jgit "Eclipse JGit Site"
 [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"
+[bouncycastle]: http://bouncycastle.org "The Legion of the Bouncy Castle"

src/site/roadmap.mkd

@@ -1,28 +1,17 @@
 ## Roadmap
 
 This is not exactly a formal roadmap but it is a priority list of what might be implemented in future releases.  
-This list is volatile.
+This list is volatile and may not reflect what will be in the next release.
 
-### TODO (high priority)
-
-* Eclipse: create plugin to enumerate repositories and delegate cloning to EGit
-* Manager: support federation RPCs
-* Manager: redesign ref indicators in log, search, and activity views to support multiple local branches, remote branches, and tags
-
-### TODO (medium priority)
-
-* Gitblit: editable settings page in GO/WAR
-* Gitblit: Clone Repository feature (issue 5)
+* Integrate an SSH daemon to complete the transport trifecta: http/https, git, and ssh
+* GitHub-style Pull Requests or Gerrit-style Patchsets (issue 215)
+* Clone/Mirror Repository feature (issue 5)
     * optional scheduled pulls
     * optional automatic push to origin/remotes?
     * optional manual push to origin/remotes?
-* Gitblit: Repository regex substitutions should be stored in .git/.config, not gitblit.properties
-
-### IDEAS
-
-* Gitblit: GitHub-style Pull Requests or Gerrit-style Patchsets
-* Gitblit: Re-use the EGit branch visualization table cell renderer as some sort of servlet
-* Gitblit: diff should highlight inserted/removed fragment compared to original line
-* Gitblit: respect Gerrit branch permissions
-* Gitblit: Consider creating more Git model objects and exposing them via the JSON RPC interface to allow inspection/retrieval of Git commits, Git trees, etc from Gitblit.
-* Gitblit: Blame coloring by author (issue 2)
+* Re-use the EGit branch visualization table cell renderer as some sort of servlet (issue 194)
+* Diff should highlight inserted/removed fragment compared to original line
+* Respect Gerrit branch permissions, if found (issue 36)
+* Repository regex substitutions should be stored in .git/.config, not gitblit.properties
+* Editable settings page in GO/WAR
+* Create Eclipse plugin to enumerate repositories and delegate cloning to EGit

src/site/setup_authentication.mkd

@@ -8,6 +8,7 @@ Gitblit supports additional authentication mechanisms aside from it's internal o
 * Windows authentication
 * Redmine auhentication
 * Salesforce.com authentication
+* Servlet container authentication
 
 ### LDAP Authentication
 *SINCE 1.0.0*
@@ -77,25 +78,48 @@ You can start Gitblit GO with an in-memory LDAP server by specifying the *--ldap
 
 ### Windows Authentication
 
+Windows authentication is based on the use of Waffle and JNA.  It is known to work properly for authenticating against the local Windows machine, but it is unclear if it works properly with a domain controller and Active Directory.  To use this service, your Gitblit server must be installed on a Windows machine.
+
+    realm.userService = com.gitblit.WindowsUserService
+    realm.windows.defaultDomain =
+
 ### Redmine Authentication
 
+You may authenticate your users against a Redmine installation as long as your Redmine install has properly enabled [API authentication](http://www.redmine.org/projects/redmine/wiki/Rest_Api#Authentication).  This user service only supports user authentication; it does not support team creation based on Redmine groups.  Redmine administrators will also be Gitblit administrators.
+
+    realm.userService = com.gitblit.RedmineUserService
+    realm.redmine.url = http://example.com/redmine
+
 ### Salesforce.com Authentication
 
+You may authenticate your users against Salesforce.com.  You can require that user's belong to a particular organization by specifying a non-zero organization id.
+
+    realm.userService = com.gitblit.SalesforceUserService
+    realm.salesforce.orgId = 0
+
+### Container Authentication
+
+If you are using the WAR variant and deploying into your own servlet container which has a pre-defined authentication mechanism protecting the Gitblit webapp, then you may instruct Gitblit to automatically create Gitblit accounts for container-authenticated user principals.
+
+    realm.container.autoCreateAccounts = true
+
 ## Custom Authentication
+
 This is the simplest choice where you implement custom authentication and delegate all other standard user and team operations to one of Gitblit's user service implementations.  This choice insulates your customization from changes in User and Team model classes and additional API that may be added to IUserService.
 
-Please subclass [com.gitblit.GitblitUserService](https://github.com/gitblit/gitblit/blob/master/src/com/gitblit/GitblitUserService.java) and override the *setup()* and *authenticate()* methods.  
+Please subclass [com.gitblit.GitblitUserService](https://github.com/gitblit/gitblit/blob/master/src/main/java/com/gitblit/GitblitUserService.java) and override the *setup()* and *authenticate()* methods.  
 Make sure to set the *serviceImpl* field in your *setup()* method.
 
 You may use your subclass by specifying its fully qualified classname in the *realm.userService* setting.
 
 Your subclass must be on Gitblit's classpath and must have a public default constructor.  
 
 ### Custom Everything
-Instead of maintaining a `users.conf` or `users.properties` file, you may want to integrate Gitblit into an existing environment.
+
+Instead of maintaining a `users.conf` file, you may want to integrate Gitblit into an existing environment.
 
 You may use your own custom *com.gitblit.IUserService* implementation by specifying its fully qualified classname in the *realm.userService* setting.
 
 Your user service class must be on Gitblit's classpath and must have a public default constructor.  
-Please see the following interface definition [com.gitblit.IUserService](https://github.com/gitblit/gitblit/blob/master/src/com/gitblit/IUserService.java).
+Please see the following interface definition [com.gitblit.IUserService](https://github.com/gitblit/gitblit/blob/master/src/main/java/com/gitblit/IUserService.java).
 

src/site/setup_proxy.mkd

@@ -65,3 +65,27 @@ ProxyPreserveHost On
     4. Set *web.mountParameters=false* in `gitblit.properties` or `web.xml` this will use parameterized URLs.  
     Alternatively, you can respecify *web.forwardSlashCharacter*.
 
+### Controlling Advertised Repository URLs
+
+In some reverse-proxy configurations you may be running Gitblit using an http interface with an https reverse-proxy proxy.  This will lead to Gitblit generating incorrect repository urls.
+
+You can control the url that Gitblit generates by setting X-Forwarded headers in your proxy server.
+
+*X-Forwarded-Proto*://servername(:*X-Forwarded-Port*)(/*X-Forwarded-Context*)
+
+---X:MEDIAWIKI---
+{| class="table table-bordered"
+! Header
+! Description
+|-
+| X-Forwarded-Port
+| The port to use in generated repository http/https urls
+|-
+| X-Forwarded-Proto
+| The protocol/scheme to use in generated repository http/https urls
+|-
+| X-Forwarded-Context
+| The context to use in generated repository http/https urls
+|}
+---X:MEDIAWIKI---
+

src/site/setup_viewer.mkd

@@ -0,0 +1,47 @@
+## Gitblit as a Viewer
+
+Gitblit is designed to be a complete Git server solution, however you may already have a Git serving solution such as ssh+gitolite or Gerrit.  For these scenarios, you may configure Gitblit to be just a repository viewer.
+
+### Lock-down your Viewer
+
+Here is an example configuration that disables all administration, all Git serving features, and requires an authenticated user to view anything.
+
+    git.repositoriesFolder = ${baseFolder}/git
+    git.cacheRepositoryList = true
+    git.searchRepositoriesSubfolders = true
+    git.searchRecursionDepth = -1
+    git.searchExclusions =
+    git.daemonPort = 0
+    git.enableGitServlet = false
+    git.enableGarbageCollection = false
+    git.defaultAccessRestriction = VIEW
+    web.authenticateViewPages = true
+    web.allowAdministration = false
+    web.enableRpcServlet = false
+    web.enableRpcManagement = false
+    web.enableRpcAdministration = false
+    web.allowForking = false
+
+###  Tomcat or Reverse-Proxy Servers
+
+If you are running Gitblit on a Tomcat-based container you will likely run into forward-slash character troubles.
+
+To resolve this either set:
+
+    web.mountParameters = false
+
+or
+
+    web.forwardSlashCharacter = !
+
+
+### Advertised Repository Urls
+
+You may also want to advertise repository urls for your other Git serving solution from Gitblit.
+
+- *{0}* is the token for the repository name
+- *{1}* is the token for the username
+
+The username is only practical if you have setup the account names for your other git serving solution to match the Gitblit account.
+
+    web.otherUrls = ssh://localhost/git/{0} git://localhost:29418/git/{0} https://{1}@localhost/r/{0}