diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/00_index.mkd | 19 | ||||
| -rw-r--r-- | docs/00_setup.mkd | 4 | ||||
| -rw-r--r-- | docs/01_faq.mkd | 19 |
3 files changed, 17 insertions, 25 deletions
diff --git a/docs/00_index.mkd b/docs/00_index.mkd index bcf41e11..7a2bc569 100644 --- a/docs/00_index.mkd +++ b/docs/00_index.mkd @@ -4,7 +4,7 @@ Its designed primarily as a tool for small workgroups who want to host [Git][git ### Current Release
-[%VERSION%](http://gitblit.com/%DISTRIBUTION%) based on [%JGIT%][jgit] (*%BUILDDATE%*)
+%VERSION% ([go](http://gitblit.com/%GO%)|[war](http://gitblit.com/%WAR%)) based on [%JGIT%][jgit] (*%BUILDDATE%*)
sources @ [Github][gitbltsrc]
@@ -13,8 +13,7 @@ sources @ [Github][gitbltsrc] 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](http://maven.apache.org) repository.<br/>This is to ensure authenticity of dependencies and to keep the Gitblit distribution svelte.
-### Features
-- Out-of-the-box integrated stack requiring minimal configuration
+### Gitblit Features
- JGit SmartHTTP servlet
- Browser and git client authentication
- Four repository access control configurations and a Read-Only flag
@@ -29,7 +28,6 @@ sources @ [Github][gitbltsrc] - Administrators may create, edit, rename, or delete repositories 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
- Git-notes support
- Branch metrics (uses Google Charts)
- HEAD and branch RSS feeds
@@ -41,7 +39,6 @@ sources @ [Github][gitbltsrc] - Markdown file view support
- Syntax highlighting for popular source code types
- Customizable regular expression substitution for commit messages (i.e. bug or code review link integration)
-- Single text file for server configuration
- Single text file for users configuration
- Optional utility pages
<ul class='noBullets'>
@@ -49,12 +46,15 @@ sources @ [Github][gitbltsrc] <li> Ticgit ticket pages *(based on last MIT release bf57b032 2009-01-27)*</li>
</ul>
+### Gitblit-Go Features
+- Out-of-the-box integrated stack requiring minimal configuration
+- Automatically generates a self-signed certificate for https communications
+- Single text file for server configuration
+
### Limitations
-- [%JGIT%][jgit] does not currently [garbage collect or repack](http://www.kernel.org/pub/software/scm/git/docs/git-gc.html)
- HTTP/HTTPS are the only supported protocols
- Access controls are not path-based, they are repository-based
- Only Administrators can create, rename or delete repositories
-- Gitblit is an integrated, full-stack solution. There is no WAR build at this time.
### Caveats
- Gitblit may eat your data. Use at your own risk.
@@ -64,7 +64,6 @@ sources @ [Github][gitbltsrc] - Code documentation
- Unit testing
- Update Build.java to JGit 1.0.0, when its released
-- WAR solution
### Idea List
- Consider clone remote repository feature
@@ -90,7 +89,7 @@ Gitblit is distributed under the terms of the [Apache Software Foundation licens 
### Bundled Dependencies
-The following dependencies are bundled with the Gitblit zip distribution file.
+The following dependencies are bundled with Gitblit.
- [google-code-prettify](http://code.google.com/p/google-code-prettify) (Apache 2.0)
- [JavaService](http://forge.ow2.org/projects/javaservice) (BSD and LGPL)
@@ -99,7 +98,7 @@ The following dependencies are bundled with the Gitblit zip distribution file. - 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 Gitblit is launched for the first time.
+The following dependencies are automatically downloaded by Gitblit-Go (or already bundled with the WAR) from the Apache Maven repository and from the Eclipse Maven repository when Gitblit is launched for the first time.
- [JGit][jgit] (EDL 1.0)
- [Wicket](http://wicket.apache.org) (Apache 2.0)
diff --git a/docs/00_setup.mkd b/docs/00_setup.mkd index ccf38b83..02816e7f 100644 --- a/docs/00_setup.mkd +++ b/docs/00_setup.mkd @@ -1,6 +1,6 @@ -## Server Setup and Configuration
+## Gitblit-Go Setup and Configuration
-1. Download and unzip [Gitblit %VERSION%](http://gitblit.com/%DISTRIBUTION%).<br/>
+1. Download and unzip [Gitblit-Go %VERSION%](http://gitblit.com/%GO%).<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 3605387a..552c89d2 100644 --- a/docs/01_faq.mkd +++ b/docs/01_faq.mkd @@ -12,10 +12,10 @@ There are a few ways this can occur: 3. The repository is clone-restricted and your password changed.
4. A regression in Gitblit. :(
-### Why can't I access Gitblit from another machine?
+### Why can't I access Gitblit-Go 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?
+### 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).
@@ -47,22 +47,12 @@ Gitblit eliminates all that complication with its 100% Java stack and simple sin 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.
-### What about periodic Git garbage collection (git-gc)?
-Good question. I'm not sure.
-
-Git repositories grow and grow and periodically need to be repacked every once in a while. Git calls this process [garbage collection](http://www.kernel.org/pub/software/scm/git/docs/git-gc.html) (which is not to be confused with [garbage collection](http://en.wikipedia.org/wiki/Garbage_collection_(computer_science)).)
-
-[JGit's][jgit] documentation is sparse and its unclear whether or not JGit performs this function.
-
### Can I run Gitblit in conjunction with my existing Git tooling?
-Yes. You can configure Gitblit to only be a repository viewer.
+Yes.
### 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.
-### I want to deploy Gitblit into my own servlet container. Where is the WAR?
-At this time there is no WAR build available.
-
### 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`.
@@ -76,6 +66,9 @@ 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).
+### 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.
+
### 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 (arguably not more complicated than managing users). While this is possible, JGit's SmartHTTP implementation is a simpler and universal transport mechanism.
|