← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Jelmer Vernooij
  • Date: 2008-07-26 14:09:59 UTC
  • mto: This revision was merged to the branch mainline in revision 184.
  • Revision ID: jelmer@samba.org-20080726140959-rxkq2kb69rjdgqe8
Add simple manual pages for loggerhead.

Show diffs side-by-side

added added

removed removed

Lines of Context:
README.txt
16
16
'python-simpletal' and 'python-paste' packages installed.  You need
17
17
version 1.2 or newer of Paste.
18
18
 
19
 
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
20
20
serve on the command line:
21
21
 
22
 
    ./serve-branches ~/path/to/branch
 
22
    ./serve-branches.py ~/path/to/branch
23
23
 
24
24
The script listens on port 8080 so head to http://localhost:8080/ in
25
25
your browser to see the branch.  You can also pass a directory that
36
36
 
37
37
Previous versions of Loggerhead read their configuration from a config
38
38
file.  This mode of operation is still supported by the
39
 
'start-loggerhead' script.  A 'loggerhead.conf.example' file is
 
39
'start-loggerhead.py' script.  A 'loggerhead.conf.example' file is
40
40
included in the source which has comments explaining the various
41
41
options.
42
42
 
43
43
Loggerhead can then be started by running::
44
44
 
45
 
    $ ./start-loggerhead
 
45
    $ ./start-loggerhead.py
46
46
 
47
47
This will run loggerhead in the background, listening on port 8080 by
48
48
default.
49
49
 
50
50
To stop Loggerhead, run::
51
51
 
52
 
    $ ./stop-loggerhead
 
52
    $ ./stop-loggerhead.py
53
53
 
54
54
In the configuration file you can configure projects, and branches per
55
55
project.  The idea is that you could be publishing several (possibly
58
58
included with the source.
59
59
 
60
60
A debug and access log are stored in the logs/ folder, relative to
61
 
the location of the start-loggerhead script.
 
61
the location of the start-loggerhead.py script.
62
62
 
63
63
 
64
64
SERVING LOGGERHEAD FROM BEHIND APACHE
74
74
        ProxyPassReverse http://127.0.0.1:8080/
75
75
    </Location>
76
76
 
77
 
If Paste Deploy is installed, the 'serve-branches' script can be
 
77
If Paste Deploy is installed, the 'serve-branches.py' script can be
78
78
run behind a proxy at the root of a site, but if you're running it at
79
79
some path into the site, you'll need to add a 'prefix' argument to the
80
80
PrefixMiddleware call in the script.  More flexible configuration