diff --git a/docs/customservices.md b/docs/customservices.md index 8252a72..d1b2e8c 100644 --- a/docs/customservices.md +++ b/docs/customservices.md @@ -32,6 +32,7 @@ Available services are located in `src/components/`: - [Matrix](#matrix) - [Mealie](#mealie) - [Medusa](#medusa) +- [Miniflux](#miniflux) - [Nextcloud](#nextcloud) - [OctoPrint / Moonraker](#octoprintmoonraker) - [Olivetin](#olivetin) @@ -389,6 +390,22 @@ The url must be the root url of Medusa application. **API Key**: The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API. +## Miniflux + +Displays the number of unread articles from your Miniflux RSS reader. + +```yaml +- name: "Miniflux" + type: "Miniflux" + logo: "assets/tools/sample.png" + url: https://my-service.url + apikey: "<---insert-api-key-here--->" + style: "status" # Either "status" or "counter" + checkInterval: 60000 # Optional: Interval (in ms) for updating the unread count +``` + +**API Key**: Generate an API key in Miniflux web interface under **Settings > API Keys > Create a new API key** + ## Nextcloud Displays Nextcloud version and shows if Nextcloud is online, offline, or in [maintenance diff --git a/dummy-data/miniflux/v1/entries b/dummy-data/miniflux/v1/entries new file mode 100644 index 0000000..962714f --- /dev/null +++ b/dummy-data/miniflux/v1/entries @@ -0,0 +1,36 @@ +{ + "total": 42, + "entries": [ + { + "id": 888, + "user_id": 1, + "feed_id": 42, + "title": "Example Unread Entry", + "url": "http://example.org/article.html", + "comments_url": "", + "author": "John Doe", + "content": "

This is an unread RSS entry

", + "hash": "29f99e4074cdacca1766f47697d03c66070ef6a14770a1fd5a867483c207a1bb", + "published_at": "2025-11-11T16:15:19Z", + "created_at": "2025-11-11T16:15:19Z", + "status": "unread", + "share_code": "", + "starred": false, + "reading_time": 5, + "enclosures": null, + "feed": { + "id": 42, + "user_id": 1, + "title": "Tech Blog", + "site_url": "http://example.org", + "feed_url": "http://example.org/feed.atom", + "checked_at": "2025-11-11T21:06:03.133839Z", + "category": { + "id": 22, + "user_id": 1, + "title": "Technology" + } + } + } + ] +} diff --git a/src/components/services/Miniflux.vue b/src/components/services/Miniflux.vue new file mode 100644 index 0000000..0ae3bb7 --- /dev/null +++ b/src/components/services/Miniflux.vue @@ -0,0 +1,160 @@ + + + + +