138 lines
4.0 KiB
Markdown
138 lines
4.0 KiB
Markdown
# Miniflux
|
|
<div align="center">
|
|
<img src="https://miniflux.app/images/overview.png" />
|
|
</div>
|
|
|
|
## Descrizione
|
|
[![Sito ufficiale](https://img.shields.io/static/v1.svg?color=555555&logoColor=ffffff&logo=firefoxbrowser&style=flat&label=&message=Homepage)](https://miniflux.app/) [![Sorgente](https://img.shields.io/static/v1.svg?color=555555&logoColor=ffffff&logo=github&style=flat&label=&message=Sorgente)](https://github.com/miniflux/v2) [![Docker Hub](https://img.shields.io/static/v1.svg?color=555555&logoColor=ffffff&logo=docker&style=flat&label=&message=Docker Hub)](https://hub.docker.com/r/miniflux/miniflux) [![Docs](https://img.shields.io/static/v1.svg?color=555555&logoColor=ffffff&logo=readthedocs&style=flat&label=&message=Docs)](https://miniflux.app/docs/)
|
|
|
|
Miniflux è un lettore web di feed dal design minimalista e privacy-friendly:
|
|
- Interfaccia web multilingua e compatibile anche con tablet/smartphone
|
|
- Scorciatoie da trastiera
|
|
- Rimozione automatica dei traccianti (se presenti)
|
|
- Compatibile con le [API](https://miniflux.app/docs/services.html) più comuni e usate
|
|
|
|
## 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
|
|
|
|
**N.B. Tutti i file e le cartelle devono essere creati a mano.**
|
|
|
|
### network
|
|
`docker`
|
|
```bash
|
|
docker network create custom-bridge
|
|
```
|
|
|
|
`podman`
|
|
```bash
|
|
podman network create custom-bridge
|
|
```
|
|
|
|
## Esempi
|
|
Semplice esempio per iniziare ad usare subito il container
|
|
|
|
### docker-compose
|
|
`docker-compose.yml`
|
|
```yml
|
|
version: "3.8"
|
|
services:
|
|
db:
|
|
container_name: miniflux-db
|
|
image: postgres:13-alpine
|
|
security_opt:
|
|
- no-new-privileges:true
|
|
networks:
|
|
- custom-bridge
|
|
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
|
|
security_opt:
|
|
- no-new-privileges:true
|
|
networks:
|
|
- custom-bridge
|
|
restart: unless-stopped
|
|
depends_on:
|
|
- db
|
|
ports:
|
|
- ${MINIFLUX_WEBUI_PORT:-8080}:8080
|
|
env_file: .env
|
|
healthcheck:
|
|
test: ["CMD", "/usr/bin/miniflux", "-healthcheck", "auto"]
|
|
|
|
networks:
|
|
custom-bridge:
|
|
name: custom-bridge
|
|
driver: bridge
|
|
```
|
|
|
|
`.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
|
|
Vedi [Todo](#Todo)
|
|
|
|
## Aggiornamento
|
|
### Automatico
|
|
Usando [watchtower](../watchtower) il container si aggiorna automaticamente
|
|
|
|
### Manuale
|
|
1. `docker-compose pull`
|
|
2. `docker-compose up -d`
|
|
3. `docker image prune`
|
|
|
|
## Backup e ripristino
|
|
### Backup
|
|
Usate [borg](../borg) per fare i backup giornalieri dell'intera cartella `miniflux`
|
|
|
|
### Ripristino
|
|
Per una maggiore spiegazione sui passaggi da fare, controllate [qua](../borg#user-content-controllare-la-cartella-dei-backup)
|
|
1. fermare il container `docker-compose down`
|
|
2. cancellare l'intera cartella `miniflux`
|
|
3. dal backup copiare la cartella `miniflux`
|
|
4. far ripartire il container `docker-compose up -d`
|
|
|
|
## Todo
|
|
Implementare:
|
|
- reverse proxy: **[caddy](https://caddyserver.com/)** o **[traefik](https://doc.traefik.io/traefik/)**
|
|
|
|
---
|
|
|
|
Licenza: [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/legalcode.txt) |