Add some brief documentation to the configuration file.

diff --git a/gitosis.conf b/gitosis.conf
index 5262dca..a3f0198 100644 (file)
--- a/gitosis.conf
+++ b/gitosis.conf
@@ -1,3 +1,22 @@
+# UCC gitosis git repository configuration
+# Do not edit this file except under git version control
+# 
+# To add a new repository, make sure that all users have a $USERNAME.key
+# in keydir/ . Then create a new group:
+# [group $yourgroupname]
+# writable = $reponame
+# members = $user1 $user2
+#
+# Commit and push the changes using git, and then the user should run
+# git push [email protected]:$reponame.git
+# to export their changes to here.
+#
+# To be visible in gitweb, a section for the repository must be added,
+# and an export flag set, like this:
+# [repo $reponame]
+# daemon = yes
+# owner = $repomastername
+
 [gitosis]
 
 [group gitosis-admin]