Merge branch 'sb/doc-submodule-sync-recursive' into maint
[git] / Documentation / howto / use-git-daemon.txt
1 Content-type: text/asciidoc
2
3 How to use git-daemon
4 =====================
5
6 Git can be run in inetd mode and in stand alone mode. But all you want is
7 let a coworker pull from you, and therefore need to set up a Git server
8 real quick, right?
9
10 Note that git-daemon is not really chatty at the moment, especially when
11 things do not go according to plan (e.g. a socket could not be bound).
12
13 Another word of warning: if you run
14
15         $ git ls-remote git://127.0.0.1/rule-the-world.git
16
17 and you see a message like
18
19         fatal: The remote end hung up unexpectedly
20
21 it only means that _something_ went wrong. To find out _what_ went wrong,
22 you have to ask the server. (Git refuses to be more precise for your
23 security only. Take off your shoes now. You have any coins in your pockets?
24 Sorry, not allowed -- who knows what you planned to do with them?)
25
26 With these two caveats, let's see an example:
27
28         $ git daemon --reuseaddr --verbose --base-path=/home/gitte/git \
29           --export-all -- /home/gitte/git/rule-the-world.git
30
31 (Of course, unless your user name is `gitte` _and_ your repository is in
32 ~/rule-the-world.git, you have to adjust the paths. If your repository is
33 not bare, be aware that you have to type the path to the .git directory!)
34
35 This invocation tries to reuse the address if it is already taken
36 (this can save you some debugging, because otherwise killing and restarting
37 git-daemon could just silently fail to bind to a socket).
38
39 Also, it is (relatively) verbose when somebody actually connects to it.
40 It also sets the base path, which means that all the projects which can be
41 accessed using this daemon have to reside in or under that path.
42
43 The option `--export-all` just means that you _don't_ have to create a
44 file named `git-daemon-export-ok` in each exported repository. (Otherwise,
45 git-daemon would complain loudly, and refuse to cooperate.)
46
47 Last of all, the repository which should be exported is specified. It is
48 a good practice to put the paths after a "--" separator.
49
50 Now, test your daemon with
51
52         $ git ls-remote git://127.0.0.1/rule-the-world.git
53
54 If this does not work, find out why, and submit a patch to this document.