MasterpieceDockerCompose/miniflux/README.md

# Miniflux in docker

<div align="center">
  <img src="https://miniflux.app/images/overview.png" />
</div>

# Descrizione

* [Sito ufficiale](https://miniflux.app/)
* [Repo (Github)](https://github.com/miniflux/v2)
* [Documentazione](https://miniflux.app/docs/index.html)

Miniflux è un lettore di feed minimalista:

- Scritto in Go (Golang)
- Funziona solo con Postgresql
- Non usa alcun ORM
- Utilizzo di Javascript moderno (ES6 e API Fetch)
- Binario singolo compilato staticamente senza dipendenze
- Il numero di caratteristiche è volontariamente limitato

# Struttura file e cartelle

```
/home/
└── ~/
    └── docker/
        └── miniflux/
            ├── db/
            ├── .env
            └── docker-compose.yml
```

* `db/` - cartella dove i dati del database vengono salvati
* `.env` - file contenenti le variabili environment per il docker compose
* `docker-compose.yml` - file usato per creare il container

Tutti i file e le cartelle devono essere creati a mano.</br>

# docker-compose

`docker-compose.yml`
```yml
version: "3.8"
services:
  db:
    container_name: miniflux-db
    image: postgres:13-alpine
    restart: always
    env_file: .env
    volumes:
      - ${POSTGRES_DATA:-/home/docker/miniflux/db}:/var/lib/postgresql/data
      - /etc/localtime:/etc/localtime:ro
    healthcheck:
      test: ["CMD", "pg_isready", "-U", "miniflux"]
      interval: 1m30s
      timeout: 10s
      retries: 3
      start_period: 10s

  feeder:
    container_name: miniflux
    image: ghcr.io/miniflux/miniflux
    restart: unless-stopped
    depends_on:
      - db
    ports:
      - ${MINIFLUX_WEBUI_PORT:-8080}:8080
    env_file: .env
    healthcheck:
      test: ["CMD", "/usr/bin/miniflux", "-healthcheck", "auto"]
```

`.env`
```bash
# Generale
POSTGRES_DATA=/home/docker/miniflux/db
MINIFLUX_WEBUI_PORT=8080

# Postgres
POSTGRES_USER=miniflux
POSTGRES_PASSWORD=secret

# Miniflux
DATABASE_URL=postgres://miniflux:secret@db/miniflux?sslmode=disable
RUN_MIGRATIONS=1
CREATE_ADMIN=1
ADMIN_USERNAME=admin
ADMIN_PASSWORD=password
```

# Reverse proxy

Ancora non ho previsto l'uso di un reverse proxy. (Vedi [Todo](#Todo))

# Aggiornamenti

[Watchtower](https://gitea.it/miracle091/MasterpieceDockerCompose/src/branch/master/watchtower) aggiorna l'immagine automaticamente.

Aggiornamento manuale:

- `docker-compose pull`</br>
- `docker-compose up -d`</br>
- `docker image prune`

# Backup e ripristino

#### Backup

Copiare a mano, tramite crontab o altro la cartella `miniflux` (Vedi [Todo](#Todo))

#### Ripristino

* spegnere il container `docker-compose down`</br>
* cancellare l'intera cartella `miniflux`</br>
* dal backup copiare la cartella `miniflux`</br>
* far partire il container `docker-compose up -d`

# Todo

Implementare:
- reverse proxy: **[caddy](https://caddyserver.com/) o [traefik](https://doc.traefik.io/traefik/).**
- backup: **[borg](https://github.com/DoTheEvo/selfhosted-apps-docker/tree/master/borg_backup) per fare i backup giornalieri completi.**