[Lxr-general] [PATCH] Documentation update

[Jan-Benedict G. <jb...@lu...>]

Hi!

After the GIT hacking weekend, there's also a documentation update.

MfG, JBG

2006-03-26  Maximilian Wilhelm <ma...@rf...>
            Jan-Benedict Glaw <jb...@lu...>

	* INSTALL (Installation requirements): Add git-core to the
	requirement list in case GIT is to be used.
	(Database installation): Don't try to create the database
	as user "lxr", but owned by "lxr". This allows for a more
	restrictive database installation. There's no need to give
	any extra rights to LXR.
	(LXR installation directory): Alternatively describe to not
	hose your host's Perl installation but to configure Apache
	to additionally search in the LXR directory for the LXR
	Perl modules.
	(Edit LXR config file): At least mention the filename of the
	config file once.

--- a/INSTALL	2 Nov 2005 23:39:55 -0000	1.21
+++ b/INSTALL	26 Mar 2006 10:39:14 -0000
@@ -30,6 +30,9 @@ The current version of the lxr depends o
 	BitKeeper (bk) installed
 	Digest::SHA module (available from CPAN)
=20
+9) If you are using the GIT support, you'll need:
+	git-core
+
 Installing the database
 -----------------------
 You will need to create a database for lxr, and possibly create a user
@@ -44,7 +47,7 @@ For Postgresql:
 Create a user for lxr and give the user permission to create databases:
 	   createuser lxr
 Create a database for lxr:
-	   createdb -U lxr lxr
+	   createdb -O lxr lxr
 Initialise the database:
 	   psql -U lxr lxr
 	   \i initdb-postgres
@@ -72,20 +75,43 @@ choice. A good choice could be /usr/loca
  cd /usr/local/
  tar -zxf /path/to/lxr/lxr-x.x.tgz (as root or with appropriate permission=
s)
=20
-Now you have to put the perl modules that LXR uses into a directory on
-your system that will be searched by mod_perl when the LXR scripts are
-executed. Execute:
+Now you have to make the LXR Perl modules available to your webserver's LXR
+instance. Either copy those modules into your local site_perl directory to
+make them globally accessible
=20
  cp /usr/local/lxr/Local.pm /usr/lib/perl5/site_perl/
  cp -r /usr/local/lxr/lib/LXR /usr/lib/perl5/site_perl
=20
-Now you should copy the template files for LXR to your installation
+or configure your webserver to additionally search for these modules in yo=
ur
+LXR distribution directory. For Apache 1, this is done by first putting a
+PerlRequire into the mod_perl configuration:
+
+  <IfModule mod_perl.c>
+    <IfModule mod_alias.c>
+      Alias /perl/ /var/www/perl/
+    </IfModule>
+    <Location /perl>
+      SetHandler perl-script
+      PerlHandler Apache::Registry
+      PerlRequire "/etc/apache/perl_require.pl"
+      Options +ExecCGI
+    </Location>
+  </IfModule>
+
+and extinding @INC inside this new perl_require.pl script:
+
+  #!/usr/bin/env perl -w
+  @INC=3D(@INC, "/usr/local/lxr", "/usr/local/lxr/lib");
+  1;
+
+You should finally copy the template files for LXR to your installation
=20
  mv /usr/local/lxr/templates/* /usr/local/lxr/
=20
+
 Edit the lxr config file
 ------------------------
-Go through the config file and fill in the relevant values.
+Go through the config file (lxr.conf) and fill in the relevant values.
 If you have glimpse installed, you should set
=20
  'glimpsebin' =3D> '/path/to/your/glimpse/executable'

--=20
Jan-Benedict Glaw       jb...@lu...    . +49-172-7608481             =
_ O _
"Eine Freie Meinung in  einem Freien Kopf    | Gegen Zensur | Gegen Krieg  =
_ _ O
 f=C3=BCr einen Freien Staat voll Freier B=C3=BCrger"  | im Internet! |   i=
m Irak!   O O O
ret =3D do_actions((curr | FREE_SPEECH) & ~(NEW_COPYRIGHT_LAW | DRM | TCPA)=
);