~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Robey Pointer
  • Date: 2007-01-02 07:17:25 UTC
  • Revision ID: robey@lag.net-20070102071725-nreem2cu8aiu4vsb
add the ability to auto-publish anything found under a particular folder.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
LOGGERHEAD
2
2
==========
3
3
 
4
 
[ Version 1.2 for Bazaar 1.2 ]
5
 
 
6
 
Loggerhead is a web viewer for Bazaar branches.  It can be used to
7
 
navigate a branch history, annotate files, perform searches... all the
8
 
usual things.
9
 
 
10
 
To get started, first you need to create a 'loggerhead.conf' file
11
 
specifying the branches you want to view.  A 'loggerhead.conf.example'
12
 
file is included in the source which has comments explaining the
13
 
various options.
14
 
 
15
 
Loggerhead can then be started by running::
16
 
 
17
 
    $ ./start-loggerhead.py
18
 
 
19
 
This will run loggerhead in the background.  It listens on port 8080
20
 
by default, so go to http://localhost:8080/ in your browser to see the
21
 
list of bublished branches.
22
 
 
23
 
To stop Loggerhead, run::
24
 
 
25
 
    $ ./stop-loggerhead.py
26
 
 
27
 
If you want to view Bazaar branches from your existing Apache
28
 
installation, you'll need to configure Apache to proxy certain
29
 
requests to Loggerhead.  Adding lines like this to you Apache
30
 
configuration is one way to do this::
 
4
[ version 1.0 for bazaar 0.13 ]
 
5
 
 
6
Loggerhead is a web viewer for bazaar branches.  It can be used to navigate
 
7
a branch history, annotate files, perform searches... all the usual things.
 
8
 
 
9
This is a TurboGears (http://www.turbogears.org) project.  It can be
 
10
started by running the 'start-loggerhead.py' script.
 
11
 
 
12
If you're not familiar with turbogears, the easiest way to get this script
 
13
started is to run it via::
 
14
 
 
15
    $ nohup ./start-loggerhead.py &
 
16
    
 
17
and add the following lines to your apache configuration::
31
18
 
32
19
    <Location "/branches/">
33
20
        ProxyPass http://127.0.0.1:8080/
34
21
        ProxyPassReverse http://127.0.0.1:8080/
35
22
    </Location>
36
 
 
37
 
In the configuration file you can configure projects, and branches per
38
 
project.  The idea is that you could be publishing several (possibly
39
 
unrelated) projects through the same loggerhead instance, and several
40
 
branches for the same project.  See the "loggerhead.conf.example" file
41
 
included with the source.
42
 
 
43
 
Although Loggerhead is a TurboGears (http://www.turbogears.org)
44
 
project, don't bother with "dev.cfg" or any of the other TurboGears
45
 
config files.  Loggerhead overrides those values with its own.
46
 
 
47
 
A debug and access log are stored in the logs/ folder, relative to
48
 
the location of the start-loggerhead.py script.
49
 
 
50
 
You may update the Bazaar branch at any time (for example, from a cron).
51
 
Loggerhead will notice and refresh, and Bazaar uses its own branch
52
 
locking to prevent corruption.
53
 
 
54
 
 
55
 
FILES CHANGED CACHE
56
 
-------------------
57
 
 
58
 
To speed up the display of the changelog view for large trees,
59
 
loggerhead can be configured to cache the files changes between
60
 
revisions.  Set the 'cachepath' value in the config file.
 
23
    
 
24
The port configuration is in "dev.cfg".
 
25
 
 
26
The config file is "loggerhead.conf".  In there, you can configure projects,
 
27
and branches per project.  The idea is that you could be publishing several
 
28
(possibly unrelated) projects through the same loggerhead instance, and 
 
29
several branches for the same project.
 
30
 
 
31
 
 
32
CACHES
 
33
------
 
34
 
 
35
To speed up most operations, loggerhead will start creating two caches per
 
36
branch when it first launches:
 
37
 
 
38
    - a revision data cache
 
39
    - a text searching cache
 
40
 
 
41
You can put the cache folder anywhere, but I find that a folder under
 
42
the branch's .bzr/ folder is the simplest place.
 
43
 
 
44
The caches for a branch with 10,000 revisions take about 15 minutes each
 
45
on my machine, but YMMV.  Once they are built, they update every six hours
 
46
or so but usually finish quickly (or instantly) after the initial creation.
 
47
Until the revision cache is built, all operations will be slow.
 
48
 
 
49
You may update the bazaar branch at any time (for example, from a cron).
 
50
Loggerhead will notice and refresh, and bazaar uses its own branch locking
 
51
to prevent corruption.
61
52
 
62
53
 
63
54
SUPPORT
64
55
-------
65
56
 
66
 
Loggerhead is loosely based on bazaar-webserve, which was loosely
67
 
based on hgweb.  Discussion should take place on the bazaar-dev
68
 
mailing list at bazaar@lists.canonical.com.  You can join the list at
69
 
<https://lists.ubuntu.com/mailman/listinfo/bazaar>.  You don't need to
70
 
subscribe to post, but your first post will be held briefly for manual
71
 
moderation.
 
57
This is loosely based on bazaar-webserve, which was loosely based on hgweb.
 
58
Discussion should take place on the bazaar-dev mailing list.
72
59