multi-service daemon: documentation
Signed-off-by: Junio C Hamano <junkio@cox.net>
Junio C Hamano committed
Aug 20, 2006 at 19:32 UTC
355f541249633487aa2685e7e7e29963f596b308
1 file changed
+39
-8
Documentation/git-daemon.txt
+39
-8
@@ -11,17 +11,16 @@ SYNOPSIS
11
'git-daemon' [--verbose] [--syslog] [--inetd | --port=n] [--export-all]
12
[--timeout=n] [--init-timeout=n] [--strict-paths]
13
[--base-path=path] [--user-path | --user-path=path]
14
- [--reuseaddr] [--detach] [--pid-file=file]
15
- [--user=user [--group=group]] [directory...]
14
+ [--enable=service] [--disable=service]
15
+ [--allow-override=service] [--forbid-override=service]
16
+ [--reuseaddr] [--detach] [--pid-file=file]
17
+ [--user=user [--group=group]] [directory...]
18
19
DESCRIPTION
20
-----------
21
A really simple TCP git daemon that normally listens on port "DEFAULT_GIT_PORT"
20
-aka 9418. It waits for a connection, and will just execute "git-upload-pack"
21
-when it gets one.
22
-
23
-It's careful in that there's a magic request-line that gives the command and
24
-what directory to upload, and it verifies that the directory is OK.
22
+aka 9418. It waits for a connection asking for a service, and will serve
23
+that service if it is enabled.
24
25
It verifies that the directory has the magic file "git-daemon-export-ok", and
26
it will refuse to export any git directory that hasn't explicitly been marked
@@ -29,7 +28,12 @@ for export this way (unless the '--export-all' parameter is specified). If you
28
pass some directory paths as 'git-daemon' arguments, you can further restrict
29
the offers to a whitelist comprising of those.
30
32
-This is ideally suited for read-only updates, i.e., pulling from git repositories.
31
+By default, only `upload-pack` service is enabled, which serves
32
+`git-fetch-pack` and `git-peek-remote` clients that are invoked
33
+from `git-fetch`, `git-ls-remote`, and `git-clone`.
34
+
35
+This is ideally suited for read-only updates, i.e., pulling from
36
+git repositories.
37
38
OPTIONS
39
-------
@@ -105,11 +109,38 @@ Giving these options is an error when used with `--inetd`; use
109
the facility of inet daemon to achieve the same before spawning
110
`git-daemon` if needed.
111
112
+--enable-service, --disable-service::
113
+ Enable/disable the service site-wide per default. Note
114
+ that a service disabled site-wide can still be enabled
115
+ per repository if it is marked overridable and the
116
+ repository enables the service with an configuration
117
+ item.
118
+
119
+--allow-override, --forbid-override::
120
+ Allow/forbid overriding the site-wide default with per
121
+ repository configuration. By default, all the services
122
+ are overridable.
123
+
124
<directory>::
125
A directory to add to the whitelist of allowed directories. Unless
126
--strict-paths is specified this will also include subdirectories
127
of each named directory.
128
129
+SERVICES
130
+--------
131
+
132
+upload-pack::
133
+ This serves `git-fetch-pack` and `git-peek-remote`
134
+ clients. It is enabled by default, but a repository can
135
+ disable it by setting `daemon.uploadpack` configuration
136
+ item to `false`.
137
+
138
+upload-tar::
139
+ This serves `git-tar-tree --remote=repository` client.
140
+ It is not enabled by default, but a repository can
141
+ enable it by setting `daemon.uploadtar` configuration
142
+ item to `true`.
143
+
144
Author
145
------
146
Written by Linus Torvalds <torvalds@osdl.org>, YOSHIFUJI Hideaki