aboutsummaryrefslogtreecommitdiffstats
path: root/INSTALL
blob: f2786475787144d107cf03a4d27ee21f1439a28c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
WELCOME

These are the installation instructions for LXRng, such as they are.


DEPENDENCIES

(Package names for Ubunty Feisty in brackets, where applicable.)

* Freetext index engine of your choice.  Presently supported:
  - Search::Xapian

* Database and DBI modules of your choice.  Presently supported:
  - DBD::Pg [libdbd-pg-perl]

* HTML/Web Perl modules
  - CGI::Simple [libcgi-simple-perl]
  - CGI::Ajax [libcgi-ajax-perl]
  - HTML::Entities [libhtml-parser-perl]
  - Template [libtemplate-perl]

* "Exuberant ctags", runnable as ctags-exuberant somewhere in the
   current $PATH. [exuberant-ctags]

* (For generation of png icons from svg source: inkscape [inkscape])

* (For PDF generation: pdflatex [texlive texlive-latex-recommended
  texlive-pdfetex texlive-fonts-extra lmodern])


INSTALLATION

* Create suitable database
  $ createdb lxrng

* Add www-data (or equivalent HTTP daemon user) as database user.  No
  special privileges should be afforded.
  $ createuser www-data

* Copy the lxrng.conf-dist to lxrng.conf and edit as desired.

* Create database tables
  $ lxr-db-admin <my-tree> --init

* Cross reference your source repository
  $ lxr-genxref <my-tree>

* Copy the apache2-site.conf-dist to apache2-site.conf and adjust.
  # ln -s <lxr-path>/apache2-site.conf /etc/apache2/sites-enabled/010-lxrng
  # /etc/init.d/apache2 reload
  (Or equivalent, depending on operating system (distribution) flavor.)

* (Generate PNG icons)
  $ make -C <lxr-path>/cgi-bin/gfx

* Point web browser to configured web location.