← 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:37:05 UTC
  • mto: This revision was merged to the branch mainline in revision 171.
  • Revision ID: michael.hudson@canonical.com-20080623023705-wid5yrjjux8cssoa
https://launchpad.net/bugs/241999
more readme stuff

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
 
10
11
GETTING STARTED
11
12
---------------
12
13
 
15
16
'python-simpletal' and 'python-paste' packages installed.  You need
16
17
version 1.2 or newer of Paste.
17
18
 
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
 
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
 
24
33
 
25
34
USING A CONFIG FILE
26
35
-------------------
35
44
 
36
45
    $ ./start-loggerhead.py
37
46
 
38
 
This will run loggerhead in the background.  It listens on port 8080
39
 
by default, so go to http://localhost:8080/ in your browser to see the
40
 
list of bublished branches.
 
47
This will run loggerhead in the background, listening on port 8080 by
 
48
default.
41
49
 
42
50
To stop Loggerhead, run::
43
51
 
52
60
A debug and access log are stored in the logs/ folder, relative to
53
61
the location of the start-loggerhead.py script.
54
62
 
55
 
You may update the Bazaar branch at any time (for example, from a cron).
56
 
Loggerhead will notice and refresh, and Bazaar uses its own branch
57
 
locking to prevent corruption.
58
63
 
59
64
SERVING LOGGERHEAD FROM BEHIND APACHE
60
65
-------------------------------------
69
74
        ProxyPassReverse http://127.0.0.1:8080/
70
75
    </Location>
71
76
 
 
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...
72
82
 
73
83
 
74
84
FILES CHANGED CACHE