Go to file
Alexandros Kosiaris 6703e03ce6 contrib: Add support for a $MINIFLUX_IMAGE env var in docker-compose
Allowing to override the image used in docker-compose files can allow
for richer and more easy local development/debugging sessions. The
docker image building process is already using the latest tag anyway,
making it really easy to build an image with a (set of) specific
commits. Using the above built image with the provided docker-compose
files isn't doable without modifications though. Add that support via
environmental variables.
2021-06-16 20:34:25 -07:00
.github Setup golangci-lint Github Action 2021-03-22 21:34:48 -07:00
api Add per feed cookies option 2021-03-22 20:27:58 -07:00
cli Add new option DATABASE_CONNECTION_LIFETIME 2021-05-23 19:40:33 -07:00
client client: expose comments_url entry field 2021-06-04 22:18:39 -07:00
config Add new config option CLEANUP_ARCHIVE_BATCH_SIZE 2021-05-23 20:52:13 -07:00
contrib contrib: Add support for a $MINIFLUX_IMAGE env var in docker-compose 2021-06-16 20:34:25 -07:00
crypto Add "Share article" feature 2020-03-17 20:09:46 -07:00
database add option to hide categories from the global unread list 2021-06-12 13:06:30 -07:00
errors Fix typo in license header 2018-10-08 15:50:15 -07:00
fever Fever API: add client IP in middleware logs 2020-08-08 21:51:52 -07:00
http Avoid extra HTTP request for fetching custom stylesheet 2021-05-31 14:29:33 -07:00
integration Send full article content to wallabag 2021-02-21 11:05:29 -08:00
locale add option to hide categories from the global unread list 2021-06-12 13:06:30 -07:00
logger Add option to toggle date/time in log messages 2019-06-08 17:48:45 -07:00
metric Add database stats to Prometheus exporter 2021-05-22 20:31:49 -07:00
model add option to hide categories from the global unread list 2021-06-12 13:06:30 -07:00
oauth2 Refactor user validation 2021-01-03 21:36:35 -08:00
packaging Tweak watchdog 2021-05-22 20:25:38 -07:00
proxy Do not proxy image data url 2020-10-14 22:26:54 -07:00
reader Use runes instead of bytes to truncate JSON feed titles 2021-05-31 11:42:59 -07:00
service Add new config option CLEANUP_ARCHIVE_BATCH_SIZE 2021-05-23 20:52:13 -07:00
storage add option to hide categories from the global unread list 2021-06-12 13:06:30 -07:00
systemd Add Systemd watchdog 2021-05-22 18:46:15 -07:00
template add option to hide categories from the global unread list 2021-06-12 13:06:30 -07:00
tests Setup golangci-lint Github Action 2021-03-22 21:34:48 -07:00
timer Fix typo in license header 2018-10-08 15:50:15 -07:00
timezone Add missing package descriptions for GoDoc 2018-10-08 17:32:17 -07:00
ui add option to hide categories from the global unread list 2021-06-12 13:06:30 -07:00
url Handle invalid feeds with relative URLs 2020-12-02 20:58:18 -08:00
validator Make web app display mode configurable 2021-02-28 13:29:51 -08:00
version Build multi-platform images with Docker Buildx 2020-10-18 15:09:47 -07:00
worker Refactor feed creation to allow setting most fields via API 2021-01-02 16:48:22 -08:00
.gitignore Move Debian package builder to main repo 2020-10-18 21:28:42 -07:00
ChangeLog Update ChangeLog 2021-06-06 10:03:44 -07:00
LICENSE First commit 2017-11-19 22:01:46 -08:00
Makefile Remove completely generated files 2021-02-18 21:50:27 -08:00
Procfile Make latest changes compatible with Heroku 2018-08-29 20:50:36 -07:00
README.md Update contributor link and Godoc badge for client 2020-10-18 21:53:07 -07:00
SECURITY.md Fix typo in SECURITY.md 2021-05-24 15:23:20 -07:00
doc.go Fix typo in license header 2018-10-08 15:50:15 -07:00
go.mod Bump github.com/prometheus/client_golang from 1.10.0 to 1.11.0 2021-06-14 18:40:44 -07:00
go.sum Bump github.com/prometheus/client_golang from 1.10.0 to 1.11.0 2021-06-14 18:40:44 -07:00
main.go Remove completely generated files 2021-02-18 21:50:27 -08:00
miniflux.1 Add new config option CLEANUP_ARCHIVE_BATCH_SIZE 2021-05-23 20:52:13 -07:00

README.md

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