none
authorJohnTalintyre <JohnTalintyre>
Wed, 29 Aug 2001 16:03:45 +0000 (16:03 +0000)
committerJohnTalintyre <JohnTalintyre>
Wed, 29 Aug 2001 16:03:45 +0000 (16:03 +0000)
TWiki/TWikiDocumentation.mdwn
TWiki/TWikiUserAuthentication.mdwn
TWiki/WebHome.mdwn

index 293e95e..8f6e7ee 100644 (file)
@@ -39,3 +39,9 @@ All support topics are loaded here to create one long and complete documentation
 ----
 
 ----
+
+----
+
+----
+
+----
index 5159cdb..d64d98c 100644 (file)
@@ -1,19 +1,65 @@
+<div>
+  <ul>
+    <li><a href="#TWiki Authentication"> TWiki Authentication</a><ul>
+        <li><a href="#Authentication Options"> Authentication Options</a></li>
+        <li><a href="#Tracking by IP Address"> Tracking by IP Address</a></li>
+        <li><a href="#TWiki Username vs. Login Usernam"> TWiki Username vs. Login Username</a></li>
+      </ul>
+    </li>
+  </ul>
+</div>
+
 ## <a name="TWiki Authentication"></a> TWiki Authentication
 
-TWiki does not authenticate users internally, it depends on the <code>**REMOTE\_USER**</code> environment variable. This variable is set when you enable basic authentication or authentication via SSL (https protocol)
+TWiki does not authenticate users internally, it depends on the <code>**REMOTE\_USER**</code> environment variable. This variable is set when you enable basic authentication or authentication via SSL (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.
+
+### <a name="Authentication Options"></a> Authentication Options
+
+No special installation steps need to be performed if the server is already authenticated. If not, you have three remaining options to controlling user access:
+
+1. **Forget about authentication.** All changes are registered to [[TWikiGuest]] user, so you can't tell who made changes. Your site is completely open and public.
+2. **Use Basic Authentication** for the <code>**edit**</code> and <code>**attach**</code> scripts. This uses .htaccess and generates the familiar grey log-in window. [[TWiki Installation Notes|Main/TWikiDocumentation#TWiki_Installation_Notes]] has more.
+3. **Use SSL** to authenticate and secure the whole server.
+
+### <a name="Tracking by IP Address"></a> Tracking by IP Address
+
+The <code>**REMOTE\_USER**</code> environment variable is only set for the scripts that are under authentication. If, for example, the <code>**edit**</code>, <code>**save**</code> and <code>**preview**</code> scripts are authenticated, but not <code>**view**</code>, you would get your [[WikiName]] in <code>**preview**</code> for the <code>**%WIKIUSERNAME%**</code> variable, but <code>**view**</code> will show <code>**TWikiGuest**</code> instead of your WikiName.
+
+There is a way to tell TWiki to remember the user for the scripts that are not authenticated, ex: in case the <code>**REMOTE\_USER**</code> environment variable is not set. 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 <code>**view**</code> will show the correct username instead of <code>**TWikiGuest**</code>. You can enable this by setting the <code>**$doRememberRemoteUser**</code> flag in <code>**TWiki.cfg**</code>. TWiki persistently stores the IP address / username pairs in file <code>**$remoteUserFilename**</code>, which is <code>**"$dataDir/remoteusers.txt"**</code> by default. Please note that this can fail if the IP address changes due to dynamically assigned IP addresses or proxy servers.
+
+**Authentication Test:** You are Main.admin (%WIKIUSERNAME%)
 
-TWiki keeps track who made changes to topics at what time. This gives a complete audit trail of changes.
+### <a name="TWiki Username vs. Login Usernam"></a> TWiki Username vs. Login Username
 
-No special installation steps need to be performed in case the server is already autenticated. If not you can opt for one of these:
+This section applies only if your %WIKITOOLNAME% is installed on a server that is both **authenticated** and on an **intranet**.
 
-- Forget about authentication. All changes will be registered as [[TWikiGuest]] user, e.g. you can't tell who made changes.
-- Use basic authentication for the <code>**edit**</code> and <code>**attach**</code> scripts. [[TWiki Installation Notes|Main/TWikiDocumentation#TWiki_Installation_Notes]] tells you more about that.
-- Use SSL to authenticate and secure the whole server.
+%WIKITOOLNAME% internally manages two usernames: Login username and TWiki username.
 
-The <code>**REMOTE\_USER**</code> environment variable is only set for the scripts that are under authentication. If for example the <code>**edit**</code>, <code>**save**</code> and <code>**preview**</code> scripts are authenticated, but not <code>**view**</code>, you would get your [[WikiName]] in <code>**preview**</code> for the <code>**%WIKIUSERNAME%**</code> variable, but <code>**view**</code> will show <code>**TWikiGuest**</code> instead of your WikiName.
+- **Login username:** When you login to the intranet, you use your existing login username, ex: <code>**pthoeny**</code>. This name is normally passed to %WIKITOOLNAME% by the <code>**REMOTE\_USER**</code> environment variable, and used by internally by %WIKITOOLNAME%. Login usernames are maintained by your system administrator.
+- **TWiki username:** Your name in [[WikiNotation]], ex: <code>**PeterThoeny**</code>, is recorded when you register using [[TWikiRegistration]]; doing so also generates a personal home page in the Main web.
 
-There is a way to tell TWiki to remember the user for the scripts that are not authenticated, e.g. for the case where the <code>**REMOTE\_USER**</code> environment variable is not set. 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 <code>**view**</code> will show the correct username instead of <code>**TWikiGuest**</code>. You can enable this by setting the <code>**$doRememberRemoteUser**</code> flag in <code>**TWiki.cfg**</code>. TWiki persistently stores the IP address / username pairs in file <code>**$remoteUserFilename**</code>, which is <code>**"$dataDir/remoteusers.txt"**</code> by default. Please note that this can fail in case the IP address changes due to dynamically assigned IP addresses or proxy servers.
+%WIKITOOLNAME% can automatically map an intranet username to a TWiki username, provided that the username pair exists in the [[TWikiUsers]] topic. This is also handled automatically when you register.
 
-Test: You are Main.admin.
+> **_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:
+>
+> <div>
+>   <center><code><b>Main.WikiUsername</b></code> or <code><b>%MAINWEB%.WikiUsername</b></code></center>
+> </div>
+>
+> This points
+>
+> <code>**WikiUser**</code>
+>
+> to the %WIKITOOLNAME%.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.
 
--- [[PeterThoeny]] - 16 Mar 2001 <br />
+-- [[PeterThoeny]] - 16 Mar 2001 <br /> -- [[MikeMannix]] - 29 Aug 2001
index 061d986..340097b 100644 (file)
@@ -8,37 +8,41 @@
 
 **Starting points** at the %WIKITOOLNAME%.%WEB% web:
 
-- [[WelcomeGuest]]: Look here first to get you rolling on %WIKITOOLNAME%.
-- [[TWikiRegistration]]: Create your %WIKITOOLNAME% account in order to edit topics.
-- **_User documentation:_**
-  - [[TWikiWeb]]: Explains what %WIKITOOLNAME% is.
-  - [[TWikiFAQ]]: List of frequently asked questions around the %WIKITOOLNAME% tool.
-  - [[TWikiTutorial]]: Get a jump start on %WIKITOOLNAME%.
-  - [[GoodStyle]]: Things to consider when changing text.
-  - [[WikiSyntax]], [[TextFormattingRules]]: Easy to learn rules for editing text.
-  - [[TextFormattingFAQ]]: Answers to frequently asked questions about text formatting.
-  - [[TWikiVariables]]: Add variable content like other topics and inline search.
-  - [[FileAttachments]]: Add files to any topic.
-  - [[RenameTopic]]: Renaming, moving, deleting topics.
-  - [[TWikiFormTemplate]]: Defining and using forms that add structured information to a topic.
-- **_Webmaster documentation:_**
-  - [[TWikiHistory]] shows TWiki's implementation history.
-  - [[TWikiDocumentation]] is the implementation documentation of TWiki, containing these topics:
-    1. [[TWikiImplementationNotes]]
+- [[WelcomeGuest]]: Start here for a %WIKITOOLNAME% crash course.
+- [[TWikiRegistration]]: Create an %WIKITOOLNAME% account in order to edit topics and customize services.
+
+### <a name="User Guide"></a> User Guide
+
+- - [[TWikiWeb]]: Brief %WIKITOOLNAME% backgrounder: first there was Wiki...
+  - [[WikiSyntax]]: TWiki language basics.
+  - [[TWikiFAQ]]: The first things people ask about %WIKITOOLNAME%.
+  - [[TextFormattingFAQ]]: Most requested facts about posting in TWiki.
+  - [[TWikiTutorial]]: A %WIKITOOLNAME% quick start alternative.
+  - [[GoodStyle]]: Tips for an open communications environment.
+  - [[TextFormattingRules]]: The full power of TWiki on a page.
+  - [[TWikiVariables]]: Manipulate text, graphics, calculations, and more with simple expanding text strings.
+  - [[FileAttachments]]: Upload files to any topic, for display or distribution.
+  - [[ModifyTopics|Main/RenameTopic]]: Rename, move, delete pages.
+  - [[TWikiForms|Main/TWikiFormTemplate]]: Create custom forms to structure information as required.
+
+### <a name="Webmaster Reference"></a> Webmaster Reference
+
+- - [[TWikiHistory]]: a timeline tracing the development of TWiki.
+  - [[TWikiDocumentation]]: the complete Web administrator's reference, containing:
+    1. [[TWikiSystemRequirements|Main/TWikiImplementationNotes]]
     2. [[TWikiInstallationNotes]]
     3. [[TWikiUpgradeNotes]]
     4. [[TWikiAuthentication]]
-    5. [[TWikiUsernameVsLoginUsername]]
-    6. [[TWikiAccessControl]]
-    7. [[TWikiTemplates]]
-    8. [[TWikiSkins]]
-    9. [[TWikiVariables]]
-    10. [[TWikiNotificationOfChanges]]
+    5. [[TWikiAccessControl]]
+    6. [[TWikiVariables]]
+    7. [[TWikiFormTemplate]]
+    8. [[TWikiTemplates]]
+    9. [[TWikiSkins]]
+    10. [[TWikiPlugins]]
     11. [[MetaDataDefinition]]
-    12. [[TWikiFormTemplate]]
-    13. [[TWikiPlugins]]
-    14. [[RenameTopic]]
-    15. [[TWikiAdministration]] tells you how to rename or delete a topic or web.
+    12. [[MonitorSiteActivity|Main/TWikiNotificationOfChanges]]
+    13. [[ModifyTopics|Main/RenameTopic]]
+    14. [[ModifyWebs|Main/TWikiAdministration]]
 
 <form action="http://www.dementia.org/twiki//search/%WEB%/">
   <ul>