archlinux-de/flarum-discussion-feed

Simple and efficient Atom feed for Flarum

1.0.2 2024-12-01 08:32 UTC

Requires

• php: ^8.1
• flarum/core: ^1.6.0

Requires (Dev)

• nesbot/carbon: ^2.62.1
• phpstan/extension-installer: ^1.4
• phpstan/phpstan: ^2.0
• phpstan/phpstan-deprecation-rules: ^2.0
• phpstan/phpstan-phpunit: ^2.0
• phpunit/phpunit: ^10.5
• squizlabs/php_codesniffer: ^3.7

GPL-3.0-or-later

README

This simple extensions generates a feed of recent created discussions. A scheduled task will regulary update the feed on disk so it can be served by your web server without invoking Flarum or PHP. This is benefitial if you have a lot of subscribers pulling your feed in short intervals.

Installation

Install and enable the extension

composer require archlinux-de/flarum-discussion-feed

Now enable the extension in your admin backend.

Web server setup

You might want to add the following rule to your Nginx config

location = /feed.xml {
    types { } default_type "application/atom+xml; charset=utf-8";
    expires 15m;
}

Enable Flarum's scheduler

Refer to schedule:run to setup your Flarum scheduler.

Permissions

Make sure the user which runs the scheduler has permissions to create the feed.xml file within Flarum's public directory.