← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

allow customization of the "branch from <here>" location displayed on each page

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