~ubuntu-branches/ubuntu/raring/lurker/raring

« back to all changes in this revision

Viewing changes to INSTALL

  • Committer: Bazaar Package Importer
  • Author(s): Jonas Meurer
  • Date: 2004-09-26 16:27:51 UTC
  • Revision ID: james.westby@ubuntu.com-20040926162751-z1ohcjltv7ojtg6z
Tags: upstream-1.2
ImportĀ upstreamĀ versionĀ 1.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Quick start
 
2
===========
 
3
 
 
4
0 Find and install development files for: 
 
5
 
 
6
   g++ >= 3.2            - http://gcc.gnu.org/
 
7
   zlib                  - http://www.gzip.org/zlib/
 
8
   mimelib  (kdenetwork) - ftp://download.uk.kde.org/pub/kde/stable/latest/src
 
9
   xsltproc (libxslt1)   - http://xmlsoft.org/XSLT/
 
10
 
 
11
 If you need to, lurker can be built using only g++ 2.95, however 3.2+ is
 
12
 recommended as the resulting binaries are much smaller and faster.
 
13
 
 
14
 If you do not want kdenetwork, you can also download mimelib separately
 
15
 from http://sourceforge.net/project/showfiles.php?group_id=8168 and tell
 
16
 lurker to compile it and statically link to it.
 
17
 
 
18
 xsltproc is not strictly required for lurker. It is not used during compile
 
19
 and is only used if your lurker.conf references it. However, it is the
 
20
 preferred method for rendering html, so we recommend installing it.
 
21
 
 
22
 For debian: apt-get install xsltproc libmimelib1-dev g++ zlib1g-dev
 
23
 
 
24
1 [flags] ./configure [options]
 
25
  
 
26
  To control the mimelib location, setting these options may help:
 
27
  --with-mimelib-local        Use internal lurker/mimelib/*
 
28
  --with-mimelib-include=DIR  Location of mimelib/message.h
 
29
  --with-mimelib-libname=LIB  Try an alternative library name
 
30
  
 
31
  To control the zlib location, setting these options may help:
 
32
  --with-zlib-include=DIR     Location of zlib.h
 
33
  --with-zlib-libname=LIB     Try an alternative library name
 
34
  
 
35
  To control the environment, variants of these flags may help:
 
36
  LDFLAGS="-L/sw/lib"
 
37
  CPPFLAGS="-I/sw/include -DDW_UNIX"
 
38
  
 
39
2 make
 
40
 
 
41
3 make install  (as root if you don't have permission)
 
42
  
 
43
  You may want to strip the binaries as they can be quite large.
 
44
 
 
45
  This will install these files:
 
46
  
 
47
        /usr/local/lib/cgi-bin/*.cgi
 
48
                - The CGIs which power lurker
 
49
                - These must be placed such that the webserver can run them
 
50
        /usr/local/var/www/lurker/*
 
51
                - The lurker content which must be web accessible
 
52
                - The subdirectories "attach, list, mbox, message, mindex,
 
53
                  search, splash, and thread" must all be writeable by
 
54
                  whatever user executes lurker.cgi
 
55
        /usr/local/bin/lurker-*
 
56
                - Command-line utilities for importing email, cleaning
 
57
                  cached web files, and interfacing with shell scripts
 
58
        /usr/local/var/lib/lurker/*
 
59
                - The lurker database directory where mail is imported to
 
60
                - The directory and its contents must be writeable by the
 
61
                  user who runs lurker-index
 
62
                - This must be readable by the user who runs lurker.cgi
 
63
  
 
64
  You must install the file /usr/local/etc/lurker.conf by hand.
 
65
  Then customize it using the provided lurker.conf as a starting point.
 
66
 
 
67
4 Setup delivery of new mail to lurker-index
 
68
  
 
69
  For procmail, 
 
70
        :0 w
 
71
        * ^X-Mailing-List: <debian-japanese@lists.debian.org>.*
 
72
        | lurker-index -c /etc/lurker.conf -l japanese -m
 
73
  ... works for me.
 
74
 
 
75
5 Feed archived mail through lurker-index.
 
76
  
 
77
  lurker-index -c /etc/lurker.conf -l devel -b 5 < debian-devel.mbox
 
78
  
 
79
  Keep in mind these points:
 
80
  
 
81
    a. Lurker imports benefit primarily from a fast CPU and fast RAM.
 
82
       Lurker rendering of pages benefits from more RAM (for disk cache).
 
83
    
 
84
    b. The lurker database will consume space on the order of 40% of the
 
85
       mailboxes it indexes. You must keep the mbox lurker creates, 
 
86
       although the original mbox is not required after lurker-index.
 
87
    
 
88
    c. Nearly all of the processing time lurker spends is on importing
 
89
       messages. Once you have indexed your archive, lurker no longer needs
 
90
       as much resources.
 
91
    
 
92
6 Setup a cronjob to update the archive every 15 minutes
 
93
  
 
94
  0,15,30,45 * * * * lurker-prune -c /etc/lurker.conf -d /path/to/www/lurker
 
95
  
 
96
  This must be run with the ability to read and delete files from the
 
97
  web-server cache directory.
 
98
  
 
99
7 Configure your webserver.
 
100
  
 
101
  You must make certain that .xsl and .xml files have type text/xml.
 
102
  For email reply support .rfc822 must have type message/rfc822.
 
103
  You must set the default charset to UTF-8 for these files.
 
104
  You must make lurker your 404 error handler or another way of creating
 
105
      missing cache files (eg: apache's RewriteRule).
 
106
  You must pass the config file and lurker's document root to lurker.cgi 
 
107
      as ? delimited arguments in QUERY_STRING 'cfgfile?docdir'. The docdir
 
108
      is relative to the location of lurker.cgi and cfgfile is relative to
 
109
      the docdir.
 
110
  
 
111
  NOTE: The docdir here is the location of lurker.docroot.
 
112
  This has nothing at all to do with your webservers document root.
 
113
  Typically this is /usr/local/var/www/lurker or /var/www/lurker.
 
114
  
 
115
  If you run apache with a directory structure like:
 
116
 
 
117
        www/
 
118
                lurker.conf
 
119
                cgi-bin/
 
120
                        lurker.cgi
 
121
                        keyword.cgi
 
122
                        jump.cgi
 
123
                htdocs/
 
124
                        .htaccess
 
125
                        index.html
 
126
                        browserdetect.js
 
127
                        lurker.docroot
 
128
                        splash/
 
129
                        search/
 
130
                        mindex/
 
131
                        ...
 
132
 
 
133
   then .htaccess should contain:
 
134
 
 
135
        AddType text/xml .xsl
 
136
        AddType text/xml .xml
 
137
        AddType message/rfc822 .rfc822
 
138
        AddDefaultCharset UTF-8
 
139
        ErrorDocument 404 /cgi-bin/lurker.cgi?../lurker.conf?../htdocs
 
140
   
 
141
   or, using the Rewite Engine (avoids 404 log messages):
 
142
 
 
143
        AddType text/xml .xsl
 
144
        AddType text/xml .xml
 
145
        AddType message/rfc822 .rfc822
 
146
        AddDefaultCharset UTF-8
 
147
        RewriteEngine on
 
148
        RewriteCond %{REQUEST_FILENAME} !-s
 
149
        RewriteRule (attach|list|mbox|message|mindex|search|splash|thread)/ /cgi-bin/lurker.cgi?../lurker/lurker.conf?../htdocs [T=application/x-httpd-cgi,L,PT]
 
150
 
 
151
8 point your browser at the url where lurker is installed
 
152
 
 
153
Enjoy!