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

名称

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

概要

git http-backend

描述

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

它验证目录是否具有魔术文件“git-daemon-export-ok”,并且除非显式标记为通过这种方式导出,否则它将拒绝导出任何 Git 目录(除非设置了 GIT_HTTP_EXPORT_ALL 环境变量)。

默认情况下,仅启用 upload-pack 服务,该服务为 git fetch-packgit ls-remote 客户端提供服务,这些客户端通过 git fetchgit pullgit clone 调用。如果客户端经过身份验证,则会启用 receive-pack 服务,该服务为 git send-pack 客户端提供服务,后者通过 git push 调用。

服务

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

http.getanyfile

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

http.uploadpack

此服务为 git fetch-packgit ls-remote 客户端提供服务。此服务默认启用,但仓库可以通过将此配置值设置为 false 来禁用它。

http.receivepack

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

http.uploadarchive

此服务为 git archive 客户端提供通过 HTTP/HTTPS 协议进行远程归档的服务。此服务默认禁用。它仅在协议 v2 中工作。

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),并创建 ScriptAlias 指向 CGI。

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 广告(我们通过查询字符串中的 service 参数检测到它是一个推送)和 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-backend 传递 GIT_HTTP_EXPORT_ALL 环境变量,以绕过在允许导出每个仓库之前检查该仓库中的“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] 套件的一部分