Giter Club home page Giter Club logo

freshrss-checker's Introduction

FreshRSS Checker

FreshRSS Checker is a WebExtension that tracks unread items in a FreshRSS instance and shows a badge with the number of unread articles.

Setup

  1. Install the extension: Firefox Add-Ons - Chrome Web Store
  2. Open the extension's preferences page from add-ons manager and set the FreshRSS base URL, username, and API password (not your regular password, remember to enable mobile API access).
  3. Place the toolbar icon in a visible location if you want to see the number of unread items.

Build

  1. Clone
  2. Install dependencies with npm install
  3. Run npm run start:firefox
  4. Build with npm run build

Primary development target is Firefox, Chromium-based browsers are polyfilled.

Usage notes

  • Clicking the toolbar icon opens your FreshRSS instance
  • Right-clicking it and choosing "Check now" forces the badge to update
  • The time between checks can be set in the preferences.
  • The password is stored in the extension's local storage, effectively in clear text on the file system. It's not transmitted over the network, only an MD5 hash of your username plus password is!

freshrss-checker's People

Contributors

brawl345 avatar dependabot[bot] avatar willsalmanj avatar xuhcc avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

freshrss-checker's Issues

FreshRSS URL Error Fix

An "ERR" label is returned for some users in Chrome setting the FreshRSS URL to:
https://rss.example.com/
Error is resolved when changing FreshRSS URL to:
https://rss.example.com/p/

I do not know if this is a security issue in some Chrome instances or an issue with FreshRSS changing their URL hierarchy, but this solves the problem!

Can't quite figure out the setup

I followed the instructions in the setup and set my API password etc. Then I entered my URL (I assume this is the base URL, as in http://domain/freshrss (I have freshrss in a folder)?), but I still get ERR as the badge. What am I missing?

Very cool addon, btw. I just started self-hosting RSS with FreshRSS after The Old Reader added big ads. ;-)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.