YGGverse/Pulsar
1
0
Fork 0
mirror of https://github.com/YGGverse/Pulsar.git synced 2026-03-31 17:55:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
RSS aggregator for different protocols
34 commits 2 branches 0 tags 90 KiB
Find a file
yggverse 7cef4c1cb6 remove deprecated server dependency
2024-05-04 01:57:41 +03:00
example drop not maintained build-in server solution 2024-04-27 21:53:40 +03:00
src drop not maintained build-in server solution 2024-04-27 21:53:40 +03:00
.gitignore drop not maintained build-in server solution 2024-04-27 21:53:40 +03:00
composer.json remove deprecated server dependency 2024-05-04 01:57:41 +03:00
LICENSE Initial commit 2024-04-19 16:00:35 +03:00
README.md fix config name 2024-04-27 21:56:04 +03:00

README.md

Pulsar

RSS Aggregator for Gemini Protocol

Simple RSS feed converter to static Gemtext format, useful for news portals or localhost reading

Example

  • nex://[301:23b4:991a:634d::feed]/index.gmi - Yggdrasil instance by YGGverse

Usage

  1. git clone https://github.com/YGGverse/Pulsar.git
  2. cp example/config.json config.json - setup your feed locations
  3. php src/crawler.php - grab feeds manually or using crontab

Config

Configuration file supports multiple feed channels with custom settings:

  • source - string, filepath or URL to the valid RSS feed
  • target - string, relative or absolute path to Gemtext dumps
  • item
    • limit - integer, how many items to display on page generated
    • template - string, custom pattern for feed item, that supports following macros
      • {nl} - new line separator
      • {link} - item link
      • {guid} - item guid
      • {pubDate} - item pubDate, soon with custom time format e.g. {pubDate:Y-m-d H:s}
      • {title} - item title
      • {description} - item description

Resulting files could be placed to any local folder (for personal reading) or shared with others (using gmid, twins or any other server for gemtext statics)