← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README

https://launchpad.net/bugs/740142
Improve escaping of filenames in revision views. Fixes a couple of XSS holes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
README
1
 
LOGGERHEAD
 
1
Loggerhead
2
2
==========
3
3
 
4
 
Loggerhead is a web viewer for bazaar branches.  It can be used to navigate
5
 
a branch history, annotate files, perform searches... all the usual things.
6
 
 
7
 
This is a TurboGears (http://www.turbogears.org) project.  It can be
8
 
started by running the 'start-loggerhead.py' script.
9
 
 
10
 
If you're not familiar with turbogears, the easiest way to get this script
11
 
started is to run it via::
12
 
 
13
 
    $ nohup ./start-loggerhead.py &
14
 
    
15
 
and add the following lines to your apache configuration::
16
 
 
17
 
    <Location "/branches/">
18
 
        ProxyPass http://127.0.0.1:8080/
19
 
        ProxyPassReverse http://127.0.0.1:8080/
20
 
    </Location>
21
 
    
22
 
The port configuration is in "dev.cfg".
23
 
 
24
 
The config file is "loggerhead.conf".  In there, you can configure projects,
25
 
and branches per project.  The idea is that you could be publishing several
26
 
(possibly unrelated) projects through the same loggerhead instance, and 
27
 
several branches for the same project.
28
 
 
29
 
 
30
 
CACHES
31
 
------
32
 
 
33
 
To speed up most operations, loggerhead will start creating two caches per
34
 
branch when it first launches:
35
 
 
36
 
    - a revision data cache
37
 
    - a text searching cache
38
 
 
39
 
You can put the cache folder anywhere, but I find that a folder under
40
 
the branch's .bzr/ folder is the simplest place.
41
 
 
42
 
The caches for a branch with 10,000 revisions take about 15 minutes each
43
 
on my machine, but YMMV.  Once they are built, they update every six hours
44
 
or so but usually finish quickly (or instantly) after the initial creation.
45
 
Until the revision cache is built, all operations will be slow.
46
 
 
47
 
You may update the bazaar branch at any time (for example, from a cron).
48
 
Loggerhead will notice and refresh, and bazaar uses its own branch locking
49
 
to prevent corruption.
50
 
 
51
 
 
52
 
SUPPORT
53
 
-------
54
 
 
55
 
This is loosely based on bazaar-webserve, which was loosely based on hgweb.
56
 
Discussion should take place on the bazaar-dev mailing list.
57
 
 
 
4
Overview
 
5
--------
 
6
 
 
7
Loggerhead is a web viewer for Bazaar branches. Its lets users do
 
8
stuff like:
 
9
 
 
10
* navigate through branch history
 
11
* view the files in a given revision
 
12
* annotate files (i.e. find out the origin of each line of a file)
 
13
* perform searches.
 
14
 
 
15
 
 
16
Documentation
 
17
-------------
 
18
 
 
19
See docs/index.rst for installation instructions and basic
 
20
documentation.
 
21
 
 
22
 
 
23
Licensing
 
24
---------
 
25
 
 
26
This software is (C) Copyright Canonical Limited 2006-10 under the
 
27
GPL Version 2 or later. Please see the file COPYING.txt for the
 
28
licence details.