data/TWiki/TWikiSiteTools.txt
author Colas Nahaboo <colas@nahaboo.net>
Sat, 26 Jan 2008 15:50:53 +0100
changeset 0 414e01d06fd5
permissions -rw-r--r--
RELEASE 4.2.0 freetown
     1 %META:TOPICINFO{author="TWikiContributor" date="1177803014" format="1.1" version="14"}%
     2 %STARTINCLUDE%
     3 ---+ TWiki Site Tools
     4 
     5 _Utilities for searching, navigation, and monitoring site activity_
     6 
     7 TWiki Site Tools include utilities for navigating, searching and keeping up with site activity. Preferences can be configured by web or site-wide. You are currently in the *%SYSTEMWEB%* web. In particular, TWiki provides two highly configurable, automated site monitoring tools, *<nop>WebNotify*, to e-mail alerts when topics are edited, and *<nop>WebStatistics*, to generate detailed activity reports.
     8 
     9 %TOC%
    10 
    11 #WebNotify
    12 ---++ <nop>WebNotify - recent changes alert
    13 
    14 Each TWiki web has an automatic e-mail alert service that sends a list of recent changes on a preset schedule, like once a day. Users can subscribe and unsubscribe using %NOTIFYTOPIC% in each web. The Perl script =mailnotify= is called by a background process at regular intervals. The script sends an automated e-mail to subscribed users if topics were changed in a web since the script was last run.
    15 
    16    * You can create a WebNotify link using TWikiVariables with ==%<nop>NOTIFYTOPIC%==
    17 
    18 %INCLUDE{"WebChangesAlert"}%
    19 
    20 You can also use =%<nop>USERSWEB%= instead of =Main=, but this is not necessary even if you have renamed the main web by configuring ={MainWebName}= in [[%SCRIPTURLPATH{"configure"}%][configure]].
    21 
    22 #WebSearch
    23 ---++ <nop>WebSearch - search TWiki site
    24 
    25 WebSearch is an extremely fast and flexible search facility, part of the core TWiki feature set. WebSearchAdvanced offers more options, including:
    26    * topic title or full-text search
    27    * regular expressions
    28    * search within web or site-wide
    29    * index-style A-Z alphabetical listing sorted topic title
    30    * many more
    31 
    32 See also: SearchHelp for help; TWikiVariables and FormattedSearch for including hard-coded searches in text.
    33 
    34 #WebChanges
    35 ---++ <nop>WebChanges - what's new
    36 
    37 To check for the most recently edited topics while on-site, use the WebChanges link, usually located in the toolbar. It lists the most recently modified topics, newest first, along with the first couple of lines of the page content.
    38 
    39 This is simply a preset =SEARCH=. The number of topics listed by the =limit= parameter.:
    40 <blockquote>
    41 <pre>
    42 %<nop>SEARCH{ ".*" web="%INCLUDINGWEB%" type="regex" nosearch="on" order="modified"%BR% reverse="on" 
    43 limit="50" }%
    44 </pre>
    45 </blockquote>
    46 
    47 #WebRssAndAtom
    48 ---++ <nop>WebRss and <nop>WebAtom - news feeds on recent changes
    49 
    50 You can point your news reader at WebRss and WebAtom to find out what is new in a TWiki web. WebRssBase and WebAtomBase have the details. Like WebChanges, this is based on a =%<nop>SEARCH{}%=.
    51 
    52 #WebIndex
    53 ---++ <nop>WebIndex - list of topics
    54 
    55 WebIndex lists all web topics in alphabetical order, with the first couple of lines of text. This is simply a preset =SEARCH=:
    56 <blockquote>
    57 <pre>
    58 %<nop>SEARCH{ "\.*" scope="topic" type="regex" nosearch="on" }%
    59 </pre>
    60 </blockquote>
    61 
    62 #WebStatistics
    63 ---++ <nop>WebStatistics - site statistics
    64 
    65 You can generate a listing manually, or on an automated schedule, of visits to individual pages, on a per web basis. Compiled as a running total on a monthly basis. Includes totals for Topic Views, Topic Saves, Attachment Uploads, Most Popular Topics with number of views, and Top Contributors showing total of saves and attachment uploads. Previous months are saved.
    66 
    67    * You can create a WebStatistics link using TWikiVariables with ==%<nop>STATISTICSTOPIC%==
    68 
    69 ---+++ Configuring for automatic operation
    70 
    71    * You can automatically generate usage statistics for all webs. To enable this:
    72       * Make sure variable *{Log}{view}*, *{Log}{save}* and *{Log}{upload} in are set in [[%SCRIPTURLPATH{"configure"}%][configure]]. This will generate log file entries (see below).
    73       * The WebStatistics topic must be present in all webs where you want to have statistics. You can use the topic in the Main web as a template.
    74       * Call the =twiki/bin/statistics= script from a cron job, once a day is recommended. This will update the WebStatistics topics in all webs.
    75       * __Attention:__ The script must run as the same user as the CGI scripts are running, which is user =nobody= on many systems. Example crontab entry: %BR% =0 0 * * * (cd /path/to/twiki/bin; ./statistics &gt;/dev/null 2&gt;&amp;1)=
    76       * There is a workaround in case you can't run the script as user =nobody= : Run the utility =twiki/tools/geturl.pl= in your cron job and specify the URL of the =twiki/bin/statistics= script as a parameter. Example: %BR% =0 0 * * * (cd /path/to/twiki/tools; ./geturl.pl mydomain.com /urlpath/to/twiki/bin/statistics &gt;/dev/null 2&gt;&amp;1)= 
    77       * __NOTE:__ =geturl.pl= will do a TWiki CGI request as the <nop>TWikiGuest user, so if you use this workaround, the !WebStatistics topics you are updating will have to be writable by <nop>TWikiGuest.
    78 
    79 When running from the command line or a cron job, you can pass parameters to the script like this:
    80 <verbatim>
    81 ./statistics -logdate 200605 -webs TWiki,Sandbox
    82 </verbatim>
    83 
    84 ---+++ Generating statistics manually by URL
    85 
    86    * The =twiki/bin/statistics= script can also be executed as a CGI script, just enter the URL in your browser. Examples:
    87       * Update current month for all webs you have access to: %BR% =%SCRIPTURLPATH{statistics}%=
    88       * Update current month for %USERSWEB% web only: %BR% =%SCRIPTURLPATH{statistics}%/%USERSWEB%=
    89       * Update %SERVERTIME{$month $year}% for %USERSWEB% web: %BR% =%SCRIPTURLPATH{statistics}%/%USERSWEB%?logdate=%SERVERTIME{$year$mo}%=
    90       * Update %SERVERTIME{$month $year}% for the !ProjectX, !ProjectY and !ProjectZ webs: %BR% =%SCRIPTURLPATH{statistics}%?logdate=%SERVERTIME{$year$mo}%;webs=Project<nop>X,Project<nop>Y,Project<nop>Z=
    91 
    92 #LogFiles
    93 ---++ Log Files
    94 
    95 TWiki generates monthly log files which are used by the statistics script
    96    * The log file is defined by the *{LogFileName}* setting in [[%SCRIPTURLPATH{"configure"}%][configure]]
    97    * The file name is =log&lt;year&gt;&lt;month&gt;.txt=
    98    * Example path name: =twiki/logs/log%SERVERTIME{$year$mo}%.txt=
    99    * Each access gets logged as: %BR%
   100      =| &lt;time&gt; | &lt;wikiusername&gt; | &lt;action&gt; | &lt;web&gt;.&lt;topic&gt; | &lt;extra info&gt; | &lt;IP address&gt; |=
   101    * Example log entry: %BR%
   102      =| %SERVERTIME{$day $mon $year - $hour:$min}% | %USERSWEB%.TWikiGuest | view | %SYSTEMWEB%.WebRss |  | 66.124.232.02 |=
   103    * Actions are logged if enabled in [[%SCRIPTURLPATH{"configure"}%][configure]] by the *{Log}{<i>action</i>}* flags
   104    * Logged actions:
   105      | *Script* | *Action name* | *Extra info* |
   106      | attach | =attach= | when viewing attach screen of previous uploaded attachment: =filename= |
   107      | changes | =changes= |  |
   108      | edit | =edit= | when editing non-existing topic: =(not exist)= |
   109      | rdiff | =rdiff= | higher and lower revision numbers: =4 3= |
   110      | register | =regstart= | !WikiUserName, e-Mail address, LoginName: =user attempts to register= |
   111      | register | =register= | E-mail address: =user successfully registers= |
   112      | register | =bulkregister= | !WikiUserName of new, e-mail address, admin ID |
   113      | rename | =rename= | when moving topic: =moved to !Newweb.NewTopic= |
   114      | rename | =move= | when moving attachment: =Attachment filename moved to !Newweb.NewTopic= |
   115      | save | =save= | when replacing existing revision: =repRev 3= %BR% when user checks the minor changes box: =dontNotify= %BR% when user changes attributes to an exising attachment: =filename.ext= |
   116      | save | =cmd= | special admin parameter used when saving |
   117      | search | =search= | search string |
   118      | upload | =upload= | filename |
   119      | view | =view= | when viewing non-existing topic: =(not exist)= %BR% when viewing previous topic revision: =r3= |
   120 
   121 #ConfigureEmail
   122 ---++ E-mail
   123 
   124 ---+++ Configuring outgoing mail
   125 
   126 Outgoing mail is required for TWikiRegistration and for [[#WebNotify][recent changes alert]].
   127 
   128 TWiki will use the ==Net::SMTP== module if it is installed on your system. Set this with the ==SMTPMAILHOST== variable in TWikiPreferences.
   129 
   130 The notify e-mail uses the default =changes.tmpl= template, or a skin if activated in the TWikiPreferences.
   131 
   132 mailnotify also relies on two hidden files in each =twiki/data/Web= directory: =.changes= and =.mailnotify.= Make sure both are writable by your web server process. =.changes= contains a list of changes; go ahead and make this empty. =.mailnotify= contains a timestamp of the last time notification was done.
   133 
   134 You can use an external mail program, such as ==sendmail==, if the =Net::SMTP= module is not installed. Set the program path in =={MailProgram}== in [[%SCRIPTURLPATH{"configure"}%][configure]].
   135 
   136    * %H% Net::SMTP can be easily disabled (if there is an installation error) by setting ==SMTPMAILHOST== in TWikiPreferences to an empty value.
   137 
   138    * %T% You can set a separate ==SMTPSENDERHOST== variable to define the mail sender host (some SMTP installations require this).
   139 
   140 ---+++ Setting the automatic e-mail schedule
   141 
   142 *For Unix platforms:* Edit the =cron= table so that =mailnotify= is called in an interval of your choice. Please consult =man crontab= of how to modify the table that schedules program execution at certain intervals. Example:
   143 <pre>
   144 % crontab -e
   145 0 1 * * * (cd /path/to/twiki/bin; ./mailnotify -q)
   146 </pre>
   147 The above line will run mailnotify nightly at 01:00. The =-q= switch suppresses all normal output.
   148 
   149 *For ISP installations:* Many ISPs don't allow hosted accounts direct cron access, as it's often used for things that can heavily load the server. Workaround scripts are available.
   150 
   151 *On Windows:* You can use a scheduled task if you have administrative privileges. TWiki:Codev/CronTabWin is a free scheduler for Windows.
   152 
   153 ---++ Site Permissions
   154 
   155    * TWikiAccessControl describes how to restrict read and write access to topics and webs, by users and groups
   156    * SitePermissions lists the permissions settings of the webs on this TWiki site
   157 
   158 ---++ Help with crontab
   159 
   160 The crontab command is used to schedule commands to be executed periodically.
   161 
   162    * Wikipedia.org:Crontab - crontab documentation
   163    * [[http://www.kalab.com/freeware/pycron/pycron.htm][pycron]] - crontab for Windows
   164 
   165 __Related Topics:__ AdminDocumentationCategory, AdminToolsCategory
   166 
   167 %STOPINCLUDE%
   168 -- __Contributors:__ TWiki:Main.MikeMannix, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie, TWiki:Main.KennethLavrsen, TWiki:Main.SvenDowideit