Merge branch 'jk/list-objects-optim-wo-trees'
[git/git.git] / contrib / persistent-https / README
CommitLineData
fe043501
CR
1git-remote-persistent-https
2
3The git-remote-persistent-https binary speeds up SSL operations
4by running a daemon job (git-remote-persistent-https--proxy) that
5keeps a connection open to a server.
6
7
8PRE-BUILT BINARIES
9
10Darwin amd64:
11https://commondatastorage.googleapis.com/git-remote-persistent-https/darwin_amd64.tar.gz
12
13Linux amd64:
14https://commondatastorage.googleapis.com/git-remote-persistent-https/linux_amd64.tar.gz
15
16
17INSTALLING
18
19Move all of the git-remote-persistent-http* binaries to a directory
20in PATH.
21
22
23USAGE
24
25HTTPS requests can be delegated to the proxy by using the
26"persistent-https" scheme, e.g.
27
28git clone persistent-https://kernel.googlesource.com/pub/scm/git/git
29
30Likewise, .gitconfig can be updated as follows to rewrite https urls
31to use persistent-https:
32
33[url "persistent-https"]
34 insteadof = https
35[url "persistent-http"]
36 insteadof = http
37
2c9a2ae2
JK
38You may also want to allow the use of the persistent-https helper for
39submodule URLs (since any https URLs pointing to submodules will be
40rewritten, and Git's out-of-the-box defaults forbid submodules from
41using unknown remote helpers):
42
43[protocol "persistent-https"]
44 allow = always
45[protocol "persistent-http"]
46 allow = always
47
fe043501
CR
48
49#####################################################################
50# BUILDING FROM SOURCE
51#####################################################################
52
53LOCATION
54
55The source is available in the contrib/persistent-https directory of
56the Git source repository. The Git source repository is available at
57git://git.kernel.org/pub/scm/git/git.git/
58https://kernel.googlesource.com/pub/scm/git/git
59
60
61PREREQUISITES
62
63The code is written in Go (http://golang.org/) and the Go compiler is
64required. Currently, the compiler must be built and installed from tip
65of source, in order to include a fix in the reverse http proxy:
66http://code.google.com/p/go/source/detail?r=a615b796570a2cd8591884767a7d67ede74f6648
67
68
69BUILDING
70
71Run "make" to build the binaries. See the section on
72INSTALLING above.