summaryrefslogtreecommitdiff
path: root/contrib/persistent-https
diff options
context:
space:
mode:
authorJeff King <peff@peff.net>2017-05-31 05:18:04 (GMT)
committerJunio C Hamano <gitster@pobox.com>2017-06-01 01:07:10 (GMT)
commit2c9a2ae285b0806a5f754dcf6064f7cedc7e1fa8 (patch)
tree88127a9d4b5beb5514b0158c7ec2d59e527a8797 /contrib/persistent-https
parentb06d3643105c8758ed019125a4399cb7efdcce2c (diff)
downloadgit-2c9a2ae285b0806a5f754dcf6064f7cedc7e1fa8.zip
git-2c9a2ae285b0806a5f754dcf6064f7cedc7e1fa8.tar.gz
git-2c9a2ae285b0806a5f754dcf6064f7cedc7e1fa8.tar.bz2
docs/config: mention protocol implications of url.insteadOf
If a URL rewrite switches the protocol to something nonstandard (like "persistent-https" for "https"), the user may be bitten by the fact that the default protocol restrictions are different between the two. Let's drop a note in insteadOf that points the user in the right direction. It would be nice if we could make this work out of the box, but we can't without knowing the security implications of the user's rewrite. Only the documentation for a particular remote helper can advise one way or the other. Since we do include the persistent-https helper in contrib/ (and since it was the helper in the real-world case that inspired that patch), let's also drop a note there. Suggested-by: Elliott Cable <me@ell.io> Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'contrib/persistent-https')
-rw-r--r--contrib/persistent-https/README10
1 files changed, 10 insertions, 0 deletions
diff --git a/contrib/persistent-https/README b/contrib/persistent-https/README
index f784dd2..7c4cd8d 100644
--- a/contrib/persistent-https/README
+++ b/contrib/persistent-https/README
@@ -35,6 +35,16 @@ to use persistent-https:
[url "persistent-http"]
insteadof = http
+You may also want to allow the use of the persistent-https helper for
+submodule URLs (since any https URLs pointing to submodules will be
+rewritten, and Git's out-of-the-box defaults forbid submodules from
+using unknown remote helpers):
+
+[protocol "persistent-https"]
+ allow = always
+[protocol "persistent-http"]
+ allow = always
+
#####################################################################
# BUILDING FROM SOURCE