110 lines
4.4 KiB
Markdown
110 lines
4.4 KiB
Markdown
<p align="center">
|
||
<img src="./public/docker_backup_icon_for_appstore.png" width="200" alt="DockerBackup" />
|
||
</p>
|
||
|
||
<h1 align="center">DockerBackup</h1>
|
||
|
||
<p align="center">
|
||
<em>Backup e restauração de containers Docker via interface web, com suporte a snapshots incrementais e restore seletivo.</em>
|
||
</p>
|
||
|
||
<p align="center">
|
||
<img src="https://img.shields.io/badge/VERSION-0.0.2-blue?style=flat-square" />
|
||
<img src="https://img.shields.io/badge/NODE.JS-%3E%3D20-339933?style=flat-square&logo=node.js&logoColor=white" />
|
||
<img src="https://img.shields.io/badge/DOCKER-ready-2496ED?style=flat-square&logo=docker&logoColor=white" />
|
||
<img src="https://img.shields.io/badge/READY-yes-brightgreen?style=flat-square" />
|
||
<img src="https://img.shields.io/badge/STATUS-ACTIVE-success?style=flat-square" />
|
||
</p>
|
||
|
||
> ⚠️ **AVISO CRÍTICO:** Aplicação em estágio inicial de desenvolvimento. Não use em produção — há risco de perda de dados.
|
||
|
||
Versão atual: **0.0.2**
|
||
|
||
---
|
||
|
||
## <20> Changelog
|
||
### [0.0.3] — Settings, About, i18n e autenticação
|
||
|
||
#### Adicionado
|
||
- **Configurações:** nova aba com seletor de idioma (10 idiomas) e controle de acesso por usuário/senha
|
||
- **Sobre:** nova aba com logo, descrição, versão atual, verificação de última versão via GitHub e botão de atualização automática
|
||
- **i18n:** suporte a 10 idiomas — Português (pt-BR), English, Español, Deutsch, Polski, Italiano, Русский, 中文, 日本語, فارسی
|
||
- **Autenticação opcional:** todas as rotas da API protegidas por token SHA-256 quando habilitado; endpoints `/api/login` e `/api/auth-status` são públicos
|
||
- **Atualização automática:** endpoint `POST /api/update` executa `git pull` e reinicia o container
|
||
|
||
---
|
||
### [0.0.2] — 2026-05-09
|
||
|
||
#### Adicionado
|
||
- **Storage Locations:** nova seção para cadastrar locais de armazenamento (nome + diretório). Agora o diretório de backup é selecionado via dropdown ao criar/editar um profile, em vez de ser digitado manualmente.
|
||
- **Backup Incremental — seleção de base:** ao executar um backup incremental com múltiplos backups full disponíveis, um modal é exibido para o usuário escolher qual será usado como base. Com apenas um full disponível, é selecionado automaticamente.
|
||
- **Bloqueio de incremental sem full:** o botão de backup incremental é bloqueado com mensagem de aviso caso não exista nenhum backup full realizado para o profile.
|
||
- **Agrupamento na aba Backups:** backups incrementais são exibidos agrupados e indentados abaixo do seu respectivo backup full, com badges visuais distintos (verde para Full, amarelo para Incremental).
|
||
|
||
#### Removido
|
||
- Abas **Servers** e **Naming Rules** removidas da interface.
|
||
|
||
---
|
||
|
||
### [0.0.1] — inicial
|
||
|
||
- Cadastro de profiles de backup por container
|
||
- Backup full e incremental com GNU tar + `--listed-incremental`
|
||
- Restore seletivo de snapshots
|
||
- Suporte a escopos `somente volumes` e `container inteiro`
|
||
- Suporte a Docker API nativa (`getArchive`/`putArchive`) quando rodando dentro de container
|
||
|
||
---
|
||
|
||
## <20>🗄️ Visão geral
|
||
|
||
O `dockerbackup` fornece:
|
||
|
||
- Cadastro de **profiles de backup** por container
|
||
- Backup **full e incremental** com GNU tar + `--listed-incremental`
|
||
- Restore seletivo de snapshots, escolhendo quais containers restaurar
|
||
- Suporte a dois escopos: `somente volumes` e `container inteiro`
|
||
- Quando rodando dentro do Docker, usa a API nativa (`getArchive`/`putArchive`) sem helper
|
||
|
||
---
|
||
|
||
## ⚙️ Instalação
|
||
|
||
```bash
|
||
npm install
|
||
```
|
||
|
||
### Requisitos
|
||
|
||
- Docker Engine com acesso ao socket em `/var/run/docker.sock`
|
||
- O diretório de backup configurado no profile precisa ser visível para o Docker daemon
|
||
- Em Docker Desktop no Windows (fora de container), paths como `C:\backups` são convertidos automaticamente para `/run/desktop/mnt/host/c/backups`
|
||
- O escopo `container inteiro` exige que o app esteja rodando em Docker
|
||
|
||
---
|
||
|
||
## ▶️ Execução
|
||
|
||
### Com Docker Compose (recomendado)
|
||
|
||
```bash
|
||
docker compose up --build
|
||
```
|
||
|
||
Acesse `http://localhost:3000`.
|
||
|
||
### Sem Docker
|
||
|
||
```bash
|
||
npm start
|
||
```
|
||
|
||
---
|
||
|
||
## 📋 Observações
|
||
|
||
- O restore valida se o conjunto de mounts do container continua igual ao do backup selecionado
|
||
- O catálogo de profiles e histórico de backups fica em `./data/store.json`
|
||
- Os arquivos `.tar.gz` são gravados no diretório configurado em cada profile
|
||
- O arquivo `docker-compose.example.yml` foi mantido como referência equivalente ao compose principal
|