diff --git a/doc/1-migrate.mkd b/doc/1-migrate.mkd index 045946c..ca520c6 100644 --- a/doc/1-migrate.mkd +++ b/doc/1-migrate.mkd @@ -53,13 +53,13 @@ Here's how we migrated my work repos: cp ~/repositories/gitosis-admin.git/gitosis-export/keydir/* keydir -9. **Important: expand** any multi-key filess you may have. See the "faq, +9. **Important: expand** any multi-key files you may have. See the "faq, tips, etc" document in the doc directory for an explanation of what multi-keys are, how gitosis does them and how gitolite does it differently. You can split the keys manually, or use the following code (just - copy-paste it into you xterm): + copy-paste it into your xterm): wc -l keydir/*.pub | grep -v total | grep -v -w 1 | while read a b do @@ -69,7 +69,7 @@ Here's how we migrated my work repos: echo "$l" > ${b%.pub}@$i.pub (( i++ )) done - v $b $b.done + mv $b $b.done done This will split each multi-key file (say "sitaram.pub") into individual diff --git a/doc/2-admin.mkd b/doc/2-admin.mkd index 8c9ae56..7f1c507 100644 --- a/doc/2-admin.mkd +++ b/doc/2-admin.mkd @@ -1,16 +1,22 @@ # administering and running gitolite +Note: some of the paths in this document use variable names. Just refer to +`~/.gitolite.rc` for the correct values, assuming you followed the +instructions in the "INSTALL" document. + ### administer * ask each user who will get access to send you a public key. See other sources (for example - [here](http: /sitaramc.github.com/0-installing/2-access-gitolite.html#generating_a_public_key)) + [here](http://sitaramc.github.com/0-installing/2-access-gitolite.html#generating_a_public_key)) for how to do this - * for each "user" in `$GL_CONF`, copy their public key to a file called - "user.pub" in `$GL_KEYDIR`. For example, mine would be called - "sitaram.pub" - * edit the config file (`$GL_CONF`) to add the new users in whatever way you - like + * rename each public key according to the user's name, with a `.pub` + extension, like `sitaram.pub` or `john-smith.pub`. You can also use + periods and underscores + * copy all these `*.pub` files to `$GL_KEYDIR` + * edit the config file (`$GL_CONF`) and give the new users permissions as + required. The users names should be exactly the same as their keyfile + names, but without the `.pub` extension * backup your `~/.ssh/authorized_keys` file if you feel nervous :-) * cd to `$GL_ADMINDIR` and run `src/gl-compile-conf` @@ -18,7 +24,7 @@ That should be it, really. However, if you want to be doubly sure, or maybe the first couple of times you use it, you may want to check these: * check the outputs - + * `~/.ssh/authorized_keys` should contain one line for each "user" pub key added, between two "marker" lines (which you should please please not remove!). The line should contain a "command=" pointing to a diff --git a/doc/3-faq-tips-etc.mkd b/doc/3-faq-tips-etc.mkd index bd66101..d7b3994 100644 --- a/doc/3-faq-tips-etc.mkd +++ b/doc/3-faq-tips-etc.mkd @@ -69,7 +69,7 @@ those keys. #### who am I? -As a developer, I send a file called "id_rsa.pub" to the gitolite admin. He +As a developer, I send a file called `id_rsa.pub` to the gitolite admin. He would rename it to "sitaram.pub" and put it in the key directory. Then he'd add "sitaram" to the config file for the repos which I have access to.