X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=Documentation%2Fgit-daemon.txt;h=2a8f371ec95b619bcfb3fc289770ab7ef929214d;hb=ee34518d629331dadd58b1a75294369d679eda8b;hp=5886c83ec8b3b8a9b2d45a3094f6fbdd5f7c0904;hpb=7fc9d69fca0ea8afab6709622b694f31662fb2ee;p=git.git diff --git a/Documentation/git-daemon.txt b/Documentation/git-daemon.txt index 5886c83e..2a8f371e 100644 --- a/Documentation/git-daemon.txt +++ b/Documentation/git-daemon.txt @@ -3,30 +3,75 @@ git-daemon(1) NAME ---- -git-daemon - Some git command not yet documented. - +git-daemon - A really simple server for git repositories. SYNOPSIS -------- -'git-daemon' [ --option ] ... +'git-daemon' [--verbose] [--syslog] [--inetd | --port=n] [--export-all] + [--timeout=n] [--init-timeout=n] [--strict-paths] [directory...] DESCRIPTION ----------- -Does something not yet documented. +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. + +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 +the offers to a whitelist comprising of those. +This is ideally suited for read-only updates, ie pulling from git repositories. OPTIONS ------- ---option:: - Some option not yet documented. +--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 + whitelist is specified. + +--export-all:: + Allow pulling from all directories that look like GIT repositories + (have the 'objects' and 'refs' subdirectories), even if they + do not have the 'git-daemon-export-ok' file. + +--inetd:: + Have the server run as an inetd service. Implies --syslog. + +--port:: + Listen on an alternative port. + +--init-timeout:: + 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 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. + +--syslog:: + Log to syslog instead of stderr. Note that this option does not imply + --verbose, thus by default only error conditions will be logged. -...:: - Some argument not yet documented. +--verbose:: + Log details about the incoming connections and requested files. +:: + A directory to add to the whitelist of allowed directories. Unless + --strict-paths is specified this will also include subdirectories + of each named directory. Author ------ -Written by Linus Torvalds and YOSHIFUJI Hideaki +Written by Linus Torvalds , YOSHIFUJI Hideaki + and the git-list Documentation -------------- @@ -34,5 +79,5 @@ Documentation by Junio C Hamano and the git-list . GIT --- -Part of the link:git.html[git] suite +Part of the gitlink:git[7] suite