mirror of
https://github.com/YGGverse/pulsarss.git
synced 2026-03-31 09:05:29 +00:00
update readme
This commit is contained in:
parent
5272717dcd
commit
a9f6e39a75
1 changed files with 27 additions and 2 deletions
29
README.md
29
README.md
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
## RSS Aggregator for [Gemini Protocol](https://geminiprotocol.net/)
|
||||
|
||||
`pulsarss` is a multi-process crawler for RSS feeds. It collects the data into static [gemtext](https://geminiprotocol.net/docs/gemtext.gmi) files, organized in sub-folders by `pub_date`. It also builds an actual `index.gmi` file in the destination folders for easy reading in your favorite [Gemini browser](https://github.com/kr1sp1n/awesome-gemini#clients).
|
||||
`pulsarss` is a multi-process crawler for RSS feeds. It collects the data into static [gemtext](https://geminiprotocol.net/docs/gemtext.gmi) files, organized in sub-folders by `pub_date`; also builds an actual `index.gmi` file in the destination folders for easy reading in your favorite [Gemini browser](https://github.com/kr1sp1n/awesome-gemini#clients).
|
||||
|
||||
> [!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 list](https://github.com/kr1sp1n/awesome-gemini#servers)
|
||||
|
|
@ -27,4 +27,29 @@ pulsarss --source https://path/to/feed.rss
|
|||
|
||||
* `source` - RSS feed source (required)
|
||||
* `target` - Destination directory (`public` by default)
|
||||
* `update` - Update timeout in seconds (`60` by default)
|
||||
* `update` - Update timeout in seconds (`60` by default)
|
||||
|
||||
### Autostart
|
||||
|
||||
#### systemd
|
||||
|
||||
``` /etc/systemd/system/pulsarss.service
|
||||
# /etc/systemd/system/pulsarss.service
|
||||
|
||||
[Unit]
|
||||
After=network.target
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
User=pulsarss
|
||||
Group=pulsarss
|
||||
ExecStart=pulsarss --source https://path/to/feed.rss
|
||||
Restart=on-failure
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
```
|
||||
|
||||
* `systemctl daemon-reload` - reload systemd configuration
|
||||
* `systemctl enable pulsarss` - enable service on system startup
|
||||
* `systemctl start pulsarss` - start server
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue