Git
英语 ▾ 主题 ▾ 最新版本 ▾ git-http-backend 最后更新于 2.43.0

名称

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

概要

git http-backend

描述

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

它会验证目录是否包含“git-daemon-export-ok”的魔术文件，并且它会拒绝导出任何尚未明确标记为以这种方式导出的 Git 目录（除非设置了 GIT_HTTP_EXPORT_ALL 环境变量）。

默认情况下，只启用了 upload-pack 服务，它服务于从 git fetch、git pull 和 git clone 调用的 git fetch-pack 和 git ls-remote 客户端。如果客户端已通过身份验证，则 receive-pack 服务将被启用，它服务于从 git push 调用的 git send-pack 客户端。

服务

这些服务可以使用每个存储库配置文件启用/禁用

http.getanyfile

这为早于版本 1.6.6 的 Git 客户端提供服务，这些客户端无法使用上传包服务。启用后，客户端能够读取存储库中的任何文件，包括不再可从分支访问但仍存在的对象。它默认情况下已启用，但存储库可以通过将此配置值设置为 false 来禁用它。

http.uploadpack

这为 git fetch-pack 和 git ls-remote 客户端提供服务。它默认情况下已启用，但存储库可以通过将此配置值设置为 false 来禁用它。

http.receivepack

这为 git send-pack 客户端提供服务，允许推送。它默认情况下对匿名用户禁用，对由 Web 服务器验证的用户默认情况下启用。它可以通过将此项设置为 false 来禁用，或者通过将此项设置为 true 来为所有用户（包括匿名用户）启用。

URL 转换

为了确定磁盘上存储库的位置，git http-backend 会将环境变量 PATH_INFO（由 Web 服务器自动设置）和 GIT_PROJECT_ROOT（必须在 Web 服务器配置中手动设置）连接起来。如果未设置 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

要启用匿名读取访问但验证写入访问，需要对初始 ref 广告（我们通过查询字符串中的服务参数将其检测为推送）和 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，并将其余部分转发到 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 在获取期间处理的最大 ref 协商请求；任何需要更大缓冲区的获取都将不会成功。通常不需要更改此值，但如果您是从 ref 数量非常多的存储库中获取，则可能会有所帮助。该值可以用单位指定（例如，100M 表示 100 兆字节）。默认值为 10 兆字节。

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

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

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

GIT

git[1] 套件的一部分

scroll-to-top