← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Robey Pointer
  • Date: 2006-12-18 20:52:28 UTC
  • Revision ID: robey@lag.net-20061218205228-lucdunv478b0wls2
another pile of semi-related changes:
* added a download link to the annotate page
* fixed all pages to track paths by file_id, not (changable) path
* some small optimizations
* don't bother to display annotation for a binary file

Show diffs side-by-side

added added

removed removed

Lines of Context:
README.txt
1
 
LOGGERHEAD
2
 
==========
3
 
 
4
 
[ Version 1.17 for Bazaar 1.17 ]
5
 
 
6
 
Loggerhead is a web viewer for Bazaar branches.  It can be used to
7
 
navigate a branch history, annotate files, perform searches... all the
8
 
usual things.
9
 
 
10
 
 
11
 
GETTING STARTED
12
 
---------------
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
30
 
serve on the command line:
31
 
 
32
 
    ./serve-branches ~/path/to/branch
33
 
 
34
 
The script listens on port 8080 so head to http://localhost:8080/ in
35
 
your browser to see the branch.  You can also pass a directory that
36
 
contains branches to the script, and it will serve a very simple
37
 
directory listing at other pages.
38
 
 
39
 
You may update the Bazaar branches being viewed at any time.
40
 
Loggerhead will notice and refresh, and Bazaar uses its own branch
41
 
locking to prevent corruption.
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
 
 
62
 
 
63
 
USING A CONFIG FILE
64
 
-------------------
65
 
 
66
 
To hide branches from being displayed, add to ``~/.bazaar/locations.conf``,
67
 
under the branch's section:
68
 
 
69
 
    [/path/to/branch]
70
 
    http_serve = False
71
 
 
72
 
 
73
 
More configuration options to come soon.
74
 
 
75
 
 
76
 
SERVING LOGGERHEAD FROM BEHIND APACHE
77
 
-------------------------------------
78
 
 
79
 
If you want to view Bazaar branches from your existing Apache
80
 
installation, you'll need to configure Apache to proxy certain
81
 
requests to Loggerhead.  Adding lines like this to you Apache
82
 
configuration is one way to do this::
83
 
 
84
 
    <Location "/branches/">
85
 
        ProxyPass http://127.0.0.1:8080/branches/
86
 
        ProxyPassReverse http://127.0.0.1:8080/branches/
87
 
    </Location>
88
 
 
89
 
If Paste Deploy is installed, the 'serve-branches' script can be
90
 
run behind a proxy at the root of a site, but if you're running it at
91
 
some path into the site, you'll need to specify is using '--prefix=/some_path'.
92
 
 
93
 
 
94
 
SEARCH
95
 
------
96
 
 
97
 
Search is currently supported by using the bzr-search plugin (available
98
 
at: ``https://launchpad.net/bzr-search``
99
 
You need to have the plugin installed and each branch indexed to allow
100
 
searching on branches.
101
 
 
102
 
 
103
 
SUPPORT
104
 
-------
105
 
 
106
 
Loggerhead is loosely based on bazaar-webserve, which was loosely
107
 
based on hgweb.  Discussion should take place on the bazaar-dev
108
 
mailing list at bazaar@lists.canonical.com.  You can join the list at
109
 
<https://lists.ubuntu.com/mailman/listinfo/bazaar>.  You don't need to
110
 
subscribe to post, but your first post will be held briefly for manual
111
 
moderation.
112
 
 
113
 
Bugs are tracked on Launchpad; start at:
114
 
 
115
 
    https://bugs.launchpad.net/loggerhead
116
 
 
117
 
 
118
 
HACKING
119
 
-------
120
 
 
121
 
To run loggerhead tests, you will need the package python-nose,
122
 
and run in the loggerhead directory:
123
 
 
124
 
    nosetests
 
1
loggerhead
 
2
 
 
3
This is a TurboGears (http://www.turbogears.org) project. It can be
 
4
started by running the start-loggerhead.py script.
 
 
b'\\ No newline at end of file'