Skip to content

Latest commit

 

History

History
84 lines (56 loc) · 2.79 KB

README.md

File metadata and controls

84 lines (56 loc) · 2.79 KB

Announcements plugin for MantisBT

Copyright (c) 2010 John Reese - http://noswap.com
Copyright (c) 2017 Damien Regad

Released under the MIT license

See the Changelog.

Description

Lets privileged accounts create and post announcements that can be shown to users on a global or per-project basis, and allow users to dismiss individual messages.

Requirements

  • MantisBT 2.3.0 or above

If you need compatibility with older releases of MantisBT, please use legacy versions of the plugin, as per table below:

MantisBT version Plugin version
1.3 1.0.0
1.2 0.3

Installation

  1. Install the plugin's code
    • From a zip/tarball
      1. Download the plugin's latest release from GitHub
      2. Create a new directory Announce (note the capital 'A', it's case-sensitive) under MantisBT's /plugins directory
      3. Extract all files into the new directory
    • From the source repository
      In MantisBT's /plugins directory, clone the repository
      git clone https://github.com/mantisbt-plugins/Announce
      
  2. Go to Manage -> Manage Plugins and install the plugin.

Usage

A new Announcements item is added to the Manage menu, as shown in the following screenshot.

Manage Announcements

From there, new announcements can be added, targeted at All Projects or a specific one, restricted by access levels and limited in time. Existing announcements can be edited and deleted.

Manage Announcements

At this time, the Announcements can only be displayed at the top of the page (Location = Page Header), like in the example below. In the future, other options may be added.

Manage Announcements

The Configuration page lets the Administrator determine what access levels are allowed to manage announcements.

Manage Announcements

Support

The following support channels are available if you wish to file a bug report, or have questions related to use and installation: