diff -r 000000000000 -r 3906ca745819 packages/ssoinabox-webui/root/usr/local/share/weblogin/ssoinabox/templates/help.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/packages/ssoinabox-webui/root/usr/local/share/weblogin/ssoinabox/templates/help.html Tue Jan 08 23:13:29 2013 -0500 @@ -0,0 +1,63 @@ + + + + + WebAuth Help + + + + + +
+

SSO-in-a-Box WebAuth Service

+

This page serves as general information about the WebAuth service.

+ +

What is WebAuth?

+

WebAuth is the facility that makes it easy to tie a webpage into SSO-in-a-Box's central user account service.

+ +

I can't log in. Help!

+ +

The most common error messages are listed below, along with an explanation of what the error means. If you encounter an error message not listed + below, please see the "Contact Information" heading below.

+ +

Error: You entered an incorrect username or password (or both).

+ +

Double-check your username and password. For employees, this is your first initial followed by your last name, all lowercase. + Remember, your username and password are both case sensitive.

+ +

Internal error

+ +

This error message is sometimes seen if maintenance was performed on the login server recently. Please try accessing the service again before + contacting the help desk.

+ +

Error: You took too long to log in.

+ +

The login page is a time-sensitive URL. Thus, bookmarking it or reusing an old login URL will not work. Instead, bookmark the page of the service + you are trying to reach after you log in. When you open the bookmark, you will be redirected to the login page if you do not have an active + session.

+ +

Error: That username may not authenticate to this service.

+ +

Your account is disabled. This might happen for any number of reasons, such as account suspension or password expiration.

+ +

As a developer, how can I use WebAuth?

+

A server must have WebAuth configured on it before it will be able to use Apache's standard "AuthType" directive in .htaccess to require WebAuth + for a selection of pages. Once this is done, protecting a page or group of pages is very simple. Examples:

+
# Protect the entire directory
+AuthType WebAuth
+Require valid-user
+
# Protect only certain URLs in this directory
+<FilesMatch "^(index|admin)\.php$">
+	AuthType WebAuth
+	Require valid-user
+</FilesMatch>
+
# Restrict to a whitelist of users
+AuthType WebAuth
+Require user jschmoe jdoe
+
# Restrict to a group
+AuthType WebAuth
+AuthDBMGroupFile /etc/apache2/ldap-groups
+Require group users
+
+ +