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