~loggerhead-team/loggerhead/trunk-rich

44 by Robey Pointer
better readme
1
LOGGERHEAD
2
==========
3
165.1.1 by Michael Hudson
some NEWS
4
[ Version 1.6 for Bazaar 1.6 ]
59 by Robey Pointer
add version info to readme
5
146.1.5 by Michael Hudson
review comments
6
Loggerhead is a web viewer for Bazaar branches.  It can be used to
146.1.1 by Michael Hudson
release preparations
7
navigate a branch history, annotate files, perform searches... all the
8
usual things.
44 by Robey Pointer
better readme
9
165.1.5 by Michael Hudson
more readme stuff
10
165.1.2 by Michael Hudson
start on README
11
GETTING STARTED
12
---------------
13
218.1.1 by Marius Kruger
Add alternative insallation notes and mention the --prefix option in README.txt
14
Loggerhead depends on 
15
1) SimpleTAL for templating.
228.1.2 by Marius Kruger
Add installation instructions for loggerheadd to README.txt and changed ubuntu -> Ubuntu for consistancy.
16
   on Ubuntu package `sudo apt-get install python-simpletal`
218.1.1 by Marius Kruger
Add alternative insallation notes and mention the --prefix option in README.txt
17
   or download from http://www.owlfish.com/software/simpleTAL/download.html
18
2) Paste for the server. (You need version 1.2 or newer of Paste.) 
228.1.2 by Marius Kruger
Add installation instructions for loggerheadd to README.txt and changed ubuntu -> Ubuntu for consistancy.
19
   on Ubuntu package `sudo apt-get install python-paste`
218.1.1 by Marius Kruger
Add alternative insallation notes and mention the --prefix option in README.txt
20
   or use `easy_install Paste`
21
3) Paste Deploy  (optional, needed when proxying through Apache)
228.1.2 by Marius Kruger
Add installation instructions for loggerheadd to README.txt and changed ubuntu -> Ubuntu for consistancy.
22
   on Ubuntu package `sudo apt-get install python-pastedeploy`
218.1.1 by Marius Kruger
Add alternative insallation notes and mention the --prefix option in README.txt
23
   or use `easy_install PasteDeploy`
165.1.2 by Michael Hudson
start on README
24
185 by Martin Albisetti
* Clarify License and add copyright to all file headers (John Arbash Meinel)
25
Then simply run the 'serve-branches' with the branch you want to
165.1.5 by Michael Hudson
more readme stuff
26
serve on the command line:
27
185 by Martin Albisetti
* Clarify License and add copyright to all file headers (John Arbash Meinel)
28
    ./serve-branches ~/path/to/branch
165.1.5 by Michael Hudson
more readme stuff
29
30
The script listens on port 8080 so head to http://localhost:8080/ in
31
your browser to see the branch.  You can also pass a directory that
32
contains branches to the script, and it will serve a very simple
33
directory listing at other pages.
34
35
You may update the Bazaar branches being viewed at any time.
36
Loggerhead will notice and refresh, and Bazaar uses its own branch
37
locking to prevent corruption.
38
228.1.2 by Marius Kruger
Add installation instructions for loggerheadd to README.txt and changed ubuntu -> Ubuntu for consistancy.
39
To run loggerhead as a linux daemon: 
40
1) Copy loggerheadd to /etc/init.d
41
2) Edit the file to configure where your loggerhead is installed, and which
42
   serve-branches options you would like.
43
3) Register the service
44
   cd /etc/init.d
45
   a) on upstart based systems like Ubuntu run: 
46
      update-rc.d loggerheadd defaults
47
   b) on Sysvinit based systems like Centos or SuSE run:
48
      chkconfig --add loggerheadd
165.1.2 by Michael Hudson
start on README
49
262.2.1 by Martin Pool
Stub code to allow loggerhead to load as a plugin
50
51
LOGGERHEAD AS A BAZAAR PLUGIN
52
-----------------------------
53
54
This branch contains experimental support for using Loggerhead as a Bazaar
55
plugin.  To use it, place the top-level Loggerhead directory (the one
56
containing this file) at ``~/.bazaar/plugins/loggerhead``.
57
58
165.1.2 by Michael Hudson
start on README
59
USING A CONFIG FILE
60
-------------------
61
62
Previous versions of Loggerhead read their configuration from a config
63
file.  This mode of operation is still supported by the
185 by Martin Albisetti
* Clarify License and add copyright to all file headers (John Arbash Meinel)
64
'start-loggerhead' script.  A 'loggerhead.conf.example' file is
165.1.2 by Michael Hudson
start on README
65
included in the source which has comments explaining the various
66
options.
147.1.1 by Michael Hudson
poolie feedback
67
68
Loggerhead can then be started by running::
89 by Robey Pointer
fix up dev.cfg so that nobody will ever have to edit it, by letting the
69
183.2.1 by John Arbash Meinel
Add Copyright information to most files.
70
    $ ./start-loggerhead
146.1.1 by Michael Hudson
release preparations
71
165.1.5 by Michael Hudson
more readme stuff
72
This will run loggerhead in the background, listening on port 8080 by
73
default.
147.1.1 by Michael Hudson
poolie feedback
74
75
To stop Loggerhead, run::
89 by Robey Pointer
fix up dev.cfg so that nobody will ever have to edit it, by letting the
76
183.2.1 by John Arbash Meinel
Add Copyright information to most files.
77
    $ ./stop-loggerhead
89 by Robey Pointer
fix up dev.cfg so that nobody will ever have to edit it, by letting the
78
147.1.1 by Michael Hudson
poolie feedback
79
In the configuration file you can configure projects, and branches per
80
project.  The idea is that you could be publishing several (possibly
81
unrelated) projects through the same loggerhead instance, and several
82
branches for the same project.  See the "loggerhead.conf.example" file
146.1.1 by Michael Hudson
release preparations
83
included with the source.
44 by Robey Pointer
better readme
84
147.1.1 by Michael Hudson
poolie feedback
85
A debug and access log are stored in the logs/ folder, relative to
185 by Martin Albisetti
* Clarify License and add copyright to all file headers (John Arbash Meinel)
86
the location of the start-loggerhead script.
147.1.1 by Michael Hudson
poolie feedback
87
89 by Robey Pointer
fix up dev.cfg so that nobody will ever have to edit it, by letting the
88
165.1.2 by Michael Hudson
start on README
89
SERVING LOGGERHEAD FROM BEHIND APACHE
90
-------------------------------------
91
92
If you want to view Bazaar branches from your existing Apache
93
installation, you'll need to configure Apache to proxy certain
94
requests to Loggerhead.  Adding lines like this to you Apache
95
configuration is one way to do this::
96
97
    <Location "/branches/">
277 by Michael Hudson
* make example Apache stanza more correct with how PasteDeploy works
98
        ProxyPass http://127.0.0.1:8080/branches/
99
        ProxyPassReverse http://127.0.0.1:8080/branches/
165.1.2 by Michael Hudson
start on README
100
    </Location>
101
185 by Martin Albisetti
* Clarify License and add copyright to all file headers (John Arbash Meinel)
102
If Paste Deploy is installed, the 'serve-branches' script can be
165.1.5 by Michael Hudson
more readme stuff
103
run behind a proxy at the root of a site, but if you're running it at
218.1.1 by Marius Kruger
Add alternative insallation notes and mention the --prefix option in README.txt
104
some path into the site, you'll need to specify is using '--prefix=/some_path'.
44 by Robey Pointer
better readme
105
159.1.6 by Michael Hudson
readme changes
106
FILES CHANGED CACHE
107
-------------------
108
109
To speed up the display of the changelog view for large trees,
110
loggerhead can be configured to cache the files changes between
111
revisions.  Set the 'cachepath' value in the config file.
44 by Robey Pointer
better readme
112
113
114
SUPPORT
115
-------
116
147.1.1 by Michael Hudson
poolie feedback
117
Loggerhead is loosely based on bazaar-webserve, which was loosely
118
based on hgweb.  Discussion should take place on the bazaar-dev
119
mailing list at bazaar@lists.canonical.com.  You can join the list at
120
<https://lists.ubuntu.com/mailman/listinfo/bazaar>.  You don't need to
121
subscribe to post, but your first post will be held briefly for manual
122
moderation.
123
165.1.2 by Michael Hudson
start on README
124
Bugs are tracked on Launchpad; start at:
125
126
    https://bugs.launchpad.net/loggerhead