packages/ssoinabox-webui/root/usr/local/share/weblogin/ssoinabox/templates/help.html
changeset 0 3906ca745819
--- /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 @@
+<!DOCTYPE html>
+<!-- :mode=html: -->
+<html>
+  <head>
+    <title>WebAuth Help</title>
+    <link rel="stylesheet" type="text/css" href="images/bootstrap/css/bootstrap.min.css" />
+	<link rel="stylesheet" type="text/css" href="images/ssoinabox.css" />
+  </head>
+
+	<body>
+		<div class="main container">
+			<h1>SSO-in-a-Box WebAuth Service</h1>
+			<p>This page serves as general information about the WebAuth service.</p>
+			
+			<h2>What is WebAuth?</h2>
+			<p>WebAuth is the facility that makes it easy to tie a webpage into SSO-in-a-Box's central user account service.</p>
+			
+			<h2>I can't log in. Help!</h2>
+			
+			<p>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.</p>
+			
+			<h3>Error: You entered an incorrect username or password (or both).</h3>
+			
+			<p>Double-check your username and password. For employees, this is your first initial followed by your last name, <strong>all lowercase</strong>.
+				Remember, your username and password are both case sensitive.</p>
+			
+			<h3>Internal error</h3>
+			
+			<p>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.</p>
+
+			<h3>Error: You took too long to log in.</h3>
+			
+			<p>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.</p>
+			
+			<h3>Error: That username may not authenticate to this service.</h3>
+			
+			<p>Your account is disabled. This might happen for any number of reasons, such as account suspension or password expiration.</p>
+			
+			<h2>As a developer, how can I use WebAuth?</h2>
+			<p>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:</p>
+			<pre># Protect the entire directory
+AuthType WebAuth
+Require valid-user</pre>
+			<pre># Protect only certain URLs in this directory
+&lt;FilesMatch "^(index|admin)\.php$"&gt;
+	AuthType WebAuth
+	Require valid-user
+&lt;/FilesMatch&gt;</pre>
+			<pre># Restrict to a whitelist of users
+AuthType WebAuth
+Require user jschmoe jdoe</pre>
+			<pre># Restrict to a group
+AuthType WebAuth
+AuthDBMGroupFile /etc/apache2/ldap-groups
+Require group users</pre>
+		</div>
+	</body>
+</html>