X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fgit-http-backend.txt;h=07931c687478bf35644b0c042da1a97efaff1c1e;hb=0ed3a111638e83d1fd179e684222b3d3e0ae440f;hp=67aec067c8ffd75837ccc1d3e2524f5db2eb9a75;hpb=0622f79d8e7e91efc5870afe0ce134e1cee9f9f0;p=git.git diff --git a/Documentation/git-http-backend.txt b/Documentation/git-http-backend.txt index 67aec067c..07931c687 100644 --- a/Documentation/git-http-backend.txt +++ b/Documentation/git-http-backend.txt @@ -8,7 +8,7 @@ git-http-backend - Server side implementation of Git over HTTP SYNOPSIS -------- [verse] -'git-http-backend' +'git http-backend' DESCRIPTION ----------- @@ -18,11 +18,16 @@ The program supports clients fetching using both the smart HTTP protcol and the backwards-compatible dumb HTTP protocol, as well as clients pushing using the smart HTTP protocol. +It verifies that the directory has the magic file +"git-daemon-export-ok", and it will refuse to export any git directory +that hasn't explicitly been marked for export this way (unless the +GIT_HTTP_EXPORT_ALL environmental variable is set). + By default, only the `upload-pack` service is enabled, which serves -'git-fetch-pack' and 'git-ls-remote' clients, which are invoked from -'git-fetch', 'git-pull', and 'git-clone'. If the client is authenticated, -the `receive-pack` service is enabled, which serves 'git-send-pack' -clients, which is invoked from 'git-push'. +'git fetch-pack' and 'git ls-remote' clients, which are invoked from +'git fetch', 'git pull', and 'git clone'. If the client is authenticated, +the `receive-pack` service is enabled, which serves 'git send-pack' +clients, which is invoked from 'git push'. SERVICES -------- @@ -38,12 +43,12 @@ http.getanyfile:: by setting this configuration item to `false`. http.uploadpack:: - This serves 'git-fetch-pack' and 'git-ls-remote' clients. + This serves 'git fetch-pack' and 'git ls-remote' clients. It is enabled by default, but a repository can disable it by setting this configuration item to `false`. http.receivepack:: - This serves 'git-send-pack' clients, allowing push. It is + This serves 'git send-pack' clients, allowing push. It is disabled by default for anonymous users, and enabled by default for users authenticated by the web server. It can be disabled by setting this item to `false`, or enabled for all @@ -51,11 +56,11 @@ http.receivepack:: URL TRANSLATION --------------- -To determine the location of the repository on disk, 'git-http-backend' +To determine the location of the repository on disk, 'git http-backend' concatenates the environment variables PATH_INFO, which is set automatically by the web server, and GIT_PROJECT_ROOT, which must be set manually in the web server configuration. If GIT_PROJECT_ROOT is not -set, 'git-http-backend' reads PATH_TRANSLATED, which is also set +set, 'git http-backend' reads PATH_TRANSLATED, which is also set automatically by the web server. EXAMPLES @@ -70,6 +75,7 @@ Apache 2.x:: + ---------------------------------------------------------------- SetEnv GIT_PROJECT_ROOT /var/www/git +SetEnv GIT_HTTP_EXPORT_ALL ScriptAlias /git/ /usr/libexec/git-core/git-http-backend/ ---------------------------------------------------------------- + @@ -98,7 +104,7 @@ directive around the repository, or one of its parent directories: ---------------------------------------------------------------- + To serve gitweb at the same url, use a ScriptAliasMatch to only -those URLs that 'git-http-backend' can handle, and forward the +those URLs that 'git http-backend' can handle, and forward the rest to gitweb: + ---------------------------------------------------------------- @@ -147,7 +153,7 @@ ScriptAlias /git/ /var/www/cgi-bin/gitweb.cgi/ ENVIRONMENT ----------- -'git-http-backend' relies upon the CGI environment variables set +'git http-backend' relies upon the CGI environment variables set by the invoking web server, including: * PATH_INFO (if GIT_PROJECT_ROOT is set, otherwise PATH_TRANSLATED) @@ -157,6 +163,10 @@ by the invoking web server, including: * QUERY_STRING * REQUEST_METHOD +The GIT_HTTP_EXPORT_ALL environmental variable may be passed to +'git-http-backend' to bypass the check for the "git-daemon-export-ok" +file in each repository before allowing export of that repository. + The backend process sets GIT_COMMITTER_NAME to '$REMOTE_USER' and GIT_COMMITTER_EMAIL to '$\{REMOTE_USER}@http.$\{REMOTE_ADDR\}', ensuring that any reflogs created by 'git-receive-pack' contain some