TWiki User Authentication
TWiki site access control and user activity tracking options
TWiki does not authenticate users internally, it depends on the
environment variable. This variable is set when you enable Basic Authentication (.htaccess) or SSL "secure server" authentication (https protocol).
TWiki uses visitor identification to keep track of who made changes to topics at what time and to manage a wide range of personal site settings. This gives a complete audit trail of changes and activity.
No special installation steps are required if the server is already authenticated. If it isn't, you have these options for controlling user access:
- No login at all: Forget about authentication to make your site completely public - anyone can browse and edit freely, in classic Wiki mode. All visitors are assigned the TWikiGuest default identity, so you can't track individual user activity.
- How: Default, no web server configuration necessary
- No login to view; require login to edit: Keeping track of who changed what and when, while keeping view access unrestricted is desirable in most TWiki deployments. This option is not suitable if you need TWikiAccessControl for view restricted content since TWiki does not know who a user is when looking at content.
- How: Use Basic Authentication (
.htaccess) to control access by protecting key scripts:
upload using the
.htaccess file. The TWikiInstallationGuide has step-by-step instructions.
- No login to view unless necessary; require login to edit: You prefer not to bother the user with login for unrestricted content, but you need TWikiAccessControl for view restricted content. There are two ways to accomplish this:
- How 1: Use Basic Authentication with Partial Authentication (described below)
- How 2: Use one of the Session TWiki:Plugins where you give the user the option to login and logout.
- Require login to view and edit: Most restrictive, but TWiki knows who the user is at all times. There are two ways to accomplish this:
- How 1: Use Basic Authentication to authenticate the whole
twiki/bin directory. Consult your web server documentation.
- How 1: Use SSL (Secure Sockets Layer; HTTPS) to authenticate and secure the whole server. Consult your web server documentation.
Tracking by IP address
is an experimental feature, enabled in
. It lets you combine open access to some functions, with authentication on others, with full user activity tracking:
- Normally, the
REMOTE_USER environment variable is set for the scripts that are under authentication. If, for example, the
preview scripts are authenticated, but not
view, you would get your WikiName in
preview for the
%WIKIUSERNAME% variable, but
view will show
TWikiGuest instead of your WikiName.
- TWiki can be configured to remember the IP address/username pair whenever an authentication happens (edit topic, attach file). Once remembered, the non-authenticated scripts, like
view, will show the correct username instead of TWikiGuest.
- Enable this feature by setting the
$doRememberRemoteUser flag in
TWiki.cfg. TWiki then persistently stores the IP address/username pairs in the file,
$remoteUserFilename, which is
"$dataDir/remoteusers.txt" by default.
Quick Authentication Test
- This approach can fail if the IP address changes due to dynamically assigned IP addresses or proxy servers.
- Use the %WIKIUSERNAME% variable to return your current identity:
TWiki Username vs. Login Username
This section applies only if your TWiki site is installed on a server that is both authenticated
and on an intranet
TWiki internally manages two usernames: Login Username and TWiki Username.
- Login Username: When you login to the intranet, you use your existing login username, ex:
pthoeny. This name is normally passed to TWiki by the
REMOTE_USER environment variable, and used internally. Login Usernames are maintained by your system administrator.
- TWiki Username: Your name in WikiNotation, ex:
PeterThoeny, is recorded when you register using TWikiRegistration; doing so also generates a personal home page in the Main web.
TWiki can automatically map an Intranet (Login) Username to a TWiki Username, provided that the username pair exists in the TWikiUsers
topic. This is also handled automatically when you register.
- In the original TWiki distribution, in
twiki/data, there are two registration form topics, TWikiRegistration and TWikiRegistrationPub. The original form includes an intranet Login Username field. For Basic Authentication, the original form is replaced by the Pub version. If you started using TWiki on Basic Authentication and want to change, you have to switch back forms for future use, and manually correct the existing entries, by editing TWikiUsers, adding the Login Username for each member -
PeterThoeny - pthoeny - 01 Jan 1999 - and also in the
.htpasswd file, where you can either replace the WikiNames or duplicate the entries and have both, so both usernames will work. verification and clearer rewrite to follow in a bit. also link to original installation mention.
NOTE: To correctly enter a WikiName - your own or someone else's - be sure to include the Main web name in front of the Wiki username, followed by a period, and no spaces. Ex:
WikiUser to the TWiki.Main web, where user registration pages are stored, no matter which web it's entered in. Without the web prefix, the name appears as a NewTopic everywhere but in the Main web.
Change and reset passwords using forms on regular pages. Use TWikiAccessControl
to restrict use as required.
No permission to view TWiki.ChangePassword
Remember your password? Use ChangePassword instead. Otherwise, use this form to get a new one e-mailed to you.
- 19 May 2002