Description¶

An enhanced fork of Redmine Banner that adds role-based banners and dynamic macro features while maintaining full compatibility with the original plugin.

Key Features¶

Role-based Project Banners¶

Display different messages to different roles within the same project. Useful for showing team-specific, department-specific, or role-specific information.

Banner Macros¶

Add dynamic content to your banners using macros like countdowns, environment labels, user information, and timestamps.

Supported Redmine Versions¶

Compatible with Redmine 4.x / 5.x / 6.x (Redmine 4 support will be deprecated in the future due to Preview mechanism differences)

Why This Fork?¶

The original Redmine Banner is excellent for site-wide and project-wide notifications. However, in real-world operations, different roles often need different information:

• Project managers need budget and schedule updates
• Developers need environment and technical information
• Reporters need ticket submission guidelines
• External partners need deliverable specifications

This fork solves these challenges by allowing role-specific banners and dynamic content through macros.

Use Cases¶

Role as Team/Department/Group Names¶

While this plugin uses Redmine's "Role" feature, it can be applied flexibly:

• Frontend team: "UI library update scheduled"
• Backend team: "API server maintenance notice"
• QA team: "Test environment changes"

Macro Examples¶

• Countdown: %{countdown:2026-04-01} → "3 days remaining"
• Environment: %{env} → [PROD] / [STG] / [DEV]
• User info: %{user_name}, %{user_last_login}
• Date/time: %{today}, %{now}

Links¶

• GitHub: https://github.com/seraph3000/redmine_banner
• Detailed explanation (Japanese): https://note.com/taba_muichi/n/ncf2c00d2c54b
• Original plugin by Akiko Takano: https://github.com/akiko-pusu/redmine_banner

Fresh Installation¶

1. Copy this plugin into your Redmine plugins directory:

REDMINE_ROOT/plugins/redmine_banner

1. Run the plugin migration:

bundle exec rake redmine:plugins:migrate NAME=redmine_banner RAILS_ENV=production

1. Restart Redmine (Passenger / Puma / Thin / Unicorn, etc.)

⚠ Important: Upgrading from Original or Other Forks¶

Do NOT overwrite the plugin directory. Remove the existing plugin first, then install the latest version.

# Remove existing plugin
rm -rf plugins/redmine_banner

# Clone the latest version
git clone https://github.com/seraph3000/redmine_banner.git plugins/redmine_banner

# Run migration
bundle exec rake redmine:plugins:migrate RAILS_ENV=production

# Restart Redmine

Why? This fork has renamed files in the lib directory. If old files remain, you may encounter Zeitwerk::NameError or other class loading errors.

Don't worry: Your database data (banner settings and messages) will NOT be deleted. Plugin removal only deletes files, not database records.

Uninstall¶

bundle exec rake redmine:plugins:migrate NAME=redmine_banner VERSION=0 RAILS_ENV=production

Supported Versions¶

• Redmine 4.x / 5.x / 6.x
• Note: Redmine 4 support will be deprecated in the future due to differences in the Preview mechanism.

For detailed usage and configuration, see the README on GitHub.