{"repo":"Skulldorom/rss-api","free":true,"listed":false,"github":"https://github.com/Skulldorom/rss-api","clone":"git clone https://github.com/Skulldorom/rss-api.git","description":"Docker container to share Fresh RSS data with homepage dashboard","language":"Python","stars":12,"topics":["api","container","docker","docker-compose","fastapi","home-automation","homelab","python","rss","rss-feed"],"license":"MIT","category":"deployment-docker-iac","readme_excerpt":"rss-api Simple API to fetch rss feeds for github releases using fresh rss (powered by FastAPI) This allows you to easily integrate it with https://gethomepage.dev/ Using their Custom API integration API Documentation The API provides interactive documentation at: - Swagger UI: http://localhost:5000/docs - ReDoc: http://localhost:5000/redoc Available Endpoints - GET /freshrss/unread - Fetch unread RSS items from FreshRSS - Optional query parameters: - n (integer, default 10 , valid range 1 – 100 ) - Number of unread items to return - category (string) - FreshRSS category label to scope unread items, e.g. /freshrss/unread?category=Tech - GET /health - Container health endpoint (does not require authentication) Authentication Bearer authentication is optional . When RSS API TOKEN is not set the API accepts all requests — convenient for trusted/internal networks. Set RSS API TOKEN to a long random secret to require an Authorization: Bearer header on every protected endpoint. /health always remains unauthenticated. Generate a long random token with OpenSSL and save it in .env : When auth is enabled, clients such as Homepage must send the same header: Testing Run the test suite with: GitHub Actions runs these tests for pull requests and before publishing the Docker image from main . Example of services.yaml: Docker Copy the example environment file and set the required values: Configure these environment variables in .env or your Compose environment: Variable Required Default if un","default_branch":null,"files":null,"tree":[],"storefront":"/r/Skulldorom","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/Skulldorom/rss-api/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}