README
¶
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)
- The number of features is voluntarily limited
It's simple, fast, lightweight and super easy to install.
Miniflux 2 is a rewrite of Miniflux 1.x in Golang.
Documentation
The Miniflux documentation is available here: https://docs.miniflux.net/
- Opinionated?
- Features
- Requirements
- Installation Instructions
- Installation Tutorials
- Upgrading to a new version
- Configuration
Credits
- Author: Frédéric Guillot
- Distributed under Apache 2.0 License
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package api implements API endpoints for Miniflux application.
|
Package api implements API endpoints for Miniflux application. |
|
Package cli implements command line arguments for Miniflux application.
|
Package cli implements command line arguments for Miniflux application. |
|
Package config handles configuration values for Miniflux application.
|
Package config handles configuration values for Miniflux application. |
|
Package crypto implements helpers related to cryptography.
|
Package crypto implements helpers related to cryptography. |
|
Package daemon handles the main application process.
|
Package daemon handles the main application process. |
|
Package errors handles localized errors.
|
Package errors handles localized errors. |
|
Package fever implements Fever API endpoints.
|
Package fever implements Fever API endpoints. |
|
Package filter implements a content filter to rewrite image links.
|
Package filter implements a content filter to rewrite image links. |
|
http
|
|
|
Package integration implements API clients for third-party services.
|
Package integration implements API clients for third-party services. |
|
Package locale handles the internationalization of the application.
|
Package locale handles the internationalization of the application. |
|
Package logger handles application log messages with different levels.
|
Package logger handles application log messages with different levels. |
|
Package model contains all data structures used by the application.
|
Package model contains all data structures used by the application. |
|
Package oauth2 abstracts different OAuth2 providers.
|
Package oauth2 abstracts different OAuth2 providers. |
|
Package reader implements everything related to feed parsing.
|
Package reader implements everything related to feed parsing. |
|
encoding
Package encoding handles workarounds to deal with encoding edge cases found into the wild.
|
Package encoding handles workarounds to deal with encoding edge cases found into the wild. |
|
Package scheduler implements the application internal scheduler.
|
Package scheduler implements the application internal scheduler. |
|
Package sql contains all SQL queries or database schema instructions.
|
Package sql contains all SQL queries or database schema instructions. |
|
Package storage implements a set of functions to interact with the database.
|
Package storage implements a set of functions to interact with the database. |
|
Package template handles template parsing and execution.
|
Package template handles template parsing and execution. |
|
Package timer implements utility functions to measure the execution time of a block of code.
|
Package timer implements utility functions to measure the execution time of a block of code. |
|
Package ui implements handlers to render to user interface.
|
Package ui implements handlers to render to user interface. |
|
Package url implements a set of utility functions to parse URL.
|
Package url implements a set of utility functions to parse URL. |
|
Package version contains application and build information.
|
Package version contains application and build information. |
Click to show internal directories.
Click to hide internal directories.