~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Martin Albisetti
  • Date: 2008-07-26 17:41:49 UTC
  • mfrom: (183.2.1 copyright)
  • Revision ID: argentina@gmail.com-20080726174149-o64p6v3p3301km91
 * Clarify License and add copyright to all file headers (John Arbash Meinel)

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
 
1) SimpleTAL for templating.
16
 
   on Ubuntu package `sudo apt-get install python-simpletal`
17
 
   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`
20
 
   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`
23
 
   or use `easy_install PasteDeploy`
 
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.
24
18
 
25
19
Then simply run the 'serve-branches' with the branch you want to
26
20
serve on the command line:
36
30
Loggerhead will notice and refresh, and Bazaar uses its own branch
37
31
locking to prevent corruption.
38
32
 
39
 
To run loggerhead as a linux daemon: 
40
 
1) Copy loggerheadd to /etc/init.d
41
 
2) Edit the file to configure where your loggerhead is installed, and which
42
 
   serve-branches options you would like.
43
 
3) Register the service
44
 
   cd /etc/init.d
45
 
   a) on upstart based systems like Ubuntu run: 
46
 
      update-rc.d loggerheadd defaults
47
 
   b) on Sysvinit based systems like Centos or SuSE run:
48
 
      chkconfig --add loggerheadd
49
33
 
50
34
USING A CONFIG FILE
51
35
-------------------
86
70
configuration is one way to do this::
87
71
 
88
72
    <Location "/branches/">
89
 
        ProxyPass http://127.0.0.1:8080/branches/
90
 
        ProxyPassReverse http://127.0.0.1:8080/branches/
 
73
        ProxyPass http://127.0.0.1:8080/
 
74
        ProxyPassReverse http://127.0.0.1:8080/
91
75
    </Location>
92
76
 
93
77
If Paste Deploy is installed, the 'serve-branches' script can be
94
78
run behind a proxy at the root of a site, but if you're running it at
95
 
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
 
96
83
 
97
84
FILES CHANGED CACHE
98
85
-------------------