← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Robert Collins
  • Date: 2008-06-25 10:24:54 UTC
  • mto: (128.10.24 loggerhead.search)
  • mto: This revision was merged to the branch mainline in revision 182.
  • Revision ID: robertc@robertcollins.net-20080625102454-62atf1sil1qj0noa
Make bzr-search be an optional dependency and avoid errors when there is no search index.

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:
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
 
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
30
20
serve on the command line:
31
21
 
32
 
    ./serve-branches ~/path/to/branch
 
22
    ./serve-branches.py ~/path/to/branch
33
23
 
34
24
The script listens on port 8080 so head to http://localhost:8080/ in
35
25
your browser to see the branch.  You can also pass a directory that
40
30
Loggerhead will notice and refresh, and Bazaar uses its own branch
41
31
locking to prevent corruption.
42
32
 
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
33
 
63
34
USING A CONFIG FILE
64
35
-------------------
65
36
 
66
37
Previous versions of Loggerhead read their configuration from a config
67
38
file.  This mode of operation is still supported by the
68
 
'start-loggerhead' script.  A 'loggerhead.conf.example' file is
 
39
'start-loggerhead.py' script.  A 'loggerhead.conf.example' file is
69
40
included in the source which has comments explaining the various
70
41
options.
71
42
 
72
43
Loggerhead can then be started by running::
73
44
 
74
 
    $ ./start-loggerhead
 
45
    $ ./start-loggerhead.py
75
46
 
76
47
This will run loggerhead in the background, listening on port 8080 by
77
48
default.
78
49
 
79
50
To stop Loggerhead, run::
80
51
 
81
 
    $ ./stop-loggerhead
 
52
    $ ./stop-loggerhead.py
82
53
 
83
54
In the configuration file you can configure projects, and branches per
84
55
project.  The idea is that you could be publishing several (possibly
87
58
included with the source.
88
59
 
89
60
A debug and access log are stored in the logs/ folder, relative to
90
 
the location of the start-loggerhead script.
 
61
the location of the start-loggerhead.py script.
91
62
 
92
63
 
93
64
SERVING LOGGERHEAD FROM BEHIND APACHE
99
70
configuration is one way to do this::
100
71
 
101
72
    <Location "/branches/">
102
 
        ProxyPass http://127.0.0.1:8080/branches/
103
 
        ProxyPassReverse http://127.0.0.1:8080/branches/
 
73
        ProxyPass http://127.0.0.1:8080/
 
74
        ProxyPassReverse http://127.0.0.1:8080/
104
75
    </Location>
105
76
 
106
 
If Paste Deploy is installed, the 'serve-branches' script can be
 
77
If Paste Deploy is installed, the 'serve-branches.py' script can be
107
78
run behind a proxy at the root of a site, but if you're running it at
108
 
some path into the site, you'll need to specify is using '--prefix=/some_path'.
 
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
 
109
83
 
110
84
FILES CHANGED CACHE
111
85
-------------------