yggverse/pulsar

RSS aggregator for different protocols

Maintainers

Details

github.com/YGGverse/Pulsar

Homepage

Source

Issues

Installs: 0

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 0

Type:project

dev-main 2024-05-07 05:50 UTC

Requires

MIT 9f5680bec84fb555af4f10b4936813fd8429fa70

  • YGGverse

feedrssconverteraggregatorGemininexgemini-protocolyggversegemtextgminex-protocol

This package is auto-updated.

Last update: 2024-12-07 07:08:27 UTC

README

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:

Autostart

systemd

Launch server as the systemd service

Following example mean application installed into the home directory of pulsar user (useradd -m pulsar)

# /etc/systemd/system/pulsar.service

[Unit]
After=network.target

[Service]
Type=simple
User=pulsar
Group=pulsar
ExecStart=/usr/bin/php /home/pulsar/Pulsar/src/server.php protocol=nex config=name.json
StandardOutput=file:/home/pulsar/debug.log
StandardError=file:/home/pulsar/error.log
Restart=on-failure

[Install]
WantedBy=multi-user.target
  • sudo systemctl daemon-reload - reload systemd configuration
  • sudo systemctl enable pulsar - enable service on system startup
  • sudo systemctl start pulsar - start server