← 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
11
11
GETTING STARTED
12
12
---------------
13
13
 
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`
 
14
Loggerhead depends on SimpleTAL for templating and Paste for the
 
15
server.  So you need these installed -- on Ubuntu you want the
 
16
'python-simpletal' and 'python-paste' packages installed.  You need
 
17
version 1.2 or newer of Paste.
24
18
 
25
 
Then simply run the 'serve-branches' with the branch you want to
 
19
Then simply run the 'serve-branches.py' with the branch you want to
26
20
serve on the command line:
27
21
 
28
 
    ./serve-branches ~/path/to/branch
 
22
    ./serve-branches.py ~/path/to/branch
29
23
 
30
24
The script listens on port 8080 so head to http://localhost:8080/ in
31
25
your browser to see the branch.  You can also pass a directory that
42
36
 
43
37
Previous versions of Loggerhead read their configuration from a config
44
38
file.  This mode of operation is still supported by the
45
 
'start-loggerhead' script.  A 'loggerhead.conf.example' file is
 
39
'start-loggerhead.py' script.  A 'loggerhead.conf.example' file is
46
40
included in the source which has comments explaining the various
47
41
options.
48
42
 
49
43
Loggerhead can then be started by running::
50
44
 
51
 
    $ ./start-loggerhead
 
45
    $ ./start-loggerhead.py
52
46
 
53
47
This will run loggerhead in the background, listening on port 8080 by
54
48
default.
55
49
 
56
50
To stop Loggerhead, run::
57
51
 
58
 
    $ ./stop-loggerhead
 
52
    $ ./stop-loggerhead.py
59
53
 
60
54
In the configuration file you can configure projects, and branches per
61
55
project.  The idea is that you could be publishing several (possibly
64
58
included with the source.
65
59
 
66
60
A debug and access log are stored in the logs/ folder, relative to
67
 
the location of the start-loggerhead script.
 
61
the location of the start-loggerhead.py script.
68
62
 
69
63
 
70
64
SERVING LOGGERHEAD FROM BEHIND APACHE
80
74
        ProxyPassReverse http://127.0.0.1:8080/
81
75
    </Location>
82
76
 
83
 
If Paste Deploy is installed, the 'serve-branches' script can be
 
77
If Paste Deploy is installed, the 'serve-branches.py' script can be
84
78
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'.
 
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...
 
82
 
86
83
 
87
84
FILES CHANGED CACHE
88
85
-------------------