Documentation.

James Moger

2011-12-27 6f46fa34d3078399acaa962a89900ac5db3a6116

Documentation.

 docs/00_index.mkd

@@ -20,8 +20,8 @@
        <tr><th>Discussion</th><td><a href="http://groups.google.com/group/gitblit">Gitblit Group</a></td></tr>

        <tr><th>Google+</th><td><a href="https://plus.google.com/114464678392593421684">Gitblit+</a></td></tr>

        <tr><th>Ohloh</th><td><a target="_top" href="http://www.ohloh.net/p/gitblit"><img border="0" width="100" height="16" src="http://www.ohloh.net/p/gitblit/widgets/project_thin_badge.gif" alt="Ohloh project report for Gitblit" /></a></td></tr>

        <tr><th>Donations</th><td>If you enjoy Gitblit and want to support it's development, please consider making a donation on behalf of Gitblit to <a href="https://www.helpmegivetostjude.org/gitblit">St. Jude Children's Research Hospital</a>.

        <a href="https://www.helpmegivetostjude.org/gitblit" alt="St. Jude Children's Research Hospital"><img style="padding-top:10px;" src="stjude_150x150.gif"/></a></td></tr>

        <tr><th>Donations</th><td>If you enjoy Gitblit and want to support its development, please consider making a donation to <a href="http://www.helpmegivetostjude.org/gitblit">St. Jude Children's Research Hospital</a>.

        <a href="http://www.helpmegivetostjude.org/gitblit" alt="St. Jude Children's Research Hospital"><img style="padding-top:10px;" src="stjude_150x150.gif"/></a></td></tr>

        </tbody>

        </table>

    </div>


 docs/03_faq.mkd

@@ -119,13 +119,17 @@
**NOTE:**  

Care must be taken to preserve the relationship between user roles and repository names.<br/>Please see the *User Roles* section of the [setup](/setup.html) page for details.



### Can I restrict access to paths within a repository?

No.  Access restrictions apply to the repository as a whole.

### Can I restrict access to branches or paths within a repository?

No, not out-of-the-box.  Access restrictions apply to the repository as a whole.



Gitblit'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).

Gitblit'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 writing a Groovy *prereceive* script to block updating branch refs based on some permissions file.  I would be interested in a generic, re-usable script to include with Gitblit, should someone want to implement it.



Alternatively, you could use [gitolite](https://github.com/sitaramc/gitolite) and SSH for your repository access.



### Can I authenticate users against XYZ?

Yes.  The user service is pluggable.  You may write your own user service by implementing the *com.gitblit.IUserService* interface.  Set the fully qualified classname as the *realm.userService* property.

Yes.  The user service is pluggable.  You may write your own complete user service by implementing the *com.gitblit.IUserService* interface.  Or you may subclass *com.gitblit.GitblitUserService* and override just the authentication. Set the fully qualified classname as the *realm.userService* property.



### Why doesn't Gitblit support SSH?

Gitblit could integrate [Apache Mina][mina] to provide SSH access.  However, doing so violates Gitblit's first design principle: [KISS](http://en.wikipedia.org/wiki/KISS_principle).<br/>


 docs/04_design.mkd

@@ -1,7 +1,7 @@
## Design Principles

1. [Keep It Simple, Stupid](http://en.wikipedia.org/wiki/KISS_principle)

2. Offer useful features for serving Git repositories.  If feature is complex, refer to #1.

3. All dependencies must be retrievable from a publicly accessible [Maven](http://maven.apache.org) repository.<br/>This is to ensure authenticity of dependencies, to keep the Gitblit GO distribution svelte, and to automate the setup of developer environments.  
3. All dependencies must be retrievable from a publicly accessible [Maven](http://maven.apache.org) repository.<br/>This is to ensure authenticity of dependencies and to automate the setup of developer environments.  


## Architecture




 docs/05_roadmap.mkd

@@ -12,7 +12,6 @@
### TODO (medium priority)



* Gitblit: editable settings page in GO/WAR

* Gitblit: tag repositories and offer views of repositories by tag (issue 27)

* Gitblit: investigate create-repository-on-push.

    * Maybe a new user role to allow this?

    * Maybe a server setting to disable this completely?