Skip to content

Commit 56c549e

Browse files
committed
Documentation.
1 parent 9197d34 commit 56c549e

File tree

3 files changed

+13
-8
lines changed

3 files changed

+13
-8
lines changed

docs/00_index.mkd

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Git:Blit is an open-source, integrated pure Java stack for managing, viewing, and serving [Git][git] repositories.
33
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.
44

5-
### Current Version
5+
### Current Release
66

77
[%VERSION%](http://gitblit.com/%DISTRIBUTION%) based on [%JGIT%][jgit]   (*%BUILDDATE%*)
88

@@ -27,11 +27,12 @@ sources @ [Github][gitbltsrc]
2727
</ul>
2828
- Gitweb inspired UI
2929
- Administrators may create, edit, rename, or delete repositories through the web UI
30-
- Administrators may create, edit, or delete users through the web UI
30+
- Administrators may create, edit, rename, or delete users through the web UI
3131
- Repository Owners may edit repositories through the web UI
3232
- Automatically generates a self-signed certificate for https communications
33-
- Dates can optionally be displayed using the browser''s reported timezone
33+
- Dates can optionally be displayed using the browser's reported timezone
3434
- Author and Committer email address display can be controlled
35+
- Realtime zip downloads feature
3536
- Markdown view support
3637
- Syntax highlighting
3738
- Customizable regular expression handling for commit messages
@@ -56,7 +57,6 @@ sources @ [Github][gitbltsrc]
5657
- users.properties access
5758
- available repositories
5859
- etc
59-
- Download zip feature
6060
- Site documentation
6161
- Code documentation
6262
- Unit testing
@@ -68,7 +68,7 @@ sources @ [Github][gitbltsrc]
6868
- View images on Blob page
6969
- View other binary files on Blob page
7070
- Markdown editing feature
71-
- Blame feature (waiting for the [JGit][jgit] team to do the hard part)
71+
- Blame (waiting for the [JGit][jgit] team to do the hard part)
7272

7373
### License
7474
TBD

docs/00_setup.mkd

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Usernames must be unique and are case-insensitive.<br/>
4848
Whitespace is illegal.
4949

5050
#### Passwords
51-
User passwords are CASE-SENSITIVE and may be *plain*, *md5*, or *crypt* formatted (see `gitblit.properties` -> *realm.passwordStorage*).
51+
User passwords are CASE-SENSITIVE and may be *plain* or *md5* formatted (see `gitblit.properties` -> *realm.passwordStorage*).
5252

5353
#### User Roles
5454
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.

docs/01_faq.mkd

+7-2
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,14 @@ No. Git:Blit stores its repository configuration information within the `.git/c
1616
### I want to deploy Git:Blit into my own servlet container. Where is the WAR?
1717
At this time there is no WAR build available.
1818

19+
### Can I restrict access to paths within a repository?
20+
No. Access restrictions apply to the repository as a whole.
21+
22+
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).
23+
1924
### Why doesn't Git:Blit support SSH?
2025
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/>
21-
SSH supports requires creating, exchanging, and managing SSH keys. While this is doable, its not simple like JGit's SmartHTTP implementation.
26+
SSH support requires creating, exchanging, and managing SSH keys. While this is possible, JGit's SmartHTTP implementation is a simpler and cleaner transport mechanism.
2227

2328
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).
2429

@@ -34,7 +39,7 @@ Alternatively, you could enable the search type dropdown list in your `gitblit.p
3439

3540
### How do I run Git:Blit on port 80 or 443 in Linux?
3641
Linux requires root permissions to serve on ports < 1024.<br/>
37-
Run the server as *root* (security concern) or change the ports you are serving to 8080 (http) or 8443 (https).
42+
Run the server as *root* (security concern) or change the ports you are serving to 8080 (http) and/or 8443 (https).
3843

3944
[bitblt]: http://en.wikipedia.org/wiki/Bit_blit "Wikipedia Bitblt"
4045
[jgit]: http://eclipse.org/jgit "Eclipse JGit Site"

0 commit comments

Comments
 (0)