More Premium Hugo Themes Premium Vue Themes

Rss

PROJECT MIGRATED TO CODEBERG -- A simple twitter-feed-style RSS aggregator written in PHP, Laravel, Inertia.js, Tailwind and Vue.js

Rss

PROJECT MIGRATED TO CODEBERG -- A simple twitter-feed-style RSS aggregator written in PHP, Laravel, Inertia.js, Tailwind and Vue.js

Author Avatar Theme by ssddanbrown
Github Stars Github Stars: 552
Last Commit Last Commit: Aug 1, 2024 -
First Commit Created: Aug 27, 2024 -
default image

Overview:

The RSSA is a simple, opinionated RSS feed aggregator developed in PHPUnit. It includes several key features such as support for RSS and ATOM formats, auto-fetching of RSS feeds, customizable feed names and colors, and feed-based tags for categorization. The theme includes three different post layout modes, system-based dark/light theme, and mobile screen compatibility. Although it has some limitations in terms of features such as import of full post content, feed management via the UI, user system or management, authentication, authorization, customization, and error handling, it offers a ready-to-use docker image for easy deployment.

Features:

  • Supports RSS and ATOM formats
  • Auto-fetching of RSS feeds
  • Customizable feed names and colors
  • Feed-based tags for categorization
  • Ability to hide feed posts by default
  • Three different post layout modes (card, list, compact)
  • System-based dark/light theme
  • Ready-to-use docker image

Installation:

  1. Docker Run Command Example:
docker run -d -p 8080:80 -v /home/barry/rss:/app/storage imagename
  1. Docker Compose Example:
version: '3'
services:
  rssa:
    image: imagename
    ports:
      - "8080:80"
    volumes:
      - ./rss-files:/app/storage
  1. Building the Docker Image:
docker build -t imagename .
  1. Feed Configuration:
  • Feed configuration is handled by a plaintext file on the host system.
  • By default, the configuration file is located in a feeds.txt file within the mounted path to /app/storage.
  1. App Configuration:
  • The application allows configuration through variables set in the .env file or using environment variables when using docker.
  1. Usage Behind a Reverse Proxy:
  • When using behind a reverse proxy, ensure common forwarding headers are set for the application to detect the right host and path.

Summary:

The RSSA is a feature-rich RSS feed aggregator with support for various formats, customizable features, and a user-friendly docker deployment option. Despite some limitations in functionality, the application is designed for simplicity and ease of use, making it a suitable choice for users looking for a straightforward RSS feed aggregator solution.