Browse Source

Documentation.

tags/v0.5.0
James Moger 13 years ago
parent
commit
56c549e384
3 changed files with 13 additions and 8 deletions
  1. 5
    5
      docs/00_index.mkd
  2. 1
    1
      docs/00_setup.mkd
  3. 7
    2
      docs/01_faq.mkd

+ 5
- 5
docs/00_index.mkd View File

@@ -2,7 +2,7 @@
Git:Blit 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 Version
### Current Release
[%VERSION%](http://gitblit.com/%DISTRIBUTION%) based on [%JGIT%][jgit]   (*%BUILDDATE%*)
@@ -27,11 +27,12 @@ sources @ [Github][gitbltsrc]
</ul>
- Gitweb inspired UI
- Administrators may create, edit, rename, or delete repositories through the web UI
- Administrators may create, edit, or delete users 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
- Dates can optionally be displayed using the browser''s reported timezone
- Dates can optionally be displayed using the browser's reported timezone
- Author and Committer email address display can be controlled
- Realtime zip downloads feature
- Markdown view support
- Syntax highlighting
- Customizable regular expression handling for commit messages
@@ -56,7 +57,6 @@ sources @ [Github][gitbltsrc]
- users.properties access
- available repositories
- etc
- Download zip feature
- Site documentation
- Code documentation
- Unit testing
@@ -68,7 +68,7 @@ sources @ [Github][gitbltsrc]
- View images on Blob page
- View other binary files on Blob page
- Markdown editing feature
- Blame feature (waiting for the [JGit][jgit] team to do the hard part)
- Blame (waiting for the [JGit][jgit] team to do the hard part)
### License
TBD

+ 1
- 1
docs/00_setup.mkd View File

@@ -48,7 +48,7 @@ Usernames must be unique and are case-insensitive.<br/>
Whitespace is illegal.
#### Passwords
User passwords are CASE-SENSITIVE and may be *plain*, *md5*, or *crypt* formatted (see `gitblit.properties` -> *realm.passwordStorage*).
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.

+ 7
- 2
docs/01_faq.mkd View File

@@ -16,9 +16,14 @@ No. Git:Blit stores its repository configuration information within the `.git/c
### I want to deploy Git:Blit 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).
### 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/>
SSH supports requires creating, exchanging, and managing SSH keys. While this is doable, its not simple like JGit's SmartHTTP implementation.
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).
@@ -34,7 +39,7 @@ Alternatively, you could enable the search type dropdown list in your `gitblit.p
### How do I run Git:Blit 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) or 8443 (https).
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"

Loading…
Cancel
Save