← 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: 2009-03-16 06:23:00 UTC
  • Revision ID: michael.hudson@canonical.com-20090316062300-xzqamcrbksg4url4
fix minor visual issue caused by IE compatibility work

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
 
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
 
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
 
 
39
To run loggerhead as a linux daemon: 
 
40
1) Copy loggerheadd to /etc/init.d
 
41
2) Edit the file to configure where your loggerhead is installed, and which
 
42
   serve-branches options you would like.
 
43
3) Register the service
 
44
   cd /etc/init.d
 
45
   a) on upstart based systems like Ubuntu run: 
 
46
      update-rc.d loggerheadd defaults
 
47
   b) on Sysvinit based systems like Centos or SuSE run:
 
48
      chkconfig --add loggerheadd
 
49
 
 
50
 
 
51
LOGGERHEAD AS A BAZAAR PLUGIN
 
52
-----------------------------
 
53
 
 
54
This branch contains experimental support for using Loggerhead as a Bazaar
 
55
plugin.  To use it, place the top-level Loggerhead directory (the one
 
56
containing this file) at ``~/.bazaar/plugins/loggerhead``.
 
57
 
24
58
 
25
59
USING A CONFIG FILE
26
60
-------------------
27
61
 
28
62
Previous versions of Loggerhead read their configuration from a config
29
63
file.  This mode of operation is still supported by the
30
 
'start-loggerhead.py' script.  A 'loggerhead.conf.example' file is
 
64
'start-loggerhead' script.  A 'loggerhead.conf.example' file is
31
65
included in the source which has comments explaining the various
32
66
options.
33
67
 
34
68
Loggerhead can then be started by running::
35
69
 
36
 
    $ ./start-loggerhead.py
 
70
    $ ./start-loggerhead
37
71
 
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.
 
72
This will run loggerhead in the background, listening on port 8080 by
 
73
default.
41
74
 
42
75
To stop Loggerhead, run::
43
76
 
44
 
    $ ./stop-loggerhead.py
 
77
    $ ./stop-loggerhead
45
78
 
46
79
In the configuration file you can configure projects, and branches per
47
80
project.  The idea is that you could be publishing several (possibly
50
83
included with the source.
51
84
 
52
85
A debug and access log are stored in the logs/ folder, relative to
53
 
the location of the start-loggerhead.py script.
 
86
the location of the start-loggerhead script.
54
87
 
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
88
 
59
89
SERVING LOGGERHEAD FROM BEHIND APACHE
60
90
-------------------------------------
65
95
configuration is one way to do this::
66
96
 
67
97
    <Location "/branches/">
68
 
        ProxyPass http://127.0.0.1:8080/
69
 
        ProxyPassReverse http://127.0.0.1:8080/
 
98
        ProxyPass http://127.0.0.1:8080/branches/
 
99
        ProxyPassReverse http://127.0.0.1:8080/branches/
70
100
    </Location>
71
101
 
72
 
 
 
102
If Paste Deploy is installed, the 'serve-branches' script can be
 
103
run behind a proxy at the root of a site, but if you're running it at
 
104
some path into the site, you'll need to specify is using '--prefix=/some_path'.
73
105
 
74
106
FILES CHANGED CACHE
75
107
-------------------