← 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.
 
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`
18
28
 
19
29
Then simply run the 'serve-branches' with the branch you want to
20
30
serve on the command line:
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
-------------------
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
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
-------------------