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.
You receive maximal performance benefit by using the SQL mode, and ensuring {Register}{AllowLoginName} is off (so that the TWikiUsers? topic is not needed to convert login names to Wiki Names.
See the Extensions | HTTPDUserAdminContrib section of configure to set up the specific options.
Text file user store (.htpassword)
If you are using the Text mode 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.
DBM mode
SQL mode (DBI)
This Contrib will not create the database setup for you, you will need to have an existing database, with appropriate database connection permissions, and a database table for with the required fields that is accessible by this user.
Note that the DB Schema name is set in the top section of the settings (defaults to the .htpasswd filename).
Beware: Do not use table names, or column names that are SQL keywords (such as group)
CREATE TABLE `db`.`Users` (
`email` VARCHAR( 256 ) CHARACTER SET ascii COLLATE ascii_general_ci NOT NULL ,
`username` VARCHAR( 256 ) CHARACTER SET ascii COLLATE ascii_bin NOT NULL ,
`wikiname` VARCHAR( 256 ) CHARACTER SET ascii COLLATE ascii_bin NOT NULL,
`password` VARCHAR( 32 ) CHARACTER SET ascii COLLATE ascii_bin NOT NULL ,
`dateregistered` DATE NOT NULL
) ENGINE = MYISAM
CREATE TABLE `wikiringnet`.`Groups` (
`groupname` VARCHAR( 256 ) CHARACTER SET ascii COLLATE ascii_bin NOT NULL ,
`username` VARCHAR( 256 ) CHARACTER SET ascii COLLATE ascii_bin NOT NULL
) ENGINE = MYISAM
extra not yet documented functionality
This Contrib can also define and store group definitions in the same 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.2 or later, you can install from the
configure interface (Go to Plugins->Find More Extensions)
- If you have any problems, then you can still install manually from the command-line:
- Download one of the
.zip or .tgz archives
- Unpack the archive in the root directory of your TWiki installation.
- Run the installer script (
perl <module>_installer )
- Run
configure and enable the module, if it is a plugin.
- Repeat for any missing dependencies.
- If you are still having problems, then instead of running the installer script:
- Make sure that the file permissions allow the webserver user to access all files.
- 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.
Contrib Info
Related Topics: TWikiContribs, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences