https://github.com/yggverse/pulsarss
RSS Aggregator for Gemini Protocol
https://github.com/yggverse/pulsarss
aggregator cli crawler daemon feed gemini gemini-protocol gemtext parser rss rust
Last synced: 8 months ago
JSON representation
RSS Aggregator for Gemini Protocol
- Host: GitHub
- URL: https://github.com/yggverse/pulsarss
- Owner: YGGverse
- License: mit
- Created: 2025-02-11T16:23:03.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-02-25T17:26:55.000Z (11 months ago)
- Last Synced: 2025-05-16T09:07:31.639Z (8 months ago)
- Topics: aggregator, cli, crawler, daemon, feed, gemini, gemini-protocol, gemtext, parser, rss, rust
- Language: Rust
- Homepage: https://crates.io/crates/pulsarss
- Size: 52.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# pulsarss
[](https://deps.rs/repo/github/YGGverse/pulsarss)
[](https://crates.io/crates/pulsarss)
## RSS Aggregator for [Gemini Protocol](https://geminiprotocol.net/)
`pulsarss` is a multi-process crawler for RSS feeds, that collects and converts results into the static [gemtext](https://geminiprotocol.net/docs/gemtext.gmi) files; also aggregates an actual `index.gmi` file in the relevant folders organized by channel / item `pub_date`.
> [!NOTE]
> At this moment, `pulsarss` does not provide any built-in server. To read the data collected, use any server for static files listed in the [awesome-gemini](https://github.com/kr1sp1n/awesome-gemini#servers)
## Install
``` bash
cargo install pulsarss
```
## Launch
``` bash
pulsarss --source https://path/to/feed.rss --index index.gmi
```
### Options
* `source`, `s` - RSS feed source (required)
* `target`, `t` - Destination directory (`public` by default)
* `update`, `u` - Update timeout in seconds (`60` by default)
* `index`, `i` - Generate index files with given filename (disabled by default)
* `limit`, `l` - Limit channel items (unlimited by default)
* `output`, `o` - Print output (`dw` by default):
* `d` - debug
* `w` - warning
* `n` - disable
### Autostart
#### systemd
1. Install `pulsarss` by copy the binary compiled into the native system apps destination:
* Linux: `sudo cp /home/user/.cargo/bin/pulsarss /usr/local/bin`
2. Create `systemd` configuration file:
``` pulsarss.service
# /etc/systemd/system/pulsarss.service
[Unit]
After=network-online.target
Wants=network-online.target
[Service]
Type=simple
User=pulsarss
Group=pulsarss
ExecStart=/usr/local/bin/pulsarss -s https://path/to/feed.rss -i index.gmi
[Install]
WantedBy=multi-user.target
```
3. Run in priority:
* `systemctl daemon-reload` - reload systemd configuration
* `systemctl enable pulsarss` - enable new service
* `systemctl start pulsarss` - start the process
* `systemctl status pulsarss` - check process launched