← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README

  • Committer: Martin Albisetti
  • Date: 2009-06-08 23:04:49 UTC
  • mfrom: (356.3.3 deprecate)
  • Revision ID: martin.albisetti@canonical.com-20090608230449-wxg1l04m5ur04dzm
Remove compatibility code with 1.6, bump up minimum required bzrlib to 1.13

Show diffs side-by-side

added added

removed removed

Lines of Context:
README
1
1
LOGGERHEAD
2
2
==========
3
3
 
4
 
[ Version 1.2 for Bazaar 1.2 ]
 
4
[ Version 1.10 for Bazaar 1.6 ]
5
5
 
6
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::
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
 
10
 
 
11
GETTING STARTED
 
12
---------------
 
13
 
 
14
Loggerhead depends on:
 
15
 
 
16
1) SimpleTAL for templating.
 
17
   On Ubuntu, `sudo apt-get install python-simpletal`
 
18
   or download from http://www.owlfish.com/software/simpleTAL/download.html
 
19
2) simplejson for producing JSON data.
 
20
   On Ubuntu, `sudo apt-get install python-simplejson`
 
21
   or use `easy_install simplejson`.
 
22
3) Paste for the server. (You need version 1.2 or newer of Paste.)
 
23
   On Ubuntu, `sudo apt-get install python-paste`
 
24
   or use `easy_install Paste`
 
25
4) Paste Deploy  (optional, needed when proxying through Apache)
 
26
   On Ubuntu, `sudo apt-get install python-pastedeploy`
 
27
   or use `easy_install PasteDeploy`
 
28
 
 
29
Then simply run the 'serve-branches' with the branch you want to
 
30
serve on the command line:
 
31
 
 
32
    ./serve-branches ~/path/to/branch
 
33
 
 
34
The script listens on port 8080 so head to http://localhost:8080/ in
 
35
your browser to see the branch.  You can also pass a directory that
 
36
contains branches to the script, and it will serve a very simple
 
37
directory listing at other pages.
 
38
 
 
39
You may update the Bazaar branches being viewed at any time.
 
40
Loggerhead will notice and refresh, and Bazaar uses its own branch
 
41
locking to prevent corruption.
 
42
 
 
43
To run loggerhead as a linux daemon: 
 
44
1) Copy loggerheadd to /etc/init.d
 
45
2) Edit the file to configure where your loggerhead is installed, and which
 
46
   serve-branches options you would like.
 
47
3) Register the service
 
48
   cd /etc/init.d
 
49
   a) on upstart based systems like Ubuntu run: 
 
50
      update-rc.d loggerheadd defaults
 
51
   b) on Sysvinit based systems like Centos or SuSE run:
 
52
      chkconfig --add loggerheadd
 
53
 
 
54
 
 
55
LOGGERHEAD AS A BAZAAR PLUGIN
 
56
-----------------------------
 
57
 
 
58
This branch contains experimental support for using Loggerhead as a Bazaar
 
59
plugin.  To use it, place the top-level Loggerhead directory (the one
 
60
containing this file) at ``~/.bazaar/plugins/loggerhead``.
 
61
 
 
62
 
 
63
USING A CONFIG FILE
 
64
-------------------
 
65
 
 
66
To hide branches from being displayed, add to ``~/.bazaar/locations.conf``,
 
67
under the branch's section:
 
68
 
 
69
    [/path/to/branch]
 
70
    http_serve = False
 
71
 
 
72
 
 
73
More configuration options to come soon.
 
74
 
 
75
 
 
76
SERVING LOGGERHEAD FROM BEHIND APACHE
 
77
-------------------------------------
26
78
 
27
79
If you want to view Bazaar branches from your existing Apache
28
80
installation, you'll need to configure Apache to proxy certain
30
82
configuration is one way to do this::
31
83
 
32
84
    <Location "/branches/">
33
 
        ProxyPass http://127.0.0.1:8080/
34
 
        ProxyPassReverse http://127.0.0.1:8080/
 
85
        ProxyPass http://127.0.0.1:8080/branches/
 
86
        ProxyPassReverse http://127.0.0.1:8080/branches/
35
87
    </Location>
36
88
 
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
 
CACHES
 
89
If Paste Deploy is installed, the 'serve-branches' script can be
 
90
run behind a proxy at the root of a site, but if you're running it at
 
91
some path into the site, you'll need to specify is using '--prefix=/some_path'.
 
92
 
 
93
 
 
94
SEARCH
56
95
------
57
96
 
58
 
To speed up operations with large branches, loggerhead can be configured
59
 
to create three caches per branch when it first launches:
60
 
 
61
 
    - a revision data cache
62
 
    - a cache of files changed in a revision
63
 
    - a text searching cache
64
 
 
65
 
You can put the cache folder anywhere.
66
 
 
67
 
The revision data cache and text searching cache will be automatically
68
 
filled once loggerhead starts up.  The caches for a branch with 15,000
69
 
revisions take about four minutes each on a fairly fast machine, but
70
 
mileage may vary.  Once they are built, they update every six hours or
71
 
so but usually finish quickly (or instantly) after the initial creation.
72
 
 
 
97
Search is currently supported by using the bzr-search plugin (available
 
98
at: ``https://launchpad.net/bzr-search``
 
99
You need to have the plugin installed and each branch indexed to allow
 
100
searching on branches.
73
101
 
74
102
SUPPORT
75
103
-------
81
109
subscribe to post, but your first post will be held briefly for manual
82
110
moderation.
83
111
 
 
112
Bugs are tracked on Launchpad; start at:
 
113
 
 
114
    https://bugs.launchpad.net/loggerhead