James Moger
2011-06-28 d39680e9f54322ddcb40b00503a8ee30aee6c99c
commit | author | age
85c2e6 1 ## Gitblit Features
JM 2 - JGit SmartHTTP servlet
3 - Browser and git client authentication
4 - Four repository access control configurations with a Read-Only control flag
5     <ul class='noBullets'>
6     <li>![anonymous](blank.png) *Anonymous View, Clone & Push*</li>
7     <li>![push](lock_go_16x16.png) *Authenticated Push*</li>
8     <li>![clone](lock_pull_16x16.png) *Authenticated Clone & Push*</li>
9     <li>![view](shield_16x16.png) *Authenticated View, Clone & Push*</li>
10     <li>![freeze](cold_16x16.png) Freeze repository (i.e. deny push, make read-only)
11     </ul>
12 - Gitweb inspired web UI
13 - Administrators may create, edit, rename, or delete repositories through the web UI
14 - Administrators may create, edit, rename, or delete users through the web UI
15 - Repository Owners may edit repositories through the web UI
16 - Git-notes support
17 - Branch metrics (uses Google Charts)
18 - HEAD and Branch RSS feeds
19 - Blame annotations view
20 - Dates can optionally be displayed using the browser's reported timezone
21 - Display of Author and Committer email addresses can be disabled
22 - Case-insensitive searching of commit messages, authors, or committers
23 - Dynamic zip downloads feature
24 - Markdown file view support
25 - Syntax highlighting for popular source code types
26 - Customizable regular expression substitution for commit messages (i.e. bug or code review link integration)
27 - Single text file for users configuration
28 - Optional utility pages
29     <ul class='noBullets'>
30     <li>![docs](book_16x16.png) Docs page which enumerates all Markdown files within a repository</li>
31     <li>![tickets](bug_16x16.png) Ticgit ticket pages *(based on last MIT release bf57b032 2009-01-27)*</li>
32     </ul>
33
34 ## Gitblit GO Features
35 - Out-of-the-box integrated stack requiring minimal configuration
d39680 36 - Automatically generates a self-signed certificate for *localhost* https communications<br/>(includes script to generate a self-signed certificate for *your hostname*, see [setup](/setup.html) for details)
85c2e6 37 - Single text file for configuring server and gitblit
d39680 38 - A Windows service installation script and configuration tool
85c2e6 39
JM 40 ## Limitations
41 - HTTP/HTTPS are the only supported protocols
42 - Access controls are not path-based, they are repository-based
43 - Only Administrators can create, rename or delete repositories
44 - Only Administrators can create, modify or delete users
d39680 45 - Native Git may be needed to periodically run git-gc as [JGit][jgit] does not fully support the git-gc featureset.
85c2e6 46
JM 47 ### Caveats
48 - Gitblit may eat your data.  Use at your own risk.
49 - Gitblit may have security holes.  Patches welcome.  :)
50
51 ## Todo List
52 - Code documentation
53 - Unit testing
54
55 ### Under Consideration
56 - Clone remote repository feature
57 - Blob page improvements
58     - view images
59     - view other binary files (pdf, doc, etc)
60 - Markdown editing feature
61 - Stronger Ticgit read-only integration
62     - activity/timeline
63     - query feature with paging support
64     - change history
d39680 65 - Ticgit write integration
JM 66
67 [jgit]: http://eclipse.org/jgit "Eclipse JGit Site"