← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README

  • Committer: Ian Clatworthy
  • Date: 2010-04-13 08:49:48 UTC
  • mfrom: (401.2.12 sphinxify)
  • Revision ID: ian.clatworthy@canonical.com-20100413084948-ugxqaocz85vd0pyd
Convert docs to Sphinx format and put into a docs directory

Show diffs side-by-side

added added

removed removed

Lines of Context:
README
1
 
LOGGERHEAD
 
1
Loggerhead
2
2
==========
3
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
 
5) flup (optional, needed to use FastCGI, SCGI or AJP)
29
 
   On Ubuntu, `sudo apt-get install python-flup`
30
 
   or use `easy_install flup`
31
 
 
32
 
Then simply run the 'serve-branches' with the branch you want to
33
 
serve on the command line:
34
 
 
35
 
    ./serve-branches ~/path/to/branch
36
 
 
37
 
The script listens on port 8080 so head to http://localhost:8080/ in
38
 
your browser to see the branch.  You can also pass a directory that
39
 
contains branches to the script, and it will serve a very simple
40
 
directory listing at other pages.
41
 
 
42
 
You may update the Bazaar branches being viewed at any time.
43
 
Loggerhead will notice and refresh, and Bazaar uses its own branch
44
 
locking to prevent corruption.
45
 
 
46
 
To run loggerhead as a linux daemon:
47
 
1) Copy loggerheadd to /etc/init.d
48
 
2) Edit the file to configure where your loggerhead is installed, and which
49
 
   serve-branches options you would like.
50
 
3) Register the service
51
 
   cd /etc/init.d
52
 
   a) on upstart based systems like Ubuntu run: 
53
 
      update-rc.d loggerheadd defaults
54
 
   b) on Sysvinit based systems like Centos or SuSE run:
55
 
      chkconfig --add loggerheadd
56
 
 
57
 
 
58
 
LOGGERHEAD AS A BAZAAR PLUGIN
59
 
-----------------------------
60
 
 
61
 
This branch contains experimental support for using Loggerhead as a Bazaar
62
 
plugin.  To use it, place the top-level Loggerhead directory (the one
63
 
containing this file) at ``~/.bazaar/plugins/loggerhead``.
64
 
 
65
 
 
66
 
USING A CONFIG FILE
67
 
-------------------
68
 
 
69
 
To hide branches from being displayed, add to ``~/.bazaar/locations.conf``,
70
 
under the branch's section:
71
 
 
72
 
    [/path/to/branch]
73
 
    http_serve = False
74
 
 
75
 
 
76
 
More configuration options to come soon.
77
 
 
78
 
 
79
 
SERVING LOGGERHEAD FROM BEHIND APACHE
80
 
-------------------------------------
81
 
 
82
 
If you want to view Bazaar branches from your existing Apache
83
 
installation, you'll need to configure Apache to proxy certain
84
 
requests to Loggerhead.  Adding lines like this to you Apache
85
 
configuration is one way to do this::
86
 
 
87
 
    <Location "/branches/">
88
 
        ProxyPass http://127.0.0.1:8080/branches/
89
 
        ProxyPassReverse http://127.0.0.1:8080/branches/
90
 
    </Location>
91
 
 
92
 
If Paste Deploy is installed, the 'serve-branches' script can be
93
 
run behind a proxy at the root of a site, but if you're running it at
94
 
some path into the site, you'll need to specify is using '--prefix=/some_path'.
95
 
 
96
 
 
97
 
SEARCH
98
 
------
99
 
 
100
 
Search is currently supported by using the bzr-search plugin (available
101
 
at: ``https://launchpad.net/bzr-search``
102
 
You need to have the plugin installed and each branch indexed to allow
103
 
searching on branches.
104
 
 
105
 
 
106
 
SUPPORT
107
 
-------
108
 
 
109
 
Loggerhead is loosely based on bazaar-webserve, which was loosely
110
 
based on hgweb.  Discussion should take place on the bazaar-dev
111
 
mailing list at bazaar@lists.canonical.com.  You can join the list at
112
 
<https://lists.ubuntu.com/mailman/listinfo/bazaar>.  You don't need to
113
 
subscribe to post, but your first post will be held briefly for manual
114
 
moderation.
115
 
 
116
 
Bugs are tracked on Launchpad; start at:
117
 
 
118
 
    https://bugs.launchpad.net/loggerhead
119
 
 
120
 
 
121
 
HACKING
122
 
-------
123
 
 
124
 
To run loggerhead tests, you will need the package python-nose,
125
 
and run in the loggerhead directory:
126
 
 
127
 
    nosetests
 
4
Overview
 
5
--------
 
6
 
 
7
Loggerhead is a web viewer for Bazaar branches. Its lets users do
 
8
stuff like:
 
9
 
 
10
* navigate through branch history
 
11
* view the files in a given revision
 
12
* annotate files (i.e. find out the origin of each line of a file)
 
13
* perform searches.
 
14
 
 
15
 
 
16
Documentation
 
17
-------------
 
18
 
 
19
See docs/index.rst for installation instructions and basic
 
20
documentation.
 
21
 
 
22
 
 
23
Licensing
 
24
---------
 
25
 
 
26
This software is (C) Copyright Canonical Limited 2006-10 under the
 
27
GPL Version 2 or later. Please see the file COPYING.txt for the
 
28
licence details.