← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Matt Nordhoff
  • Date: 2009-04-30 10:39:05 UTC
  • mto: This revision was merged to the branch mainline in revision 406.
  • Revision ID: mnordhoff@mattnordhoff.com-20090430103905-10si14h2i325htrj
Strip trailing whitespace

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 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.
18
 
 
19
 
Then simply run the 'serve-branches.py' with the branch you want to
 
14
Loggerhead depends on:
 
15
 
 
16
1) SimpleTAL for templating.
 
17
   On Ubuntu, `sudo apt-get install python-simpletal`
 
18
   or download from http://www.owlfish.com/software/simpleTAL/download.html
 
19
2) simplejson for producing JSON data.
 
20
   On Ubuntu, `sudo apt-get install python-simplejson`
 
21
   or use `easy_install simplejson`.
 
22
3) Paste for the server. (You need version 1.2 or newer of Paste.)
 
23
   On Ubuntu, `sudo apt-get install python-paste`
 
24
   or use `easy_install Paste`
 
25
4) Paste Deploy  (optional, needed when proxying through Apache)
 
26
   On Ubuntu, `sudo apt-get install python-pastedeploy`
 
27
   or use `easy_install PasteDeploy`
 
28
 
 
29
Then simply run the 'serve-branches' with the branch you want to
20
30
serve on the command line:
21
31
 
22
 
    ./serve-branches.py ~/path/to/branch
 
32
    ./serve-branches ~/path/to/branch
23
33
 
24
34
The script listens on port 8080 so head to http://localhost:8080/ in
25
35
your browser to see the branch.  You can also pass a directory that
30
40
Loggerhead will notice and refresh, and Bazaar uses its own branch
31
41
locking to prevent corruption.
32
42
 
 
43
To run loggerhead as a linux daemon: 
 
44
1) Copy loggerheadd to /etc/init.d
 
45
2) Edit the file to configure where your loggerhead is installed, and which
 
46
   serve-branches options you would like.
 
47
3) Register the service
 
48
   cd /etc/init.d
 
49
   a) on upstart based systems like Ubuntu run: 
 
50
      update-rc.d loggerheadd defaults
 
51
   b) on Sysvinit based systems like Centos or SuSE run:
 
52
      chkconfig --add loggerheadd
 
53
 
 
54
 
 
55
LOGGERHEAD AS A BAZAAR PLUGIN
 
56
-----------------------------
 
57
 
 
58
This branch contains experimental support for using Loggerhead as a Bazaar
 
59
plugin.  To use it, place the top-level Loggerhead directory (the one
 
60
containing this file) at ``~/.bazaar/plugins/loggerhead``.
 
61
 
33
62
 
34
63
USING A CONFIG FILE
35
64
-------------------
36
65
 
37
66
Previous versions of Loggerhead read their configuration from a config
38
67
file.  This mode of operation is still supported by the
39
 
'start-loggerhead.py' script.  A 'loggerhead.conf.example' file is
 
68
'start-loggerhead' script.  A 'loggerhead.conf.example' file is
40
69
included in the source which has comments explaining the various
41
70
options.
42
71
 
43
72
Loggerhead can then be started by running::
44
73
 
45
 
    $ ./start-loggerhead.py
 
74
    $ ./start-loggerhead
46
75
 
47
76
This will run loggerhead in the background, listening on port 8080 by
48
77
default.
49
78
 
50
79
To stop Loggerhead, run::
51
80
 
52
 
    $ ./stop-loggerhead.py
 
81
    $ ./stop-loggerhead
53
82
 
54
83
In the configuration file you can configure projects, and branches per
55
84
project.  The idea is that you could be publishing several (possibly
58
87
included with the source.
59
88
 
60
89
A debug and access log are stored in the logs/ folder, relative to
61
 
the location of the start-loggerhead.py script.
 
90
the location of the start-loggerhead script.
62
91
 
63
92
 
64
93
SERVING LOGGERHEAD FROM BEHIND APACHE
70
99
configuration is one way to do this::
71
100
 
72
101
    <Location "/branches/">
73
 
        ProxyPass http://127.0.0.1:8080/
74
 
        ProxyPassReverse http://127.0.0.1:8080/
 
102
        ProxyPass http://127.0.0.1:8080/branches/
 
103
        ProxyPassReverse http://127.0.0.1:8080/branches/
75
104
    </Location>
76
105
 
77
 
If Paste Deploy is installed, the 'serve-branches.py' script can be
 
106
If Paste Deploy is installed, the 'serve-branches' script can be
78
107
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...
82
 
 
 
108
some path into the site, you'll need to specify is using '--prefix=/some_path'.
83
109
 
84
110
FILES CHANGED CACHE
85
111
-------------------