HTTPDUserAdminContrib
A User and Password module supporting text or DBM format htpasswd files, and SQL using HTTPD::UserAdmin
CPAN module
Usage
This Contrib adds
auth DBM
and
auth SQL support to TWiki,
though the
HTTPD::UserAdmin CPAN module.
It has been developed and tested for the TWiki-4.2, though
may be useable for previous releases.
A once off converstion from an existing TWiki htpasswd file must be done, due to differences in the way that email addresses are stored.
run
perl -pi~ -e "s/$([^:]*):([^:]*):(.*)^/$1:$2:emails=$3/g" twiki/data/.htpasswd
to convert from TWiki's native htpassword format.
From there you can use that file in the
Text
DBType
, use
dbmmanage
to import it to a DBM file, or run a similar tool to import it into your database.
Installation Instructions
- Install HTTPDUserAdminContrib
- select TWiki::Users::HTTPDUserAdminContrib in the Security|Passwords|{PasswordManager} selector in Configure
- then set the appropriate settings in the Exensions|HTTPDUserAdminContrib section of Configure.
You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server where TWiki is running.
Like many other TWiki extensions, this module is shipped with a fully automatic installer script written using the BuildContrib.
- If you have TWiki 4.1 or later, you can install from the
configure
interface (Go to Plugins->Find More Extensions)
- The webserver user has to have permission to write to all areas of your installation for this to work.
- If you have a permanent connection to the internet, you are recommended to use the automatic installer script
- Just download the
HTTPDUserAdminContrib_installer
perl script and run it.
- Notes:
- The installer script will:
- Automatically resolve dependencies,
- Copy files into the right places in your local install (even if you have renamed data directories),
- check in new versions of any installed files that have existing RCS histories files in your existing install (such as topics).
- If the $TWIKI_PACKAGES environment variable is set to point to a directory, the installer will try to get archives from there. Otherwise it will try to download from twiki.org or cpan.org, as appropriate.
- (Developers only: the script will look for twikiplugins/HTTPDUserAdminContrib/HTTPDUserAdminContrib.tgz before downloading from TWiki.org)
- If you don't have a permanent connection, you can still use the automatic installer, by downloading all required TWiki archives to a local directory.
- Point the environment variable
$TWIKI_PACKAGES
to this directory, and the installer script will look there first for required TWiki packages.
-
$TWIKI_PACKAGES
is actually a path; you can list several directories separated by :
- If you are behind a firewall that blocks access to CPAN, you can pre-install the required CPAN libraries, as described at http://twiki.org/cgi-bin/view/TWiki/HowToInstallCpanModules
- If you don't want to use the installer script, or have problems on your platform (e.g. you don't have Perl 5.8), then you can still install manually:
- Download and unpack one of the
.zip
or .tgz
archives to a temporary directory.
- Manually copy the contents across to the relevant places in your TWiki installation.
- Check in any installed files that have existing
,v
files in your existing install (take care not to lock the files when you check in)
- Manually edit LocalSite.cfg to set any configuration variables.
- Run
configure
and enable the module, if it is a plugin.
- Repeat from step 1 for any missing dependencies.
Contrib Info
Related Topics: TWikiContribs,
DeveloperDocumentationCategory,
AdminDocumentationCategory,
TWikiPreferences