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
60 commits 2 branches 0 tags 90 KiB
Find a file
yggverse b5788d0a4e add description and content lines
2024-05-05 00:28:07 +03:00
config fix protocol name 2024-05-04 21:53:45 +03:00
src add description and content lines 2024-05-05 00:28:07 +03:00
.gitignore init sqlite implementation 2024-05-04 08:25:29 +03:00
composer.json update requirements 2024-05-04 20:41:39 +03:00
LICENSE Initial commit 2024-04-19 16:00:35 +03:00
README.md fix example 2024-05-04 22:10:14 +03:00

README.md

Pulsar

RSS aggregator for different protocols

See also alternative branch to generate static gemtext

Features

  • src/crawler.php - scan configured RSS feeds and dump results to SQLite
  • src/cleaner.php - auto clean deprecated records
  • src/server.php - server launcher for different protocols:

Example

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

Install

  1. apt install git composer php-fpm php-sqlite3 php-pdo php-mbstring - install system dependencies
  2. git clone https://github.com/YGGverse/Pulsar.git - get latest Pulsar version
  3. cd Pulsar - navigate project folder
  4. composer update - install application dependencies
  5. cp config/example.json config/name.json - setup your feed

Crawler

  • php src/crawler.php config=name.json - crawl feeds configured by name.json - manually or using crontab
    • config - relative (to config folder) or absolute path to configuration file

Server

Launch as many servers as wanted, for different protocols and configurations (provided as the arguments)

  • php src/server.php protocol=nex config=name.json - launch nex protocol server with name.json config
    • config - relative (config folder) or absolute path to configuration file
    • protocol - server protocol, supported options: