← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: John Arbash Meinel
  • Date: 2008-07-26 14:52:44 UTC
  • mto: This revision was merged to the branch mainline in revision 185.
  • Revision ID: john@arbash-meinel.com-20080726145244-l7h1ndtlu5mnm9tg
Add Copyright information to most files.

Fix the documentation for start/stop in the README.txt

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
 
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
 
Then simply run the 'serve-branches' with the branch you want to
 
19
Then simply run the 'serve-branches.py' with the branch you want to
26
20
serve on the command line:
27
21
 
28
 
    ./serve-branches ~/path/to/branch
 
22
    ./serve-branches.py ~/path/to/branch
29
23
 
30
24
The script listens on port 8080 so head to http://localhost:8080/ in
31
25
your browser to see the branch.  You can also pass a directory that
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
-------------------
52
36
 
53
37
Previous versions of Loggerhead read their configuration from a config
54
38
file.  This mode of operation is still supported by the
55
 
'start-loggerhead' script.  A 'loggerhead.conf.example' file is
 
39
'start-loggerhead.py' script.  A 'loggerhead.conf.example' file is
56
40
included in the source which has comments explaining the various
57
41
options.
58
42
 
74
58
included with the source.
75
59
 
76
60
A debug and access log are stored in the logs/ folder, relative to
77
 
the location of the start-loggerhead script.
 
61
the location of the start-loggerhead.py script.
78
62
 
79
63
 
80
64
SERVING LOGGERHEAD FROM BEHIND APACHE
90
74
        ProxyPassReverse http://127.0.0.1:8080/
91
75
    </Location>
92
76
 
93
 
If Paste Deploy is installed, the 'serve-branches' script can be
 
77
If Paste Deploy is installed, the 'serve-branches.py' 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
-------------------