简体中文 ▾ 主题 ▾ 最新版本 ▾ git-http-backend 上次更新于 2.49.0

名称

git-http-backend - Git over HTTP 的服务器端实现

概要

git http-backend

描述

一个简单的 CGI 程序，用于向通过 http:// 和 https:// 协议访问仓库的 Git 客户端提供 Git 仓库内容。该程序支持客户端使用智能 HTTP 协议和向后兼容的哑 HTTP 协议进行拉取，以及客户端使用智能 HTTP 协议进行推送。如果配置正确，它还支持 Git 更高效的“v2”协议；请参阅下面 ENVIRONMENT 部分中 GIT_PROTOCOL 的讨论。

它会验证目录中是否存在“git-daemon-export-ok”这个魔法文件，并且它会拒绝导出任何未明确标记为可导出的 Git 目录（除非设置了 GIT_HTTP_EXPORT_ALL 环境变量）。

默认情况下，只启用 upload-pack 服务，该服务用于服务 git fetch-pack 和 git ls-remote 客户端，这些客户端由 git fetch、git pull 和 git clone 调用。如果客户端已认证，则启用 receive-pack 服务，该服务用于服务 git send-pack 客户端，这些客户端由 git push 调用。

服务

这些服务可以通过每个仓库的配置文件启用/禁用

http.getanyfile

该服务用于 Git 版本 1.6.6 之前且无法使用 upload pack 服务的客户端。启用后，客户端可以读取仓库中的任何文件，包括那些不再可从分支访问但仍存在于仓库中的对象。它默认启用，但仓库可以通过将此配置值设置为 false 来禁用它。

http.uploadpack

该服务用于 git fetch-pack 和 git ls-remote 客户端。它默认启用，但仓库可以通过将此配置值设置为 false 来禁用它。

http.receivepack

该服务用于 git send-pack 客户端，允许推送。对于匿名用户，它默认禁用；对于经 Web 服务器认证的用户，它默认启用。可以通过将其设置为 false 来禁用它，或者通过将其设置为 true 为所有用户（包括匿名用户）启用它。

http.uploadarchive

该服务用于通过 HTTP/HTTPS 协议进行远程归档的 git archive 客户端。它默认禁用。它仅在协议 v2 中有效。

URL 转换

为了确定磁盘上仓库的位置，git http-backend 会将 Web 服务器自动设置的环境变量 PATH_INFO 和必须在 Web 服务器配置中手动设置的 GIT_PROJECT_ROOT 连接起来。如果 GIT_PROJECT_ROOT 未设置，git http-backend 会读取 PATH_TRANSLATED，该变量也由 Web 服务器自动设置。

示例

以下所有示例都将 http://$hostname/git/foo/bar.git 映射到 /var/www/git/foo/bar.git。

Apache 2.x

确保启用了 mod_cgi、mod_alias 和 mod_env，并正确设置 GIT_PROJECT_ROOT（或 DocumentRoot），然后为 CGI 创建一个 ScriptAlias

SetEnv GIT_PROJECT_ROOT /var/www/git
SetEnv GIT_HTTP_EXPORT_ALL
ScriptAlias /git/ /usr/libexec/git-core/git-http-backend/

# This is not strictly necessary using Apache and a modern version of
# git-http-backend, as the webserver will pass along the header in the
# environment as HTTP_GIT_PROTOCOL, and http-backend will copy that into
# GIT_PROTOCOL. But you may need this line (or something similar if you
# are using a different webserver), or if you want to support older Git
# versions that did not do that copying.
#
# Having the webserver set up GIT_PROTOCOL is perfectly fine even with
# modern versions (and will take precedence over HTTP_GIT_PROTOCOL,
# which means it can be used to override the client's request).
SetEnvIf Git-Protocol ".*" GIT_PROTOCOL=$0

要启用匿名读访问但需认证写访问，请对初始引用通告（我们通过查询字符串中的服务参数将其检测为推送）和 receive-pack 调用本身都要求授权

RewriteCond %{QUERY_STRING} service=git-receive-pack [OR]
RewriteCond %{REQUEST_URI} /git-receive-pack$
RewriteRule ^/git/ - [E=AUTHREQUIRED:yes]

<LocationMatch "^/git/">
	Order Deny,Allow
	Deny from env=AUTHREQUIRED

	AuthType Basic
	AuthName "Git Access"
	Require group committers
	Satisfy Any
	...
</LocationMatch>

如果您没有 mod_rewrite 可用于匹配查询字符串，则只需保护 git-receive-pack 本身即可，例如

<LocationMatch "^/git/.*/git-receive-pack$">
	AuthType Basic
	AuthName "Git Access"
	Require group committers
	...
</LocationMatch>

在这种模式下，服务器直到客户端实际开始推送的对象协商阶段才会请求认证，而不是在初始接触时。因此，您还必须在任何应接受推送的仓库中启用 http.receivepack 配置选项。默认行为是，如果未设置 http.receivepack，则拒绝未经认证用户的任何推送；因此，初始请求将向客户端报告 403 Forbidden，甚至不提供认证的机会。

要对读写都要求认证，请在仓库或其父目录之一周围使用 Location 指令

<Location /git/private>
	AuthType Basic
	AuthName "Private Git Access"
	Require group committers
	...
</Location>

要在同一 URL 上服务 gitweb，请使用 ScriptAliasMatch 仅匹配 git http-backend 可以处理的 URL，并将其余 URL 转发到 gitweb

ScriptAliasMatch \
	"(?x)^/git/(.*/(HEAD | \
			info/refs | \
			objects/(info/[^/]+ | \
				 [0-9a-f]{2}/[0-9a-f]{38} | \
				 pack/pack-[0-9a-f]{40}\.(pack|idx)) | \
			git-(upload|receive)-pack))$" \
	/usr/libexec/git-core/git-http-backend/$1

ScriptAlias /git/ /var/www/cgi-bin/gitweb.cgi/

要在单个仓库中从不同的 gitnamespaces[7] 服务多个仓库

SetEnvIf Request_URI "^/git/([^/]*)" GIT_NAMESPACE=$1
ScriptAliasMatch ^/git/[^/]*(.*) /usr/libexec/git-core/git-http-backend/storage.git$1
加速静态 Apache 2.x

与上述类似，但 Apache 可用于返回存储在磁盘上的静态文件。在许多系统上，这可能更高效，因为 Apache 可以请求内核将文件内容直接从文件系统复制到网络

SetEnv GIT_PROJECT_ROOT /var/www/git

AliasMatch ^/git/(.*/objects/[0-9a-f]{2}/[0-9a-f]{38})$          /var/www/git/$1
AliasMatch ^/git/(.*/objects/pack/pack-[0-9a-f]{40}.(pack|idx))$ /var/www/git/$1
ScriptAlias /git/ /usr/libexec/git-core/git-http-backend/

这可以与 gitweb 配置结合使用

SetEnv GIT_PROJECT_ROOT /var/www/git

AliasMatch ^/git/(.*/objects/[0-9a-f]{2}/[0-9a-f]{38})$          /var/www/git/$1
AliasMatch ^/git/(.*/objects/pack/pack-[0-9a-f]{40}.(pack|idx))$ /var/www/git/$1
ScriptAliasMatch \
	"(?x)^/git/(.*/(HEAD | \
			info/refs | \
			objects/info/[^/]+ | \
			git-(upload|receive)-pack))$" \
	/usr/libexec/git-core/git-http-backend/$1
ScriptAlias /git/ /var/www/cgi-bin/gitweb.cgi/
Lighttpd

确保加载了 mod_cgi、mod_alias、mod_auth、mod_setenv，然后正确设置 GIT_PROJECT_ROOT 并将所有请求重定向到 CGI

alias.url += ( "/git" => "/usr/lib/git-core/git-http-backend" )
$HTTP["url"] =~ "^/git" {
	cgi.assign = ("" => "")
	setenv.add-environment = (
		"GIT_PROJECT_ROOT" => "/var/www/git",
		"GIT_HTTP_EXPORT_ALL" => ""
	)
}

启用匿名读访问但需认证写访问

$HTTP["querystring"] =~ "service=git-receive-pack" {
	include "git-auth.conf"
}
$HTTP["url"] =~ "^/git/.*/git-receive-pack$" {
	include "git-auth.conf"
}

其中 git-auth.conf 看起来像这样

auth.require = (
	"/" => (
		"method" => "basic",
		"realm" => "Git Access",
		"require" => "valid-user"
	       )
)
# ...and set up auth.backend here

对读写都要求认证

$HTTP["url"] =~ "^/git/private" {
	include "git-auth.conf"
}

环境变量

git http-backend 依赖于调用 Web 服务器设置的 CGI 环境变量，包括

  • PATH_INFO（如果设置了 GIT_PROJECT_ROOT，否则为 PATH_TRANSLATED）

  • REMOTE_USER

  • REMOTE_ADDR

  • CONTENT_TYPE

  • QUERY_STRING

  • REQUEST_METHOD

GIT_HTTP_EXPORT_ALL 环境变量可以传递给 git-http-backend，以绕过在允许导出仓库之前对每个仓库中的“git-daemon-export-ok”文件进行的检查。

GIT_HTTP_MAX_REQUEST_BUFFER 环境变量（或 http.maxRequestBuffer 配置选项）可以设置，以更改 git 在拉取期间处理的最大引用协商请求；任何需要更大缓冲区的拉取都将失败。此值通常不需要更改，但如果您从具有大量引用的仓库拉取，则可能会有所帮助。该值可以用单位指定（例如，100M 表示 100 兆字节）。默认值为 10 兆字节。

客户端可以使用 Git-Protocol HTTP 头探测可选的协议能力（如 v2 协议）。为了支持这些能力，该头的内容必须出现在 GIT_PROTOCOL 环境变量中。大多数 Web 服务器将通过 HTTP_GIT_PROTOCOL 变量将此头传递给 CGI，git-http-backend 将自动将其复制到 GIT_PROTOCOL。但是，某些 Web 服务器可能对它们将传递的头更具选择性，在这种情况下，它们需要明确配置（请参阅前面 EXAMPLES 部分中 Apache 配置中对 Git-Protocol 的提及）。

后端进程将 GIT_COMMITTER_NAME 设置为 $REMOTE_USER，将 GIT_COMMITTER_EMAIL 设置为 ${REMOTE_USER}@http.${REMOTE_ADDR}，确保由 git-receive-pack 创建的任何引用日志都包含执行推送的远程用户的一些识别信息。

所有 CGI 环境变量都可用于 git-receive-pack 调用的每个钩子。

GIT

Git[1] 套件的一部分

scroll-to-top