/breezy/unstable

To get this branch, use:
bzr branch https://code.breezy-vcs.org/breezy/unstable

« back to all changes in this revision

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

  • Committer: Jelmer Vernooij
  • Date: 2017-05-24 01:39:33 UTC
  • mfrom: (3815.3776.6)
  • Revision ID: jelmer@jelmer.uk-20170524013933-ir4y4tqtrsiz2ka2
New upstream snapshot.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
Running a smart server
2
2
======================
3
3
 
4
 
Bazaar does not require a specialised server because it operates over HTTP, FTP
 
4
Breezy does not require a specialised server because it operates over HTTP, FTP
5
5
or SFTP.  There is an optional smart server that can be invoked over SSH, from
6
6
inetd, or in a dedicated mode.
7
7
 
9
9
------------
10
10
 
11
11
We describe HTTP, FTP, SFTP and HTTP-WebDAV as "dumb" servers because they do
12
 
not offer any assistance to Bazaar.  If you make a Bazaar repository available
13
 
over any of these protocols, Bazaar will allow you to read it remotely.  Just
14
 
enter the URL to the branch in the Bazaar command you are running.::
15
 
 
16
 
    bzr log http://bazaar.launchpad.net/~bzr-pqm/bzr/bzr.dev
17
 
 
18
 
Bazaar supports writing over FTP, SFTP and (via a plugin) over HTTP-WebDAV.
 
12
not offer any assistance to Breezy.  If you make a Breezy repository available
 
13
over any of these protocols, Breezy will allow you to read it remotely.  Just
 
14
enter the URL to the branch in the Breezy command you are running.::
 
15
 
 
16
    brz log http://bazaar.launchpad.net/~brz-pqm/brz/brz.dev
 
17
 
 
18
Breezy supports writing over FTP, SFTP and (via a plugin) over HTTP-WebDAV.
19
19
 
20
20
High-performance smart server
21
21
-----------------------------
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 the
 
31
the SSH access method, brz 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; 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`::
46
 
 
47
 
    BZR_REMOTE_PATH=~/bin/bzr bzr log bzr+ssh://host/path/to/branch
48
 
 
49
 
The ``BZR_REMOTE_PATH`` environment variable adjusts how `bzr` will be
50
 
invoked on the remote system.  By default, just `bzr` will be invoked,
51
 
which requires the `bzr` executable to be on the default search path.  You can
 
39
Using Breezy over SSH requires no special configuration on the server; so long
 
40
as Breezy is installed on the server you can use ``bzr+ssh`` URLs, e.g.::
 
41
 
 
42
    brz log bzr+ssh://host/path/to/branch
 
43
 
 
44
If `brz` is not installed system-wide on the server you may need to explicitly
 
45
tell the local `brz` where to find the remote `brz`::
 
46
 
 
47
    BZR_REMOTE_PATH=~/bin/brz brz log bzr+ssh://host/path/to/branch
 
48
 
 
49
The ``BZR_REMOTE_PATH`` environment variable adjusts how `brz` will be
 
50
invoked on the remote system.  By default, just `brz` will be invoked,
 
51
which requires the `brz` executable to be on the default search path.  You can
52
52
also set this permanently per-location in ``locations.conf``.
53
53
 
54
54
Like SFTP, paths starting with ``~`` are relative to your home directory, e.g.
58
58
inetd
59
59
~~~~~
60
60
 
61
 
This example shows how to run `bzr` with a dedicated user `bzruser`
62
 
for a shared repository in ``/srv/bzr/repo`` which has a branch at
63
 
``/srv/bzr/repo/branchname``.
64
 
 
65
 
Running a Bazaar server from inetd requires an inetd.conf entry::
66
 
 
67
 
    4155  stream  TCP  nowait  bzruser  /usr/bin/bzr /usr/bin/bzr serve --inet --directory=/srv/bzr/repo
 
61
This example shows how to run `brz` with a dedicated user `brzuser`
 
62
for a shared repository in ``/srv/brz/repo`` which has a branch at
 
63
``/srv/brz/repo/branchname``.
 
64
 
 
65
Running a Breezy server from inetd requires an inetd.conf entry::
 
66
 
 
67
    4155  stream  TCP  nowait  brzuser  /usr/bin/brz /usr/bin/brz serve --inet --directory=/srv/brz/repo
68
68
 
69
69
When running client commands, the URL you supply is a `bzr://` URL relative to
70
70
the ``--directory`` option given in inetd.conf::
71
71
 
72
 
    bzr log bzr://host/branchname
 
72
    brz log bzr://host/branchname
73
73
 
74
74
If possible, paths starting with ``~`` and ``~user`` will be expanded as for
75
 
``bzr+ssh``.  Home directories outside the ``--directory`` specified to ``bzr
 
75
``bzr+ssh``.  Home directories outside the ``--directory`` specified to ``brz
76
76
serve`` will not be accessible.
77
77
 
78
78
Dedicated
81
81
This mode has the same path and URL behaviour as the inetd mode.  To
82
82
run as a specific user, you should use ``su`` or login as that user.
83
83
 
84
 
This example runs bzr on its official port number of `4155` and listens on all
 
84
This example runs brz on its official port number of `4155` and listens on all
85
85
interfaces. This allows connections from anywhere in the world that can reach
86
86
your machine on port `4155`.
87
87
 
88
88
server::
89
89
 
90
 
    bzr serve --directory=/srv/bzr/repo
 
90
    brz serve --directory=/srv/brz/repo
91
91
 
92
92
client::
93
93
 
94
 
    bzr log bzr://host/branchname
 
94
    brz log bzr://host/branchname
95
95
 
96
 
This example runs ``bzr serve`` on `localhost` port `1234`.
 
96
This example runs ``brz serve`` on `localhost` port `1234`.
97
97
 
98
98
server::
99
99
 
100
 
    bzr serve --listen=localhost --port=1234 --directory=/srv/bzr/repo
 
100
    brz serve --listen=localhost --port=1234 --directory=/srv/brz/repo
101
101
 
102
102
client::
103
103
 
104
 
    bzr log bzr://localhost:1234/branchname
 
104
    brz log bzr://localhost:1234/branchname
105
105