← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

merge txtfile-updates-bug-241999:
update readme and news, remove some dead code and tidy up
server-branches.py

Show diffs side-by-side

added added

removed removed

Lines of Context:
README.txt
1
1
LOGGERHEAD
2
2
==========
3
3
 
4
 
[ Version 1.2 for Bazaar 1.2 ]
 
4
[ Version 1.6 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.
 
10
 
 
11
GETTING STARTED
 
12
---------------
 
13
 
 
14
Loggerhead depends on SimpleTAL for templating and Paste for the
 
15
server.  So you need these installed -- on Ubuntu you want the
 
16
'python-simpletal' and 'python-paste' packages installed.  You need
 
17
version 1.2 or newer of Paste.
 
18
 
 
19
Then simply run the 'serve-branches.py' with the branch you want to
 
20
serve on the command line:
 
21
 
 
22
    ./serve-branches.py ~/path/to/branch
 
23
 
 
24
The script listens on port 8080 so head to http://localhost:8080/ in
 
25
your browser to see the branch.  You can also pass a directory that
 
26
contains branches to the script, and it will serve a very simple
 
27
directory listing at other pages.
 
28
 
 
29
You may update the Bazaar branches being viewed at any time.
 
30
Loggerhead will notice and refresh, and Bazaar uses its own branch
 
31
locking to prevent corruption.
 
32
 
 
33
 
 
34
USING A CONFIG FILE
 
35
-------------------
 
36
 
 
37
Previous versions of Loggerhead read their configuration from a config
 
38
file.  This mode of operation is still supported by the
 
39
'start-loggerhead.py' script.  A 'loggerhead.conf.example' file is
 
40
included in the source which has comments explaining the various
 
41
options.
14
42
 
15
43
Loggerhead can then be started by running::
16
44
 
17
45
    $ ./start-loggerhead.py
18
46
 
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.
 
47
This will run loggerhead in the background, listening on port 8080 by
 
48
default.
22
49
 
23
50
To stop Loggerhead, run::
24
51
 
25
52
    $ ./stop-loggerhead.py
26
53
 
 
54
In the configuration file you can configure projects, and branches per
 
55
project.  The idea is that you could be publishing several (possibly
 
56
unrelated) projects through the same loggerhead instance, and several
 
57
branches for the same project.  See the "loggerhead.conf.example" file
 
58
included with the source.
 
59
 
 
60
A debug and access log are stored in the logs/ folder, relative to
 
61
the location of the start-loggerhead.py script.
 
62
 
 
63
 
 
64
SERVING LOGGERHEAD FROM BEHIND APACHE
 
65
-------------------------------------
 
66
 
27
67
If you want to view Bazaar branches from your existing Apache
28
68
installation, you'll need to configure Apache to proxy certain
29
69
requests to Loggerhead.  Adding lines like this to you Apache
34
74
        ProxyPassReverse http://127.0.0.1:8080/
35
75
    </Location>
36
76
 
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.
 
77
If Paste Deploy is installed, the 'serve-branches.py' script can be
 
78
run behind a proxy at the root of a site, but if you're running it at
 
79
some path into the site, you'll need to add a 'prefix' argument to the
 
80
PrefixMiddleware call in the script.  More flexible configuration
 
81
should be added soon...
53
82
 
54
83
 
55
84
FILES CHANGED CACHE
70
99
subscribe to post, but your first post will be held briefly for manual
71
100
moderation.
72
101
 
 
102
Bugs are tracked on Launchpad; start at:
 
103
 
 
104
    https://bugs.launchpad.net/loggerhead