Thanks to visit codestin.com
Credit goes to Github.com

Skip to content

qjebbs/miniflux

 
 

Repository files navigation

Miniflux Fork

This is a Miniflux fork, ships with all upstream features, plus:

  • New home, an article statistics page where reading starts.
  • Masonry view with thumbnails.
  • NSFW Feature: Show / Hide content which is Not Safe For Work.
  • Quickly toggle masonry / list view for every category / feed.
  • Action menu, with additinal action Mark Above as Read.
  • Save / Edit articles.
  • Cache images to disk/database according to feeds settings

Environment Variables Added

Variable Name Description Default Value
DISABLE_CACHE_SERVICE Set the value to 1 to disable cache service None
CACHE_FREQUENCY Caching job frequency 24 (hours)
CACHE_LOCATION Where to save caches, "disk" or "database" disk
DISK_STORAGE_ROOT The path where the disk storage located ./

Disable HTTP service (with DISABLE_HTTP_SERVICE), will disable cache service on anyway.

See all other variables here.

About the NSFW Mode

The NSFW is designed to hide and skip some articles temporary in some cases, like, at work.

In the second demo below, a small dot near the Miniflux indicates that the NSFW mode is enabled.

  • With NSFW mode enabled, all feeds (and their articles) marked as NSFW will not be shown.
  • Mark feeds' NSFW flags in the feed setting pages, before enable NSFW mode.
  • Switch NSFW Mode with keyboard shorcut Shift + N on PC, or the NSFW menu on mobile.

New home

Masonry view

Miniflux 2

Miniflux is a minimalist and opinionated feed reader:

  • Written in Go (Golang)
  • Works only with Postgresql
  • Doesn't use any ORM
  • Doesn't use any complicated framework
  • Use only modern vanilla Javascript (ES6 and Fetch API)
  • Single binary compiled statically without dependency
  • The number of features is voluntarily limited

It's simple, fast, lightweight and super easy to install.

Official website: https://miniflux.app

Documentation

The Miniflux documentation is available here: https://miniflux.app/docs/ (Man page)

Screenshots

Default theme:

Default theme

Dark theme when using keyboard navigation:

Dark theme

Credits

About

Minimalist feed reader written in Go

Resources

License

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 84.7%
  • HTML 9.1%
  • JavaScript 3.0%
  • CSS 2.0%
  • Roff 0.6%
  • Makefile 0.3%
  • Other 0.3%