buildrelease

[openafs-wiki.git] / TWiki / ManagingUsers.mdwn

diff --git a/TWiki/ManagingUsers.mdwn b/TWiki/ManagingUsers.mdwn
index 3a47a31..1271db1 100644 (file)
--- a/TWiki/ManagingUsers.mdwn
+++ b/TWiki/ManagingUsers.mdwn
@@ -10,6 +10,7 @@ _Register users on your TWiki site; change/reset/install passwords; remove user
         <li><a href="#Change, Reset and Install Passwo"> Change, Reset and Install Passwords</a></li>
         <li><a href="#Changing User Account Names"> Changing User Account Names</a></li>
         <li><a href="#Removing User Accounts"> Removing User Accounts</a></li>
+        <li><a href="#Customizing registration Emails."> Customizing registration Emails.</a></li>
       </ul>
     </li>
   </ul>
@@ -64,6 +65,67 @@ To remove a user account (FredQuimby, who logs in as "fred"):
 3. Remove `FredQuimby` from all groups and from all the `ALLOWWEB/ALLOWTOPIC...` declarations, if any.%BR% **_Note:_** If you fail to do this you risk creating a security hole, as the next user to register with the wikiname FredQuimby will inherit the old FredQuimby's permissions.
 4. _[optional]_ Delete their user topic Main.FredQuimby (including attachments, if any.)
 
-**_Note:_** Consider leaving the user topic file in place so their past signatures and revision author entries don't end up looking like [[AnUncreatedTopic]]. If you want to make it clear the user is no longer around, replace the topic content with a note to that effect. The existance of the UserName topic should also prevent that user name from being re-used, sealing the potential security hole regarding inherited permissions..
+**_Note:_** Consider leaving the user topic file in place so their past signatures and revision author entries don't end up looking like [[AnUncreatedTopic]]. If you want to make it clear the user is no longer around, replace the topic content with a note to that effect. The existence of the UserName topic should also prevent that user name from being re-used, sealing the potential security hole regarding inherited permissions..
+
+## <a name="Customizing registration Emails."></a> Customizing registration Emails.
+
+TWiki's Registration can send 3 emails who's output is governed by templates:
+
+1. User registration confirmation - `templates/registerconfirm.tmpl`
+2. User registration notification - `templates/registernotify.tmpl`
+3. Email to notify the TWiki admin of registration - `templates/registernotifyadmin.tmpl`
+
+As these are [[TWikiTemplates]], they can be customized and selected using the SKIN path setting. Because there are default tmpl files in the `templates` dir, this cannot use Template topics.
+
+These template files have a specific format that matches the raw format of emails sent via SMTP, so be careful and test your changes. It is easiest to start by copying the default templates:
+
+    cd twiki/templates
+    cp registernotify.tmpl registernotify.myskin.tmpl
+    cp registerconfirm.tmpl registerconfirm.myskin.tmpl
+    cp registernotifyadmin.tmpl registernotifyadmin.myskin.tmpl
+
+then add `myskin` to the beginning of the `SKIN` setting in [[TWikiPreferences]].
+
+From this point on, your myskin templates will be used for the registration emails.
+
+To make it possible for [[TWikiUsers]] to modify the email contents, you could use a parameterized `%INCLUDE%` statement in your customized version. eg:
+
+    From: %WIKIWEBMASTERNAME% <%WIKIWEBMASTER%>
+    To: %FIRSTLASTNAME% <%EMAILADDRESS%>
+    Subject: %MAKETEXT{"[_1] - Registration for [_2] ([_3])" args="%WIKITOOLNAME%, %WIKINAME%, %EMAILADDRESS%"}%
+    MIME-Version: 1.0
+    Content-Type: text/plain; charset=%CHARSET%
+    Content-Transfer-Encoding: 8bit
+
+    %INCLUDE{
+        "Main.RegistrationNotification"
+        WIKINAME="%WIKINAME%"
+        FIRSTLASTNAME="%FIRSTLASTNAME%"
+        EMAILADDRESS="%EMAILADDRESS%"
+    }%
+
+- **_note the use of %WIKINAME%, %FIRSTLASTNAME%, %EMAILADDRESS% passed in from the INCLUDE so that the topic below is similar to the original template_**
+
+and then create a topic Main.RegisterNotifyEmail:
+
+    Welcome to %WIKITOOLNAME%.
+
+    %MAKETEXT{"Your personal [_1] topic is located at [_2]. You can customize it as you like:" args="%WIKITOOLNAME%, %SCRIPTURL{"view"}%/%USERSWEB%/%WIKINAME%"}%
+
+       * %MAKETEXT{"Some people turn it into a personal portal with favorite links, what they work on, what help they'd like, etc."}%
+       * %MAKETEXT{"Some add schedule information and vacation notice."}%
+
+    Regards
+    %WIKIWEBMASTERNAME%
+    Your TWiki Admin
+
+    %MAKETEXT{"Note:"}%
+       2 %MAKETEXT{"You can change your password at via [_1]" args="%SCRIPTURL{"view"}%/%SYSTEMWEB%/ChangePassword"}%
+       3 %MAKETEXT{"If you haven't set a password yet or you want to reset it, go to: [_1]" args="%SCRIPTURL{"view"}%/%SYSTEMWEB%/ResetPassword"}%
+
+    %MAKETEXT{"Submitted content:"}%
+    %FORMDATA%
+
+- **_remember to secure the topic appropriately to prevent attackers from getting emailed sensitive passwords._**
 
 **_Related Topics:_** [[AdminDocumentationCategory]]