~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:
7
7
navigate a branch history, annotate files, perform searches... all the
8
8
usual things.
9
9
 
10
 
 
11
10
GETTING STARTED
12
11
---------------
13
12
 
14
 
Loggerhead depends on 
15
 
1) SimpleTAL for templating.
16
 
   on ubuntu package `sudo apt-get install python-simpletal`
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.) 
19
 
   on ubuntu package `sudo apt-get install python-paste`
20
 
   or use `easy_install Paste`
21
 
3) Paste Deploy  (optional, needed when proxying through Apache)
22
 
   on ubuntu package `sudo apt-get install python-pastedeploy`
23
 
   or use `easy_install PasteDeploy`
24
 
 
25
 
Then simply run the 'serve-branches' with the branch you want to
26
 
serve on the command line:
27
 
 
28
 
    ./serve-branches ~/path/to/branch
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
 
 
 
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
39
24
 
40
25
USING A CONFIG FILE
41
26
-------------------
42
27
 
43
28
Previous versions of Loggerhead read their configuration from a config
44
29
file.  This mode of operation is still supported by the
45
 
'start-loggerhead' script.  A 'loggerhead.conf.example' file is
 
30
'start-loggerhead.py' script.  A 'loggerhead.conf.example' file is
46
31
included in the source which has comments explaining the various
47
32
options.
48
33
 
49
34
Loggerhead can then be started by running::
50
35
 
51
 
    $ ./start-loggerhead
 
36
    $ ./start-loggerhead.py
52
37
 
53
 
This will run loggerhead in the background, listening on port 8080 by
54
 
default.
 
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.
55
41
 
56
42
To stop Loggerhead, run::
57
43
 
58
 
    $ ./stop-loggerhead
 
44
    $ ./stop-loggerhead.py
59
45
 
60
46
In the configuration file you can configure projects, and branches per
61
47
project.  The idea is that you could be publishing several (possibly
64
50
included with the source.
65
51
 
66
52
A debug and access log are stored in the logs/ folder, relative to
67
 
the location of the start-loggerhead script.
 
53
the location of the start-loggerhead.py script.
68
54
 
 
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.
69
58
 
70
59
SERVING LOGGERHEAD FROM BEHIND APACHE
71
60
-------------------------------------
80
69
        ProxyPassReverse http://127.0.0.1:8080/
81
70
    </Location>
82
71
 
83
 
If Paste Deploy is installed, the 'serve-branches' script can be
84
 
run behind a proxy at the root of a site, but if you're running it at
85
 
some path into the site, you'll need to specify is using '--prefix=/some_path'.
 
72
 
86
73
 
87
74
FILES CHANGED CACHE
88
75
-------------------