Add a HOWTO for setting up a standalone git daemon
Setting up a git-daemon came up the other day on IRC, and it is slightly non trivial for the uninitiated. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
Johannes Schindelin committed
Mar 20, 2007 at 03:29 UTC
e29b96d5aa942325ddba0488c819ef5dd8fd7c48
1 file changed
+52
Documentation/howto/use-git-daemon.txt
new
+52
@@ -0,0 +1,52 @@
1
+How to use git-daemon
2
+
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?
6
+
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).
9
+
10
+Another word of warning: if you run
11
+
12
+ $ git ls-remote git://127.0.0.1/rule-the-world.git
13
+
14
+and you see a message like
15
+
16
+ fatal: The remote end hung up unexpectedly
17
+
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?)
22
+
23
+With these two caveats, let's see an example:
24
+
25
+ $ git daemon --reuseaddr --verbose --base-path=/home/gitte/git \
26
+ --export-all -- /home/gitte/git/rule-the-world.git
27
+
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!)
31
+
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).
35
+
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.
39
+
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.)
43
+
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.
46
+
47
+Now, test your daemon with
48
+
49
+ $ git ls-remote git://127.0.0.1/rule-the-world.git
50
+
51
+If this does not work, find out why, and submit a patch to this document.
52
+