Merge branch 'maint'
[gitweb.git] / Documentation / git-daemon.txt
index 344f24ea59a7f85473da4e865219bcdc0fb9db33..01c9f8eb9eff634fe8ab99908c62207ebecd5e31 100644 (file)
@@ -8,12 +8,13 @@ git-daemon - A really simple server for git repositories
 SYNOPSIS
 --------
 [verse]
-'git-daemon' [--verbose] [--syslog] [--export-all]
-             [--timeout=n] [--init-timeout=n] [--strict-paths]
-             [--base-path=path] [--user-path | --user-path=path]
-             [--interpolated-path=pathtemplate]
-             [--reuseaddr] [--detach] [--pid-file=file]
-             [--enable=service] [--disable=service]
+'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]
             [--inetd | [--listen=host_or_ipaddr] [--port=n] [--user=user [--group=group]]
             [directory...]
@@ -27,36 +28,36 @@ that service if it is enabled.
 It verifies that the directory has the magic file "git-daemon-export-ok", and
 it will refuse to export any git directory that hasn't explicitly been marked
 for export this way (unless the '--export-all' parameter is specified). If you
-pass some directory paths as 'git-daemon' arguments, you can further restrict
+pass some directory paths as 'git daemon' arguments, you can further restrict
 the offers to a whitelist comprising of those.
 
 By default, only `upload-pack` service is enabled, which serves
-`git-fetch-pack` and `git-ls-remote` clients, which are invoked
-from `git-fetch`, `git-pull`, and `git-clone`.
+'git fetch-pack' and 'git ls-remote' clients, which are invoked
+from 'git fetch', 'git pull', and 'git clone'.
 
 This is ideally suited for read-only updates, i.e., pulling from
 git repositories.
 
-An `upload-archive` also exists to serve `git-archive`.
+An `upload-archive` also exists to serve 'git archive'.
 
 OPTIONS
 -------
 --strict-paths::
        Match paths exactly (i.e. don't allow "/foo/repo" when the real path is
        "/foo/repo.git" or "/foo/repo/.git") and don't do user-relative paths.
-       git-daemon will refuse to start when this option is enabled and no
+       'git daemon' will refuse to start when this option is enabled and no
        whitelist is specified.
 
---base-path::
+--base-path=path::
        Remap all the path requests as relative to the given path.
-       This is sort of "GIT root" - if you run git-daemon with
+       This is sort of "GIT root" - if you run 'git daemon' with
        '--base-path=/srv/git' on example.com, then if you later try to pull
-       'git://example.com/hello.git', `git-daemon` will interpret the path
+       'git://example.com/hello.git', 'git daemon' will interpret the path
        as '/srv/git/hello.git'.
 
 --base-path-relaxed::
        If --base-path is enabled and repo lookup fails, with this option
-       `git-daemon` will attempt to lookup without prefixing the base path.
+       'git daemon' will attempt to lookup without prefixing the base path.
        This is useful for switching to --base-path usage, while still
        allowing the old paths.
 
@@ -80,8 +81,8 @@ OPTIONS
        Incompatible with --port, --listen, --user and --group options.
 
 --listen=host_or_ipaddr::
-       Listen on an a specific IP address or hostname.  IP addresses can
-       be either an IPv4 address or an IPV6 address if supported.  If IPv6
+       Listen on a specific IP address or hostname.  IP addresses can
+       be either an IPv4 address or an IPv6 address if supported.  If IPv6
        is not supported, then --listen=hostname is also not supported and
        --listen must be given an IPv4 address.
        Incompatible with '--inetd' option.
@@ -89,15 +90,19 @@ OPTIONS
 --port=n::
        Listen on an alternative port.  Incompatible with '--inetd' option.
 
---init-timeout::
+--init-timeout=n::
        Timeout between the moment the connection is established and the
        client request is received (typically a rather low value, since
        that should be basically immediate).
 
---timeout::
+--timeout=n::
        Timeout for specific client sub-requests. This includes the time
-       it takes for the server to process the sub-request and time spent
-       waiting for next client's request.
+       it takes for the server to process the sub-request and the time spent
+       waiting for the next client's request.
+
+--max-connections=n::
+       Maximum number of concurrent clients, defaults to 32.  Set it to
+       zero for no limit.
 
 --syslog::
        Log to syslog instead of stderr. Note that this option does not imply
@@ -105,9 +110,9 @@ OPTIONS
 
 --user-path::
 --user-path=path::
-       Allow ~user notation to be used in requests.  When
+       Allow {tilde}user notation to be used in requests.  When
        specified with no parameter, requests to
-       git://host/~alice/foo is taken as a request to access
+       git://host/{tilde}alice/foo is taken as a request to access
        'foo' repository in the home directory of user `alice`.
        If `--user-path=path` is specified, the same request is
        taken as a request to access `path/foo` repository in
@@ -138,14 +143,14 @@ OPTIONS
 +
 Giving these options is an error when used with `--inetd`; use
 the facility of inet daemon to achieve the same before spawning
-`git-daemon` if needed.
+'git daemon' if needed.
 
 --enable=service::
 --disable=service::
        Enable/disable the service site-wide per default.  Note
        that a service disabled site-wide can still be enabled
        per repository if it is marked overridable and the
-       repository enables the service with an configuration
+       repository enables the service with a configuration
        item.
 
 --allow-override=service::
@@ -164,24 +169,24 @@ SERVICES
 
 These services can be globally enabled/disabled using the
 command line options of this command.  If a finer-grained
-control is desired (e.g. to allow `git-archive` to be run
+control is desired (e.g. to allow 'git archive' to be run
 against only in a few selected repositories the daemon serves),
 the per-repository configuration file can be used to enable or
 disable them.
 
 upload-pack::
-       This serves `git-fetch-pack` and `git-ls-remote`
+       This serves 'git fetch-pack' and 'git ls-remote'
        clients.  It is enabled by default, but a repository can
        disable it by setting `daemon.uploadpack` configuration
        item to `false`.
 
 upload-archive::
-       This serves `git-archive --remote`.  It is disabled by
+       This serves 'git archive --remote'.  It is disabled by
        default, but a repository can enable it by setting
        `daemon.uploadarch` configuration item to `true`.
 
 receive-pack::
-       This serves `git-send-pack` clients, allowing anonymous
+       This serves 'git send-pack' clients, allowing anonymous
        push.  It is disabled by default, as there is _no_
        authentication in the protocol (in other words, anybody
        can push anything into the repository, including removal
@@ -199,28 +204,28 @@ $ grep 9418 /etc/services
 git            9418/tcp                # Git Version Control System
 ------------
 
-git-daemon as inetd server::
-       To set up `git-daemon` as an inetd service that handles any
+'git daemon' as inetd server::
+       To set up 'git daemon' as an inetd service that handles any
        repository under the whitelisted set of directories, /pub/foo
        and /pub/bar, place an entry like the following into
        /etc/inetd all on one line:
 +
 ------------------------------------------------
-       git stream tcp nowait nobody  /usr/bin/git-daemon
-               git-daemon --inetd --verbose --export-all
+       git stream tcp nowait nobody  /usr/bin/git
+               git daemon --inetd --verbose --export-all
                /pub/foo /pub/bar
 ------------------------------------------------
 
 
-git-daemon as inetd server for virtual hosts::
-       To set up `git-daemon` as an inetd service that handles
+'git daemon' as inetd server for virtual hosts::
+       To set up 'git daemon' as an inetd service that handles
        repositories for different virtual hosts, `www.example.com`
        and `www.example.org`, place an entry like the following into
        `/etc/inetd` all on one line:
 +
 ------------------------------------------------
-       git stream tcp nowait nobody /usr/bin/git-daemon
-               git-daemon --inetd --verbose --export-all
+       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
@@ -235,13 +240,13 @@ clients, a symlink from `/software` into the appropriate
 default repository could be made as well.
 
 
-git-daemon as regular daemon for virtual hosts::
-       To set up `git-daemon` as a regular, non-inetd service that
+'git daemon' as regular daemon for virtual hosts::
+       To set up 'git daemon' as a regular, non-inetd service that
        handles repositories for multiple virtual hosts based on
        their IP addresses, start the daemon like this:
 +
 ------------------------------------------------
-       git-daemon --verbose --export-all
+       git daemon --verbose --export-all
                --interpolated-path=/pub/%IP/%D
                /pub/192.168.1.200/software
                /pub/10.10.220.23/software
@@ -253,7 +258,7 @@ Repositories can still be accessed by hostname though, assuming
 they correspond to these IP addresses.
 
 selectively enable/disable services per repository::
-       To enable `git-archive --remote` and disable `git-fetch` against
+       To enable 'git archive --remote' and disable 'git fetch' against
        a repository, have the following in the configuration file in the
        repository (that is the file 'config' next to 'HEAD', 'refs' and
        'objects').
@@ -265,6 +270,15 @@ selectively enable/disable services per repository::
 ----------------------------------------------------------------
 
 
+ENVIRONMENT
+-----------
+'git daemon' will set REMOTE_ADDR to the IP address of the client
+that connected to it, if the IP address is available. REMOTE_ADDR will
+be available in the environment of hooks called when
+services are performed.
+
+
+
 Author
 ------
 Written by Linus Torvalds <torvalds@osdl.org>, YOSHIFUJI Hideaki