Improved INSTALL documentation
authorJean-Michel Nirgal Vourgère <jmv@nirgal.com>
Fri, 6 Aug 2010 20:21:42 +0000 (20:21 +0000)
committerJean-Michel Nirgal Vourgère <jmv@nirgal.com>
Fri, 6 Aug 2010 20:21:42 +0000 (20:21 +0000)
INSTALL

diff --git a/INSTALL b/INSTALL
index 2da63d253d480c64b71058f89289df600643ebf5..0383f4dc61eb0c12664c179d39d595c674f377c8 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,3 +1,20 @@
+This software is known to work on GNU/Debian stable 'lenny'
+
+= Required packages
+===================
+postgresql
+python-serial
+python-rrdtool
+python-psycopg2
+libjs-jquery
+
+=Recommanded packages
+===================
+ntp
+
+
+= File system setup
+===================
 addgroup ais
 mkdir --mode 2775 /var/lib/ais # mode g+ws
 chown :ais /var/lib/ais
@@ -8,14 +25,20 @@ mkdir --mode 2775 /var/lib/ais/stats/
 mkdir --mode 2775 /var/lib/ais/nmea/
 mkdir /etc/ais/
 
+= Config
+========
 create your file in /etc/ais/config
 chmod 660 /etc/ais/config
 see config.SAMPLE
 
+= Apache setup
+==============
 adduser www-data ais
 
 change apache umask in /etc/apache2/envvars from 022 to 002 so that new folders are group writables
 
+= Python module setup
+=====================
 sudo deploy
 OR
 ln -s /home/nirgal/kod/ais/bin /usr/lib/python2.5/ais
@@ -24,6 +47,8 @@ ln -s /home/nirgal/kod/ais/bin /usr/share/pyshared/ais
 find /usr/share/pyshared/ais/ -name *.py > /usr/share/python-support/ais.public
 update-python-modules /usr/share/python-support/ais.public
 
+= Postgres setup
+================
 
 createuser ais
 ALTER USER ais PASSWORD '...';
@@ -32,12 +57,3 @@ createdb ais -O ais
 psql ais -h localhost -U ais -f structure.sql
 
 
-Required packages:
-postgresql
-python-serial
-python-rrdtool
-python-psycopg2
-libjs-jquery
-
-Recommanded packages:
-ntp