~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

score one for the memory profiling we did at pycon: store the "where merged"
information in small tuples, not small sets.
this makes the 'whole history' cache for a launchpad branch take up about 15%
less RAM.

Show diffs side-by-side

added added

removed removed

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