ezmlm-web/ezmlm-web
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

new trunk taken from ezmlm-web 3.0

Browse source
This commit is contained in:
lars 2005-12-25 16:12:31 +00:00
parent 93f607c24e
commit fd93f61edd
49 changed files with 3097 additions and 1974 deletions
Download patch file Download diff file Expand all files Collapse all files

124
README
View file

@ -1,5 +1,5 @@
=================
| ezmlm-web-2.3 |
| ezmlm-web-3.0 |
=================
If you only want to know how to install ezmlm-web, then you should
@ -21,10 +21,11 @@ VIII. Bugs && Bug Reports
I. Copyright Stuff - essentially the FreeBSD licence ...
==================
ezmlm-web - version 2.3 - 10/06/02005
ezmlm-web - version 3.0 - 12/22/02005
Copyright (C) 1998, Guy Antony Halse, All Rights Reserved.
Please send bug reports and comments to guy-ezmlm@rucus.ru.ac.za
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:
@ -55,6 +56,7 @@ POSSIBILITY OF SUCH DAMAGE.
II. Some Background
===================
[this text was written by Guy Antony Halse - the original author of ezmlm-web]
The need for ezmlm-web arose from the fact that we host many student
societies on our system. These societies usually have a virtual host for web
and email, which is administered by a computer rep from the society. These
@ -94,7 +96,8 @@ III. Requirements
This version of ezmlm-web requires the following;
* qmail v1.03
* ezmlm v0.53 (idx v0.40)
* ezmlm v0.53 (or ezmlm-idx v0.40)
* clearsilver v0.10.2 (only perl support is necessary)
* Perl v5.004 and the following modules;
+ Mail::Ezmlm v0.03
+ Mail::Address v1.15
@ -108,48 +111,65 @@ This version of ezmlm-web requires the following;
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.
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 - it is required since
ezmlm-web v3.0) from http://clearsilver.net.
IV. Files
=========
In this distribution you should find eight files;
In this distribution you should find the following files;
README This file. Provides some background information.
Not needed to run ezmlm-web.
README (optional) This file. Provides some background information.
INSTALL Notes on installation. Not needed to run ezmlm-web.
INSTALL (optional) Notes on installation.
CHANGES The change history. Not needed to run ezmlm-web
INSTALL.clearsilver (optional) Notes on the installation of clearsilver.
TODO This file is a list of things I intend doing in future
versions of ezmlm-web. Not needed to run ezmlm-web.
CHANGES (optional) The change history.
ezmlm-web.cgi The ezmlm-web script proper. This program requires that
you have perl5 installed on your machine and that your web
server is capable of running CGI scripts.
UPGRADING (optional) Notes on upgrading ezmlm-web from a previous version.
index.c A C wrapper to allow ezmlm-web.cgi to run suid. Not
strictly necessary if your setup allows perl scripts to
run suid, but I prefer using wrappers anyway. It needs to
be edited and compiled to suit your system. Not needed to
run ezmlm-web.
TODO (optional) This file is a list of things I intend doing in future
versions of ezmlm-web.
ezmlmwebrc This is the configuration file for ezmlm-web. All options
are explained in this example file. You will need this
file to run ezmlm-web.
ezmlm-web.cgi (required) The ezmlm-web cgi script in perl. You will need it :)
htaccess.sample A sample Apache .htaccess file for controlling access to
the mailing lists. If you use another web server, you will
have to work this bit out for yourself.
index.c (recommended) A C wrapper to allow ezmlm-web.cgi to run
suid. Not strictly necessary if your setup allows perl scripts
to run suid, but I prefer using wrappers anyway. It needs to
be edited and compiled to suit your system. Not needed to
run ezmlm-web.
webusers.sample A sample webusers file for multi-level access control.
ezmlmwebrc (required) This is the configuration file for ezmlm-web.
All options are explained in this example file. You will need
this file to run ezmlm-web.
The directory "lang" contains the language files. You will need at least the
one, that you have choosen in "ezmlmwebrc" by the option "HTML_LANGUAGE".
htaccess.sample (recommended) A sample Apache .htaccess file for controlling access to
the mailing lists. If you use another web server, you will
have to work this bit out for yourself.
webusers.sample (recommended) A sample webusers file for multi-level access control.
lang (directory, required) It contains the language files. You will need
at least the one, that you have choosen in "ezmlmwebrc" by
the option "HTML_LANGUAGE".
css (directory, recommended) Here you find available css stylesheet files.
Pick the one you like (for now, there is only one choice :)) and
set it up by pointing the "HTML_CSS_FILE" setting in your
"ezmlmwebrc" to an appropriate URL.
template (directory, required) The clearsilver template files in this
directory defined the layout of the web interface. You should be able
to adapt them to your needs, if you like.
spec (directory, optional) Some development specific information.
V. Notes
@ -181,30 +201,27 @@ 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 entry.
$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. As of yet there is no way to create users
through the web interface, but I intend to do this eventually.
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
list1: user1 user2 user3
ALL: user1 user2
list2: ALL
ie; listname colon (:) and a comma (,) separated list of users. Spaces are
ignored but each list must appear on a new line.
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
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
@ -217,9 +234,9 @@ the same effect in a cleaner way.
VII. Language Portablity
=========================
One of the great new features of version 2.0 is that it is essentially
language independant (okay, not quite, but is 99% of the way there). Most of
the fixed strings, help, etc is defined in the files of lang directory.
Of course you can change them or create a new translation.
language independant. All of the fixed strings, help, etc is defined in the
files of lang directory. Of course you can change them or create a new
translation.
The language can be selected in ezmlmwebrc with the "HTML_LANGUAGE" option.
@ -237,26 +254,27 @@ VIII. Bugs && Bug Reports
=======================
I don't know of any bugs, but then this is a rewrite and a first release. It
has been tested reasonably well, but not exhaustively. I know it works on
FreeBSD 4.0-STABLE, FreeBSD 3.4-RELEASE, RedHat 5.1 and Redhat 6.0 all using
an Apache web server, but I would be interested to know whether it works on
other OSs and with other web servers. This version is far less dependent on
the OS than previous versions so I don't see any reason why it shouldn't.
FreeBSD 4.0-STABLE, FreeBSD 3.4-RELEASE, RedHat 5.1, Redhat 6.0 and Debian
3.0 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.
IX. Acknowledgements
===================
* Guy Antony Halse (guy-ezmlm@rucus.ru.ac.za) - He created ezmlm-web,
maintained it till 02005 and wrote nearly every line of code!
* Keith Burdis (keith@rucus.ru.ac.za) - For constantly bugging me and
* 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
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 and moving the Grahamstown
* 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
@ -265,6 +283,9 @@ IX. Acknowledgements
* 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) - he designed most of the new
interface for v3.0
X. Availability
@ -272,6 +293,9 @@ X. 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 website of Guy Antony Halse (the author of ezmlm-web) is still at:
http://rucus.ru.ac.za/~guy/ezmlm/