~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Michael Hudson
  • Date: 2008-02-28 04:30:10 UTC
  • mto: This revision was merged to the branch mainline in revision 147.
  • Revision ID: michael.hudson@canonical.com-20080228043010-mcz13so8nudi0i9n
release preparations

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 ]
 
4
[ version 1.2 for bazaar 1.2 ]
5
5
 
6
 
Loggerhead is a web viewer for Bazaar branches.  It can be used to
 
6
Loggerhead is a web viewer for bazaar branches.  It can be used to
7
7
navigate a branch history, annotate files, perform searches... all the
8
8
usual things.
9
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::
 
10
This is a TurboGears (http://www.turbogears.org) project.  It can be
 
11
started by running::
16
12
 
17
13
    $ ./start-loggerhead.py
18
14
 
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::
 
15
This will run loggerhead in the background.  To stop it, run::
24
16
 
25
17
    $ ./stop-loggerhead.py
26
18
 
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::
 
19
If you're not familiar with TurboGears, the simplest way to get running
 
20
is to add the lines like the following to your apache configuration::
31
21
 
32
22
    <Location "/branches/">
33
23
        ProxyPass http://127.0.0.1:8080/
34
24
        ProxyPassReverse http://127.0.0.1:8080/
35
25
    </Location>
36
26
 
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
 
27
The config file is "loggerhead.conf".  In there, you can configure
 
28
projects, and branches per project.  The idea is that you could be
 
29
publishing several (possibly unrelated) projects through the same
 
30
loggerhead instance, and several branches for the same project.  A
 
31
commented example of a configuration file is loggerhead.conf.example
41
32
included with the source.
42
33
 
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.
 
34
Don't bother with "dev.cfg" or any of the other TurboGears config files.
 
35
Loggerhead overrides those values with its own.
 
36
 
 
37
A debug and access log are stored in the logs/ folder.
53
38
 
54
39
 
55
40
CACHES
62
47
    - a cache of files changed in a revision
63
48
    - a text searching cache
64
49
 
65
 
You can put the cache folder anywhere.
 
50
You can put the cache folder anywhere, but I find that a folder under
 
51
the branch's .bzr/ folder is the simplest place.
66
52
 
67
53
The revision data cache and text searching cache will be automatically
68
54
filled once loggerhead starts up.  The caches for a branch with 15,000
70
56
mileage may vary.  Once they are built, they update every six hours or
71
57
so but usually finish quickly (or instantly) after the initial creation.
72
58
 
 
59
You may update the bazaar branch at any time (for example, from a cron).
 
60
Loggerhead will notice and refresh, and bazaar uses its own branch
 
61
locking to prevent corruption.
 
62
 
73
63
 
74
64
SUPPORT
75
65
-------
76
66
 
77
 
Loggerhead is loosely based on bazaar-webserve, which was loosely
78
 
based on hgweb.  Discussion should take place on the bazaar-dev
79
 
mailing list at bazaar@lists.canonical.com.  You can join the list at
80
 
<https://lists.ubuntu.com/mailman/listinfo/bazaar>.  You don't need to
81
 
subscribe to post, but your first post will be held briefly for manual
82
 
moderation.
83
 
 
 
67
This is loosely based on bazaar-webserve, which was loosely based on hgweb.
 
68
Discussion should take place on the bazaar-dev mailing list.