简体中文 ▾ 主题 ▾ 最新版本 ▾ git-daemon 最后更新于 2.50.0

名称

git-daemon - 一个非常简单的 Git 仓库服务器

概要

git daemon [--verbose] [--syslog] [--export-all]
	   [--timeout=<n>] [--init-timeout=<n>] [--max-connections=<n>]
	   [--strict-paths] [--base-path=<path>] [--base-path-relaxed]
	   [--user-path | --user-path=<path>]
	   [--interpolated-path=<pathtemplate>]
	   [--reuseaddr] [--detach] [--pid-file=<file>]
	   [--enable=<service>] [--disable=<service>]
	   [--allow-override=<service>] [--forbid-override=<service>]
	   [--access-hook=<path>] [--[no-]informative-errors]
	   [--inetd |
	     [--listen=<host-or-ipaddr>] [--port=<n>]
	     [--user=<user> [--group=<group>]]]
	   [--log-destination=(stderr|syslog|none)]
	   [<directory>…​]

描述

一个非常简单的 TCP Git 守护进程,通常监听端口 "DEFAULT_GIT_PORT"(即 9418)。它等待请求服务的连接,如果该服务已启用,则提供该服务。

它会验证目录中是否存在魔术文件 "git-daemon-export-ok",并且会拒绝导出任何未通过此方式明确标记为可导出的 Git 目录(除非指定了 --export-all 参数)。如果您将一些目录路径作为 git daemon 的参数传递,则服务仅限于这些目录内的仓库。

默认情况下,仅启用了 upload-pack 服务,该服务为 git fetch-packgit ls-remote 客户端提供服务,这些客户端由 git fetchgit pullgit clone 调用。

这非常适合只读更新,即从 Git 仓库拉取代码。

还存在一个 upload-archive 服务,用于为 git archive 提供服务。

选项

--strict-paths

精确匹配路径(即,当真实路径为 "/foo/repo.git" 或 "/foo/repo/.git" 时,不允许访问 "/foo/repo"),并且不执行用户相对路径解析。当启用此选项且未提供目录参数时,git daemon 将拒绝启动。

--base-path=<路径>

将所有路径请求重映射为相对于给定路径的路径。这类似于 "Git 根目录" - 如果您在 example.com 上运行 git daemon 并设置 --base-path=/srv/git,那么如果您稍后尝试从 git://example.com/hello.git 拉取代码,git daemon 会将该路径解释为 /srv/git/hello.git

--base-path-relaxed

如果启用了 --base-path 但仓库查找失败,使用此选项 git daemon 将尝试在不添加基础路径前缀的情况下进行查找。这对于过渡到 --base-path 使用方式,同时仍然兼容旧路径非常有用。

--interpolated-path=<路径模板>

为了支持虚拟主机,可以使用插值路径模板来动态构建替代路径。模板支持 %H(客户端提供的主机名,已转换为小写)、%CH(规范主机名)、%IP(服务器 IP 地址)、%P(端口号)以及 %D(命名仓库的绝对路径)。插值后,该路径会针对目录列表进行验证。

--export-all

允许从所有看起来像 Git 仓库(拥有 objectsrefs 子目录)的目录中拉取,即使它们没有 git-daemon-export-ok 文件。

--inetd

将服务器作为 inetd 服务运行。隐含 --syslog(可通过 --log-destination= 覆盖)。与 --detach--port--listen--user--group 选项不兼容。

--listen=<主机或IP地址>

监听特定的 IP 地址或主机名。如果支持,IP 地址可以是 IPv4 或 IPv6 地址。如果不支持 IPv6,则 --listen=<主机名> 也不受支持,并且 --listen 必须提供 IPv4 地址。可以多次使用。与 --inetd 选项不兼容。

--port=<n>

监听替代端口。与 --inetd 选项不兼容。

--init-timeout=<n>

从连接建立到收到客户端请求之间的超时时间(以秒为单位,通常值较低,因为这应该是即时的)。

--timeout=<n>

特定客户端子请求的超时时间(以秒为单位)。这包括服务器处理子请求的时间以及等待下一个客户端请求所花费的时间。

--max-connections=<n>

并发客户端的最大数量,默认为 32。设置为零表示无限制。

--syslog

--log-destination=syslog 的缩写。

--log-destination=<目标>

将日志消息发送到指定的目标。注意,此选项并不隐含 --verbose,因此默认情况下仅记录错误情况。<目标> 必须是以下之一:

stderr

写入标准错误。注意,如果指定了 --detach,进程将断开与真实标准错误的连接,使得该目标实际上等同于 none

syslog

使用 git-daemon 标识符写入 syslog。

none

禁用所有日志记录。

如果指定了 --inetd--detach,默认目标为 syslog,否则为 stderr

--user-path
--user-path=<路径>

允许在请求中使用 ~user 表示法。如果不带参数指定,对 git://host/~alice/foo 的请求被视为访问用户 alice 主目录中的 foo 仓库。如果指定了 --user-path=<路径>,则同样的请求被视为访问用户 alice 主目录中 <路径>/foo 仓库的请求。

--verbose

记录有关传入连接和请求文件的详细信息。

--reuseaddr

在绑定监听套接字时使用 SO_REUSEADDR。这允许服务器在不必等待旧连接超时的情况下重启。

--detach

从 shell 分离。隐含 --syslog

--pid-file=<文件>

将进程 ID 保存到 <文件> 中。当守护进程在 --inetd 下运行时将被忽略。

--user=<用户>
--group=<组>

在进入服务循环之前更改守护进程的 uid 和 gid。当仅给定 --user 而没有 --group 时,将使用该用户的主要组 ID。该选项的值传递给 getpwnam(3)getgrnam(3),不支持数字 ID。

在与 --inetd 一起使用时提供这些选项是错误的;如果需要,请在启动 git daemon 之前利用 inet 守护进程的功能来实现同样的效果。

像许多切换用户 ID 的程序一样,守护进程在运行 git 程序(例如 upload-packreceive-pack)时不会重置环境变量(如 HOME)。使用此选项时,您可能还需要在启动守护进程之前设置并导出 HOME 指向 <用户> 的主目录,并确保该目录中的任何 Git 配置文件对 <用户> 可读。

--enable=<服务>
--disable=<服务>

在全站范围内启用/禁用服务。注意,即使一个服务在全站范围内被禁用,如果该服务被标记为可覆盖,且仓库通过配置项启用了该服务,它仍然可以在该仓库中被启用。

--allow-override=<服务>
--forbid-override=<服务>

允许/禁止使用每个仓库的配置覆盖全站默认值。默认情况下,所有服务均可被覆盖。

--informative-errors
--no-informative-errors

当开启信息性错误时,git-daemon 会向客户端报告更详细的错误,区分 "无此仓库" 和 "仓库未导出" 等情况。这对客户端更方便,但可能会泄露未导出仓库存在的信息。当未启用信息性错误时,所有错误都会向客户端报告 "拒绝访问"。默认为 --no-informative-errors

--access-hook=<路径>

每次客户端连接时,首先运行由 <路径> 指定的外部命令,并将服务名称(例如 "upload-pack")、仓库路径、主机名(%H)、规范主机名(%CH)、IP 地址(%IP)和 TCP 端口(%P)作为其命令行参数。外部命令可以通过以非零状态退出(或以零状态退出以允许)来决定拒绝该服务。在做出此决定时,它还可以查看 $REMOTE_ADDR 和 $REMOTE_PORT 环境变量以了解请求者。

外部命令可以选择将其标准输出写入单行,在拒绝服务时作为错误消息发送给请求者。

<目录>

其余参数提供了一个目录列表。如果指定了任何目录,那么 git-daemon 进程将仅在请求的目录包含在这些目录中时才为其提供服务。如果指定了 --strict-paths,则请求的目录必须与这些目录之一完全匹配。

服务

这些服务可以使用该命令的命令行选项全局启用/禁用。如果需要更细粒度的控制(例如,仅允许在守护进程服务的少数特定仓库中运行 git archive),可以使用每个仓库的配置文件来启用或禁用它们。

upload-pack

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

upload-archive

该服务为 git archive --remote 提供服务。它默认禁用,但仓库可以通过将 daemon.uploadarch 配置项设置为 true 来启用它。

receive-pack

该服务为 git send-pack 客户端提供服务,允许匿名推送。它默认禁用,因为协议中没有身份验证(换句话说,任何人都可以向仓库推送任何内容,包括删除引用)。这仅适用于每个人都友好的封闭局域网设置。可以通过将 daemon.receivepack 配置项设置为 true 来启用此服务。

示例

我们在 /etc/services 中假设以下内容
$ grep 9418 /etc/services
git		9418/tcp		# Git Version Control System
git daemon 作为 inetd 服务器

要将 git daemon 设置为处理 /pub/foo/pub/bar 内任何仓库的 inetd 服务,请在 /etc/inetd 中添加如下条目,所有内容写在同一行:

	git stream tcp nowait nobody  /usr/bin/git
		git daemon --inetd --verbose --export-all
		/pub/foo /pub/bar
git daemon 作为虚拟主机的 inetd 服务器

要将 git daemon 设置为处理不同虚拟主机(www.example.comwww.example.org)仓库的 inetd 服务,请在 /etc/inetd 中添加如下条目,所有内容写在同一行:

	git stream tcp nowait nobody /usr/bin/git
		git daemon --inetd --verbose --export-all
		--interpolated-path=/pub/%H%D
		/pub/www.example.org/software
		/pub/www.example.com/software
		/software

在此示例中,根目录 /pub 将包含每个受支持的虚拟主机名的子目录。此外,两台主机都将仓库简单地声明为 git://www.example.com/software/repo.git。对于 1.4.0 之前的客户端,还可以建立一个从 /software 到适当默认仓库的符号链接。

git daemon 作为虚拟主机的常规守护进程

要将 git daemon 设置为基于 IP 地址处理多个虚拟主机仓库的常规非 inetd 服务,请按如下方式启动守护进程:

	git daemon --verbose --export-all
		--interpolated-path=/pub/%IP/%D
		/pub/192.168.1.200/software
		/pub/10.10.220.23/software

在此示例中,根目录 /pub 将包含每个受支持的虚拟主机 IP 地址的子目录。不过,假设仓库与这些 IP 地址对应,仍然可以通过主机名访问它们。

按仓库选择性启用/禁用服务

要对仓库启用 git archive --remote 并禁用 git fetch,请在仓库的配置文件(即 HEADrefsobjects 旁边的 config 文件)中包含以下内容:

	[daemon]
		uploadpack = false
		uploadarch = true

环境变量

git daemonREMOTE_ADDR 设置为连接到它的客户端的 IP 地址(如果 IP 地址可用)。REMOTE_ADDR 将在执行服务时调用的钩子环境中可用。

GIT

Git[1] 套件的一部分