mirror of
https://github.com/funkypenguin/geek-cookbook/
synced 2025-12-13 17:56:26 +00:00
Add miniflux (#16)
This commit is contained in:
67
manuscript/recipies/miniflux.md
Normal file
67
manuscript/recipies/miniflux.md
Normal file
@@ -0,0 +1,67 @@
|
|||||||
|
# Miniflux
|
||||||
|
|
||||||
|
Miniflux is a lightweight RSS reader, developed by [Frédéric Guillot](https://github.com/fguillot). (Who also happens to be the developer of the favorite Open Source Kanban app, [Kanboard](https://kanboard.net/))
|
||||||
|
|
||||||
|
Features (among many) that I appreciate:
|
||||||
|
|
||||||
|
* Compatible with the Fever API, read your feeds through existing mobile and desktop clients (_This is the killer feature for me. I hardly ever read RSS on my desktop, I typically read on my iPhone or iPad, using [Fiery Feeds](http://cocoacake.net/apps/fiery/) or my new squeeze, [Unread](https://www.goldenhillsoftware.com/unread/)_)
|
||||||
|
* Send your bookmarks to Pinboard, Wallabag, Shaarli or Instapaper (_I use this to automatically pin my bookmarks for collection on my [blog](https://www.funkypenguin.co.nz/blog/)_)
|
||||||
|
* Feeds can be configured to download a "full" version of the content (_rather than an excerpt_)
|
||||||
|
* Use the Bookmarklet to subscribe to a website directly from any browsers
|
||||||
|
|
||||||
|
|
||||||
|
## Ingredients
|
||||||
|
|
||||||
|
1. [Docker swarm cluster](/ha-docker-swarm/) with [persistent shared storage](/ha-docker-swarm/shared-storage-ceph.md)
|
||||||
|
2. [Traefik](/ha-docker-swarm/traefik) configured per design
|
||||||
|
|
||||||
|
## Preparation
|
||||||
|
|
||||||
|
### Setup data locations
|
||||||
|
|
||||||
|
Create the location for the bind-mount of the application data, so that it's persistent:
|
||||||
|
|
||||||
|
```
|
||||||
|
mkdir -p /var/data/miniflux
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### Setup Docker Swarm
|
||||||
|
|
||||||
|
Create a docker swarm config file in docker-compose syntax (v3), something like this:
|
||||||
|
|
||||||
|
```
|
||||||
|
version: '3'
|
||||||
|
|
||||||
|
services:
|
||||||
|
miniflux:
|
||||||
|
image: saghul/miniflux
|
||||||
|
volumes:
|
||||||
|
- /etc/localtime:/etc/localtime:ro
|
||||||
|
- /var/data/miniflux/:/config/
|
||||||
|
networks:
|
||||||
|
- traefik
|
||||||
|
deploy:
|
||||||
|
labels:
|
||||||
|
- traefik.frontend.rule=Host:miniflux.example.com
|
||||||
|
- traefik.docker.network=traefik
|
||||||
|
- traefik.port=80
|
||||||
|
|
||||||
|
networks:
|
||||||
|
traefik:
|
||||||
|
external: true
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## Serving
|
||||||
|
|
||||||
|
### Launch Miniflux stack
|
||||||
|
|
||||||
|
Launch the Huginn stack by running ```docker stack deploy miniflux -c <path -to-docker-compose.yml>```
|
||||||
|
|
||||||
|
Log into your new instance at https://**YOUR-FQDN**. Default credentials are admin/admin, after which you can change (under 'profile') and add more users.
|
||||||
|
|
||||||
|
## Chef's Notes
|
||||||
|
|
||||||
|
1. I chose [saghul/miniflux](https://hub.docker.com/r/saghul/miniflux/)'s over the "official" [miniflux/miniflux](https://hub.docker.com/r/miniflux/miniflux/) image, because currently the official image doesn't log to stdout (which you want, for docker logging commands), and because I have an expectation that nginx is more lightweight (faster) than apache.
|
||||||
|
2. Find the bookmarklet under the "about" page. I know, it took me ages too.
|
||||||
12
mkdocs.yml
12
mkdocs.yml
@@ -33,14 +33,16 @@ pages:
|
|||||||
- Keepalived: ha-docker-swarm/keepalived.md
|
- Keepalived: ha-docker-swarm/keepalived.md
|
||||||
- Traefik: ha-docker-swarm/traefik.md
|
- Traefik: ha-docker-swarm/traefik.md
|
||||||
- Docker Swarm Mode: ha-docker-swarm/docker-swarm-mode.md
|
- Docker Swarm Mode: ha-docker-swarm/docker-swarm-mode.md
|
||||||
- Recommended:
|
- Mail Server: recipies/mail.md
|
||||||
- Mail Server: recipies/mail.md
|
- Chef's Favorites:
|
||||||
|
- Wekan: recipies/wekan.md
|
||||||
|
- Huginn: recipies/huginn.md
|
||||||
|
- Miniflux: recipies/miniflux.md
|
||||||
|
- Menu:
|
||||||
|
- Tiny Tiny RSS: recipies/tiny-tiny-rss.md
|
||||||
- GitLab: recipies/gitlab.md
|
- GitLab: recipies/gitlab.md
|
||||||
- GitLab Runner: recipies/gitlab-runner.md
|
- GitLab Runner: recipies/gitlab-runner.md
|
||||||
- Wekan: recipies/wekan.md
|
|
||||||
- Piwik: recipies/piwik.md
|
- Piwik: recipies/piwik.md
|
||||||
- Tiny Tiny RSS: recipies/tiny-tiny-rss.md
|
|
||||||
- Huginn: recipies/huginn.md
|
|
||||||
- Reference:
|
- Reference:
|
||||||
- OAuth Proxy: reference/oauth_proxy.md
|
- OAuth Proxy: reference/oauth_proxy.md
|
||||||
- Networks: reference/networks.md
|
- Networks: reference/networks.md
|
||||||
|
|||||||
Reference in New Issue
Block a user