Update draft release notes to 1.7.8
[git/jrn.git] / Documentation / git-daemon.txt
blob69a1e4af9ec007a6cc59cce07298a6a825369ef1
1 git-daemon(1)
2 =============
4 NAME
5 ----
6 git-daemon - A really simple server for git repositories
8 SYNOPSIS
9 --------
10 [verse]
11 'git daemon' [--verbose] [--syslog] [--export-all]
12              [--timeout=<n>] [--init-timeout=<n>] [--max-connections=<n>]
13              [--strict-paths] [--base-path=<path>] [--base-path-relaxed]
14              [--user-path | --user-path=<path>]
15              [--interpolated-path=<pathtemplate>]
16              [--reuseaddr] [--detach] [--pid-file=<file>]
17              [--enable=<service>] [--disable=<service>]
18              [--allow-override=<service>] [--forbid-override=<service>]
19              [--inetd | [--listen=<host_or_ipaddr>] [--port=<n>] [--user=<user> [--group=<group>]]
20              [<directory>...]
22 DESCRIPTION
23 -----------
24 A really simple TCP git daemon that normally listens on port "DEFAULT_GIT_PORT"
25 aka 9418.  It waits for a connection asking for a service, and will serve
26 that service if it is enabled.
28 It verifies that the directory has the magic file "git-daemon-export-ok", and
29 it will refuse to export any git directory that hasn't explicitly been marked
30 for export this way (unless the '--export-all' parameter is specified). If you
31 pass some directory paths as 'git daemon' arguments, you can further restrict
32 the offers to a whitelist comprising of those.
34 By default, only `upload-pack` service is enabled, which serves
35 'git fetch-pack' and 'git ls-remote' clients, which are invoked
36 from 'git fetch', 'git pull', and 'git clone'.
38 This is ideally suited for read-only updates, i.e., pulling from
39 git repositories.
41 An `upload-archive` also exists to serve 'git archive'.
43 OPTIONS
44 -------
45 --strict-paths::
46         Match paths exactly (i.e. don't allow "/foo/repo" when the real path is
47         "/foo/repo.git" or "/foo/repo/.git") and don't do user-relative paths.
48         'git daemon' will refuse to start when this option is enabled and no
49         whitelist is specified.
51 --base-path=<path>::
52         Remap all the path requests as relative to the given path.
53         This is sort of "GIT root" - if you run 'git daemon' with
54         '--base-path=/srv/git' on example.com, then if you later try to pull
55         'git://example.com/hello.git', 'git daemon' will interpret the path
56         as '/srv/git/hello.git'.
58 --base-path-relaxed::
59         If --base-path is enabled and repo lookup fails, with this option
60         'git daemon' will attempt to lookup without prefixing the base path.
61         This is useful for switching to --base-path usage, while still
62         allowing the old paths.
64 --interpolated-path=<pathtemplate>::
65         To support virtual hosting, an interpolated path template can be
66         used to dynamically construct alternate paths.  The template
67         supports %H for the target hostname as supplied by the client but
68         converted to all lowercase, %CH for the canonical hostname,
69         %IP for the server's IP address, %P for the port number,
70         and %D for the absolute path of the named repository.
71         After interpolation, the path is validated against the directory
72         whitelist.
74 --export-all::
75         Allow pulling from all directories that look like GIT repositories
76         (have the 'objects' and 'refs' subdirectories), even if they
77         do not have the 'git-daemon-export-ok' file.
79 --inetd::
80         Have the server run as an inetd service. Implies --syslog.
81         Incompatible with --detach, --port, --listen, --user and --group
82         options.
84 --listen=<host_or_ipaddr>::
85         Listen on a specific IP address or hostname.  IP addresses can
86         be either an IPv4 address or an IPv6 address if supported.  If IPv6
87         is not supported, then --listen=hostname is also not supported and
88         --listen must be given an IPv4 address.
89         Can be given more than once.
90         Incompatible with '--inetd' option.
92 --port=<n>::
93         Listen on an alternative port.  Incompatible with '--inetd' option.
95 --init-timeout=<n>::
96         Timeout (in seconds) between the moment the connection is established
97         and the client request is received (typically a rather low value, since
98         that should be basically immediate).
100 --timeout=<n>::
101         Timeout (in seconds) for specific client sub-requests. This includes
102         the time it takes for the server to process the sub-request and the
103         time spent waiting for the next client's request.
105 --max-connections=<n>::
106         Maximum number of concurrent clients, defaults to 32.  Set it to
107         zero for no limit.
109 --syslog::
110         Log to syslog instead of stderr. Note that this option does not imply
111         --verbose, thus by default only error conditions will be logged.
113 --user-path::
114 --user-path=<path>::
115         Allow {tilde}user notation to be used in requests.  When
116         specified with no parameter, requests to
117         git://host/{tilde}alice/foo is taken as a request to access
118         'foo' repository in the home directory of user `alice`.
119         If `--user-path=path` is specified, the same request is
120         taken as a request to access `path/foo` repository in
121         the home directory of user `alice`.
123 --verbose::
124         Log details about the incoming connections and requested files.
126 --reuseaddr::
127         Use SO_REUSEADDR when binding the listening socket.
128         This allows the server to restart without waiting for
129         old connections to time out.
131 --detach::
132         Detach from the shell. Implies --syslog.
134 --pid-file=<file>::
135         Save the process id in 'file'.  Ignored when the daemon
136         is run under `--inetd`.
138 --user=<user>::
139 --group=<group>::
140         Change daemon's uid and gid before entering the service loop.
141         When only `--user` is given without `--group`, the
142         primary group ID for the user is used.  The values of
143         the option are given to `getpwnam(3)` and `getgrnam(3)`
144         and numeric IDs are not supported.
146 Giving these options is an error when used with `--inetd`; use
147 the facility of inet daemon to achieve the same before spawning
148 'git daemon' if needed.
150 --enable=<service>::
151 --disable=<service>::
152         Enable/disable the service site-wide per default.  Note
153         that a service disabled site-wide can still be enabled
154         per repository if it is marked overridable and the
155         repository enables the service with a configuration
156         item.
158 --allow-override=<service>::
159 --forbid-override=<service>::
160         Allow/forbid overriding the site-wide default with per
161         repository configuration.  By default, all the services
162         are overridable.
164 <directory>::
165         A directory to add to the whitelist of allowed directories. Unless
166         --strict-paths is specified this will also include subdirectories
167         of each named directory.
169 SERVICES
170 --------
172 These services can be globally enabled/disabled using the
173 command line options of this command.  If a finer-grained
174 control is desired (e.g. to allow 'git archive' to be run
175 against only in a few selected repositories the daemon serves),
176 the per-repository configuration file can be used to enable or
177 disable them.
179 upload-pack::
180         This serves 'git fetch-pack' and 'git ls-remote'
181         clients.  It is enabled by default, but a repository can
182         disable it by setting `daemon.uploadpack` configuration
183         item to `false`.
185 upload-archive::
186         This serves 'git archive --remote'.  It is disabled by
187         default, but a repository can enable it by setting
188         `daemon.uploadarch` configuration item to `true`.
190 receive-pack::
191         This serves 'git send-pack' clients, allowing anonymous
192         push.  It is disabled by default, as there is _no_
193         authentication in the protocol (in other words, anybody
194         can push anything into the repository, including removal
195         of refs).  This is solely meant for a closed LAN setting
196         where everybody is friendly.  This service can be
197         enabled by `daemon.receivepack` configuration item to
198         `true`.
200 EXAMPLES
201 --------
202 We assume the following in /etc/services::
204 ------------
205 $ grep 9418 /etc/services
206 git             9418/tcp                # Git Version Control System
207 ------------
209 'git daemon' as inetd server::
210         To set up 'git daemon' as an inetd service that handles any
211         repository under the whitelisted set of directories, /pub/foo
212         and /pub/bar, place an entry like the following into
213         /etc/inetd all on one line:
215 ------------------------------------------------
216         git stream tcp nowait nobody  /usr/bin/git
217                 git daemon --inetd --verbose --export-all
218                 /pub/foo /pub/bar
219 ------------------------------------------------
222 'git daemon' as inetd server for virtual hosts::
223         To set up 'git daemon' as an inetd service that handles
224         repositories for different virtual hosts, `www.example.com`
225         and `www.example.org`, place an entry like the following into
226         `/etc/inetd` all on one line:
228 ------------------------------------------------
229         git stream tcp nowait nobody /usr/bin/git
230                 git daemon --inetd --verbose --export-all
231                 --interpolated-path=/pub/%H%D
232                 /pub/www.example.org/software
233                 /pub/www.example.com/software
234                 /software
235 ------------------------------------------------
237 In this example, the root-level directory `/pub` will contain
238 a subdirectory for each virtual host name supported.
239 Further, both hosts advertise repositories simply as
240 `git://www.example.com/software/repo.git`.  For pre-1.4.0
241 clients, a symlink from `/software` into the appropriate
242 default repository could be made as well.
245 'git daemon' as regular daemon for virtual hosts::
246         To set up 'git daemon' as a regular, non-inetd service that
247         handles repositories for multiple virtual hosts based on
248         their IP addresses, start the daemon like this:
250 ------------------------------------------------
251         git daemon --verbose --export-all
252                 --interpolated-path=/pub/%IP/%D
253                 /pub/192.168.1.200/software
254                 /pub/10.10.220.23/software
255 ------------------------------------------------
257 In this example, the root-level directory `/pub` will contain
258 a subdirectory for each virtual host IP address supported.
259 Repositories can still be accessed by hostname though, assuming
260 they correspond to these IP addresses.
262 selectively enable/disable services per repository::
263         To enable 'git archive --remote' and disable 'git fetch' against
264         a repository, have the following in the configuration file in the
265         repository (that is the file 'config' next to 'HEAD', 'refs' and
266         'objects').
268 ----------------------------------------------------------------
269         [daemon]
270                 uploadpack = false
271                 uploadarch = true
272 ----------------------------------------------------------------
275 ENVIRONMENT
276 -----------
277 'git daemon' will set REMOTE_ADDR to the IP address of the client
278 that connected to it, if the IP address is available. REMOTE_ADDR will
279 be available in the environment of hooks called when
280 services are performed.
284 Part of the linkgit:git[1] suite