summaryrefslogtreecommitdiff
path: root/Documentation/git-daemon.txt
diff options
context:
space:
mode:
authorJunio C Hamano <junkio@cox.net>2006-08-21 02:32:43 (GMT)
committerJunio C Hamano <junkio@cox.net>2006-08-28 06:32:37 (GMT)
commit355f541249633487aa2685e7e7e29963f596b308 (patch)
tree174db86d9260c66c38c58ec976c1b2ac223444c7 /Documentation/git-daemon.txt
parent74c0cc21a57a15bbce46ee02bc882064ee9bcf6b (diff)
downloadgit-355f541249633487aa2685e7e7e29963f596b308.zip
git-355f541249633487aa2685e7e7e29963f596b308.tar.gz
git-355f541249633487aa2685e7e7e29963f596b308.tar.bz2
multi-service daemon: documentation
Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation/git-daemon.txt')
-rw-r--r--Documentation/git-daemon.txt47
1 files changed, 39 insertions, 8 deletions
diff --git a/Documentation/git-daemon.txt b/Documentation/git-daemon.txt
index 17619a3..35c3c4b 100644
--- a/Documentation/git-daemon.txt
+++ b/Documentation/git-daemon.txt
@@ -11,17 +11,16 @@ SYNOPSIS
'git-daemon' [--verbose] [--syslog] [--inetd | --port=n] [--export-all]
[--timeout=n] [--init-timeout=n] [--strict-paths]
[--base-path=path] [--user-path | --user-path=path]
- [--reuseaddr] [--detach] [--pid-file=file]
- [--user=user [--group=group]] [directory...]
+ [--enable=service] [--disable=service]
+ [--allow-override=service] [--forbid-override=service]
+ [--reuseaddr] [--detach] [--pid-file=file]
+ [--user=user [--group=group]] [directory...]
DESCRIPTION
-----------
A really simple TCP git daemon that normally listens on port "DEFAULT_GIT_PORT"
-aka 9418. It waits for a connection, and will just execute "git-upload-pack"
-when it gets one.
-
-It's careful in that there's a magic request-line that gives the command and
-what directory to upload, and it verifies that the directory is OK.
+aka 9418. It waits for a connection asking for a service, and will serve
+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
@@ -29,7 +28,12 @@ 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
the offers to a whitelist comprising of those.
-This is ideally suited for read-only updates, i.e., pulling from git repositories.
+By default, only `upload-pack` service is enabled, which serves
+`git-fetch-pack` and `git-peek-remote` clients that are invoked
+from `git-fetch`, `git-ls-remote`, and `git-clone`.
+
+This is ideally suited for read-only updates, i.e., pulling from
+git repositories.
OPTIONS
-------
@@ -105,11 +109,38 @@ 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.
+--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
+ item.
+
+--allow-override, --forbid-override::
+ Allow/forbid overriding the site-wide default with per
+ repository configuration. By default, all the services
+ are overridable.
+
<directory>::
A directory to add to the whitelist of allowed directories. Unless
--strict-paths is specified this will also include subdirectories
of each named directory.
+SERVICES
+--------
+
+upload-pack::
+ This serves `git-fetch-pack` and `git-peek-remote`
+ clients. It is enabled by default, but a repository can
+ disable it by setting `daemon.uploadpack` configuration
+ item to `false`.
+
+upload-tar::
+ This serves `git-tar-tree --remote=repository` client.
+ It is not enabled by default, but a repository can
+ enable it by setting `daemon.uploadtar` configuration
+ item to `true`.
+
Author
------
Written by Linus Torvalds <torvalds@osdl.org>, YOSHIFUJI Hideaki