some documentation fixes
added svn:keywords for documentation files
This commit is contained in:
parent
dbd74020f8
commit
c593d9b3ed
29
INSTALL
29
INSTALL
|
@ -1,16 +1,17 @@
|
||||||
The following notes will guide you through the installation of ezmlm-web:
|
The following notes will guide you through the installation of ezmlm-web:
|
||||||
|
|
||||||
|
$Id$
|
||||||
|
|
||||||
OVERVIEW:
|
OVERVIEW:
|
||||||
0 - important notes
|
0 - important notes
|
||||||
1 - get it
|
1 - get it
|
||||||
2 - install executable and shared files
|
2 - install executable and shared files
|
||||||
3 - configuration file
|
3 - configuration file
|
||||||
4 - compile cgi wrapper
|
4 - create a suid cgi wrapper
|
||||||
5 - install cgi wrapper
|
5 - [optional] configure access control (http authentication)
|
||||||
6 - [optional] configure access control (http authentication)
|
6 - css stylesheet file
|
||||||
7 - css stylesheet file
|
7 - final test
|
||||||
8 - final test
|
8 - any problems?
|
||||||
9 - any problems?
|
|
||||||
|
|
||||||
|
|
||||||
------------------------------------------------------------------------------
|
------------------------------------------------------------------------------
|
||||||
|
@ -33,7 +34,7 @@ OVERVIEW:
|
||||||
|
|
||||||
1b) debian package
|
1b) debian package
|
||||||
This is the (by far) most convenient way to install ezmlm-web.
|
This is the (by far) most convenient way to install ezmlm-web.
|
||||||
Read debian-releated/README.Debian for details.
|
Read debian/README.Debian for details.
|
||||||
(debian users may stop reading here)
|
(debian users may stop reading here)
|
||||||
|
|
||||||
|
|
||||||
|
@ -85,18 +86,18 @@ OVERVIEW:
|
||||||
some method (eg .htaccess for Apache).
|
some method (eg .htaccess for Apache).
|
||||||
|
|
||||||
|
|
||||||
6. Install some method of securing access to the page. The following
|
5. Install some method of securing access to the page. The following
|
||||||
information is applicable to Apache web servers ... Detailed
|
information is applicable to Apache web servers ... Detailed
|
||||||
information on user authentication can be obtained from the Apache
|
information on user authentication can be obtained from the Apache
|
||||||
documentation (http://www.apache.org) and ApacheWeek
|
documentation (http://www.apache.org) and ApacheWeek
|
||||||
(http://www.apacheweek.com/features/userauth).
|
(http://www.apacheweek.com/features/userauth).
|
||||||
|
|
||||||
6.1 Ensure that your Apache setup will allow .htaccess file to control
|
5.1 Ensure that your Apache setup will allow .htaccess file to control
|
||||||
access in the directory that contains. This is controlled by the
|
access in the directory that contains. This is controlled by the
|
||||||
AllowOverride tag in access.conf. (Also ensure you have the
|
AllowOverride tag in access.conf. (Also ensure you have the
|
||||||
necessary Apache modules installed)
|
necessary Apache modules installed)
|
||||||
|
|
||||||
6.2 Create a htpasswd file. This is done using the htpasswd command that
|
5.2 Create a htpasswd file. This is done using the htpasswd command that
|
||||||
comes with Apache. Its command line syntax is;
|
comes with Apache. Its command line syntax is;
|
||||||
htpasswd [-c] passwordfile username
|
htpasswd [-c] passwordfile username
|
||||||
|
|
||||||
|
@ -104,7 +105,7 @@ OVERVIEW:
|
||||||
people through the web, and create an entry for each user you want
|
people through the web, and create an entry for each user you want
|
||||||
to have access ... See the ApacheWeek article for more details.
|
to have access ... See the ApacheWeek article for more details.
|
||||||
|
|
||||||
6.3 Create a .htaccess file in the directory that contains index.cgi.
|
5.3 Create a .htaccess file in the directory that contains index.cgi.
|
||||||
Note that using Apache's built in access control, you can only control
|
Note that using Apache's built in access control, you can only control
|
||||||
access to directories, not individual files, hence the need for a
|
access to directories, not individual files, hence the need for a
|
||||||
sub-directory in step 5.
|
sub-directory in step 5.
|
||||||
|
@ -121,14 +122,14 @@ OVERVIEW:
|
||||||
Again, see the ApacheWeek article for details.
|
Again, see the ApacheWeek article for details.
|
||||||
|
|
||||||
|
|
||||||
7. Copy the stylesheet file (/usr/local/share/ezmlm-web/css/default.css)
|
6. Copy the stylesheet file (/usr/local/share/ezmlm-web/css/default.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
|
||||||
a place like "/var/www/ezmlm-web.css" could be appropriate.
|
a place like "/var/www/ezmlm-web.css" could be appropriate.
|
||||||
Now you may have to change the "HTML_CSS_FILE" setting in your
|
Now you may have to change the "HTML_CSS_FILE" setting in your
|
||||||
ezmlmwebrc file. This value is a URL - not the local filename.
|
ezmlmwebrc file. This value is a URL - not the local filename.
|
||||||
|
|
||||||
|
|
||||||
8. Test the installation with your favourite web browser. You should be
|
7. Test the installation with your favourite web browser. You should be
|
||||||
asked for a username and password (supplied in 6.2) and then be presented
|
asked for a username and password (supplied in 6.2) and then be presented
|
||||||
with a screen entitled "EZ Mailing List Manger". You can then try to
|
with a screen entitled "EZ Mailing List Manger". You can then try to
|
||||||
create and edit mailing lists ... Have Fun :)
|
create and edit mailing lists ... Have Fun :)
|
||||||
|
@ -140,7 +141,7 @@ OVERVIEW:
|
||||||
(e.g. /var/log/apache/error.log).
|
(e.g. /var/log/apache/error.log).
|
||||||
|
|
||||||
|
|
||||||
9. If you have any problems:
|
8. If you have any problems:
|
||||||
- take a look at https://systemausfall.org/toolforge/ezmlm-web
|
- take a look at https://systemausfall.org/toolforge/ezmlm-web
|
||||||
- send me an email: ezmlm-web@sumpfralle.de
|
- send me an email: ezmlm-web@sumpfralle.de
|
||||||
- subscribe to the mailinglist: ezmlm-web-subscribe@lists.systemausfall.org
|
- subscribe to the mailinglist: ezmlm-web-subscribe@lists.systemausfall.org
|
||||||
|
|
16
README
16
README
|
@ -2,6 +2,8 @@
|
||||||
| ezmlm-web-3.2 |
|
| ezmlm-web-3.2 |
|
||||||
=================
|
=================
|
||||||
|
|
||||||
|
$Id$
|
||||||
|
|
||||||
If you only want to know how to install ezmlm-web, then you should
|
If you only want to know how to install ezmlm-web, then you should
|
||||||
read INSTALL.
|
read INSTALL.
|
||||||
|
|
||||||
|
@ -126,7 +128,7 @@ 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
|
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.
|
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
|
||||||
|
@ -158,7 +160,7 @@ translation.
|
||||||
The language can be selected in ezmlmwebrc with the "HTML_LANGUAGE" option.
|
The language can be selected in ezmlmwebrc with the "HTML_LANGUAGE" option.
|
||||||
|
|
||||||
If anyone gets round to writing full templates for languages I would
|
If anyone gets round to writing full templates for languages I would
|
||||||
appreciate it if you would do two things;
|
appreciate it if you would do two things:
|
||||||
|
|
||||||
Firstly, make them public and announce them on the ezmlm@lists.cr.yp.to
|
Firstly, make them public and announce them on the ezmlm@lists.cr.yp.to
|
||||||
mailing list so that others may benefit.
|
mailing list so that others may benefit.
|
||||||
|
@ -176,11 +178,11 @@ read README.gnupg and follow the instructions.
|
||||||
|
|
||||||
VII. Bugs && Bug Reports
|
VII. Bugs && Bug Reports
|
||||||
========================
|
========================
|
||||||
I don't know of any bugs, but then this is a rewrite and a first release. It
|
I don't know of any bugs ...
|
||||||
has been tested reasonably well, but not exhaustively. I know it works on
|
Ezmlm-web has been tested reasonably well, but not exhaustively. I know it
|
||||||
FreeBSD 4.0-STABLE, FreeBSD 3.4-RELEASE, RedHat 5.1, Redhat 6.0 and Debian
|
works on FreeBSD 4.0-STABLE, FreeBSD 3.4-RELEASE, RedHat 5.1, Redhat 6.0 and
|
||||||
3.0 all using an Apache web server, but I would be interested to know whether
|
Debian 3.0 all using an Apache web server, but I would be interested to know
|
||||||
it works on other OSs and with other web servers.
|
whether it works on other OSs and with other web servers.
|
||||||
|
|
||||||
Please mail bug reports and comments to
|
Please mail bug reports and comments to
|
||||||
ezmlm-web@sumpfralle.de
|
ezmlm-web@sumpfralle.de
|
||||||
|
|
26
README.gnupg
26
README.gnupg
|
@ -1,5 +1,7 @@
|
||||||
This file describes how to manage encrypted mailing lists with ezmlm-web.
|
This file describes how to manage encrypted mailing lists with ezmlm-web.
|
||||||
|
|
||||||
|
$Id$
|
||||||
|
|
||||||
Content:
|
Content:
|
||||||
1) Requirements
|
1) Requirements
|
||||||
2) Installation of gpg-ezmlm
|
2) Installation of gpg-ezmlm
|
||||||
|
@ -31,21 +33,27 @@ Content:
|
||||||
make test
|
make test
|
||||||
make install
|
make install
|
||||||
|
|
||||||
|
See INSTALL in the Mail::Ezmlm::Gpg module
|
||||||
|
(https://systemausfall.org/toolforge/ezmlm-web/downloads/Ezmlm-Gpg)
|
||||||
|
for details on how to install it.
|
||||||
|
|
||||||
|
|
||||||
3) Setup of ezmlm-web
|
3) Setup of ezmlm-web
|
||||||
The location of the encryption configuration file for ezmlm-web depends
|
Support for encrypted mailing lists can be turned on by copying the
|
||||||
on the location of your ezmlmwebrc file. ezmlm-web will just check, if
|
template configuration file (examples/ezmlmwebrc.gnupg.dist) to
|
||||||
a file prefixed with ".gnupg" exists besides ezmlmwebrc.
|
the directory, where you did put your ezmlmwebrc file (omit the ".dist"
|
||||||
In short: you have to put it into the same directory, as you placed your
|
suffix).
|
||||||
ezmlmwebrc. ezmlm-web will NOT look into any other location.
|
ezmlm-web will just check, if a file suffixed with ".gnupg" exists
|
||||||
|
besides ezmlmwebrc.
|
||||||
|
|
||||||
To support the setup of encrypted mailing lists, you have to include the
|
To support encrypted mailing lists, the following lines in your
|
||||||
following lines in your ezmlmwebrc.gnupg file.
|
ezmlmwebrc.gnupg file are necessary:
|
||||||
use Mail::Ezmlm::Gpg;
|
use Mail::Ezmlm::Gpg;
|
||||||
GPG_SUPPRT = yes;
|
GPG_SUPPRT = yes;
|
||||||
|
|
||||||
You can find a documented example of the ezmlmwebrc.gnupg file in the
|
The documented example of the ezmlmwebrc.gnupg file in the examples
|
||||||
examples directory.
|
directory is helpful.
|
||||||
|
|
||||||
|
|
||||||
4) Notes
|
4) Notes
|
||||||
As soon as you installed all the necessary programs and after you did put
|
As soon as you installed all the necessary programs and after you did put
|
||||||
|
|
13
debian/README.Debian
vendored
13
debian/README.Debian
vendored
|
@ -1,5 +1,7 @@
|
||||||
How to use ezmlm-web with debian
|
How to use ezmlm-web with debian
|
||||||
|
|
||||||
|
$Id$
|
||||||
|
|
||||||
Table of content
|
Table of content
|
||||||
1 - install the package
|
1 - install the package
|
||||||
2 - install required additional software
|
2 - install required additional software
|
||||||
|
@ -12,7 +14,16 @@ Table of content
|
||||||
#################################################################
|
#################################################################
|
||||||
|
|
||||||
1) install the package
|
1) install the package
|
||||||
you surely did this already :)
|
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
|
2) install required additional software
|
||||||
|
|
Loading…
Reference in a new issue