Move setup_diff_pager to libgit.a
[git/jnareb-git.git] / Documentation / git-http-backend.txt
blobf4e0741c115905f61a0e92c5255658f4b8e25711
1 git-http-backend(1)
2 ===================
4 NAME
5 ----
6 git-http-backend - Server side implementation of Git over HTTP
8 SYNOPSIS
9 --------
10 [verse]
11 'git http-backend'
13 DESCRIPTION
14 -----------
15 A simple CGI program to serve the contents of a Git repository to Git
16 clients accessing the repository over http:// and https:// protocols.
17 The program supports clients fetching using both the smart HTTP protocol
18 and the backwards-compatible dumb HTTP protocol, as well as clients
19 pushing using the smart HTTP protocol.
21 It verifies that the directory has the magic file
22 "git-daemon-export-ok", and it will refuse to export any git directory
23 that hasn't explicitly been marked for export this way (unless the
24 GIT_HTTP_EXPORT_ALL environmental variable is set).
26 By default, only the `upload-pack` service is enabled, which serves
27 'git fetch-pack' and 'git ls-remote' clients, which are invoked from
28 'git fetch', 'git pull', and 'git clone'.  If the client is authenticated,
29 the `receive-pack` service is enabled, which serves 'git send-pack'
30 clients, which is invoked from 'git push'.
32 SERVICES
33 --------
34 These services can be enabled/disabled using the per-repository
35 configuration file:
37 http.getanyfile::
38         This serves Git clients older than version 1.6.6 that are unable to use the
39         upload pack service.  When enabled, clients are able to read
40         any file within the repository, including objects that are
41         no longer reachable from a branch but are still present.
42         It is enabled by default, but a repository can disable it
43         by setting this configuration item to `false`.
45 http.uploadpack::
46         This serves 'git fetch-pack' and 'git ls-remote' clients.
47         It is enabled by default, but a repository can disable it
48         by setting this configuration item to `false`.
50 http.receivepack::
51         This serves 'git send-pack' clients, allowing push.  It is
52         disabled by default for anonymous users, and enabled by
53         default for users authenticated by the web server.  It can be
54         disabled by setting this item to `false`, or enabled for all
55         users, including anonymous users, by setting it to `true`.
57 URL TRANSLATION
58 ---------------
59 To determine the location of the repository on disk, 'git http-backend'
60 concatenates the environment variables PATH_INFO, which is set
61 automatically by the web server, and GIT_PROJECT_ROOT, which must be set
62 manually in the web server configuration.  If GIT_PROJECT_ROOT is not
63 set, 'git http-backend' reads PATH_TRANSLATED, which is also set
64 automatically by the web server.
66 EXAMPLES
67 --------
68 All of the following examples map 'http://$hostname/git/foo/bar.git'
69 to '/var/www/git/foo/bar.git'.
71 Apache 2.x::
72         Ensure mod_cgi, mod_alias, and mod_env are enabled, set
73         GIT_PROJECT_ROOT (or DocumentRoot) appropriately, and
74         create a ScriptAlias to the CGI:
76 ----------------------------------------------------------------
77 SetEnv GIT_PROJECT_ROOT /var/www/git
78 SetEnv GIT_HTTP_EXPORT_ALL
79 ScriptAlias /git/ /usr/libexec/git-core/git-http-backend/
80 ----------------------------------------------------------------
82 To enable anonymous read access but authenticated write access,
83 require authorization with a LocationMatch directive:
85 ----------------------------------------------------------------
86 <LocationMatch "^/git/.*/git-receive-pack$">
87         AuthType Basic
88         AuthName "Git Access"
89         Require group committers
90         ...
91 </LocationMatch>
92 ----------------------------------------------------------------
94 To require authentication for both reads and writes, use a Location
95 directive around the repository, or one of its parent directories:
97 ----------------------------------------------------------------
98 <Location /git/private>
99         AuthType Basic
100         AuthName "Private Git Access"
101         Require group committers
102         ...
103 </Location>
104 ----------------------------------------------------------------
106 To serve gitweb at the same url, use a ScriptAliasMatch to only
107 those URLs that 'git http-backend' can handle, and forward the
108 rest to gitweb:
110 ----------------------------------------------------------------
111 ScriptAliasMatch \
112         "(?x)^/git/(.*/(HEAD | \
113                         info/refs | \
114                         objects/(info/[^/]+ | \
115                                  [0-9a-f]{2}/[0-9a-f]{38} | \
116                                  pack/pack-[0-9a-f]{40}\.(pack|idx)) | \
117                         git-(upload|receive)-pack))$" \
118         /usr/libexec/git-core/git-http-backend/$1
120 ScriptAlias /git/ /var/www/cgi-bin/gitweb.cgi/
121 ----------------------------------------------------------------
123 To serve multiple repositories from different linkgit:gitnamespaces[7] in a
124 single repository:
126 ----------------------------------------------------------------
127 SetEnvIf Request_URI "^/git/([^/]*)" GIT_NAMESPACE=$1
128 ScriptAliasMatch ^/git/[^/]*(.*) /usr/libexec/git-core/git-http-backend/storage.git$1
129 ----------------------------------------------------------------
131 Accelerated static Apache 2.x::
132         Similar to the above, but Apache can be used to return static
133         files that are stored on disk.  On many systems this may
134         be more efficient as Apache can ask the kernel to copy the
135         file contents from the file system directly to the network:
137 ----------------------------------------------------------------
138 SetEnv GIT_PROJECT_ROOT /var/www/git
140 AliasMatch ^/git/(.*/objects/[0-9a-f]{2}/[0-9a-f]{38})$          /var/www/git/$1
141 AliasMatch ^/git/(.*/objects/pack/pack-[0-9a-f]{40}.(pack|idx))$ /var/www/git/$1
142 ScriptAlias /git/ /usr/libexec/git-core/git-http-backend/
143 ----------------------------------------------------------------
145 This can be combined with the gitweb configuration:
147 ----------------------------------------------------------------
148 SetEnv GIT_PROJECT_ROOT /var/www/git
150 AliasMatch ^/git/(.*/objects/[0-9a-f]{2}/[0-9a-f]{38})$          /var/www/git/$1
151 AliasMatch ^/git/(.*/objects/pack/pack-[0-9a-f]{40}.(pack|idx))$ /var/www/git/$1
152 ScriptAliasMatch \
153         "(?x)^/git/(.*/(HEAD | \
154                         info/refs | \
155                         objects/info/[^/]+ | \
156                         git-(upload|receive)-pack))$" \
157         /usr/libexec/git-core/git-http-backend/$1
158 ScriptAlias /git/ /var/www/cgi-bin/gitweb.cgi/
159 ----------------------------------------------------------------
162 ENVIRONMENT
163 -----------
164 'git http-backend' relies upon the CGI environment variables set
165 by the invoking web server, including:
167 * PATH_INFO (if GIT_PROJECT_ROOT is set, otherwise PATH_TRANSLATED)
168 * REMOTE_USER
169 * REMOTE_ADDR
170 * CONTENT_TYPE
171 * QUERY_STRING
172 * REQUEST_METHOD
174 The GIT_HTTP_EXPORT_ALL environmental variable may be passed to
175 'git-http-backend' to bypass the check for the "git-daemon-export-ok"
176 file in each repository before allowing export of that repository.
178 The backend process sets GIT_COMMITTER_NAME to '$REMOTE_USER' and
179 GIT_COMMITTER_EMAIL to '$\{REMOTE_USER}@http.$\{REMOTE_ADDR\}',
180 ensuring that any reflogs created by 'git-receive-pack' contain some
181 identifying information of the remote user who performed the push.
183 All CGI environment variables are available to each of the hooks
184 invoked by the 'git-receive-pack'.
186 Author
187 ------
188 Written by Shawn O. Pearce <spearce@spearce.org>.
190 Documentation
191 --------------
192 Documentation by Shawn O. Pearce <spearce@spearce.org>.
196 Part of the linkgit:git[1] suite