mirror of
https://github.com/driftywinds/rssrise.git
synced 2025-12-19 03:23:32 +00:00
36 lines
1.4 KiB
Markdown
36 lines
1.4 KiB
Markdown
## RSSrise - Apprise Notifications for FreshRSS Instances
|
|
|
|
<img align="left" width="100" height="100" src="https://raw.githubusercontent.com/driftywinds/rssrise/abd2256beda2cea988ce36b5ba94ba2b4279360e/icons/rssrise.svg"> Stay up to date with your FreshRSS Instance on the go.
|
|
|
|
<br>
|
|
|
|
[](https://img.shields.io/docker/pulls/driftywinds/rssrise.svg?style=for-the-badge)
|
|
|
|
RSSrise is primarily for notifications, it does not show the contents of the feed at all. The notifications you receive have the title, the URL and the category of the item only.
|
|
|
|
Also available on Docker Hub - [```driftywinds/rssrise:latest```](https://hub.docker.com/repository/docker/driftywinds/rssrise/general)
|
|
|
|
### How to use: -
|
|
|
|
1. Download the ```compose.yml``` and ```.env``` files from the repo [here](https://github.com/driftywinds/rssrise).
|
|
2. Customise the ```.env``` file according to your needs.
|
|
3. Run ```docker compose up -d```.
|
|
|
|
<br>
|
|
|
|
You can check logs live with this command: -
|
|
```
|
|
docker compose logs -f
|
|
```
|
|
### For dev testing: -
|
|
- have python3 installed on your machine
|
|
- clone the repo
|
|
- go into the directory and run these commands: -
|
|
```
|
|
python3 -m venv .venv
|
|
source .venv/bin/activate
|
|
pip install --no-cache-dir -r requirements.txt
|
|
```
|
|
- configure ```.env``` variables.
|
|
- then run ```python3 main.py```
|