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
Pulsar/README.md
yggverse 9bb15c4bec update readme
2024-05-04 21:40:50 +03:00

1.4 KiB
Raw Blame History

Pulsar

RSS aggregator for different protocols

Features

  • src/crawler.php - scan configured RSS feeds and dump results to SQLite (alternative branch)
  • src/cleaner.php - auto clean deprecated records
  • src/server.php - server launcher with multiple host support, based on Ratchet asynchronous socket library

Example

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

Install

  1. apt install git composer php-fpm 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 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

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