~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Robey Pointer
  • Date: 2006-12-23 19:29:05 UTC
  • Revision ID: robey@lag.net-20061223192905-wwzq2hluxta8k5mf
add setup.py info so an sdist tarball can be made

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
LOGGERHEAD
2
2
==========
3
3
 
4
 
[ version 1.1.1 for bazaar 0.13 ]
5
 
 
6
4
Loggerhead is a web viewer for bazaar branches.  It can be used to navigate
7
5
a branch history, annotate files, perform searches... all the usual things.
8
6
 
9
7
This is a TurboGears (http://www.turbogears.org) project.  It can be
10
 
started by running::
11
 
 
12
 
    $ ./start-loggerhead.py
 
8
started by running the 'start-loggerhead.py' script.
 
9
 
 
10
If you're not familiar with turbogears, the easiest way to get this script
 
11
started is to run it via::
 
12
 
 
13
    $ nohup ./start-loggerhead.py &
13
14
    
14
 
This will run loggerhead in the background.  To stop it, run::
15
 
 
16
 
    $ ./stop-loggerhead.py
17
 
 
18
 
If you're not familiar with TurboGears, the simplest way to get running is
19
 
to add the following lines to your apache configuration::
 
15
and add the following lines to your apache configuration::
20
16
 
21
17
    <Location "/branches/">
22
18
        ProxyPass http://127.0.0.1:8080/
23
19
        ProxyPassReverse http://127.0.0.1:8080/
24
20
    </Location>
25
21
    
 
22
The port configuration is in "dev.cfg".
 
23
 
26
24
The config file is "loggerhead.conf".  In there, you can configure projects,
27
25
and branches per project.  The idea is that you could be publishing several
28
26
(possibly unrelated) projects through the same loggerhead instance, and 
29
27
several branches for the same project.
30
28
 
31
 
Don't bother with "dev.cfg" or any of the other TurboGears config files.
32
 
Loggerhead overrides those values with its own.
33
 
 
34
 
A debug and access log are stored in the logs/ folder.
35
 
 
36
29
 
37
30
CACHES
38
31
------