~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
50
USING A CONFIG FILE
51
-------------------
52
53
Previous versions of Loggerhead read their configuration from a config
54
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)
55
'start-loggerhead' script.  A 'loggerhead.conf.example' file is
165.1.2 by Michael Hudson
start on README
56
included in the source which has comments explaining the various
57
options.
147.1.1 by Michael Hudson
poolie feedback
58
59
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
60
183.2.1 by John Arbash Meinel
Add Copyright information to most files.
61
    $ ./start-loggerhead
146.1.1 by Michael Hudson
release preparations
62
165.1.5 by Michael Hudson
more readme stuff
63
This will run loggerhead in the background, listening on port 8080 by
64
default.
147.1.1 by Michael Hudson
poolie feedback
65
66
To stop Loggerhead, run::
89 by Robey Pointer
fix up dev.cfg so that nobody will ever have to edit it, by letting the
67
183.2.1 by John Arbash Meinel
Add Copyright information to most files.
68
    $ ./stop-loggerhead
89 by Robey Pointer
fix up dev.cfg so that nobody will ever have to edit it, by letting the
69
147.1.1 by Michael Hudson
poolie feedback
70
In the configuration file you can configure projects, and branches per
71
project.  The idea is that you could be publishing several (possibly
72
unrelated) projects through the same loggerhead instance, and several
73
branches for the same project.  See the "loggerhead.conf.example" file
146.1.1 by Michael Hudson
release preparations
74
included with the source.
44 by Robey Pointer
better readme
75
147.1.1 by Michael Hudson
poolie feedback
76
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)
77
the location of the start-loggerhead script.
147.1.1 by Michael Hudson
poolie feedback
78
89 by Robey Pointer
fix up dev.cfg so that nobody will ever have to edit it, by letting the
79
165.1.2 by Michael Hudson
start on README
80
SERVING LOGGERHEAD FROM BEHIND APACHE
81
-------------------------------------
82
83
If you want to view Bazaar branches from your existing Apache
84
installation, you'll need to configure Apache to proxy certain
85
requests to Loggerhead.  Adding lines like this to you Apache
86
configuration is one way to do this::
87
88
    <Location "/branches/">
277 by Michael Hudson
* make example Apache stanza more correct with how PasteDeploy works
89
        ProxyPass http://127.0.0.1:8080/branches/
90
        ProxyPassReverse http://127.0.0.1:8080/branches/
165.1.2 by Michael Hudson
start on README
91
    </Location>
92
185 by Martin Albisetti
* Clarify License and add copyright to all file headers (John Arbash Meinel)
93
If Paste Deploy is installed, the 'serve-branches' script can be
165.1.5 by Michael Hudson
more readme stuff
94
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
95
some path into the site, you'll need to specify is using '--prefix=/some_path'.
44 by Robey Pointer
better readme
96
159.1.6 by Michael Hudson
readme changes
97
FILES CHANGED CACHE
98
-------------------
99
100
To speed up the display of the changelog view for large trees,
101
loggerhead can be configured to cache the files changes between
102
revisions.  Set the 'cachepath' value in the config file.
44 by Robey Pointer
better readme
103
104
105
SUPPORT
106
-------
107
147.1.1 by Michael Hudson
poolie feedback
108
Loggerhead is loosely based on bazaar-webserve, which was loosely
109
based on hgweb.  Discussion should take place on the bazaar-dev
110
mailing list at bazaar@lists.canonical.com.  You can join the list at
111
<https://lists.ubuntu.com/mailman/listinfo/bazaar>.  You don't need to
112
subscribe to post, but your first post will be held briefly for manual
113
moderation.
114
165.1.2 by Michael Hudson
start on README
115
Bugs are tracked on Launchpad; start at:
116
117
    https://bugs.launchpad.net/loggerhead