Documentation/git-daemon.txt

   1 git-daemon(1)
   2 =============
   3
   4 NAME
   5 ----
   6 git-daemon - A really simple server for git repositories
   7
   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>...]
  21
  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.
  27
  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.
  33
  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'.
  37
  38 This is ideally suited for read-only updates, i.e., pulling from
  39 git repositories.
  40
  41 An `upload-archive` also exists to serve 'git archive'.
  42
  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.
  50
  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'.
  57
  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.
  63
  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.
  73
  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.
  78
  79 --inetd::
  80         Have the server run as an inetd service. Implies --syslog.
  81         Incompatible with --port, --listen, --user and --group options.
  82
  83 --listen=<host_or_ipaddr>::
  84         Listen on a specific IP address or hostname.  IP addresses can
  85         be either an IPv4 address or an IPv6 address if supported.  If IPv6
  86         is not supported, then --listen=hostname is also not supported and
  87         --listen must be given an IPv4 address.
  88         Can be given more than once.
  89         Incompatible with '--inetd' option.
  90
  91 --port=<n>::
  92         Listen on an alternative port.  Incompatible with '--inetd' option.
  93
  94 --init-timeout=<n>::
  95         Timeout between the moment the connection is established and the
  96         client request is received (typically a rather low value, since
  97         that should be basically immediate).
  98
  99 --timeout=<n>::
 100         Timeout for specific client sub-requests. This includes the time
 101         it takes for the server to process the sub-request and the time spent
 102         waiting for the next client's request.
 103
 104 --max-connections=<n>::
 105         Maximum number of concurrent clients, defaults to 32.  Set it to
 106         zero for no limit.
 107
 108 --syslog::
 109         Log to syslog instead of stderr. Note that this option does not imply
 110         --verbose, thus by default only error conditions will be logged.
 111
 112 --user-path::
 113 --user-path=<path>::
 114         Allow {tilde}user notation to be used in requests.  When
 115         specified with no parameter, requests to
 116         git://host/{tilde}alice/foo is taken as a request to access
 117         'foo' repository in the home directory of user `alice`.
 118         If `--user-path=path` is specified, the same request is
 119         taken as a request to access `path/foo` repository in
 120         the home directory of user `alice`.
 121
 122 --verbose::
 123         Log details about the incoming connections and requested files.
 124
 125 --reuseaddr::
 126         Use SO_REUSEADDR when binding the listening socket.
 127         This allows the server to restart without waiting for
 128         old connections to time out.
 129
 130 --detach::
 131         Detach from the shell. Implies --syslog.
 132
 133 --pid-file=<file>::
 134         Save the process id in 'file'.  Ignored when the daemon
 135         is run under `--inetd`.
 136
 137 --user=<user>::
 138 --group=<group>::
 139         Change daemon's uid and gid before entering the service loop.
 140         When only `--user` is given without `--group`, the
 141         primary group ID for the user is used.  The values of
 142         the option are given to `getpwnam(3)` and `getgrnam(3)`
 143         and numeric IDs are not supported.
 144 +
 145 Giving these options is an error when used with `--inetd`; use
 146 the facility of inet daemon to achieve the same before spawning
 147 'git daemon' if needed.
 148
 149 --enable=<service>::
 150 --disable=<service>::
 151         Enable/disable the service site-wide per default.  Note
 152         that a service disabled site-wide can still be enabled
 153         per repository if it is marked overridable and the
 154         repository enables the service with a configuration
 155         item.
 156
 157 --allow-override=<service>::
 158 --forbid-override=<service>::
 159         Allow/forbid overriding the site-wide default with per
 160         repository configuration.  By default, all the services
 161         are overridable.
 162
 163 <directory>::
 164         A directory to add to the whitelist of allowed directories. Unless
 165         --strict-paths is specified this will also include subdirectories
 166         of each named directory.
 167
 168 SERVICES
 169 --------
 170
 171 These services can be globally enabled/disabled using the
 172 command line options of this command.  If a finer-grained
 173 control is desired (e.g. to allow 'git archive' to be run
 174 against only in a few selected repositories the daemon serves),
 175 the per-repository configuration file can be used to enable or
 176 disable them.
 177
 178 upload-pack::
 179         This serves 'git fetch-pack' and 'git ls-remote'
 180         clients.  It is enabled by default, but a repository can
 181         disable it by setting `daemon.uploadpack` configuration
 182         item to `false`.
 183
 184 upload-archive::
 185         This serves 'git archive --remote'.  It is disabled by
 186         default, but a repository can enable it by setting
 187         `daemon.uploadarch` configuration item to `true`.
 188
 189 receive-pack::
 190         This serves 'git send-pack' clients, allowing anonymous
 191         push.  It is disabled by default, as there is _no_
 192         authentication in the protocol (in other words, anybody
 193         can push anything into the repository, including removal
 194         of refs).  This is solely meant for a closed LAN setting
 195         where everybody is friendly.  This service can be
 196         enabled by `daemon.receivepack` configuration item to
 197         `true`.
 198
 199 EXAMPLES
 200 --------
 201 We assume the following in /etc/services::
 202 +
 203 ------------
 204 $ grep 9418 /etc/services
 205 git             9418/tcp                # Git Version Control System
 206 ------------
 207
 208 'git daemon' as inetd server::
 209         To set up 'git daemon' as an inetd service that handles any
 210         repository under the whitelisted set of directories, /pub/foo
 211         and /pub/bar, place an entry like the following into
 212         /etc/inetd all on one line:
 213 +
 214 ------------------------------------------------
 215         git stream tcp nowait nobody  /usr/bin/git
 216                 git daemon --inetd --verbose --export-all
 217                 /pub/foo /pub/bar
 218 ------------------------------------------------
 219
 220
 221 'git daemon' as inetd server for virtual hosts::
 222         To set up 'git daemon' as an inetd service that handles
 223         repositories for different virtual hosts, `www.example.com`
 224         and `www.example.org`, place an entry like the following into
 225         `/etc/inetd` all on one line:
 226 +
 227 ------------------------------------------------
 228         git stream tcp nowait nobody /usr/bin/git
 229                 git daemon --inetd --verbose --export-all
 230                 --interpolated-path=/pub/%H%D
 231                 /pub/www.example.org/software
 232                 /pub/www.example.com/software
 233                 /software
 234 ------------------------------------------------
 235 +
 236 In this example, the root-level directory `/pub` will contain
 237 a subdirectory for each virtual host name supported.
 238 Further, both hosts advertise repositories simply as
 239 `git://www.example.com/software/repo.git`.  For pre-1.4.0
 240 clients, a symlink from `/software` into the appropriate
 241 default repository could be made as well.
 242
 243
 244 'git daemon' as regular daemon for virtual hosts::
 245         To set up 'git daemon' as a regular, non-inetd service that
 246         handles repositories for multiple virtual hosts based on
 247         their IP addresses, start the daemon like this:
 248 +
 249 ------------------------------------------------
 250         git daemon --verbose --export-all
 251                 --interpolated-path=/pub/%IP/%D
 252                 /pub/192.168.1.200/software
 253                 /pub/10.10.220.23/software
 254 ------------------------------------------------
 255 +
 256 In this example, the root-level directory `/pub` will contain
 257 a subdirectory for each virtual host IP address supported.
 258 Repositories can still be accessed by hostname though, assuming
 259 they correspond to these IP addresses.
 260
 261 selectively enable/disable services per repository::
 262         To enable 'git archive --remote' and disable 'git fetch' against
 263         a repository, have the following in the configuration file in the
 264         repository (that is the file 'config' next to 'HEAD', 'refs' and
 265         'objects').
 266 +
 267 ----------------------------------------------------------------
 268         [daemon]
 269                 uploadpack = false
 270                 uploadarch = true
 271 ----------------------------------------------------------------
 272
 273
 274 ENVIRONMENT
 275 -----------
 276 'git daemon' will set REMOTE_ADDR to the IP address of the client
 277 that connected to it, if the IP address is available. REMOTE_ADDR will
 278 be available in the environment of hooks called when
 279 services are performed.
 280
 281
 282
 283 Author
 284 ------
 285 Written by Linus Torvalds <torvalds@osdl.org>, YOSHIFUJI Hideaki
 286 <yoshfuji@linux-ipv6.org> and the git-list <git@vger.kernel.org>
 287
 288 Documentation
 289 --------------
 290 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 291
 292 GIT
 293 ---
 294 Part of the linkgit:git[1] suite