← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Michael Hudson
  • Date: 2008-06-23 02:07:29 UTC
  • mto: This revision was merged to the branch mainline in revision 171.
  • Revision ID: michael.hudson@canonical.com-20080623020729-o1h8x1x41om1enwj
start on README

Show diffs side-by-side

added added

removed removed

Lines of Context:
README.txt
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
GETTING STARTED
 
11
---------------
 
12
 
 
13
Loggerhead depends on SimpleTAL for templating and Paste for the
 
14
server.  So you need these installed -- on Ubuntu you want the
 
15
'python-simpletal' and 'python-paste' packages installed.  You need
 
16
version 1.2 or newer of Paste.
 
17
 
 
18
Then simply run the 'serve-branches.py' script of loggerhead from the
 
19
directory containing the branches you want to serve.
 
20
 
 
21
For example:
 
22
 
 
23
    XXX
 
24
 
 
25
USING A CONFIG FILE
 
26
-------------------
 
27
 
 
28
Previous versions of Loggerhead read their configuration from a config
 
29
file.  This mode of operation is still supported by the
 
30
'start-loggerhead.py' script.  A 'loggerhead.conf.example' file is
 
31
included in the source which has comments explaining the various
 
32
options.
14
33
 
15
34
Loggerhead can then be started by running::
16
35
 
24
43
 
25
44
    $ ./stop-loggerhead.py
26
45
 
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::
31
 
 
32
 
    <Location "/branches/">
33
 
        ProxyPass http://127.0.0.1:8080/
34
 
        ProxyPassReverse http://127.0.0.1:8080/
35
 
    </Location>
36
 
 
37
46
In the configuration file you can configure projects, and branches per
38
47
project.  The idea is that you could be publishing several (possibly
39
48
unrelated) projects through the same loggerhead instance, and several
40
49
branches for the same project.  See the "loggerhead.conf.example" file
41
50
included with the source.
42
51
 
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
52
A debug and access log are stored in the logs/ folder, relative to
48
53
the location of the start-loggerhead.py script.
49
54
 
51
56
Loggerhead will notice and refresh, and Bazaar uses its own branch
52
57
locking to prevent corruption.
53
58
 
 
59
SERVING LOGGERHEAD FROM BEHIND APACHE
 
60
-------------------------------------
 
61
 
 
62
If you want to view Bazaar branches from your existing Apache
 
63
installation, you'll need to configure Apache to proxy certain
 
64
requests to Loggerhead.  Adding lines like this to you Apache
 
65
configuration is one way to do this::
 
66
 
 
67
    <Location "/branches/">
 
68
        ProxyPass http://127.0.0.1:8080/
 
69
        ProxyPassReverse http://127.0.0.1:8080/
 
70
    </Location>
 
71
 
 
72
 
54
73
 
55
74
FILES CHANGED CACHE
56
75
-------------------
70
89
subscribe to post, but your first post will be held briefly for manual
71
90
moderation.
72
91
 
 
92
Bugs are tracked on Launchpad; start at:
 
93
 
 
94
    https://bugs.launchpad.net/loggerhead