Changeset 4804 for trunk/Nebulous-Server/docs/setup.txt

Timestamp:

Aug 16, 2005, 5:11:01 PM (21 years ago)

Author:

jhoblitt

Message:

podify

File:

• trunk/Nebulous-Server/docs/setup.txt (modified) (3 diffs)

trunk/Nebulous-Server/docs/setup.txt

@@ -1 @@
-- Create a UNIX group for Nebulous
+=pod
 
-# groupadd -g 877 nebulous
+=head1 Installing a Nebulous Server
+
+=head2 Create a UNIX group for Nebulous
+
+    groupadd -g 877 nebulous
 
 This is a silly hack to generate a gid.
 
-$ perl -le 'map { $gid += ord } split //, shift; print $gid' nebulous
+    perl -le 'map { $gid += ord } split //, shift; print $gid' nebulous
 
-- Add the users that you want to be able to access Nebulous to that group
+=head2 Add the users that you want to be able to access Nebulous to that group
 
-# usermod -G nebulous foouser
+    usermod -G nebulous foouser
 
-- build and install the Nebulous Perl modules (see: README)
+=head2 Build and install the Nebulous Perl modules (see: README)
 
-- create and initialize the database (see: docs/database_setup.txt)
+=head2 Create and initialize the database (see: docs/database_setup.txt)
 
-- Install Apache with mod_perl
+=head2 Install Apache with mod_perl
 
-- mod_perl-1.29 install
-perl Makefile.PL USE_APXS=1 INSTALLDIRS=vendor WITH_APXS=/usr/sbin/apxs EVERYTHING=1 PERL_DEBUG=1
+Nebulous will work with both Apache 1.3 & 2.x.
 
-#MP_TRACE = 1 MP_DEBUG = 1 MP_USE_DSO = 1 MP_INST_APACHE2 = 1 MP_APXS = /usr/sbin/apxs2
+=head3 Apache 1.x 
 
-- add the "nebulous" group to /etc/group
-- configure Apache to run as the nebulous group. 
+=item * building mod_perl-1.29 from source:
 
-install Apache2 >= 2.0.54 and mod_perl >= 2.0.0
+    perl Makefile.PL USE_APXS=1 INSTALLDIRS=vendor WITH_APXS=/usr/sbin/apxs EVERYTHING=1 PERL_DEBUG=1
 
-Apache::DBI >= '0.97' is required for connect_on_init() to work under mod_perl
->= 2.0.1
+    #MP_TRACE = 1 MP_DEBUG = 1 MP_USE_DSO = 1 MP_INST_APACHE2 = 1 MP_APXS = /usr/sbin/apxs2
+
+=head3 Apache 2.x 
+
+To use Nebulous with Apache2 you must have Apache2 >= 2.0.54 and mod_perl >=
+2.0.0
+
+Apache::DBI >= '0.97' is required for connect_on_init() to work under mod_perl >= 2.0.1
+
+=head3 Common Apache Setup
+
+=item * add the "nebulous" group to /etc/group
+=item * configure Apache to run as the nebulous group. 
+
 
 # out of date from here down...
@@ -75 +89 @@
 chmod 1777 /tmp/imageserver.log
 
-- test the imageserver.pl is working
+=head2 Testing the Nebulous Server
 
-telnet localhost 80
-Trying 127.0.0.1...
-Connected to localhost.
-Escape character is '^]'.
-GET /cgi-bin/imageserver.pl HTTP/1.0
+You can test your configuration with the C<telnet> utility.
 
-HTTP/1.1 411 Length Required
-Date: Tue, 28 Sep 2004 21:15:58 GMT
-Server: Apache/2.0.49 (Gentoo/Linux)
-Content-Length: 0
-Connection: close
-Content-Type: text/plain; charset=ISO-8859-1
+    telnet localhost 80
+    Trying 127.0.0.1...
+    Connected to localhost.
+    Escape character is '^]'.
+    GET /cgi-bin/imageserver.pl HTTP/1.0
 
-Connection closed by foreign host.
+    HTTP/1.1 411 Length Required
+    Date: Tue, 28 Sep 2004 21:15:58 GMT
+    Server: Apache/2.0.49 (Gentoo/Linux)
+    Content-Length: 0
+    Connection: close
+    Content-Type: text/plain; charset=ISO-8859-1
 
-- if you get an HTTP 5xx code check your apache error_log
+    Connection closed by foreign host.
 
+If you get an HTTP 5xx code check your apache error_log
 
-mkdir /po01/nebulous
-chown root:nebulous /po01/nebulous
-chmod 0770 /po01/nebulous
+=head2 Directory Permissions
+
+    mkdir /po01/nebulous
+    chown root:nebulous /po01/nebulous
+    chmod 0770 /po01/nebulous
+
+=head2 MySQL Configuration
 
 in /etc/mysql/my.cnf
@@ -104 +123 @@
 max_connections = 200
 
+=cut