describe: allow more than one revs to be named.
[git/git.git] / Documentation / git-daemon.txt
CommitLineData
7fc9d69f
JH
1git-daemon(1)
2=============
3
4NAME
5----
72e9340c 6git-daemon - A really simple server for git repositories.
7fc9d69f
JH
7
8SYNOPSIS
9--------
353ce815 10[verse]
2707da9c 11'git-daemon' [--verbose] [--syslog] [--inetd | --port=n] [--export-all]
353ce815 12 [--timeout=n] [--init-timeout=n] [--strict-paths] [directory...]
7fc9d69f
JH
13
14DESCRIPTION
15-----------
62cd033d
LAS
16A really simple TCP git daemon that normally listens on port "DEFAULT_GIT_PORT"
17aka 9418. It waits for a connection, and will just execute "git-upload-pack"
18when it gets one.
19
20It's careful in that there's a magic request-line that gives the command and
21what directory to upload, and it verifies that the directory is ok.
7fc9d69f 22
62cd033d
LAS
23It verifies that the directory has the magic file "git-daemon-export-ok", and
24it will refuse to export any git directory that hasn't explicitly been marked
2707da9c
PB
25for export this way (unless the '--export-all' parameter is specified). If you
26pass some directory paths as 'git-daemon' arguments, you can further restrict
27the offers to a whitelist comprising of those.
62cd033d
LAS
28
29This is ideally suited for read-only updates, ie pulling from git repositories.
7fc9d69f
JH
30
31OPTIONS
32-------
ce335fe0 33--strict-paths::
4dbd1352
AE
34 Match paths exactly (i.e. don't allow "/foo/repo" when the real path is
35 "/foo/repo.git" or "/foo/repo/.git") and don't do user-relative paths.
36 git-daemon will refuse to start when this option is enabled and no
37 whitelist is specified.
38
2707da9c
PB
39--export-all::
40 Allow pulling from all directories that look like GIT repositories
4dbd1352 41 (have the 'objects' and 'refs' subdirectories), even if they
2707da9c
PB
42 do not have the 'git-daemon-export-ok' file.
43
62cd033d 44--inetd::
bce8230d 45 Have the server run as an inetd service. Implies --syslog.
7fc9d69f 46
62cd033d
LAS
47--port::
48 Listen on an alternative port.
7fc9d69f 49
2707da9c
PB
50--init-timeout::
51 Timeout between the moment the connection is established and the
52 client request is received (typically a rather low value, since
53 that should be basically immediate).
54
55--timeout::
56 Timeout for specific client sub-requests. This includes the time
57 it takes for the server to process the sub-request and time spent
58 waiting for next client's request.
59
9048fe1c
PB
60--syslog::
61 Log to syslog instead of stderr. Note that this option does not imply
62 --verbose, thus by default only error conditions will be logged.
63
b5cf3c8b
PB
64--verbose::
65 Log details about the incoming connections and requested files.
66
4dbd1352
AE
67<directory>::
68 A directory to add to the whitelist of allowed directories. Unless
69 --strict-paths is specified this will also include subdirectories
70 of each named directory.
71
7fc9d69f
JH
72Author
73------
4dbd1352
AE
74Written by Linus Torvalds <torvalds@osdl.org>, YOSHIFUJI Hideaki
75<yoshfuji@linux-ipv6.org> and the git-list <git@vger.kernel.org>
7fc9d69f
JH
76
77Documentation
78--------------
79Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
80
81GIT
82---
a7154e91 83Part of the gitlink:git[7] suite
7fc9d69f 84