MasterpieceDockerCompose/komga/README.md

112 lines
3.6 KiB
Markdown
Raw Normal View History

2021-05-25 11:36:01 +02:00
# Komga
2021-05-17 10:40:18 +02:00
<div align="center">
<img src="https://i.ibb.co/s2JRD9H/komga.png" />
2021-05-17 10:40:18 +02:00
</div>
2021-05-25 11:36:01 +02:00
## Descrizione
[![Sito ufficiale](https://img.shields.io/static/v1.svg?color=555555&logoColor=ffffff&logo=firefoxbrowser&style=flat&label=&message=Homepage)](https://komga.org/) [![Sorgente](https://img.shields.io/static/v1.svg?color=555555&logoColor=ffffff&logo=github&style=flat&label=&message=Sorgente)](https://github.com/gotson/komga) [![Docker Hub](https://img.shields.io/static/v1.svg?color=555555&logoColor=ffffff&logo=docker&style=flat&label=&message=Docker&nbsp;Hub)](https://hub.docker.com/r/gotson/komga) [![Docs](https://img.shields.io/static/v1.svg?color=555555&logoColor=ffffff&logo=readthedocs&style=flat&label=&message=Docs)](https://komga.org/guides/) [![Demo](https://img.shields.io/static/v1.svg?color=555555&logoColor=ffffff&logo=jekyll&style=flat&label=&message=Demo)](https://demo.komga.org/ "Login: demo@komga.org | Password: komga-demo")
2021-05-17 10:40:18 +02:00
Komga è un server per la gestione di manga/comics:
- Lettore web integrato e configurabile
- Organizzare i vostri manga/comics in collezioni
- Modifica e importazione dei metadati, sia locali che integrati
- Multiutente, con possiblità di gestire (anche singolarmente) l'accesso alle librerie
- Compatibile con i classici formati (CBZ, CBR, PDF e EPUB)
2021-05-17 10:40:18 +02:00
2021-05-25 11:36:01 +02:00
## Struttura file e cartelle
2021-05-17 10:40:18 +02:00
```
/home/
└── docker/
└── komga/
├── config/
├── data/
├── .env
└── docker-compose.yml
2021-05-17 10:40:18 +02:00
```
2021-05-17 12:45:18 +02:00
* `config/` - cartella dove risiedono i dati che servono a komga
* `data/` - cartella dove vanno messi i manga/comics
* `.env` - file contenenti le variabili environment per il docker-compose
2021-05-17 12:45:18 +02:00
* `docker-compose.yml` - file usato per creare il container
2021-05-17 10:40:18 +02:00
2021-05-25 11:36:01 +02:00
**N.B. Tutti i file e le cartelle devono essere creati a mano.**
2021-05-17 10:40:18 +02:00
2021-05-25 11:36:01 +02:00
## Esempi
Semplice esempio per iniziare ad usare subito il container
2021-05-17 10:40:18 +02:00
### network
```bash
docker network create custom-bridge
```
oppure
```bash
podman network create custom-bridge
```
2021-05-25 11:36:01 +02:00
### docker-compose
2021-05-17 10:40:18 +02:00
`docker-compose.yml`
```yml
version: "3.5"
2021-05-17 10:40:18 +02:00
services:
komga:
container_name: komga
image: gotson/komga
security_opt:
- no-new-privileges:true
networks:
- custom-bridge
2021-05-17 10:40:18 +02:00
restart: unless-stopped
ports:
2021-05-17 12:45:18 +02:00
- ${KOMGA_WEBUI_PORT:-8080}:8080
2021-05-17 10:40:18 +02:00
env_file: .env
volumes:
- ${KOMGA_CONFIG:-/home/docker/komga/config}:/config
2021-05-17 16:12:18 +02:00
- ${KOMGA_DATA:-/home/docker/komga/data}:/data
networks:
custom-bridge:
name: custom-bridge
driver: bridge
2021-05-17 10:40:18 +02:00
```
`.env`
```bash
# Generale
2021-05-17 12:45:18 +02:00
KOMGA_WEBUI_PORT=8080
2021-05-17 11:57:31 +02:00
KOMGA_CONFIG=/config
KOMGA_DATA=/data
2021-05-17 10:40:18 +02:00
# Komga
ND_LOGLEVEL=info
```
2021-05-25 11:36:01 +02:00
## Reverse proxy
Ancora non ho previsto l'uso di un reverse proxy (Vedi [Todo](#Todo))
2021-05-17 10:40:18 +02:00
2021-05-25 11:36:01 +02:00
## Aggiornamento
### Automatico
Usando [watchtower](../watchtower) il container si aggiorna automaticamente
2021-05-17 10:40:18 +02:00
2021-05-25 11:36:01 +02:00
### Manuale
1. `docker-compose pull`
2. `docker-compose up -d`
3. `docker image prune`
2021-05-17 10:40:18 +02:00
2021-05-25 11:36:01 +02:00
## Backup e ripristino
### Backup
Usate [borg](../borg_backup) per fare i backup giornalieri dell'intera cartella `komga`
2021-05-17 10:40:18 +02:00
2021-05-25 11:36:01 +02:00
### 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`
2021-05-17 10:40:18 +02:00
2021-05-25 11:36:01 +02:00
## Todo
2021-05-17 10:40:18 +02:00
Implementare:
2021-05-25 11:36:01 +02:00
- 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)