214 lines
8.1 KiB
Text
214 lines
8.1 KiB
Text
=================
|
|
| ezmlm-web-3.2 |
|
|
=================
|
|
|
|
$Id$
|
|
|
|
If you only want to know how to install ezmlm-web, then you should
|
|
read INSTALL.
|
|
|
|
Contents
|
|
========
|
|
I. Copyright Stuff
|
|
II. Requirements
|
|
III. Multi-level list access
|
|
IV. Multilingual interface
|
|
V. Bugs && Bug Reports
|
|
VI. Acknowledgements
|
|
VII. Availability
|
|
|
|
|
|
I. Copyright Stuff - essentially the FreeBSD licence ...
|
|
==================
|
|
ezmlm-web - version 3.2 - 04/14/02006
|
|
|
|
Copyright (C) 1998, Guy Antony Halse, All Rights Reserved.
|
|
Copyright (C) 02005-02007, Lars Kruse, All Rights Reserved.
|
|
|
|
Please send bug reports and comments to ezmlm-web@sumpfralle.de
|
|
|
|
Redistribution and use in source and binary forms, with or without
|
|
modification, are permitted provided that the following conditions are met:
|
|
|
|
Redistributions of source code must retain the above copyright notice, this
|
|
list of conditions and the following disclaimer.
|
|
|
|
Redistributions in binary form must reproduce the above copyright notice,
|
|
this list of conditions and the following disclaimer in the documentation
|
|
and/or other materials provided with the distribution.
|
|
|
|
Neither name Guy Antony Halse nor the names of any contributors may be used
|
|
to endorse or promote products derived from this software without specific
|
|
prior written permission.
|
|
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS
|
|
IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
|
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE
|
|
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
|
|
II. Requirements
|
|
================
|
|
This version of ezmlm-web requires the following;
|
|
|
|
* qmail v1.03
|
|
* ezmlm-idx v0.40 or higher
|
|
* clearsilver v0.10.3 (only perl support is necessary)
|
|
* Perl v5.004 and the following modules;
|
|
+ Mail::Ezmlm v0.07
|
|
+ Mail::Address v1.15 OR Email::Address
|
|
+ CGI v2.6
|
|
+ CGI::Carp v1.06
|
|
+ DB_File v1.65
|
|
+ Getopt::Std v4.1
|
|
+ File::Find v?
|
|
+ File::Copy v2.02
|
|
+ File::Path v1.07
|
|
+ Text::ParseWords v3.24
|
|
+ Encode (optional)
|
|
|
|
The version number indicates the version of the module that ezmlm-web was
|
|
developed with. Earlier versions may work, but then they haven't been
|
|
tested. Have a look on http://www.CPAN.org/, http://www.qmail.org/, and
|
|
http://www.ezmlm.org/ for anything you are missing. Of course, newer
|
|
versions are expected to work as well.
|
|
|
|
To install perl modules you may use the cpan command line interface.
|
|
Just run "cpan" and type something like "install Mail::Ezmlm".
|
|
|
|
You can download clearsilver (a templating engine) from http://clearsilver.net.
|
|
|
|
|
|
III. Multi-Level Access
|
|
=======================
|
|
Ezmlm-web has a multi-level access system. This depends on a file called
|
|
webusers being present in $LIST_DIR. If the file is not present, then ANY
|
|
valid user has access to all lists. If, however, this file exists a number
|
|
of constraints come into place.
|
|
|
|
- The webusers file is scanned for either the list name (case insensitive) or
|
|
an ALL (case sensitive) entry.
|
|
- The list entry (or ALL) is scanned for the current user (as set in
|
|
$REMOTE_USER) or an ALL (user) entry.
|
|
- If any valid match is made, then the user is allowed to edit the list.
|
|
Otherwise the user is politely told to go away ;-)
|
|
|
|
If list creation is allowed and the webusers file exists, then the person who
|
|
creates the list is the default owner. There is no way to create users
|
|
through the web interface, as this depends on your authentication system.
|
|
|
|
The format of a webusers file is as follows:
|
|
|
|
list1: user1 user2 user3
|
|
ALL: user1 user2
|
|
list2: ALL
|
|
|
|
Once this file exists, the ezmlm-web script will allow the list users to
|
|
configure their access lists along with any other options.
|
|
|
|
You can permit some users to create lists by adding a line similar to the
|
|
following to your webusers file:
|
|
|
|
ALLOW_CREATE: user2 user3
|
|
|
|
If there is no line starting with "ALLOW_CREATE:" in the webusers file, then
|
|
no one will be allowed to create lists. This behaviour is new for ezmlm-web
|
|
since version 2.2. To stay compatible to old installations, the commandline
|
|
option "-c" for ezmlm-web.cgi will still allow everyone to create lists. The
|
|
use of this option is deprecated, since the line "ALLOW_CREATE: ALL" provides
|
|
the same effect in a cleaner way.
|
|
|
|
You find the details of the format of webusers (5) file in the respective
|
|
manpage.
|
|
|
|
|
|
IV. Multilingual interface
|
|
=======================
|
|
One of the great new features since version 2.0 is that it is essentially
|
|
language independant. All of the fixed strings, help, etc is defined in the
|
|
files of the lang directory. Of course you can change them or create a new
|
|
translation.
|
|
|
|
The default fallback language can be selected in ezmlmwebrc with the
|
|
"HTML_LANGUAGE" option. ezmlm-web tries to determine the language of the
|
|
current user by evaluating the http header information of the browser.
|
|
Additionally the user may select a different language via the web interface.
|
|
|
|
The currently supported languages are:
|
|
- English
|
|
- German
|
|
- Slovenian
|
|
- Portuguese (Brazil)
|
|
|
|
Please visit the translation center at http://translate.systemausfall.org
|
|
to contribute some translations for your native language. Thanks!
|
|
|
|
|
|
V. Bugs && Bug Reports
|
|
======================
|
|
I don't know of any bugs ...
|
|
Ezmlm-web has been tested reasonably well, but not exhaustively. I know it
|
|
works on FreeBSD 4.0-STABLE, FreeBSD 3.4-RELEASE, RedHat 5.1, Redhat 6.0 and
|
|
Debian all using an Apache web server, but I would be interested to know
|
|
whether it works on other OSs and with other web servers.
|
|
|
|
Please mail bug reports and comments to
|
|
ezmlm-web@sumpfralle.de
|
|
Or (even better) submit a bug report at
|
|
https://systemausfall.org/trac/ezmlm-web
|
|
Or subscribe to the ezmlm-web mailinglist:
|
|
ezmlm-web-subscribe@lists.systemausfall.org
|
|
|
|
|
|
VI. Acknowledgements
|
|
====================
|
|
* Guy Antony Halse (guy-ezmlm@rucus.ru.ac.za) - he created ezmlm-web
|
|
and maintained it till 02005
|
|
* Keith Burdis (keith@rucus.ru.ac.za) - For constantly bugging me (Guy) and
|
|
ensuring that I actually got round to writing some code :)
|
|
* Bryan Kilian (bryan@rucus.ru.ac.za) and the administrators of the
|
|
Litestep mailing list - For helping beta test and putting up with me (Guy)
|
|
pestering them.
|
|
* Several societies at Rhodes. For switching to my web interface and so
|
|
unknowingly helping to beta test it.
|
|
* Barry Irwin (bvi@moria.org) - For trusting me (Guy) and moving the Grahamstown
|
|
Foundation over to qmail and ezmlm - yet another beta tester :-)
|
|
* David Summers (david@summersoft.fay.ar.us) - For some ideas. And for
|
|
offering to make up an RPM version. I hope the offer still exists for
|
|
version 2.0 :-)
|
|
* Glen Stewart (glen_stewart@associate.com) - For a multitude of ideas.
|
|
* Fred Lindberg (lindberg@id.wustl.edu) for his useful posts to the
|
|
mailing list, suggestions, help, etc
|
|
* Galen Johnson (gjohnson@totalsports.net) - For some ideas on bugfixes.
|
|
* Reinin Ooyama (lenin@hasiru.net) - a Japanese translation and bugixes for v2.3
|
|
* Henning Rieger (age@systemausfall.org) - designed most of the new
|
|
interface for v3.0
|
|
* Clavdia Horvat - designed the new color scheme of v3.2 and translated to
|
|
Slovenian
|
|
* Carlinhos Cecconi - added the translation for Portugues do Brasil
|
|
|
|
|
|
VII. Availability
|
|
=================
|
|
More information on ezmlm-web and developments to ezmlm-web can be found at:
|
|
https://systemausfall.org/toolforge/ezmlm-web/
|
|
|
|
The public subversion repository is at:
|
|
https://svn.systemausfall.org/svn/ezmlm-web/
|
|
|
|
The (inofficial) debian repository containing ezmlm-web is at:
|
|
http://systemausfall.org/toolforge/debian/
|
|
|
|
The website of Guy Antony Halse (the original author of ezmlm-web) is still at:
|
|
http://rucus.ru.ac.za/~guy/ezmlm/
|
|
|
|
The old ftp-archive of ezmlm-web is still available on:
|
|
ftp://rucus.ru.ac.za/pub/mail/ezmlm/
|
|
|