From cef709e13285a02030ff05f930ef96e951a37f26 Mon Sep 17 00:00:00 2001 From: miracle091 Date: Tue, 25 May 2021 11:36:01 +0200 Subject: [PATCH] Rework dei readme --- README.md | 2 +- borg_backup/README.md | 71 +++++++++++++++------------------------ folding@home/README.md | 68 ++++++++++++++++--------------------- gitea/README.md | 72 +++++++++++++++++---------------------- jellyfin/README.md | 66 ++++++++++++++++-------------------- komga/README.md | 71 +++++++++++++++++---------------------- metube/README.md | 66 ++++++++++++++++-------------------- miniflux/README.md | 76 ++++++++++++++++++------------------------ navidrome/README.md | 75 ++++++++++++++++++----------------------- syncthing/README.md | 67 ++++++++++++++++--------------------- unifi/README.md | 76 ++++++++++++++++++------------------------ watchtower/.env | 2 +- watchtower/README.md | 43 +++++++++++------------- 13 files changed, 322 insertions(+), 433 deletions(-) diff --git a/README.md b/README.md index b2c1ae1..e5a8ae1 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ * **Struttura file e cartelle** * **docker-compose** * **Reverse proxy** -* **Aggiornamenti** +* **Aggiornamento** * **Backup e ripristino** * **Todo** diff --git a/borg_backup/README.md b/borg_backup/README.md index 3e6e10a..f9e368f 100644 --- a/borg_backup/README.md +++ b/borg_backup/README.md @@ -1,17 +1,12 @@ -# BorgBackup in docker - +# BorgBackup
-# Utilizzo - -* [Sito ufficiale](https://www.borgbackup.org/) -* [Repo (Github)](https://github.com/borgbackup/borg) -* [Demo (Video)](https://asciinema.org/a/133292) +## Utilizzo +[Sito ufficiale](https://www.borgbackup.org/) - [Repo (Github)](https://github.com/borgbackup/borg) - [Demo (Video)](https://asciinema.org/a/133292) BorgBackup è un software per effettuare backup da terminale ([e non solo](https://github.com/borgbackup/community#graphical-front-ends)): - - [Deduplicazione](https://en.wikipedia.org/wiki/Data_deduplication) dei file invece del classico *"copia/incolla"* - Possibilità di crittografia (AES 256-bit) e verifica dei dati (HMAC-SHA256) - Possibilità di offuscare i dati, in modo da rendere i backup più *"sicuri"* @@ -19,8 +14,7 @@ BorgBackup è un software per effettuare backup da terminale ([e non solo](https - Possibilità di personalizzare il numero di backup da mantenere (giornalieri, settimanali, mensili, annuali) - Ottimo supporto della [comnunità](https://github.com/borgbackup/community) -# Struttura file e cartelle - +## Struttura file e cartelle ``` /home/ ├── borg/ @@ -38,23 +32,19 @@ BorgBackup è un software per effettuare backup da terminale ([e non solo](https * `borg_backup.sh` - bash script per effettuare i backup * `borg_backup.log` - file di log con le date dei backup -Tutti i file e le cartelle devono essere forniti a mano.
+**N.B. Tutti i file e le cartelle devono essere creati a mano.** -# Setup +## Setup +### Installare BorgBackup +Normalmente si trova già in molti [package manager](https://borgbackup.readthedocs.io/en/latest/installation.html#distribution-package) delle distro linux/unix più usate. -#### Installare BorgBackup - -- Normalmente si trova già in molti [package manager](https://borgbackup.readthedocs.io/en/latest/installation.html#distribution-package) delle distro linux/unix più usate. - -#### Creare e inizializzare una nuova cartella per i backup - -- `mkdir /home/borg`
-- `borg init --encryption=none /home/borg/docker_backup` +### Creare e inizializzare una nuova cartella per i backup +1. `mkdir /home/borg`
+2. `borg init --encryption=none /home/borg/docker_backup` Notare l'assenza dell'uso del comando `sudo`. In caso di problemi con i permessi di scrittura/lettura usatelo. -#### Bash script - +### Bash script Lo script deve avere la flag **executable (eseguibile)**, nel caso lanciate il comando `chmod +x borg_backup.sh` tanto è indolore. `borg_backup.sh` @@ -99,35 +89,28 @@ echo '------------------------------' >> $LOGFILE ``` ### Avvio manuale +1. lanciate il seguente comando `sh ./borg_backup.sh` +2. alla domanda: `Attempting to access a previously unknown unencrypted repository` +3. rispondete con `yes` -`sh ./borg_backup.sh` - -Vi verrà posta la seguente domanda: *Attempting to access a previously unknown unencrypted repository*, rispondete con *yes*.
- -### Avvio automaticato - -Il metodo migliore è usare [cron](https://en.wikipedia.org/wiki/Cron). +### Avvio automatizzato +Il metodo migliore è usare [cron](https://en.wikipedia.org/wiki/Cron), che sicuramente è già pre-installato nella vostra distro linux. Create un cronjob che faccia partire lo script [alle 03:00 di notte](https://crontab.guru/#0_03_*_*_*): - -* lanciare il comando `crontab -e` -* poi scrivere quanto segue `0 3 * * * /home/borg/borg_backup.sh`
+1. lanciate il seguente comando `crontab -e` +2. poi scrivere quanto segue `0 3 * * * /home/borg/borg_backup.sh` Comandi utili: - * `systemctl status cron` - controlla se il servizio è attivo e/o installato * `crontab -l` - lista degli attuali cronjob * `journalctl -u cron` - cronologia di cron -# Controllare la cartella dei backup +## Controllare la cartella dei backup +1. entrare nella cartella dei backup `cd /home/borg/docker_backup/` +2. scrivere `borg list .` per ottenere la lista dei backup effettuati +3. scegliere il backup che vi interessa usando una [data epoch](https://en.wikipedia.org/wiki/Unix_time), esempio 1588986941 +4. montare il backup su una cartella temporanea `borg mount .::1588986941 /mnt/temp` +5. controllare il contenuto della cartella e fate quello necessario +6. smontare la cartella temporanea del backup `borg umount /mnt/temp` -* entrare nella cartella dei backup `cd /home/borg/docker_backup/` -* scrivere `borg list .` per ottenere la lista dei backup effettuati -* scegliere il backup che vi interessa usando una [data epoch](https://en.wikipedia.org/wiki/Unix_time), esempio 1588986941 -* montare il backup su una cartella temporanea `borg mount .::1588986941 /mnt/temp` -* controllare il contenuto della cartella e fate quello necessario -* smontare la cartella temporanea del backup `borg umount /mnt/temp` - -# Extra - -Testare i backup effettuati insieme alla vostra procedura di ripristino. \ No newline at end of file +**N.B. Di tanto in tanto, controllare i backup effettuati per evitare brutte sorprese!!!** diff --git a/folding@home/README.md b/folding@home/README.md index 887e685..3db0a70 100644 --- a/folding@home/README.md +++ b/folding@home/README.md @@ -1,26 +1,19 @@ -# Folding@Home in docker - +# Folding@Home
-# Descrizione - -* [Sito ufficiale](https://foldingathome.org/) -* [Repo (Github)](https://github.com/linuxserver/docker-foldingathome) -* [Documentazione](https://docs.linuxserver.io/images/docker-foldingathome) +## Descrizione +[Sito ufficiale](https://foldingathome.org/) - [Repo (Github)](https://github.com/linuxserver/docker-foldingathome) - [Docs](https://docs.linuxserver.io/images/docker-foldingathome) Folding@Home è un progetto di calcolo distribuito per aiutare la ricerca medica: - - Simulazione del comportamento delle proteine (e non solo) relative a malattie degenerative, infettive e altro -- Possibilità di selezionare, tramite l'interfaccia web, il tipo di ricerca da aiutare +- Possibilità di selezionare il tipo di ricerca da aiutare - Possibilità di usare sia la CPU che la GPU -- Aiutare gli scienziati (di tutto il mondo) in modo indiretto > **P.S è un progetto a cui tengo particolarmente, quindi anche se avete un computer vecchio che non usate, questo è il progetto perfetto per renderlo di nuovo utile a tutti.** -# Struttura file e cartelle - +## Struttura file e cartelle ``` /home/ └── docker/ @@ -34,10 +27,12 @@ Folding@Home è un progetto di calcolo distribuito per aiutare la ricerca medica * `.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.
+**N.B. Tutti i file e le cartelle devono essere creati a mano.** -# docker-compose +## Esempi +Semplice esempio per iniziare ad usare subito il container +### docker-compose `docker-compose.yml` ```yml version: "3.4" @@ -69,34 +64,29 @@ FAH_DATA=/home/docker/fah/data TZ=Europe/Amsterdam ``` -# Reverse proxy +## Reverse proxy +Ancora non ho previsto l'uso di un reverse proxy (Vedi [Todo](#Todo)) -Ancora non ho previsto l'uso di un reverse proxy. (Vedi [Todo](#Todo)) +## Aggiornamento +### Automatico +Usando [watchtower](../watchtower) il container si aggiorna automaticamente -# Aggiornamenti +### Manuale +1. `docker-compose pull` +2. `docker-compose up -d` +3. `docker image prune` -[Watchtower](../watchtower) aggiorna l'immagine automaticamente. +## Backup e ripristino +### Backup +Usate [borg](../borg_backup) per fare i backup giornalieri dell'intera cartella `folding@home` -Aggiornamento manuale: - -- `docker-compose pull` -- `docker-compose up -d` -- `docker image prune` - -# Backup e ripristino - -#### Backup - -Usare [borg](../borg_backup) per fare i backup giornalieri dell'intera cartella `folding@home`. - -#### Ripristino - -* spegnere il container `docker-compose down` -* cancellare l'intera cartella `folding@home` -* dal backup copiare la cartella `folding@home` -* far ripartire il container `docker-compose up -d` - -# Todo +### Ripristino +Per una maggiore spiegazione sui passaggi da fare, controllate [qua](../borg_backup#user-content-controllare-la-cartella-dei-backup) +1. fermare il container `docker-compose down` +2. cancellare l'intera cartella `folding@home` +3. dal backup copiare la cartella `folding@home` +4. far ripartire il container `docker-compose up -d` +## Todo Implementare: -- reverse proxy: **[caddy](https://caddyserver.com/) o [traefik](https://doc.traefik.io/traefik/).** +- reverse proxy: **[caddy](https://caddyserver.com/)** o **[traefik](https://doc.traefik.io/traefik/)** diff --git a/gitea/README.md b/gitea/README.md index ff4bf83..b895de7 100644 --- a/gitea/README.md +++ b/gitea/README.md @@ -1,24 +1,17 @@ -# Gitea in docker - +# Gitea
-# Descrizione +## Descrizione +[Sito ufficiale](https://gitea.io/) - [Repo (Github)](https://github.com/go-gitea/gitea) - [Demo](https://try.gitea.io/) - [Docs](https://docs.gitea.io/) -* [Sito ufficiale](https://gitea.io/) -* [Repo (Github)](https://github.com/go-gitea/gitea) -* [Demo](https://try.gitea.io/) -* [Documentazione](https://docs.gitea.io/) - -Gitea è un simil-github veloce, semplice e facile da configurare: - -- Scritto in Go (Golang) -- Il progetto che si avvicina maggiormente a GitHub (esteticamente) +Gitea è un repository per git veloce, semplice e facile da configurare: +- Il progetto che si avvicina maggiormente a GitHub (esteticamente) ma rimanendo open source - Supporta i maggiori database (SQLite, MySQL/MariaDB e PostgreSQL) +- Interfaccia web multilingua -# Struttura file e cartelle - +## Struttura file e cartelle ``` /home/ └── docker/ @@ -34,10 +27,12 @@ Gitea è un simil-github veloce, semplice e facile da configurare: * `.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.
+**N.B. Tutti i file e le cartelle devono essere creati a mano.** -# docker-compose +## Esempi +Semplice esempio per iniziare ad usare subito il container +### docker-compose `docker-compose.yml` ```yml version: "3.8" @@ -100,34 +95,29 @@ GITEA__database__USER=gitea GITEA__database__PASSWD=gitea ``` -# Reverse proxy +## Reverse proxy +Ancora non ho previsto l'uso di un reverse proxy (Vedi [Todo](#Todo)) -Ancora non ho previsto l'uso di un reverse proxy. (Vedi [Todo](#Todo)) +## Aggiornamento +### Automatico +Usando [watchtower](../watchtower) il container si aggiorna automaticamente -# Aggiornamenti +### Manuale +1. `docker-compose pull` +2. `docker-compose up -d` +3. `docker image prune` -[Watchtower](../watchtower) aggiorna l'immagine automaticamente. +## Backup e ripristino +### Backup +Usate [borg](../borg_backup) per fare i backup giornalieri dell'intera cartella `gitea` -Aggiornamento manuale: - -- `docker-compose pull` -- `docker-compose up -d` -- `docker image prune` - -# Backup e ripristino - -#### Backup - -Usare [borg](../borg_backup) per fare i backup giornalieri dell'intera cartella ``. - -#### Ripristino - -* spegnere il container `docker-compose down` -* cancellare l'intera cartella `gitea` -* dal backup copiare la cartella `gitea` -* far ripartire il container `docker-compose up -d` - -# Todo +### Ripristino +Per una maggiore spiegazione sui passaggi da fare, controllate [qua](../borg_backup#user-content-controllare-la-cartella-dei-backup) +1. fermare il container `docker-compose down` +2. cancellare l'intera cartella `gitea` +3. dal backup copiare la cartella `gitea` +4. far ripartire il container `docker-compose up -d` +## Todo Implementare: -- reverse proxy: **[caddy](https://caddyserver.com/) o [traefik](https://doc.traefik.io/traefik/).** +- reverse proxy: **[caddy](https://caddyserver.com/)** o **[traefik](https://doc.traefik.io/traefik/)** diff --git a/jellyfin/README.md b/jellyfin/README.md index 525049a..174485c 100644 --- a/jellyfin/README.md +++ b/jellyfin/README.md @@ -1,18 +1,12 @@ -# Jellyfin in docker - +# Jellyfin
-# Descrizione - -* [Sito ufficiale](https://jellyfin.org/) -* [Repo (Github)](https://github.com/linuxserver/docker-jellyfin) -* [Demo](https://demo.jellyfin.org/) Login: ```demo``` Password: ```lasciare vuoto``` -* [Documentazione](https://docs.linuxserver.io/images/docker-jellyfin) +## Descrizione +[Sito ufficiale](https://jellyfin.org/) - [Repo (Github)](https://github.com/linuxserver/docker-jellyfin) - [Demo](https://demo.jellyfin.org/) Login: ```demo``` Password: ```lasciare vuoto``` - [Docs](https://docs.linuxserver.io/images/docker-jellyfin) Jellyfin è un server per la gestione di film, serie tv e musica: - - Interfaccia web personalizzabile tramite [CSS](https://libredd.it/r/jellyfin/?f=flair_name%3A%22Custom%20CSS%22) - Possibilità di organizzare i vostri file in collezioni - Possibilità di modificare e importare i metadati locali, integrati e tramite servizi esterni (IMDb, OMDb, TvDB, etc) @@ -20,8 +14,7 @@ Jellyfin è un server per la gestione di film, serie tv e musica: - [Client ufficiali (e non) multi-piattaforma](https://jellyfin.org/docs/general/clients/index.html) - [Transcodifica hardware](https://jellyfin.org/docs/general/administration/hardware-acceleration.html) -# Struttura file e cartelle - +## Struttura file e cartelle ``` /home/ └── docker/ @@ -36,10 +29,12 @@ Jellyfin è un server per la gestione di film, serie tv e musica: * `.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.
+**N.B. Tutti i file e le cartelle devono essere creati a mano.** -# docker-compose +## Esempi +Semplice esempio per iniziare ad usare subito il container +### docker-compose `docker-compose.yml` ```yml version: "3" @@ -82,34 +77,29 @@ TZ=Europe/Amsterdam #DOCKER_MODS=linuxserver/mods:jellyfin-opencl-intel # necessario per usare OpenCL-Intel ``` -# Reverse proxy +## Reverse proxy +Ancora non ho previsto l'uso di un reverse proxy (Vedi [Todo](#Todo)) -Ancora non ho previsto l'uso di un reverse proxy. (Vedi [Todo](#Todo)) +## Aggiornamento +### Automatico +Usando [watchtower](../watchtower) il container si aggiorna automaticamente -# Aggiornamenti +### Manuale +1. `docker-compose pull` +2. `docker-compose up -d` +3. `docker image prune` -[Watchtower](../watchtower) aggiorna l'immagine automaticamente. +## Backup e ripristino +### Backup +Usate [borg](../borg_backup) per fare i backup giornalieri dell'intera cartella `jellyfin` -Aggiornamento manuale: - -- `docker-compose pull` -- `docker-compose up -d` -- `docker image prune` - -# Backup e ripristino - -#### Backup - -Usare [borg](../borg_backup) per fare i backup giornalieri dell'intera cartella `jellyfin`. - -#### Ripristino - -* spegnere il container `docker-compose down` -* cancellare l'intera cartella `jellyfin` -* dal backup copiare la cartella `jellyfin` -* far ripartire il container `docker-compose up -d` - -# Todo +### Ripristino +Per una maggiore spiegazione sui passaggi da fare, controllate [qua](../borg_backup#user-content-controllare-la-cartella-dei-backup) +1. fermare il container `docker-compose down` +2. cancellare l'intera cartella `jellyfin` +3. dal backup copiare la cartella `jellyfin` +4. far ripartire il container `docker-compose up -d` +## Todo Implementare: -- reverse proxy: **[caddy](https://caddyserver.com/) o [traefik](https://doc.traefik.io/traefik/).** +- reverse proxy: **[caddy](https://caddyserver.com/)** o **[traefik](https://doc.traefik.io/traefik/)** diff --git a/komga/README.md b/komga/README.md index 2611772..018ae14 100644 --- a/komga/README.md +++ b/komga/README.md @@ -1,27 +1,19 @@ -# Komga in docker - +# Komga
-# Descrizione - -* [Sito ufficiale](https://komga.org/) -* [Repo (Github)](https://github.com/gotson/komga) -* [Demo](https://demo.komga.org/) Login: ```demo@komga.org``` Password: ```komga-demo``` -* [Documentazione](https://komga.org/guides/) +## Descrizione +[Sito ufficiale](https://komga.org/) - [Repo (Github)](https://github.com/gotson/komga) - [Demo](https://demo.komga.org/) Login: ```demo@komga.org``` Password: ```komga-demo``` - [Docs](https://komga.org/guides/) Komga è un server per la gestione di manga/comics: - -- Interfaccia web moderna e compatibile con tablet e smartphone -- Possibilità di organizzare i vostri file in collezioni +- Interfaccia web moderna, semplice e leggera +- Possibilità di organizzare i vostri comics in collezioni - Possibilità di modificare e importare i metadati locali (e integrati) - Multiutente, con possiblità di gestire l'accesso alle librerie (anche singolarmente) - Supporto ai maggiori tipi di formati (CBZ, CBR, PDF e EPUB) -- Possibilità di interazione esterna tramite REST API - -# Struttura file e cartelle +## Struttura file e cartelle ``` /home/ └── docker/ @@ -37,10 +29,12 @@ Komga è un server per la gestione di manga/comics: * `.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.
+**N.B. Tutti i file e le cartelle devono essere creati a mano.** -# docker-compose +## Esempi +Semplice esempio per iniziare ad usare subito il container +### docker-compose `docker-compose.yml` ```yml version: "3" @@ -68,34 +62,29 @@ KOMGA_DATA=/data ND_LOGLEVEL=info ``` -# Reverse proxy +## Reverse proxy +Ancora non ho previsto l'uso di un reverse proxy (Vedi [Todo](#Todo)) -Ancora non ho previsto l'uso di un reverse proxy. (Vedi [Todo](#Todo)) +## Aggiornamento +### Automatico +Usando [watchtower](../watchtower) il container si aggiorna automaticamente -# Aggiornamenti +### Manuale +1. `docker-compose pull` +2. `docker-compose up -d` +3. `docker image prune` -[Watchtower](../watchtower) aggiorna l'immagine automaticamente. +## Backup e ripristino +### Backup +Usate [borg](../borg_backup) per fare i backup giornalieri dell'intera cartella `komga` -Aggiornamento manuale: - -- `docker-compose pull` -- `docker-compose up -d` -- `docker image prune` - -# Backup e ripristino - -#### Backup - -Usare [borg](../borg_backup) per fare i backup giornalieri dell'intera cartella `komga`. - -#### Ripristino - -* spegnere il container `docker-compose down` -* cancellare l'intera cartella `komga` -* dal backup copiare la cartella `komga` -* far ripartire il container `docker-compose up -d` - -# Todo +### Ripristino +Per una maggiore spiegazione sui passaggi da fare, controllate [qua](../borg_backup#user-content-controllare-la-cartella-dei-backup) +1. fermare il container `docker-compose down` +2. cancellare l'intera cartella `komga` +3. dal backup copiare la cartella `komga` +4. far ripartire il container `docker-compose up -d` +## Todo Implementare: -- reverse proxy: **[caddy](https://caddyserver.com/) o [traefik](https://doc.traefik.io/traefik/).** +- reverse proxy: **[caddy](https://caddyserver.com/)** o **[traefik](https://doc.traefik.io/traefik/)** diff --git a/metube/README.md b/metube/README.md index 113c22c..85f22a8 100644 --- a/metube/README.md +++ b/metube/README.md @@ -1,21 +1,16 @@ -# MeTube in docker - +# MeTube
-# Descrizione - +## Descrizione * [Repo (Github)](https://github.com/alexta69/metube) -MeTube è una semplice interfaccia per youtube-dl: - +MeTube è youtube-dl con un'interfaccia web: - Interfaccia web moderna, semplice e leggera -- youtube-dl è integrato -- Supporta le playlist - -# Struttura file e cartelle +- Supporta le playlist intere +## Struttura file e cartelle ``` /home/ └── docker/ @@ -29,10 +24,12 @@ MeTube è una semplice interfaccia per youtube-dl: * `.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.
+**N.B. Tutti i file e le cartelle devono essere creati a mano.** -# docker-compose +## Esempi +Semplice esempio per iniziare ad usare subito il container +### docker-compose `docker-compose.yml` ```yml version: "3" @@ -55,34 +52,29 @@ METUBE_WEBUI_PORT=8081 METUBE_DOWNLOADS=/home/docker/metube/downloads ``` -# Reverse proxy +## Reverse proxy +Ancora non ho previsto l'uso di un reverse proxy (Vedi [Todo](#Todo)) -Ancora non ho previsto l'uso di un reverse proxy. (Vedi [Todo](#Todo)) +## Aggiornamento +### Automatico +Usando [watchtower](../watchtower) il container si aggiorna automaticamente -# Aggiornamenti +### Manuale +1. `docker-compose pull` +2. `docker-compose up -d` +3. `docker image prune` -[Watchtower](../watchtower) aggiorna l'immagine automaticamente. +## Backup e ripristino +### Backup +Usate [borg](../borg_backup) per fare i backup giornalieri dell'intera cartella `metube` -Aggiornamento manuale: - -- `docker-compose pull` -- `docker-compose up -d` -- `docker image prune` - -# Backup e ripristino - -#### Backup - -Usare [borg](../borg_backup) per fare i backup giornalieri dell'intera cartella `metube`. - -#### Ripristino - -* spegnere il container `docker-compose down` -* cancellare l'intera cartella `metube` -* dal backup copiare la cartella `metube` -* far ripartire il container `docker-compose up -d` - -# Todo +### Ripristino +Per una maggiore spiegazione sui passaggi da fare, controllate [qua](../borg_backup#user-content-controllare-la-cartella-dei-backup) +1. fermare il container `docker-compose down` +2. cancellare l'intera cartella `metube` +3. dal backup copiare la cartella `metube` +4. far ripartire il container `docker-compose up -d` +## Todo Implementare: -- reverse proxy: **[caddy](https://caddyserver.com/) o [traefik](https://doc.traefik.io/traefik/).** +- reverse proxy: **[caddy](https://caddyserver.com/)** o **[traefik](https://doc.traefik.io/traefik/)** diff --git a/miniflux/README.md b/miniflux/README.md index 96756e9..77636f5 100644 --- a/miniflux/README.md +++ b/miniflux/README.md @@ -1,26 +1,17 @@ -# Miniflux in docker - +# Miniflux
-# Descrizione +## Descrizione +* [Sito ufficiale](https://miniflux.app/) - [Repo (Github)](https://github.com/miniflux/v2) - [Documentazione](https://miniflux.app/docs/index.html) -* [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 +Miniflux è un lettore di feed dal design minimalista e privacy-friendly: +- Interfaccia web multilingua e compatibile anche con tablet/smartphone +- Scorciatoie da trastiera +- Rimozione automatica dei traccianti +## Struttura file e cartelle ``` /home/ └── docker/ @@ -34,10 +25,12 @@ Miniflux è un lettore di feed minimalista: * `.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.
+**N.B. Tutti i file e le cartelle devono essere creati a mano.** -# docker-compose +## Esempi +Semplice esempio per iniziare ad usare subito il container +### docker-compose `docker-compose.yml` ```yml version: "3.8" @@ -88,34 +81,29 @@ ADMIN_USERNAME=admin ADMIN_PASSWORD=password ``` -# Reverse proxy +## Reverse proxy +Ancora non ho previsto l'uso di un reverse proxy (Vedi [Todo](#Todo)) -Ancora non ho previsto l'uso di un reverse proxy. (Vedi [Todo](#Todo)) +## Aggiornamento +### Automatico +Usando [watchtower](../watchtower) il container si aggiorna automaticamente -# Aggiornamenti +### Manuale +1. `docker-compose pull` +2. `docker-compose up -d` +3. `docker image prune` -[Watchtower](../watchtower) aggiorna l'immagine automaticamente. +## Backup e ripristino +### Backup +Usate [borg](../borg_backup) per fare i backup giornalieri dell'intera cartella `miniflux` -Aggiornamento manuale: - -- `docker-compose pull` -- `docker-compose up -d` -- `docker image prune` - -# Backup e ripristino - -#### Backup - -Usare [borg](../borg_backup) per fare i backup giornalieri dell'intera cartella `miniflux`. - -#### Ripristino - -* spegnere il container `docker-compose down` -* cancellare l'intera cartella `miniflux` -* dal backup copiare la cartella `miniflux` -* far ripartire il container `docker-compose up -d` - -# Todo +### Ripristino +Per una maggiore spiegazione sui passaggi da fare, controllate [qua](../borg_backup#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/).** +- reverse proxy: **[caddy](https://caddyserver.com/)** o **[traefik](https://doc.traefik.io/traefik/)** diff --git a/navidrome/README.md b/navidrome/README.md index e772465..b8c4762 100644 --- a/navidrome/README.md +++ b/navidrome/README.md @@ -1,29 +1,21 @@ -# Navidrome Music Server in docker - +# Navidrome Music Server
-# Descrizione +## Descrizione +* [Sito ufficiale](https://www.navidrome.org/) - [Repo (Github)](https://github.com/navidrome/navidrome) - [Demo](https://demo.navidrome.org/) Login: ```demo``` Password: ```demo``` - [Docs](https://www.navidrome.org/docs/) -* [Sito ufficiale](https://www.navidrome.org/) -* [Repo (Github)](https://github.com/navidrome/navidrome) -* [Demo](https://demo.navidrome.org/) Login: ```demo``` Password: ```demo``` -* [Documentazione](https://www.navidrome.org/docs/) - -Navidrome è un server di gestione e streaming musicale: - -- Gestisce collezioni musicali molto grandi -- Legge e usa tutti i vostri metadati integrati nei file -- Multiutente, ogni utente ha i propri conteggi di riproduzione, playlist, preferiti, ecc... -- Monitora automaticamente la tua libreria per le modifiche, importando nuovi file e ricaricando i nuovi metadati +Navidrome è un server per la gestione e lo streaming di file musicali: - Interfaccia web multilingua, tematizzabile, moderna e reattiva basata su Material UI +- Gestisce collezioni musicali molto grandi +- Usa i metadati integrati nei file +- Gestione multiutente, ogni utente ha le proprie playlist, preferiti, ecc... - Supporto alla transcodifica on-the-fly (anche Opus) e può essere impostato per singolo utente - Compatibile con tutti i client Subsonic/Madsonic/Airsonic - Uso delle risorse molto contenuto -# Struttura file e cartelle - +## Struttura file e cartelle ``` /home/ └── docker/ @@ -39,10 +31,12 @@ Navidrome è un server di gestione e streaming musicale: * `.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.
+**N.B. Tutti i file e le cartelle devono essere creati a mano.** -# docker-compose +## Esempi +Semplice esempio per iniziare ad usare subito il container +### docker-compose `docker-compose.yml` ```yml version: "3" @@ -70,34 +64,29 @@ MUSIC_DIR=/home/music ND_LOGLEVEL=info ``` -# Reverse proxy +## Reverse proxy +Ancora non ho previsto l'uso di un reverse proxy (Vedi [Todo](#Todo)) -Ancora non ho previsto l'uso di un reverse proxy. (Vedi [Todo](#Todo)) +## Aggiornamento +### Automatico +Usando [watchtower](../watchtower) il container si aggiorna automaticamente -# Aggiornamenti +### Manuale +1. `docker-compose pull` +2. `docker-compose up -d` +3. `docker image prune` -[Watchtower](../watchtower) aggiorna l'immagine automaticamente. +## Backup e ripristino +### Backup +Usate [borg](../borg_backup) per fare i backup giornalieri dell'intera cartella `navidrome` -Aggiornamento manuale: - -- `docker-compose pull` -- `docker-compose up -d` -- `docker image prune` - -# Backup e ripristino - -#### Backup - -Usare [borg](../borg_backup) per fare i backup giornalieri dell'intera cartella `navidrome`. - -#### Ripristino - -* spegnere il container `docker-compose down` -* cancellare l'intera cartella `navidrome` -* dal backup copiare la cartella `navidrome` -* far ripartire il container `docker-compose up -d` - -# Todo +### Ripristino +Per una maggiore spiegazione sui passaggi da fare, controllate [qua](../borg_backup#user-content-controllare-la-cartella-dei-backup) +1. fermare il container `docker-compose down` +2. cancellare l'intera cartella `navidrome` +3. dal backup copiare la cartella `navidrome` +4. far ripartire il container `docker-compose up -d` +## Todo Implementare: -- reverse proxy: **[caddy](https://caddyserver.com/) o [traefik](https://doc.traefik.io/traefik/).** +- reverse proxy: **[caddy](https://caddyserver.com/)** o **[traefik](https://doc.traefik.io/traefik/)** diff --git a/syncthing/README.md b/syncthing/README.md index 720234e..7ca9622 100644 --- a/syncthing/README.md +++ b/syncthing/README.md @@ -1,23 +1,17 @@ -# Syncthing in docker - +# Syncthing
-# Descrizione +## Descrizione +[Sito ufficiale](https://syncthing.net/) - [Repo (Github)](https://github.com/linuxserver/docker-syncthing) - [Docs](https://docs.linuxserver.io/images/docker-syncthing) -* [Sito ufficiale](https://syncthing.net/) -* [Repo (Github)](https://github.com/linuxserver/docker-syncthing) -* [Documentazione](https://docs.linuxserver.io/images/docker-syncthing) - -Syncthing è un simil-dropbox decentralizzato, sicuro e privato: - -- Scritto in Go (Golang) -- Multipiattaforma (Linux, macOS, Windows, ARM e PowerPC) -- Praticamente un dropbox ma decentralizzato e senza limiti di spazio/banda - -# Struttura file e cartelle +Syncthing è un dropbox ma decentralizzato e privato: +- Solo interfaccia web multilingua e compatibile anche con tablet/smartphone +- Basato su un [protocollo](https://docs.syncthing.net/specs/bep-v1.html#bep-v1) decentralizzato, crittografato e open source +- Esistono [client](https://syncthing.net/downloads/) sia ufficiali che di terze parti +## Struttura file e cartelle ``` /home/ └── docker/ @@ -29,14 +23,16 @@ Syncthing è un simil-dropbox decentralizzato, sicuro e privato: ``` * `config/` - cartella dove risiedono i dati che servono a syncthing -* `data/` - cartella dove vengono risiedono e vengono condivisi i dati presenti +* `data/` - cartella dove risiedono e vengono condivisi i dati presenti * `.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.
+**N.B. Tutti i file e le cartelle devono essere creati a mano.** -# docker-compose +## Esempi +Semplice esempio per iniziare ad usare subito il container +### docker-compose `docker-compose.yml` ```yml version: "3" @@ -73,33 +69,28 @@ TZ=Europe/Amsterdam ``` # Reverse proxy +Ancora non ho previsto l'uso di un reverse proxy (Vedi [Todo](#Todo)) -Ancora non ho previsto l'uso di un reverse proxy. (Vedi [Todo](#Todo)) +# Aggiornamento +### Automatico +Usando [watchtower](../watchtower) il container si aggiorna automaticamente -# Aggiornamenti +### Manuale +1. `docker-compose pull` +2. `docker-compose up -d` +3. `docker image prune` -[Watchtower](../watchtower) aggiorna l'immagine automaticamente. +## Backup e ripristino +### Backup +Usate [borg](../borg_backup) per fare i backup giornalieri dell'intera cartella `syncthing` -Aggiornamento manuale: - -- `docker-compose pull` -- `docker-compose up -d` -- `docker image prune` - -# Backup e ripristino - -#### Backup - -Usare [borg](../borg_backup) per fare i backup giornalieri dell'intera cartella `syncthing`. - -#### Ripristino - -* spegnere il container `docker-compose down` +### Ripristino +Per una maggiore spiegazione sui passaggi da fare, controllate [qua](../borg_backup#user-content-controllare-la-cartella-dei-backup) +* fermare il container `docker-compose down` * cancellare l'intera cartella `syncthing` * dal backup copiare la cartella `syncthing` * far ripartire il container `docker-compose up -d` -# Todo - +## Todo Implementare: -- reverse proxy: **[caddy](https://caddyserver.com/) o [traefik](https://doc.traefik.io/traefik/).** +- reverse proxy: **[caddy](https://caddyserver.com/)** o **[traefik](https://doc.traefik.io/traefik/)** diff --git a/unifi/README.md b/unifi/README.md index 4e857cc..db92b37 100644 --- a/unifi/README.md +++ b/unifi/README.md @@ -1,25 +1,18 @@ -# Unifi Controller in docker - +# Unifi Controller
-# Descrizione +## Descrizione +[Sito ufficiale](https://www.ui.com/software/) - [Repo (Github)](https://github.com/linuxserver/docker-unifi-controller) - [Demo](https://demo.ui.com) - [Docs](https://dl.ui.com/guides/UniFi/UniFi_Controller_V5_UG.pdf) -* [Sito ufficiale](https://www.ui.com/software/) -* [Repo (Github)](https://github.com/linuxserver/docker-unifi-controller) -* [Demo](https://demo.ui.com) -* [Documentazione](https://dl.ui.com/guides/UniFi/UniFi_Controller_V5_UG.pdf) - -Unfi Controller è un'interfaccia per la gestione di hardware Ubiquiti: - -- Interfaccia web moderna e compatibile con tablet e smartphone -- Aggiornamenti frequenti e stabili -- Possibilità di aggiornare, configurare e personalizzare tutto l'hardware (compatibile) +Unfi Controller è un controller per la gestione di hardware Ubiquiti: +- Interfaccia web +- Aggiornamenti stabili, sia del controller che dell'hardware +- Possibilità di aggiornare, configurare e personalizzare tutto l'hardware Ubiquiti - Possibilità di backup della configurazione, sia del controller che dell'hardware -# Struttura file e cartelle - +## Struttura file e cartelle ``` /home/ └── docker/ @@ -33,10 +26,12 @@ Unfi Controller è un'interfaccia per la gestione di hardware Ubiquiti: * `.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.
+**N.B. Tutti i file e le cartelle devono essere creati a mano.** -# docker-compose +## Esempi +Semplice esempio per iniziare ad usare subito il container +### docker-compose `docker-compose.yml` ```yml version: "3" @@ -65,37 +60,32 @@ UNIFI_STUN_PORT=3478 UNIFI_CONFIG=/config # Unifi -MEM_LIMIT=1024M # opzionale, di base è un 1 GB +MEM_LIMIT=1024M # opzionale, di base è un 1 GB di ram massima allocata ``` -# Reverse proxy +## Reverse proxy +Ancora non ho previsto l'uso di un reverse proxy (Vedi [Todo](#Todo)) -Ancora non ho previsto l'uso di un reverse proxy. (Vedi [Todo](#Todo)) +## Aggiornamento +### Automatico +Se usate [watchtower](../watchtower) il container si aggiorna automaticamente -# Aggiornamenti +### Manuale +1. `docker-compose pull` +2. `docker-compose up -d` +3. `docker image prune` -[Watchtower](../watchtower) aggiorna l'immagine automaticamente. +## Backup e ripristino +### Backup +Usado [borg](../borg_backup) per fare i backup giornalieri dell'intera cartella `unifi` -Aggiornamento manuale: - -- `docker-compose pull` -- `docker-compose up -d` -- `docker image prune` - -# Backup e ripristino - -#### Backup - -Usare [borg](../borg_backup) per fare i backup giornalieri dell'intera cartella `unifi`. - -#### Ripristino - -* spegnere il container `docker-compose down` -* cancellare l'intera cartella `unifi` -* dal backup copiare la cartella `unifi` -* far ripartire il container `docker-compose up -d` - -# Todo +### Ripristino +Per una maggiore spiegazione sui passaggi da fare, controllate [qua](../borg_backup#user-content-controllare-la-cartella-dei-backup) +1. fermare il container `docker-compose down` +2. cancellare l'intera cartella `unifi` +3. dal backup copiare la cartella `unifi` +4. far ripartire il container `docker-compose up -d` +## Todo Implementare: -- reverse proxy: **[caddy](https://caddyserver.com/) o [traefik](https://doc.traefik.io/traefik/).** +- reverse proxy: **[caddy](https://caddyserver.com/)** o **[traefik](https://doc.traefik.io/traefik/)** diff --git a/watchtower/.env b/watchtower/.env index 29ffb37..1656fb4 100644 --- a/watchtower/.env +++ b/watchtower/.env @@ -1,5 +1,5 @@ # Watchtower -WATCHTOWER_SCHEDULE=0 0 0 * * SAT +WATCHTOWER_SCHEDULE=0 0 * * SAT # https://crontab.guru/#0_0_*_*_SAT WATCHTOWER_CLEANUP=true WATCHTOWER_TIMEOUT=30s WATCHTOWER_DEBUG=false diff --git a/watchtower/README.md b/watchtower/README.md index 1a6f652..128b6e1 100644 --- a/watchtower/README.md +++ b/watchtower/README.md @@ -1,23 +1,19 @@ -# Watchtower in docker - +# Watchtower
-# Utilizzo - -* [Sito ufficiale](https://containrrr.dev/watchtower/) -* [Repo (Github)](https://github.com/containrrr/watchtower) +## Descrizione +[Sito ufficiale](https://containrrr.dev/watchtower/) - [Repo (Github)](https://github.com/containrrr/watchtower) - [Docs](https://containrrr.dev/watchtower/usage-overview/) Watchtower è un'applicazione per monitorare e aggiornare i cointainer: - -- Aggiornamento e riavvio dei container +- Supporto alle repo locali e/o private, compreso il supporto alle credenziali di accesso (se necessarie) +- Controllo, aggiornamento e riavvio dei container, in modo totalmente autonomo - Cancellazione automatica delle vecchie images -- Possibilità di (multi-)notifica in caso di aggiornamenti (email, slack, msteams, gotify, shoutrrr) -- Molto configurabile - -# Struttura file e cartelle +- Possibilità di notifica in caso di aggiornamenti +- Configurabile in quasi ogni aspetto +## Struttura file e cartelle ``` /home/ └── docker/ @@ -29,10 +25,12 @@ Watchtower è un'applicazione per monitorare e aggiornare i cointainer: * `.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 forniti a mano.
+**N.B. Tutti i file e le cartelle devono essere creati a mano.** -# docker-compose +## Esempi +Semplice esempio per iniziare ad usare subito il container +### docker-compose `docker-compose.yml` ```yml version: "3" @@ -49,19 +47,18 @@ services: `.env` ```bash # Watchtower -WATCHTOWER_SCHEDULE=0 0 0 * * SAT +WATCHTOWER_SCHEDULE=0 0 * * SAT # https://crontab.guru/#0_0_*_*_SAT WATCHTOWER_CLEANUP=true WATCHTOWER_TIMEOUT=30s WATCHTOWER_DEBUG=false WATCHTOWER_INCLUDE_STOPPED=false ``` -# Aggiornamenti +## Aggiornamento +### Automatico +Chiaramente il container si aggiorna da solo :satisfied: -[Watchtower](https://gitea.it/miracle091/MasterpieceDockerCompose/src/branch/master/watchtower) si aggiorna da solo. - -Aggiornamento manuale: - -- `docker-compose pull`
-- `docker-compose up -d`
-- `docker image prune` +### Manuale +1. `docker-compose pull` +2. `docker-compose up -d` +3. `docker image prune`