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

Updated description of webusers file to the behaviour since ezmlm-web v3.3.

Browse source 
Thanks to Daniele for the hint!
This commit is contained in:
lars 2010-01-18 23:08:51 +00:00
parent 5f01e987f2
commit 253b80f338
3 changed files with 33 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
INSTALL
View file

@ -146,10 +146,10 @@ OVERVIEW:
Direct links to a specifc domain use the following format: Direct links to a specifc domain use the following format:
http://BASE_URL/ezmlm-web?domain=foo http://BASE_URL/ezmlm-web?domain=foo
Note that since version 3.3 webusers file has to explictly let users create Note that since version 3.3 webusers file has to explicitly allow certain
and manage lists. If you are relying on the user beeing able to create lists users to create and manage lists. If you are relying on the user beeing able
if no webusers file exists, then you will have to explicitly create one with to create lists if no webusers file exists, then you will have to explicitly
the appropiate permissions. create one with the appropiate permissions.
7. Copy the stylesheet files (/usr/local/share/ezmlm-web/www-data/*.css) 7. Copy the stylesheet files (/usr/local/share/ezmlm-web/www-data/*.css)
to a location of your choice. It has to be accessible by an URL - maybe to a location of your choice. It has to be accessible by an URL - maybe

19
README
View file

@ -91,9 +91,8 @@ You can download clearsilver (a templating engine) from http://clearsilver.net.
III. Multi-Level Access III. Multi-Level Access
======================= =======================
Ezmlm-web has a multi-level access system. This depends on a file called 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 webusers being present in $LIST_DIR. If the file is not present, then NO
valid user has access to all lists. If, however, this file exists a number user has access to any list. In other words: this file is mandatory.
of constraints come into place.
- The webusers file is scanned for either the list name (case insensitive) or - The webusers file is scanned for either the list name (case insensitive) or
an ALL (case sensitive) entry. an ALL (case sensitive) entry.
@ -108,9 +107,9 @@ through the web interface, as this depends on your authentication system.
The format of a webusers file is as follows: The format of a webusers file is as follows:
list1: user1 user2 user3 list1: user1 user2 user3
ALL: user1 user2 ALL: user1 user2
list2: ALL list2: ALL
Once this file exists, the ezmlm-web script will allow the list users to Once this file exists, the ezmlm-web script will allow the list users to
configure their access lists along with any other options. configure their access lists along with any other options.
@ -118,7 +117,7 @@ configure their access lists along with any other options.
You can permit some users to create lists by adding a line similar to the You can permit some users to create lists by adding a line similar to the
following to your webusers file: 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 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 no one will be allowed to create lists. This behaviour is new for ezmlm-web
@ -130,6 +129,12 @@ the same effect in a cleaner way.
You find the details of the format of webusers (5) file in the respective You find the details of the format of webusers (5) file in the respective
manpage. manpage.
If you just want to have the most simply (and most dangerous) access settings,
then you could just use the following as a starter:
ALL: ALL
ALLOW_CREATE: ALL
IV. Multilingual interface IV. Multilingual interface
========================== ==========================

25
man/webusers.5
View file

@ -1,4 +1,4 @@
.TH webusers 5 "April 02007" "ezmlm-web" "access configuration file" .TH webusers 5 "January 02010" "ezmlm-web" "access configuration file"
.SH NAME .SH NAME
webusers \- define the access permissions for a directory of lists webusers \- define the access permissions for a directory of lists
.SH DESCRIPTION .SH DESCRIPTION
@ -6,12 +6,15 @@ webusers \- define the access permissions for a directory of lists
\fBwebusers\fR contains the access definitions for the lists below a certain \fBwebusers\fR contains the access definitions for the lists below a certain
directory. directory.
.PP .PP
This file is optional. The actions of users are unrestricted, if the This file is required for every installation. Otherwise no lists are available.
\fBwebusers\fR file does not exist. Be careful when using this setting. This behaviour was introduced in ezmlm-web v3.3.
.PP .PP
A webusers file is only useful if you can request some kind of authentication A webusers file is most useful if you can request some kind of authentication
from the user. Usually this should be done via http-authentication. See from the user. Usually this should be done via http-authentication. See
the INSTALL file for more details. the INSTALL file for more details.
.PP
Below you find an example of a \fBwebusers\fR file, that grants full access to
everyone. Be careful when using this setup.
.SH LOCATION .SH LOCATION
By default the \fBwebusers\fR file is located in the same directory as the By default the \fBwebusers\fR file is located in the same directory as the
mailing lists. This can be adjusted with the setting \fIWEBUSERS_FILE\fR in mailing lists. This can be adjusted with the setting \fIWEBUSERS_FILE\fR in
@ -19,7 +22,6 @@ the configuration file ezmlmwebrc (5). Read its manpage for details.
.SH FILE FORMAT .SH FILE FORMAT
.IP "The file consists of lines of the following form:" .IP "The file consists of lines of the following form:"
.sp .sp
.nf
LISTNAME: USER1 USER2 LISTNAME: USER1 USER2
.PP .PP
Empty lines and lines starting with a '#' are ignored. The same goes for Empty lines and lines starting with a '#' are ignored. The same goes for
@ -44,17 +46,24 @@ users: arb
members: ALL members: ALL
ALL: root ALL: root
ALLOW_CREATE: root guy ALLOW_CREATE: root guy
.fi
.IP "A simple setup without restrictions (dangerous!):"
.sp
.nf
ALL: ALL
ALLOW_CREATE: ALL
.fi
.PP .PP
In the example above, the users \fIroot\fR and \fIguy\fR are allowed to create In the example above, the users \fIroot\fR and \fIguy\fR are allowed to create
new lists. new lists.
.PP .PP
Every authenticated user may configure the list \fImembers\fR. Everyone may configure the list \fImembers\fR.
.PP .PP
The user \fIroot\fR can manage all mailing lists. The user \fIroot\fR can manage and create every mailing list.
.SH AUTHOR .SH AUTHOR
Written by Lars Kruse Written by Lars Kruse
.SH "REPORTING BUGS" .SH "REPORTING BUGS"
Report bugs to <devel@sumpfralle.de> Report bugs to <devel@sumpfralle.de>
.SH COPYRIGHT .SH COPYRIGHT
Copyright \(co 02007 Lars Kruse Copyright \(co 02010 Lars Kruse