Difference: TWikiSiteTools (13 vs. 14)

Revision 142007-04-28 - TWikiContributor

Line: 1 to 1
Deleted:
<
<
 
Changed:
<
<

TWiki Site Tools

>
>

TWiki Site Tools

  Utilities for searching, navigation, and monitoring site activity
Changed:
<
<
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 TWiki web. In particular, TWiki provides two highly configurable, automated site monitoring tools, WebNotify, to e-mail alerts when topics are edited, and WebStatistics, to generate detailed activity reports.
>
>
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 TWiki web. In particular, TWiki provides two highly configurable, automated site monitoring tools, WebNotify, to e-mail alerts when topics are edited, and WebStatistics, to generate detailed activity reports.
 

WebNotify - recent changes alert

Line: 16 to 17
 

Web Changes Notification Service

Each TWiki web has an automatic e-mail notification service that sends you an e-mail with links to all of the topics modified since the last alert.

Users subscribe to email notifications using their WikiName or an alternative email address, and can specify the webs/topics they wish to track, Whole groups of users can also be subscribed for notification.

The general format of a subscription is:

three spaces * subscriber [ : topics ]

Where subscriber can be a WikiName, an E-mail address, or a group name. If subscriber contains any characters that are not legal in an email address, then it must be enclosed in 'single' or "double" quotes.

topics is an optional space-separated list of topics:

  • ... without a Web. prefix
  • ...that exist in this web.
Users may further customize the specific content they will receive using the following controls:
  • Using wild-card character in topic names - You can use * in a topic name, where it is treated as a wildcard character. A * will match zero or more other characters - so, for example, Fred* will match all topic names starting with Fred, *Fred will match all topic names ending with Fred, and * will match all topic names.
  • Unsubscribing to specific topics - Each topic may optionally be preceded by a '+' or '-' sign. The '+' sign means "subscribe to this topic". The '-' sign means "unsubscribe" or "don't send notifications regarding this particular topic". This allows users to elect to filter out certain topics. Topic filters ('-') take precedence over topic includes ('+') i.e. if you unsubscribe from a topic it will cancel out any subscriptions to that topic.
  • Including child-topics in subscription - Each topic may optionally be followed by an integer in parentheses, indicating the depth of the tree of children below that topic. Changes in all these children will be detected and reported along with changes to the topic itself. Note This uses the TWiki "Topic parent" feature.
  • Subscribing to entire topic ("news mode") - Each topic may optionally be immediately followed by an exclamation mark ! and/or a question mark ? with no intervening spaces, indicating that the topic (and children if there is a tree depth specifier as well) should be mailed out as complete topics instead of change summaries. ! causes the full topic to be mailed every time even if there have been no changes, and ? will mail the full topic only if there have been changes. One can limit the content of the subscribed topic to send out by inserting %STARTPUBLISH% and %STOPPUBLISH% markers within the topic. Note that "news mode" subscriptions require a corresponding cron job that includes the "-news" option (see details).

Examples: Subscribe Daisy to all changes to topics in this web.

   * daisy.cutter@flowers.com
Subscribe Daisy to all changes to topics that start with Web.
   * daisy.cutter@flowers.com : Web*
Subscribe Daisy to changes to topics starting with Petal, and their immediate children, WeedKillers and children to a depth of 3, and all topics that match start with Pretty and end with Flowers e.g. PrettyPinkFlowers
   * DaisyCutter: Petal* (1) WeedKillers (3) Pretty*Flowers
Subscribe StarTrekFan to changes to all topics that start with Star except those that end in Wars, sInTheirEyes or shipTroopers.
   * StarTrekFan: Star* - *Wars - *sInTheirEyes - *shipTroopers
Subscribe Daisy to the full content of NewsLetter whenever it has changed
   * daisy@flowers.com: NewsLetter?
Subscribe buttercup to NewsLetter and its immediate children, even if it hasn't changed.
   * buttercup@flowers.com: NewsLetter! (1)
Subscribe GardenGroup (which includes Petunia) to all changed topics under AllnewsLetters to a depth of 3. Then unsubscribe Petunia from the ManureNewsLetter, which she would normally get as a member of GardenGroup:
   * GardenGroup: AllNewsLetters? (3)
   * petunia@flowers.com: - ManureNewsLetter
Subscribe IT:admins (a non-TWiki group defined by an alternate user mapping) to all changes to Web* topics.
   * 'IT:admins' : Web*

A user may be listed many times in the WebNotify topic. Where a user has several lines in WebNotify that all match the same topic, they will only be notified about changes that topic once (though they will still receive individual mails for news topics).

If a group is listed for notification, the group will be recursively expanded to the e-mail addresses of all members.

ALERT! Warning: Because an email address is not linked to a user name, there is no way for TWiki to check access controls for subscribers identified by email addresses. A subscriber identified by an email address alone will only be sent change notifications if the topic they are subscribed to is readable by guest users. You can limit what email addresses can be used in %NOTIFYTOPIC%, or even block use of emails altogther, using the {MailerContrib}{EmailFilterIn} setting in =configure.

TIP Tip: List names in alphabetical order to make it easier to find the names.

Note for System Administrators: Notification is supported by an add-on to the TWiki kernel called the MailerContrib. See the MailerContrib topic for details of how to set up this service.

Note: If you prefer a news feed, point your reader to WebRss (for RSS 1.0 feeds) or WebAtom (for ATOM 1.0 feeds). Learn more at WebRssBase and WebAtomBase, respectively.

Changed:
<
<
You can also use %MAINWEB% instead of Main, but this is not necessary even if you have renamed the main web by configuring {MainWebName} in configure.
>
>
You can also use %USERSWEB% instead of Main, but this is not necessary even if you have renamed the main web by configuring {MainWebName} in configure.
 

WebSearch - search TWiki site

Line: 43 to 44
 
Added:
>
>

WebRss and WebAtom - news feeds on recent changes

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 %SEARCH{}%.

 

WebIndex - list of topics

Line: 68 to 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.
    • 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:
      0 0 * * * (cd /path/to/twiki/bin; ./statistics >/dev/null 2>&1)
    • 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:
      0 0 * * * (cd /path/to/twiki/tools; ./geturl.pl mydomain.com /urlpath/to/twiki/bin/statistics >/dev/null 2>&1)
Added:
>
>
    • NOTE: geturl.pl will do a TWiki CGI request as the TWikiGuest user, so if you use this workaround, the WebStatistics topics you are updating will have to be writable by TWikiGuest.
  When running from the command line or a cron job, you can pass parameters to the script like this:
Line: 78 to 85
 
  • The twiki/bin/statistics script can also be executed as a CGI script, just enter the URL in your browser. Examples:
    • Update current month for all webs you have access to:
      /twiki5/bin/statistics
Changed:
<
<
    • Update current month for Main web only:
      /twiki5/bin/statistics/Main
    • Update Apr 2018 for Main web:
      /twiki5/bin/statistics/Main?logdate=201804
>
>
    • Update current month for Main web only:
      /twiki5/bin/statistics/Main
    • Update Apr 2018 for Main web:
      /twiki5/bin/statistics/Main?logdate=201804
 
    • Update Apr 2018 for the ProjectX, ProjectY and ProjectZ webs:
      /twiki5/bin/statistics?logdate=201804;webs=ProjectX,ProjectY,ProjectZ

Line: 92 to 99
 
  • Each access gets logged as:
    | <time> | <wikiusername> | <action> | <web>.<topic> | <extra info> | <IP address> |
  • Example log entry:
Changed:
<
<
| 26 Apr 2018 - 13:31 | TWikiGuest | view | WebRss |  | 66.124.232.02 |
>
>
| 26 Apr 2018 - 13:31 | TWikiGuest | view | WebRss |  | 66.124.232.02 |
 
Line: 105 to 112
 
register bulkregister WikiUserName of new, e-mail address, admin ID
rename rename when moving topic: moved to Newweb.NewTopic
rename move when moving attachment: Attachment filename moved to Newweb.NewTopic
Deleted:
<
<
passwd resetpasswd LoginName, WikiName, E-mail address, success code from addUserPassword
passwd changepasswd LoginName, WikiName
 
save save when replacing existing revision: repRev 3
when user checks the minor changes box: dontNotify
when user changes attributes to an exising attachment: filename.ext
save cmd special admin parameter used when saving
search search search string
Line: 137 to 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:
% crontab -e

Changed:
<
<
0 2 * * * (cd /path/to/twiki/bin; ./mailnotify -q)
>
>
0 1 * * * (cd /path/to/twiki/bin; ./mailnotify -q)
 
Changed:
<
<
The above line will run mailnotify nightly at 02:00. The -q switch suppresses all normal output.
>
>
The above line will run mailnotify nightly at 01:00. The -q switch suppresses all normal output.
  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.
Line: 150 to 155
 
  • TWikiAccessControl describes how to restrict read and write access to topics and webs, by users and groups
  • SitePermissions lists the permissions settings of the webs on this TWiki site
Added:
>
>

Help with crontab

The crontab command is used to schedule commands to be executed periodically.

  • Wikipedia.org:Crontab - crontab documentation
  • pycron - crontab for Windows
 Related Topics: AdminDocumentationCategory, AdminToolsCategory
Added:
>
>
-- Contributors: TWiki:Main.MikeMannix, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie, TWiki:Main.KennethLavrsen, TWiki:Main.SvenDowideit
 
This site is powered by the TWiki collaboration platformCopyright & by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiSiteTools