tutorial: setting up a tree for subsystem maintainers
[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--------
2707da9c
PB
10'git-daemon' [--verbose] [--syslog] [--inetd | --port=n] [--export-all]
11 [--timeout=n] [--init-timeout=n] [directory...]
7fc9d69f
JH
12
13DESCRIPTION
14-----------
62cd033d
LAS
15A really simple TCP git daemon that normally listens on port "DEFAULT_GIT_PORT"
16aka 9418. It waits for a connection, and will just execute "git-upload-pack"
17when it gets one.
18
19It's careful in that there's a magic request-line that gives the command and
20what directory to upload, and it verifies that the directory is ok.
7fc9d69f 21
62cd033d
LAS
22It verifies that the directory has the magic file "git-daemon-export-ok", and
23it will refuse to export any git directory that hasn't explicitly been marked
2707da9c
PB
24for export this way (unless the '--export-all' parameter is specified). If you
25pass some directory paths as 'git-daemon' arguments, you can further restrict
26the offers to a whitelist comprising of those.
62cd033d
LAS
27
28This is ideally suited for read-only updates, ie pulling from git repositories.
7fc9d69f
JH
29
30OPTIONS
31-------
2707da9c
PB
32--export-all::
33 Allow pulling from all directories that look like GIT repositories
34 (have the 'objects' subdirectory and a 'HEAD' file), even if they
35 do not have the 'git-daemon-export-ok' file.
36
62cd033d 37--inetd::
bce8230d 38 Have the server run as an inetd service. Implies --syslog.
7fc9d69f 39
62cd033d
LAS
40--port::
41 Listen on an alternative port.
7fc9d69f 42
2707da9c
PB
43--init-timeout::
44 Timeout between the moment the connection is established and the
45 client request is received (typically a rather low value, since
46 that should be basically immediate).
47
48--timeout::
49 Timeout for specific client sub-requests. This includes the time
50 it takes for the server to process the sub-request and time spent
51 waiting for next client's request.
52
9048fe1c
PB
53--syslog::
54 Log to syslog instead of stderr. Note that this option does not imply
55 --verbose, thus by default only error conditions will be logged.
56
b5cf3c8b
PB
57--verbose::
58 Log details about the incoming connections and requested files.
59
7fc9d69f
JH
60Author
61------
62Written by Linus Torvalds <torvalds@osdl.org> and YOSHIFUJI Hideaki <yoshfuji@linux-ipv6.org>
63
64Documentation
65--------------
66Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
67
68GIT
69---
a7154e91 70Part of the gitlink:git[7] suite
7fc9d69f 71