How to use ezmlm-web with debian

$Id$

Table of content
1 - install the package
2 - install required additional software
3 - create user-sprecific suid binaries
4 - create a user-specific configuration
5 - enable stylesheet
6 - access control
7 - testing

#################################################################

1) install the package
	The debian packages for ezmlm-web are not part of the main
	debian distribution. Instead you have to use the debian repository
	at systemausfall.org. Just add the following line to your
	/etc/apt/sources.list:

	deb http://systemausfall.org/toolforge/debian testing main contrib non-free

	Now you may simply execute the following commands:
		apt-get update
		apt-get install ezmlm-web libemail-ezmlm-perl


2) install required additional software
	clearsilver perl bindings:
		* download clearsilver (http://clearsilver.net) v0.10.2 or higher
		* compile and install it with perl enabled


3) create user-specific suid binaries
	As perl-suid is considered deprecated, you have to compile a C-wrapper
	for every user of your debian system, who wants to manage his mailing
	lists with ezmlm-we.
	Usually you do this only for your virtual mailing list user.

	to create a wrapper, type the following:
		ezmlm-web-make-suid USERNAME DESTINATION_FILE

	e.g: ezmlm-web-make-suid john ~john/public_html/cgi-bin/ezmlm-web


4) create a user-specific configuration file (optional)
	Copy /usr/share/doc/ezmlm-web/examples/ezmlmwebrc to ~john/.ezmlmwebrc
	and change its content according to your setup.


5) enable the stylesheet
	Copy the stylesheet file (/usr/share/ezmlm-web/css/default.css)
	to a location of your choice. It has to be accessible by an URL - maybe
	a place like "/var/www/ezmlm-web.css" could be appropriate.
	Now you may have to change the "HTML_CSS_FILE" setting in your
	ezmlmwebrc file. This value is a URL - not the local filename.


6) access control (optional)
	Configure access control for the fresh cgi binary. Maybe you can
	use the htaccess.sample file in /usr/share/doc/ezmlm-web/examples as
	a template.

	Now you should create a webusers file to define the permissions of all
	possible web users. An example webusers file can be found at
	/usr/share/doc/ezmlm-web/examples/webusers.sample.

	See /usr/share/doc/ezmlm-web/README for details about access control.


7) testing
	Now you can access the ezmlm-web interface by using your web browser.
	e.g. point it to http://localhost/~john/cgi-bin/ezmlm-web
	If the web interface looks not as colorful as you expected, then you
	may have to revisit your stylesheet setting (HTML_CSS_FILE in ezmlmwebrc).