aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRalf Jung <post@ralfj.de>2015-07-19 11:48:25 +0200
committerRalf Jung <post@ralfj.de>2015-07-19 11:48:25 +0200
commitfb62ddc8232972e0d22a4fd512343b34e1bdfd50 (patch)
tree1ceedc6cb74be0a254fce08f727be9da65348d54
parent64ee17d3794aeb781203968d805ef8ab1963d871 (diff)
some more README work
-rw-r--r--README.rst13
1 files changed, 8 insertions, 5 deletions
diff --git a/README.rst b/README.rst
index 2518498..3842308 100644
--- a/README.rst
+++ b/README.rst
@@ -102,12 +102,12 @@ found.``.
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 shouldalso configure a shared HMAC secret, such that the webhook can verify
+one should also configure a shared HMAC secret, such that the webhook can verify
that the data indeed comes from GitHub.
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
-has not yet been configure for git-mirror, neither locally nor remotely.
+has not yet been configured for git-mirror at all.
To give the script access to your repositories, you need to create an access
token for it. Go to "Personal Access Tokens" in your GitHub configuration, and
@@ -120,12 +120,15 @@ below ``mail-sender``)::
Now you can call the automatic setup script as follows::
- ./github-add-hooks.py -o UserName -e email@example.com -l ~/repositories/repo-name.git/ -n github-repo-name
+ ./github-add-hooks.py -o UserName -e email@example.com \
+ -l ~/repositories/repo-name.git/ -n github-repo-name
Notice that the username is case-sensitive! This will do all the setup on the
GitHub side, and it will add an appropriate configuration block to your local
-``git-mirror.conf``. You will still have to manually add the local git hook to
-gitolite.
+``git-mirror.conf``. You still have to manually add the local git hook to
+gitolite. Once you are done, any push happening to 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.
Source, License
---------------