zephyrisle/flarum-holiday-notify

This package is abandoned and no longer maintained. No replacement package was suggested.

Holiday notifications and gray mode for Flarum

dev-main 2026-02-11 14:03 UTC

Requires

• flarum/core: ^1.8.0
• guzzlehttp/guzzle: ^7.0
• overtrue/chinese-calendar: ^1.0
• psr/container: 1.1

Requires (Dev)

• phpunit/phpunit: *

MIT

• ZephyrIsle

• notification
• holiday
• flarum
• gray-mode

README

A Flarum extension that provides holiday notifications using AI-generated content and gray mode for memorial days.

Features

• Gray Mode: Automatically applies grayscale filter to the forum on Memorial Days (Dec 13, Sep 18), excluding user avatars.
• Holiday Notifications: Sends notifications to all users on major holidays (Gregorian & Lunar).
• AI Integration: Generates unique holiday greetings using OpenAI (GPT-3.5/4).
• Admin Panel: Fully configurable holidays, independent switches, and OpenAI settings.
• Customizable: Add custom holidays, support for custom templates.

Requirements

• Flarum ^1.8
• A running queue worker (recommended) for mass notifications

Installation

Install with composer:

composer require zephyrisle/flarum-holiday-notify

php flarum migrate
php flarum cache:clear

Configuration

1. Go to Admin > Extensions > Holiday Notify & Gray Mode.
2. Configure OpenAI API Key and URL (optional, required for AI generation).
3. Enable/Disable specific holidays.
4. Add custom holidays if needed.

Scheduler

To ensure notifications are sent automatically, you must have the Flarum scheduler running. Add this to your crontab:

* * * * * php /path/to/flarum schedule:run >> /dev/null 2>&1

The holiday check runs daily at 08:00.

Development

Frontend

cd js
npm install
npm run dev

Backend

To run tests:

vendor/bin/phpunit

Technical Details

• Frontend: TypeScript/JavaScript (Admin interface), CSS Filters (Gray Mode).
• Backend: PHP, MySQL, Queue (for mass notifications).
• AI: OpenAI API integration.

License

MIT