← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/server.txt

  • Committer: John Arbash Meinel
  • Date: 2007-08-02 21:00:51 UTC
  • mto: This revision was merged to the branch mainline in revision 2670.
  • Revision ID: john@arbash-meinel.com-20070802210051-lqpg4mgbeyl3h2ld
(Lukáš Lalinský) Add a special header for intptr_t for MSVC which doesn't have it in the standard place

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/server.txt
1
 
Running a smart server
2
 
======================
 
1
=======================
 
2
Running a Bazaar Server
 
3
=======================
3
4
 
4
5
Bazaar does not require a specialised server because it operates over HTTP, FTP
5
6
or SFTP.  There is an optional smart server that can be invoked over SSH, from
6
7
inetd, or in a dedicated mode.
7
8
 
8
9
Dumb servers
9
 
------------
 
10
============
10
11
 
11
12
We describe HTTP, FTP, SFTP and HTTP-WebDAV as "dumb" servers because they do
12
13
not offer any assistance to Bazaar.  If you make a Bazaar repository available
17
18
 
18
19
Bazaar supports writing over FTP, SFTP and (via a plugin) over HTTP-WebDAV.
19
20
 
20
 
High-performance smart server
21
 
-----------------------------
 
21
High-performance server
 
22
=======================
22
23
 
23
 
The high-performance smart server (hpss) performs certain operations much faster
24
 
than dumb servers are capable of.  In future releases, the range of operations
25
 
that are improved by using the smart server will increase as we continue to
26
 
tune performance.
 
24
The high-performance server is currently in development.  It provides a dumb
 
25
server facility as well as additional capabilities which allow the version of
 
26
bzr that accompanies this documentation to perform some operations much faster
 
27
than via dumb servers.  In future releases of bzr the range of operations that
 
28
are improved by using the high-performance server will increase.
27
29
 
28
30
To maintain the highest security possible, the current
29
 
smart server provides read-only access by default.  To
 
31
high-performance server provides read-only access by default.  To
30
32
enable read-write access, run it with ``--allow-writes``. When using
31
 
the SSH access method, bzr automatically runs with the
 
33
the SSH access method, bzr automatically runs with with the
32
34
``--allow-writes`` option.
33
35
 
34
 
The alternative ways of configuring a smart server are explained below.
 
36
The server can be configured to run in three different ways:
35
37
 
36
38
SSH
37
 
~~~
 
39
---
38
40
 
39
41
Using Bazaar over SSH requires no special configuration on the server::
40
42
 
50
52
(https://bugs.launchpad.net/bzr/+bug/109143).
51
53
 
52
54
inetd
53
 
~~~~~
 
55
-----
54
56
 
55
57
This example shows how to run `bzr` with a dedicated user `bzruser`
56
58
for a shared repository in ``/srv/bzr/repo`` which has a branch at
58
60
 
59
61
Running a Bazaar server from inetd requires an inetd.conf entry::
60
62
 
61
 
    4155  stream  tcp  nowait  bzruser  /usr/bin/bzr /usr/bin/bzr serve --inet --directory=/srv/bzr/repo
 
63
    4155  stream  tcp  nowait  bzruser  /usr/bin/bzr serve --inet --directory=/srv/bzr/repo
62
64
 
63
65
When running client commands, the URL you supply is a `bzr://` URL relative to
64
66
the ``--directory`` option given in inetd.conf::
66
68
    bzr log bzr://host/branchname
67
69
 
68
70
Dedicated
69
 
~~~~~~~~~
 
71
---------
70
72
 
71
73
This mode has the same path and URL behaviour as the inetd mode.  To
72
74
run as a specific user, you should use ``su`` or login as that user.
 
75
This example runs ``bzr serve`` on `localhost` port `1234`.
 
76
 
 
77
server::
 
78
 
 
79
    bzr serve --port=localhost:1234 --directory=/srv/bzr/repo
 
80
    
 
81
client::
 
82
 
 
83
    bzr log bzr://host:1234/branchname
73
84
 
74
85
This example runs bzr on its official port number of `4155` and listens on all
75
86
interfaces. This allows connections from anywhere in the world that can reach
76
87
your machine on port `4155`.
77
88
 
78
89
server::
79
 
 
80
90
    bzr serve --directory=/srv/bzr/repo
81
 
 
82
 
client::
83
 
 
84
 
    bzr log bzr://host/branchname
85
 
 
86
 
This example runs ``bzr serve`` on `localhost` port `1234`.
87
 
 
88
 
server::
89
 
 
90
 
    bzr serve --port=localhost:1234 --directory=/srv/bzr/repo
91
 
    
92
 
client::
93
 
 
94
 
    bzr log bzr://localhost:1234/branchname
95