summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJames Moger <james.moger@gitblit.com>2011-05-25 16:21:17 -0400
committerJames Moger <james.moger@gitblit.com>2011-05-25 16:21:17 -0400
commitf13c4c5a35a18d8478b276cc44570bbc3398aa73 (patch)
tree34d2144ed5a518422afbbc17c55de3c07e639d3e /docs
parent56c549e384b1a648c77bbd09a2cc77976e8a64de (diff)
downloadgitblit-f13c4c5a35a18d8478b276cc44570bbc3398aa73.tar.gz
gitblit-f13c4c5a35a18d8478b276cc44570bbc3398aa73.zip
Selected Apache License. Dropped : from name. Its simpler.
Diffstat (limited to 'docs')
-rw-r--r--docs/00_index.mkd21
-rw-r--r--docs/00_setup.mkd8
-rw-r--r--docs/01_eclipse.mkd6
-rw-r--r--docs/01_faq.mkd32
-rw-r--r--docs/page_header.html2
5 files changed, 36 insertions, 33 deletions
diff --git a/docs/00_index.mkd b/docs/00_index.mkd
index b5a04163..703d8eb4 100644
--- a/docs/00_index.mkd
+++ b/docs/00_index.mkd
@@ -1,5 +1,5 @@
## Overview
-Git:Blit is an open-source, integrated pure Java stack for managing, viewing, and serving [Git][git] repositories.
+Gitblit 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 Release
@@ -9,9 +9,9 @@ Its designed primarily as a tool for small workgroups who want to host [Git][git
sources @ [Github][gitbltsrc]
### Design Principles
-1. [KISS](http://en.wikipedia.org/wiki/KISS_principle)
+1. [Keep It Simple, Stupid](http://en.wikipedia.org/wiki/KISS_principle)
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 Git:Blit distribution svelte.
+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
@@ -32,7 +32,7 @@ sources @ [Github][gitbltsrc]
- Automatically generates a self-signed certificate for https communications
- Dates can optionally be displayed using the browser's reported timezone
- Author and Committer email address display can be controlled
-- Realtime zip downloads feature
+- Dynamic zip downloads feature
- Markdown view support
- Syntax highlighting
- Customizable regular expression handling for commit messages
@@ -49,15 +49,14 @@ sources @ [Github][gitbltsrc]
- 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
-- Git:Blit is an integrated, full-stack solution. There is no WAR build at this time.
+- Gitblit is an integrated, full-stack solution. There is no WAR build at this time.
### Todo List
-- Review spots where Git:Blit can cache data instead of abusing the disk
+- Review spots where Gitblit can cache data instead of abusing the disk
- stats
- users.properties access
- available repositories
- etc
-- Site documentation
- Code documentation
- Unit testing
@@ -71,7 +70,7 @@ sources @ [Github][gitbltsrc]
- Blame (waiting for the [JGit][jgit] team to do the hard part)
### License
-TBD
+Licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
### Inspirations
- [Gitweb](http://www.git-scm.com)
@@ -82,7 +81,7 @@ TBD
![block diagram](architecture.png "Git Blit Architecture")
### Bundled Dependencies
-The following dependencies are bundled with the Git:Blit zip distribution file.
+The following dependencies are bundled with the Gitblit zip distribution file.
- [google-code-prettify](http://code.google.com/p/google-code-prettify) (Apache 2.0)
- [JavaService](http://forge.ow2.org/projects/javaservice) (BSD and LGPL)
@@ -91,7 +90,7 @@ The following dependencies are bundled with the Git:Blit 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 Git:Blit is launched for the first time.
+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.
- [JGit][jgit] (EDL 1.0)
- [Wicket](http://wicket.apache.org) (Apache 2.0)
@@ -117,7 +116,7 @@ The following dependencies are automatically downloaded from the Apache Maven re
4. Select your gitblit project root and **Refresh** the project, this should correct all build problems.
5. Review the settings in `gitblit.properties` in your project root.<br/>
Make sure you set an appropriate value for *git.repositoriesFolder*.
-6. Execute the *com.gitblit.Launcher* class to start Git:Blit.
+6. Execute the *com.gitblit.Launcher* class to start Gitblit.
[jgit]: http://eclipse.org/jgit "Eclipse JGit Site"
[git]: http://git-scm.com "Official Git Site"
diff --git a/docs/00_setup.mkd b/docs/00_setup.mkd
index 8d7da672..447f1515 100644
--- a/docs/00_setup.mkd
+++ b/docs/00_setup.mkd
@@ -1,6 +1,6 @@
## Setup and Configuration
-1. Download and unzip [%VERSION%](http://gitblit.com/%DISTRIBUTION%).<br/>
+1. Download and unzip [Gitblit %VERSION%](http://gitblit.com/%DISTRIBUTION%).<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:
@@ -51,7 +51,7 @@ Whitespace is illegal.
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.
+There is only one actual *role* in Gitblit 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.
### Creating your own Self-Signed Certificate
@@ -59,8 +59,8 @@ Review the contents of the `makekeystore.cmd` or `makekeystore_jdk.cmd` script a
**NOTE:** The certificate password AND the keystore password must match!
### Running as a Service
-Review the contents of the `installService.cmd` or `installService64.cmd`, as appropriate for your JVM.<br/>
-Set the *JDK* variable in the script to the location of your JDK, add any necessary start parameters, and execute the script.
+Review the contents of the `installService.cmd` or `installService64.cmd`, as appropriate for your installed Java Virtual Machine.<br/>
+Set the *JVM* variable in the script to the location of your Java Virtual Machine, add any necessary start parameters, and execute the script.
#### Command-Line Parameters
--tempFolder Server temp folder
diff --git a/docs/01_eclipse.mkd b/docs/01_eclipse.mkd
index c04834c5..e768b73a 100644
--- a/docs/01_eclipse.mkd
+++ b/docs/01_eclipse.mkd
@@ -1,17 +1,17 @@
## Eclipse Tips
### Do Not Verify Self-Signed Certificates
-If you are using a self-signed certificate, like the one that is automatically generated by Git:Blit, you have to tell Eclipse/EGit to ignore certificate verification errors.
+If you are using a self-signed certificate, like the one that is automatically generated by Gitblit, you have to tell Eclipse/EGit to ignore certificate verification errors.
![sslverify](sslverify.png "http.sslVerify setting")
![sslverify2](sslverify2.png "Adding http.sslVerify setting")
-### Pushing a New Project to a New Git:Blit Repository
+### Pushing a New Project to a New Gitblit Repository
1. Project Root->Team->Share->Git
Create a Git repository inside the project
-### Pushing a Git-Controlled Project to another Git:Blit Repository
+### Pushing a Git-Controlled Project to another Gitblit Repository
1. Project Root->Team->Remote->Push
2. Enter the URL information of the repository
3. In the Refspec dialog click the buttons named "All all branches spec" and "All all tags spec"
diff --git a/docs/01_faq.mkd b/docs/01_faq.mkd
index f76cf6ed..86aa9ad2 100644
--- a/docs/01_faq.mkd
+++ b/docs/01_faq.mkd
@@ -1,34 +1,37 @@
## Frequently Asked Questions
-### Git:Blit? What kind of name is that?
+### Gitblit? What kind of name is that?
Its a phonetic play on [bitblt][bitblt] which is an image processing operation meaning *bit-block transfer*.
-### Why use Git:Blit?
+### Why use Gitblit?
Its small. Its portable. Its easy to manage.
### 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.
-### Does Git:Blit use a database to store its data?
-No. Git:Blit 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`.
+### 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 Git:Blit into my own servlet container. Where is the WAR?
+### 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`.
+
+### I want to deploy Gitblit 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).
+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 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/>
+### 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 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).
-### What types of Search does Git:Blit support?
-Git:Blit supports case-insensitive searches of *commit message* (default), *author*, and *committer*.<br/>
+### 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:
@@ -37,11 +40,12 @@ To search by *author* or *committer* use the following syntax in the search box:
Alternatively, you could enable the search type dropdown list in your `gitblit.properties` file.
-### How do I run Git:Blit on port 80 or 443 in Linux?
+### 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).
[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"
-[mina]: http://mina.apache.org " Apache Mina" \ No newline at end of file
+[mina]: http://mina.apache.org "Apache Mina"
+[bouncycastle]: http://bouncycastle.org "The Legion of the Bouncy Castle" \ No newline at end of file
diff --git a/docs/page_header.html b/docs/page_header.html
index 5768fffd..fd40c5a2 100644
--- a/docs/page_header.html
+++ b/docs/page_header.html
@@ -1,7 +1,7 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
- <title>Git:Blit</title>
+ <title>Gitblit</title>
<link rel="stylesheet" type="text/css" href="./gitblit.css"/>
<link rel="stylesheet" type="text/css" href="./markdown.css"/>
<link rel="shortcut icon" type="image/png" href="./gitblt-favicon.png" />