Merge pull request #6 from lemval/master

James Moger

2012-01-31 78dc06a87f82ed19e3eebe1f16dc6c1bdaf5fbc5

 docs/01_features.mkd

@@ -1,19 +1,25 @@
## Gitblit Features

## Standard Features (GO/WAR)

- JGit SmartHTTP servlet

- Browser and git client authentication

- Four *per-repository* access control configurations with a Read-Only control flag

    <ul class='noBullets'>

    <li>![anonymous](blank.png) *Anonymous View, Clone & Push*</li>

    <li>![push](lock_go_16x16.png) *Authenticated Push*</li>

    <li>![clone](lock_pull_16x16.png) *Authenticated Clone & Push*</li>

    <li>![view](shield_16x16.png) *Authenticated View, Clone & Push*</li>

    <li>![freeze](cold_16x16.png) Freeze repository (i.e. deny push, make read-only)

    </ul>

    - ![anonymous](blank.png) *Anonymous View, Clone & Push*

    - ![push](lock_go_16x16.png) *Authenticated Push*

    - ![clone](lock_pull_16x16.png) *Authenticated Clone & Push*

    - ![view](shield_16x16.png) *Authenticated View, Clone & Push*

    - ![freeze](cold_16x16.png) Freeze repository (i.e. deny push, make read-only)

- Ability to federate with one or more other Gitblit instances

- RSS/JSON RPC interface

- Java/Swing Gitblit Manager tool 
- Gitweb inspired web UI

- Administrators may create, edit, rename, or delete repositories through the web UI

- Administrators may create, edit, rename, or delete users through the web UI

- Groovy pre- and post- push hook scripts, per-repository or globally for all repositories

- Email push notifications *(via sendmail.groovy push script)*

- Administrators may create, edit, rename, or delete repositories through the web UI or RPC interface

- Administrators may create, edit, rename, or delete users through the web UI or RPC interface

- Administrators may create, edit, rename, or delete teams through the web UI or RPC interface

- Repository Owners may edit repositories through the web UI

- Git-notes support

- Gravatar integration

- Git-notes display support

- gh-pages display support (Jekyll is not supported)

- Branch metrics (uses Google Charts)

- HEAD and Branch RSS feeds

- Blame annotations view

@@ -26,22 +32,22 @@
- Customizable regular expression substitution for commit messages (i.e. bug or code review link integration)

- Single text file for users configuration

- Optional utility pages

    <ul class='noBullets'>

    <li>![docs](book_16x16.png) Docs page which enumerates all Markdown files within a repository</li>

    <li>![tickets](bug_16x16.png) Ticgit ticket pages *(based on last MIT release bf57b032 2009-01-27)*</li>

    </ul>

    - ![docs](book_16x16.png) Docs page which enumerates all Markdown files within a repository

    - ![tickets](bug_16x16.png) Ticgit ticket pages *(based on last MIT release bf57b032 2009-01-27)*



## Gitblit GO Features

- Out-of-the-box integrated stack requiring minimal configuration

- 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)

- Automatically generates a self-signed certificate for *localhost* https communications  
    (includes script to generate a self-signed certificate for *your hostname*, see [setup](/setup.html) for details)

- Single text file for configuring server and gitblit

- A Windows service installation script and configuration tool



## Limitations

- HTTP/HTTPS are the only supported protocols

- Access controls are not path-based, they are repository-based

- HTTP/HTTPS are the only supported Git protocols

- Built-in access controls are not path-based, they are repository-based.  
- Only Administrators can create, rename or delete repositories

- Only Administrators can create, modify or delete users

- Only Administrators can create, modify or delete teams

- Native Git may be needed to periodically run git-gc as [JGit][jgit] does not fully support the git-gc featureset.



### Caveats