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