1
:command:`serve-branches`
2
=========================
4
The :command:`serve-branches` script runs a standalone Loggerhead server in
7
.. program:: serve-branches
14
serve-branches [OPTIONS] <target directory>
19
.. cmdoption:: --user-dirs
21
Serve user directories as ``~user`` (requires ``--trunk-dir``).
23
If both options are set, then for requests where the CGI ``PATH_INFO``
24
starts with "/~<name>", serve branches under the <name> directory.
26
.. cmdoption:: --trunk-dir=DIR
28
The directory that contains the trunk branches (requires ``--user-dirs``).
30
If both options are set, then for requests where the CGI ``PATH_INFO``
31
does not start with "/~<name>", serve branches under DIR.
35
Listen on the given port.
41
Listen on the interface corresponding to the given IP.
43
Defaults to listening on all interfaces, i.e., "0.0.0.0".
45
.. cmdoption:: --protocol
47
Serve the application using the specified protocol.
49
Can be one of: "http", "scgi", "fcgi", "ajp" (defaults to "http").
51
.. cmdoption:: --prefix
53
Set the supplied value as the CGI ``SCRIPT_NAME`` for the application.
55
This option is intended for use when serving Loggerhead behind a
56
reverse proxy, with Loggerhead being "mounted" at a directory below
57
the root. E.g., if the reverse proxy translates requests for
58
``http://example.com/loggerhead`` onto the standalone Loggerhead process,
59
that process should be run with ``--prefix=/loggerhead``.
61
.. cmdoption:: --log-folder=LOG_FOLDER
63
The directory in which to place Loggerhead's log files.
65
Defaults to the current directory.
67
.. cmdoption:: --cache-dir=SQL_CACHE_DIR
69
The directory in which to place the SQL cache.
71
Defaults to the current directory.
73
.. cmdoption:: --use-cdn
75
Serve YUI javascript libraries from Yahoo!'s CDN.
77
.. cmdoption:: --allow-writes
79
Allow writing to the Bazaar server.
81
Setting this option keeps Loggerhead from adding a 'readonly+' prefix
82
to the base URL of the branch. The only effect of suppressing this prefix
83
is to make visible the display of instructions for checking out the
84
'public_branch' URL for the branch being browsed.
86
.. cmdoption:: -h, --help
88
Print the help message and exit
90
.. cmdoption:: --version
92
Print the software version and exit.
97
The following options are only useful when developing / debugging Loggerhead
100
.. cmdoption:: --profile
102
Generate per-request callgrind profile data.
104
Data for each request is written to a file ``%d-stats.callgrind``,
105
where ``%d`` is replaced by the sequence number of the request.
107
.. cmdoption:: --memory-profile
109
Profile the memory usage using the `Dozer
110
<http://pypi.python.org/pypi/Dozer>`_ middleware.
112
.. cmdoption:: --reload
114
Restart the application when any of its python file change.
116
This option should only used for development purposes.
added
removed
docs/serve-branches.rst
