From 6f46fa34d3078399acaa962a89900ac5db3a6116 Mon Sep 17 00:00:00 2001 From: James Moger Date: Tue, 27 Dec 2011 17:31:50 -0500 Subject: [PATCH] Documentation. --- docs/00_index.mkd | 4 ++-- docs/03_faq.mkd | 12 ++++++++---- docs/04_design.mkd | 2 +- docs/05_roadmap.mkd | 1 - 4 files changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/00_index.mkd b/docs/00_index.mkd index 5060ca1c..bee0635e 100644 --- a/docs/00_index.mkd +++ b/docs/00_index.mkd @@ -20,8 +20,8 @@ DiscussionGitblit Group Google+Gitblit+ OhlohOhloh project report for Gitblit - DonationsIf you enjoy Gitblit and want to support it's development, please consider making a donation on behalf of Gitblit to St. Jude Children's Research Hospital. - + DonationsIf you enjoy Gitblit and want to support its development, please consider making a donation to St. Jude Children's Research Hospital. + diff --git a/docs/03_faq.mkd b/docs/03_faq.mkd index 8b08e19a..0d41f623 100644 --- a/docs/03_faq.mkd +++ b/docs/03_faq.mkd @@ -119,13 +119,17 @@ Yes. You can manually manipulate all of them and (most) changes will be immedia **NOTE:** Care must be taken to preserve the relationship between user roles and repository names.
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).
diff --git a/docs/04_design.mkd b/docs/04_design.mkd index e16a9b11..d4ddbc93 100644 --- a/docs/04_design.mkd +++ b/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.
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.
This is to ensure authenticity of dependencies and to automate the setup of developer environments. ## Architecture diff --git a/docs/05_roadmap.mkd b/docs/05_roadmap.mkd index 9be6372e..bb7aaad9 100644 --- a/docs/05_roadmap.mkd +++ b/docs/05_roadmap.mkd @@ -12,7 +12,6 @@ This list is volatile. ### 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? -- 2.39.5