Merge pull request #3 from damien-list/master

[git-mirror.git] / README.md

diff --git a/README.md b/README.md
index 31f2d93c8d1979f71303b1aa05c2c5bb5c13f501..6bcf71ccb5d39dd455af5a6aa682abc1b7ec2cad 100644 (file)
--- a/README.md
+++ b/README.md
@@ -32,6 +32,9 @@ repository, so enable the following line in `/home/git/.gitolite.rc`:
 Make sure you read the [security note](http://gitolite.com/gitolite/non-core.html#pushcode)
 concerning this configuration.
 
+Furthermore, uncomment the `repo-specific-hooks` line in the rc file or add it
+to the `ENABLE` list if it doesn't exist.
+
 Now add a file called `local/hooks/repo-specific/git-mirror` to your 
 `gitolite-admin` repository, make it executable, and give it the following
 content:
@@ -95,7 +98,8 @@ The next step is to add this as a webhook to the GitHub repository you want to
 sync with, to create a fresh SSH key and configure it as deployment key for the 
 repository, and to configure git-mirror accordingly. For additional security, 
 one should also configure a shared HMAC secret, such that the webhook can verify 
-that the data indeed comes from GitHub.
+that the data indeed comes from GitHub.  On the git-mirror side, the HMAC secret
+is configured with the `hmac-secret` repository option.
 
 To make your job easier, there is a script `github-add-hooks.py` that can do 
 all this for you. It assumes that the repository exists on the GitHub side, but 
@@ -123,6 +127,10 @@ either gitolite or GitHub will be visible on the other side
 immediately. This applies even to pull requests that you merge in the
 GitHub web interface.
 
+The script will only sync branches when they get pushed to. To initialize the
+GitHub repository with all the branches that already exist, you can do `git push
+--all git@github.com:user/repo`.
+
 ## Source, License
 
 You can find the sources in the [git