~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Steve 'Ashcrow' Milner
  • Date: 2008-10-24 02:26:05 UTC
  • mto: This revision was merged to the branch mainline in revision 231.
  • Revision ID: stevem@gnulinux.net-20081024022605-bukahu7dovm7ii6u
Updated to follow pep8.

Show diffs side-by-side

added added

removed removed

Lines of Context:
11
11
GETTING STARTED
12
12
---------------
13
13
 
14
 
Loggerhead depends on:
15
 
 
 
14
Loggerhead depends on 
16
15
1) SimpleTAL for templating.
17
 
   On Ubuntu, `sudo apt-get install python-simpletal`
 
16
   on ubuntu package `sudo apt-get install python-simpletal`
18
17
   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`
 
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`
24
20
   or use `easy_install Paste`
25
 
4) Paste Deploy  (optional, needed when proxying through Apache)
26
 
   On Ubuntu, `sudo apt-get install python-pastedeploy`
 
21
3) Paste Deploy  (optional, needed when proxying through Apache)
 
22
   on ubuntu package `sudo apt-get install python-pastedeploy`
27
23
   or use `easy_install PasteDeploy`
28
24
 
29
25
Then simply run the 'serve-branches' with the branch you want to
40
36
Loggerhead will notice and refresh, and Bazaar uses its own branch
41
37
locking to prevent corruption.
42
38
 
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
 
 
62
39
 
63
40
USING A CONFIG FILE
64
41
-------------------
99
76
configuration is one way to do this::
100
77
 
101
78
    <Location "/branches/">
102
 
        ProxyPass http://127.0.0.1:8080/branches/
103
 
        ProxyPassReverse http://127.0.0.1:8080/branches/
 
79
        ProxyPass http://127.0.0.1:8080/
 
80
        ProxyPassReverse http://127.0.0.1:8080/
104
81
    </Location>
105
82
 
106
83
If Paste Deploy is installed, the 'serve-branches' script can be