← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/en/user-guide/server.txt

(jameinel) Allow 'bzr serve' to interpret SIGHUP as a graceful shutdown.
 (bug #795025) (John A Meinel)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/user-guide/server.txt
13
13
over any of these protocols, Bazaar will allow you to read it remotely.  Just
14
14
enter the URL to the branch in the Bazaar command you are running.::
15
15
 
16
 
    bzr log http://bazaar-vcs.org/bzr/bzr.dev
 
16
    bzr log http://bazaar.launchpad.net/~bzr-pqm/bzr/bzr.dev
17
17
 
18
18
Bazaar supports writing over FTP, SFTP and (via a plugin) over HTTP-WebDAV.
19
19
 
28
28
To maintain the highest security possible, the current
29
29
smart server provides read-only access by default.  To
30
30
enable read-write access, run it with ``--allow-writes``. When using
31
 
the SSH access method, bzr automatically runs with with the
 
31
the SSH access method, bzr automatically runs with the
32
32
``--allow-writes`` option.
33
33
 
34
34
The alternative ways of configuring a smart server are explained below.
36
36
SSH
37
37
~~~
38
38
 
39
 
Using Bazaar over SSH requires no special configuration on the server::
 
39
Using Bazaar over SSH requires no special configuration on the server; so long
 
40
as Bazaar is installed on the server you can use ``bzr+ssh`` URLs, e.g.::
 
41
 
 
42
    bzr log bzr+ssh://host/path/to/branch
 
43
 
 
44
If `bzr` is not installed system-wide on the server you may need to explicitly
 
45
tell the local `bzr` where to find the remote `bzr`::
40
46
 
41
47
    BZR_REMOTE_PATH=~/bin/bzr bzr log bzr+ssh://host/path/to/branch
42
48
 
43
49
The ``BZR_REMOTE_PATH`` environment variable adjusts how `bzr` will be
44
50
invoked on the remote system.  By default, just `bzr` will be invoked,
45
 
which requires the `bzr` executable to be on the default search path.
 
51
which requires the `bzr` executable to be on the default search path.  You can
 
52
also set this permanently per-location in ``locations.conf``.
46
53
 
47
 
The ``bzr+ssh://`` URL scheme only supports absolute paths from the
48
 
root of the filesystem.  Future versions are expected to support ``~``
49
 
in the same way as ``sftp://`` URLs
50
 
(https://bugs.launchpad.net/bzr/+bug/109143).
 
54
Like SFTP, paths starting with ``~`` are relative to your home directory, e.g.
 
55
``bzr+ssh://example.com/~/code/proj``.  Additionally, paths starting with
 
56
``~user`` will be relative to that user's home directory.
51
57
 
52
58
inetd
53
59
~~~~~
58
64
 
59
65
Running a Bazaar server from inetd requires an inetd.conf entry::
60
66
 
61
 
    4155  stream  tcp  nowait  bzruser  /usr/bin/bzr /usr/bin/bzr serve --inet --directory=/srv/bzr/repo
 
67
    4155  stream  TCP  nowait  bzruser  /usr/bin/bzr /usr/bin/bzr serve --inet --directory=/srv/bzr/repo
62
68
 
63
69
When running client commands, the URL you supply is a `bzr://` URL relative to
64
70
the ``--directory`` option given in inetd.conf::
65
71
 
66
72
    bzr log bzr://host/branchname
67
73
 
 
74
If possible, paths starting with ``~`` and ``~user`` will be expanded as for
 
75
``bzr+ssh``.  Home directories outside the ``--directory`` specified to ``bzr
 
76
serve`` will not be accessible.
 
77
 
68
78
Dedicated
69
79
~~~~~~~~~
70
80
 
88
98
server::
89
99
 
90
100
    bzr serve --port=localhost:1234 --directory=/srv/bzr/repo
91
 
    
 
101
 
92
102
client::
93
103
 
94
104
    bzr log bzr://localhost:1234/branchname