From df157e72b57cf6c5272ff2c3d6af1adbc1ad7e68 Mon Sep 17 00:00:00 2001 From: Sitaram Chamarty Date: Fri, 4 Feb 2011 09:20:34 +0530 Subject: [PATCH] gitweb doc fixes This patch is dedicated to the person who, when referred to [1] for gitweb access help, assumed we're talking about a Unix userid called "gitweb" and said it still doesn't work. He looked at the description examples and wasn't sure what to do with them. Finally, he missed the sentence "All gitolite does is:" in the document, and assumed *he* was supposed to do what the next 3 bullets said (in this case, create the "description" file manually). He didn't once think of the gitolite.conf file as being the location for these instructions, or that "give read access" means "R = ..." instead of a Unix level "chmod ...". Do things have to be spelled out so goddamn clearly? Can't people think for a few seconds and see if there is another way before giving up? I blame the prevalence of Windows and GUI IDEs. People can only "click". They can't "think" anymore... [1]: http://sitaramc.github.com/gitolite/doc/2-admin.html#gwd --- doc/2-admin.mkd | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/doc/2-admin.mkd b/doc/2-admin.mkd index ebc1a4d..a1da52b 100644 --- a/doc/2-admin.mkd +++ b/doc/2-admin.mkd @@ -278,23 +278,30 @@ This is a feature that I personally do not use (corporate environments don't like unauthenticated access of any kind to any repo!), but someone wanted it, so here goes. -Gitolite defines two "special" usernames: `daemon` and `gitweb`. +Gitolite has two pre-defined, "special", usernames: `daemon` and `gitweb`. To make a repo or repo group accessible via "git daemon", just give read permission to the special user "daemon". Similarly, give read permission to -`gitweb` to allow the gitweb CGI to show the repo. +`gitweb` to allow the gitweb CGI to show the repo. Something like this: -This gives you a quick way to offer multiple repos up for gitweb/daemon + repo foo bar baz + R = gitweb daemon + +This gives you a quick way to offer multiple repos up for gitweb and/or daemon access. However, setting a description for the project also enables gitweb permissions -so you may as well use that method and kill two birds with one stone, like so: +so you can do it that way if you want. Of course in this case you have to +deal with each repo separately. Add lines like this to gitolite.conf: - gitolite = "fast, secure, access control for git in a corporate environment" + foo = "some description" + bar = "some other description" + baz = "yet another description" -You can also specify an owner for gitweb to show, if you like: +You can also specify an owner for gitweb to show, if you like; for example I +might use: - gitolite "Sitaram Chamarty" = "fast, secure, access control for git in a corporate environment" + gitolite "Sitaram Chamarty" = "fast, secure, fine-grained, access control for git" Note that gitolite does **not** install or configure gitweb/git-daemon -- that is a one-time setup you must do separately. All gitolite does is: