wiki:MotdPlugin

Version 6 (modified by ChristianM, 3 years ago) (diff)

--

Display a MOTD in Trac

Description

Unlike the NewsFlashMacro, this plugin allows the system-administrator to display a MOTD on every trac page. Once the user acknowledge the message, it is no longer shown.

For a sysadmin it was always hard to inform every trac user about upcoming system updates, maintenance periods, hardware changes or whatever. With this plugin it's now possible to display such message(s) to every trac page, even when having many projects, by simply editing 1 (one!!) textfile.

Bugs/Feature Requests

Existing bugs and feature requests for MotdPlugin are here.

If you have any issues, create a new ticket.

Download and Source

Download the zipped source from here, check out MotdPlugin from here using Subversion, or browse the source with Trac.

Configuration

MotdPlugin can be configured with the following options:

[motd]
message_file = /data/messag_of_the_day.ini
message_dir = /data/motd.d
date_format = <reserved for future use>

message_file

  • default: /data/motd.ini
  • location of the file containing the messages to display

message_dir

  • default: /data/motd.d
  • directory containing HTML-files with messages to display

date_format

  • default: %Y-%m-%d %H:%M
  • allows configuration of the date-format for parameter valid_until. format is given in python 'datetime' format.

motd.ini file

MotdPlugin uses an ini-style file for configuring the messages that should be displayed.

[MsgName]
title = <message header>
message = <message text (in one line!)>
priority = <message priority, for future use>
valid_until = <expiration date for message>
repeat = <for future use>

The section name (MsgName) has to be unique within the message file. Format of the expiration date is (currently) "yyyy-mm-dd HH:MM", next version will have a configurable format.

Example

[Message1]
title = System Maintenance
message = Trac services will be unavailable next Friday from 4pm to 6pm!
valid_until = 2011-03-04 18:00

[Message2]
title = New version of xxx has been installed
valid_until = 2011-03-03 23:59

The first example should be selfexplaining. In the second example there is the message parameter missing! In that case MotdPlugin searches for a file named Message2.html in the directory specified by message_dir in trac.ini and displays the complete content of this file.

Recent Changes

[13979] by rjollos on 2014-06-17 11:08:11
Replaced tabs with spaces and fixed indentation.
[10027] by ChristianM on 2011-04-05 17:17:30
fix bug #8648 (remove with-statement to be compatible with older
python versions)
additional some cosmetic fixes
[9964] by ChristianM on 2011-03-16 20:37:44
  • restructured htdocs (moved *.js and *.css in seperate dirs)
  • add admin interface
  • add "repeat"

Author/Contributors

Author: ChristianM
Maintainer: ChristianM
Contributors: