Largely completed, uber-cool federation feature.

James Moger

2011-09-12 831469ba89ea8bca3bfbd1d662dbdd2c9f233798

 docs/01_features.mkd

@@ -1,7 +1,7 @@
## Gitblit Features

- JGit SmartHTTP servlet

- Browser and git client authentication

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

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

@@ -9,6 +9,7 @@
    <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>

- Ability to federate with one or more other Gitblit instances

- 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

@@ -33,32 +34,20 @@


## Gitblit GO Features

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

- Automatically generates a self-signed certificate for https communications

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

- 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

- Only Administrators can create, rename or delete repositories

- Only Administrators can create, modify or delete users

- Commit hooks are not supported

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



### Caveats

- Gitblit may eat your data.  Use at your own risk.

- Gitblit may have security holes.  Patches welcome.  :)



## Todo List

- Code documentation

- Unit testing

- Update to JGit 1.0.0 when JGit team provides Maven artifacts



### Under Consideration

- Clone remote repository feature

- Blob page improvements

    - view images

    - view other binary files (pdf, doc, etc)

- Markdown editing feature

- Stronger Ticgit read-only integration

    - activity/timeline

    - query feature with paging support

    - change history

- Ticgit write integration
[jgit]: http://eclipse.org/jgit "Eclipse JGit Site"