[vhffs-dev] [svn] commit: r181 - in /trunk: Changelog INSTALL Makefile README Relases.notes TODO vhffs-api/src/Vhffs/Constants.pm vhffs-backend/conf/vhffs.conf vhffs-backend/tools/vhffs-initdb

[vhffs-dev@xxxxxxxxx]

Author: soda
Date: Fri Apr 14 16:56:33 2006
New Revision: 181

Log:
Update documentation


Modified:
    trunk/Changelog
    trunk/INSTALL
    trunk/Makefile
    trunk/README
    trunk/Relases.notes
    trunk/TODO
    trunk/vhffs-api/src/Vhffs/Constants.pm
    trunk/vhffs-backend/conf/vhffs.conf
    trunk/vhffs-backend/tools/vhffs-initdb

Modified: trunk/Changelog
==============================================================================
--- trunk/Changelog (original)
+++ trunk/Changelog Fri Apr 14 16:56:33 2006
@@ -1,4 +1,10 @@
-VHFFS RC9
+VHFFS RC11
+	Julien:
+	 	- New installer, use now a Makefile
+		- Fix some bugs
+		- Fix a BIG security problem around listengine
+
+VHFFS RC10
 	Julien:
 		- Add nospam and novirus directive
 		- Support for anti-spam and anti-virus ( /!\ data definition changes )

Modified: trunk/INSTALL
==============================================================================
--- trunk/INSTALL (original)
+++ trunk/INSTALL Fri Apr 14 16:56:33 2006
@@ -1,20 +1,44 @@
-VHFFS INSTALL
-------------
+									*******************
+									*  VHFFS INSTALL  *
+									* I'm loving it ! *
+									*******************
 
-Please read doc on http://vhffs.org
-or read the vhffsbook on http://gunnm.org/~soda/wip/vhffsbook/
+Fast way
+*******************
+1. Install VHFFS with : make install
+	* If you use debian-based system, you can use make install-debian
+	  to install debian-packages to satisfy dependencies
+2. Install VHFFS database : /usr/share/vhffs/backend/tools/vhffs-initdb
+	* You need a postgresql server
+	* Invoke as /usr/share/vhffs/backend/tools/vhffs-initdb DATABASE SUPERUSER DBUSER
+	* SUPERUSER is the user who owns the postgresql server. See this user by running a ps axu|grep post
+3. Configure the /etc/vhffs/vhffs.conf file
+	* Can be made before configure apache
+4. Configure apache to enable panel
+	* See in /usr/share/doc/vhffs/config some examples
+	* See some examples on http://www.vhffs.org
+	* Main ideas : allow perl execution as CGI and the docroot should be /usr/share/vhffs/panel
+5. Check if panel works
+	* If works, you're really great
+	* If it does not work, please run by hand perl /usr/share/vhffs/panel/auth.pl and see errors.
+	  Most of case, you forget to install some perl-dependencies
+	* You can encounter errors if you made an error when you enter database informations in the /etc/vhffs/vhffs.conf
+6. Create you first-user, be subscribing to the panel
+	* The user will NOT be created until you run robots
+	* Password is not so important, you can change it through vhffs-passwd tool
+7. Configure cron.d to runs periodically the robots
+	* See http://www.vhffs.org for examples
+8. Configure your services
+	* See /usr/share/doc/vhffs for example
+	* Examples ar http://www.vhffs.org
+	* Ask at vhffs@xxxxxxxxx
+9. Check your configuration and panel configuration
+10. Enjoy running VHFFS
 
 
-Fast method
-------------
-Install in a sort of chroot (in /tmp/toto) :
-DESTDIR=/tmp/toto sh Makefile
 
-
-Install in / : sh Makefile
-
-
-Check install by run: perl /usr/share/vhffs/panel/auth.pl
-If no error, it's good, you should create postgresql database
-and configure vhffs. No errors means that the result is a HTML page.
-If errors, please read http://vhffs.org and see what are dependencies.
+VHFFS book
+*******************
+French people can have more informations in the VHFFS book.
+It's a big PDF file which contains useful tools to use and manage VHFFS platforms.
+It is available at http://www.gunnm.org/~soda/wip/vhffsbook/

Modified: trunk/Makefile
==============================================================================
--- trunk/Makefile (original)
+++ trunk/Makefile Fri Apr 14 16:56:33 2006
@@ -15,6 +15,14 @@
 
 
 install-debian: debian-deps install
+
+help:
+	#Help for VHFFS makefile
+	#make help - display this help
+	#make install - install VHFFS on this host
+	#make install-debian - install VHFFS on this host and debian-dependencies. Use with debian-based systems
+	#make debian-deps - install debian-dependencies
+	#make test-deps - test if all dependencies are installed
 
 debian-deps:
 	/usr/bin/apt-get install 	libxml-rss-perl liblocale-gettext-perl \
@@ -65,8 +73,7 @@
 	install -d -m 755 $(BACKENDDIR)/pgsql
 	install -d -m 755 $(BACKENDDIR)/tools
 	install -m 644 vhffs-backend/src/pgsql/*.sql $(BACKENDDIR)/pgsql/
-	install -m 755 vhffs-backend/tools/vhffs-initdb $(BACKENDDIR)/vhffs-initdb
-	install -m 755 vhffs-backend/tools/vhffs-migratedb $(BACKENDDIR)/vhffs-migratedb
+	install -m 755 vhffs-backend/tools/vhffs-initdb $(BACKENDDIR)/tools/vhffs-initdb
 
 install-intl:
 	install -d -m 755 $(INTLDIR)
@@ -208,9 +215,9 @@
 	install -d -m 755 $(PANELDIR)/user
 	install -d -m 755 $(PANELDIR)/web
 	#install files
+	install -m 644 vhffs-panel/*.js $(PANELDIR)/
+	install -m 644 vhffs-panel/*.ico $(PANELDIR)/
 	install -m 755 vhffs-panel/*.pl $(PANELDIR)/
-	install -m 755 vhffs-panel/*.js $(PANELDIR)/
-	install -m 755 vhffs-panel/*.ico $(PANELDIR)/
 	install -m 755 vhffs-panel/acl/*.pl $(PANELDIR)/acl/
 	install -m 755 vhffs-panel/admin/*.pl $(PANELDIR)/admin/
 	install -m 755 vhffs-panel/admin/cvs/*.pl $(PANELDIR)/admin/cvs/

Modified: trunk/README
==============================================================================
--- trunk/README (original)
+++ trunk/README Fri Apr 14 16:56:33 2006
@@ -8,3 +8,5 @@
 http:///gunnm.org/~soda/wip/vhffsbook.
 
 If you are English and you speak French, you can translate the vhffsbook ;-)
+
+To install VHFFS, try make help in the root

Modified: trunk/Relases.notes
==============================================================================
--- trunk/Relases.notes (original)
+++ trunk/Relases.notes Fri Apr 14 16:56:33 2006
@@ -1,4 +1,16 @@
+Release Notes for RC11:
+***********************
+ * New installer. You don't have to use vhffs-install.sh script
+   use now make install. To get help on this installer, please
+   type make help
+
+
+***************************************************************
+***************************************************************
+***************************************************************
+
 Release Notes for RC9:
+**********************
 
 * Language can now be chosen from the auth.pl page for panel.
 * Only one theme is now available on the panel

Modified: trunk/TODO
==============================================================================
--- trunk/TODO (original)
+++ trunk/TODO Fri Apr 14 16:56:33 2006
@@ -1,5 +1,4 @@
 - improve listengine
 - improve archives format for listengine
 - improve panel, see ajax or css design
-- remove symlink of vhffs-listengine to vhffs-panel
 

Modified: trunk/vhffs-api/src/Vhffs/Constants.pm
==============================================================================
--- trunk/vhffs-api/src/Vhffs/Constants.pm (original)
+++ trunk/vhffs-api/src/Vhffs/Constants.pm Fri Apr 14 16:56:33 2006
@@ -8,7 +8,7 @@
 use constant
 {
     VHFFS_VERSION => 4.0,
-    VHFFS_RELEASE_NAME => "VHFFS4 RC9",
+    VHFFS_RELEASE_NAME => "koala",
     
     WAITING_FOR_VALIDATION => 1,
     VALIDATION_REFUSED => 2,

Modified: trunk/vhffs-backend/conf/vhffs.conf
==============================================================================
--- trunk/vhffs-backend/conf/vhffs.conf (original)
+++ trunk/vhffs-backend/conf/vhffs.conf Fri Apr 14 16:56:33 2006
@@ -1,16 +1,48 @@
+######
+# This is the default configuration file for VHFFS
+# Please ask vhffs@xxxxxxxxx for questions
+# Visit http://www.vhffs.org
+###############################
 <global>
-	host_name		=	Tuxfamily.org
+	#This is the name of your hosting service
+	host_name		=	My Hosting service
+
+	#The directory where you store ALL data
 	datadir			=	/data
+
+	#Directory which contains templates for the vhffs panel
 	templatedir		=	/usr/share/vhffs/templates/
+
+	#Directory which contains themes
 	themesdir		=	/usr/share/vhffs/panel/themes/
+
+	#Directory which contains internationalisation stuff
+
 	intldir			=	/usr/share/vhffs/intl/
+
+	#The default theme
 	default_template	=	default
+
+	#Mail sent to hosted people have From: vhffs_master
 	vhffs_master 		=	VHFFS Admin <admin@localhost>
+
+	#Mail of moderator
 	vhffs_moderator 		=	VHFFS Admin <moderator@localhost>
+
+	#Tag inserted in the subject of each sended mail
 	mailtag 		=	[VHFFS]
+
+	#Allow subscribing to the platform
 	allow_subscribe		=	yes
+
+	#The mail where alert are sent
 	alert_mail		=	root@localhost
-	
+
+	########
+	#Modules
+	#For each modules, you can use it if you declare "yes"
+	#For example, to disable the web service, you
+	#can specify use_web = no
 	<modules>
 		use_web			=	yes
 		use_cvs			=	yes
@@ -24,6 +56,9 @@
 		use_mailuser	=	no
 		use_largefile	= 	yes
 	</modules>
+
+	####################
+	#Panel configuration
 	<panel>
 		url				=   http://your.panel.url
 		help_url		=	http://help.hoster

Modified: trunk/vhffs-backend/tools/vhffs-initdb
==============================================================================
--- trunk/vhffs-backend/tools/vhffs-initdb (original)
+++ trunk/vhffs-backend/tools/vhffs-initdb Fri Apr 14 16:56:33 2006
@@ -3,43 +3,50 @@
 #Create VHFFS database
 #This script should be run with the identity of the postgres superuser
 
-SCRIPTDIR="/usr/share/vhffs/backend/"
+SCRIPTDIR="/usr/share/vhffs/backend/pgsql"
 FILES="create_object.sql create_object_history.sql create_acl.sql create_user.sql create_use_info.sql create_groups.sql create_groups_info.sql create_user_info.sql create_user_group.sql create_shadow_view.sql create_pass_view.sql create_panel_prefs.sql create_notes.sql create_mxdomain.sql create_boxes.sql create_forward.sql create_dns.sql create_cvs.sql create_ml.sql create_mysql.sql create_postgreql.sql create_svn.sql create_mailings.sql create_ml.sql create_confirmation.sql create_postgresql.sql create_httpd.sql"
 DB=$1
-DBUSER=$2
+PGUSER=$2
+DBUSER=$3
 
-if [ $# -lt 2 ]; then
-	echo "Error should invoke as vhffs-initdb DATABASE DBUSER"
+if [ $# -ne 3 ]; then
+	echo "Error should invoke as vhffs-initdb DATABASE SUPERUSER DBUSER"
+	echo "DATABASE is the name of your VHFFS database"
+	echo "SUPERUSER is the name of the unix-user who runs the PostgreSQL server"
+	echo "DBUSER is the future name of the PostgreSQL user, will be created by this script"
 	exit 1
+fi
+
+if [ $USER != "root" ]; then
+	echo "This program needs to be run by root user"
+	exit 2
 fi
 
 
 echo "Remove old users and databases and create new ones"
-/usr/bin/dropdb $DB 2>/dev/null 1>&2|| true
+su $PGUSER "dropdb $DB" 2>/dev/null 1>&2
 
 if [ $? -ne 0 ]; then
-	echo "Error while delete old database"
-	exit 1
+	echo "Warning: error while delete old database, maybe it was not delete"
 fi
 
-/usr/bin/dropuser $DBUSER 2>/dev/null 1>&2|| true
+su $PGUSER "dropuser $DBUSER" 2>/dev/null 1>&2
 
 if [ $? -ne 0 ]; then
-	echo "Error while delete old user"
-	exit 1
+	echo "Warning: error while delete old VHFFS database user"
 fi
 
-/usr/bin/createuser --no-createdb --no-adduser $DBUSER 2>/dev/null 1>&2|| true
-/usr/bin/createdb -O $DBUSER $DB 2>/dev/null 1>&2|| true
+su $PGUSER "createuser -D -A $DBUSER" 2>/dev/null 1>&2
+su $PGUSER "createdb -O $DBUSER $DB" 2>/dev/null 1>&2
 
-echo "Create database"
+echo -n "Create database: "
 for v in $FILES; do
-	psql  -U $DBUSER -f "$SCRIPTDIR/$v" $DB 2>/dev/null 1>&2
+	su $PGUSER "psql -f $SCRIPTDIR/$v $DB" 2>/dev/null 1>&2
+	echo -n "$v "
 done
+echo " ... done"
 
-echo "Init database"
 
-echo "Database created"
-
-echo "Don't forget to create user permission in pg_hba.conf !"
-exit 1
+echo "Don't forget to create user permission for postgresql access in the pg_hba.conf file."
+echo "Thanks for using VHFFS platform"
+exit 0