Skip to content

Commit dfa0ee2

Browse files
mpasternakclaude
andcommitted
README: clarify backup scope is deploy config, not data/volumes/DB
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 8a923ec commit dfa0ee2

1 file changed

Lines changed: 29 additions & 4 deletions

File tree

README.md

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,40 @@
33
[![CI](https://github.com/iplweb/bpp-deploy-backup/actions/workflows/ci.yml/badge.svg)](https://github.com/iplweb/bpp-deploy-backup/actions/workflows/ci.yml)
44
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)
55

6-
Jednoplikowy skrypt shellowy do pobierania pełnej kopii zapasowej instalacji
6+
Jednoplikowy skrypt shellowy do pobierania kopii zapasowej **plików
7+
konfiguracyjnych i uruchomieniowych** instalacji
78
[BPP](https://github.com/iplweb/bpp-deploy) ze zdalnego hosta na maszynę
89
lokalną.
910

10-
## Co jest pakowane
11+
## Zakres backupu
12+
13+
> **Uwaga:** to **nie jest** backup całego systemu ani backup danych
14+
> aplikacji. Skrypt archiwizuje wyłącznie pliki potrzebne do odtworzenia
15+
> **konfiguracji uruchomieniowej** instancji BPP.
1116
1217
Skrypt łączy się przez SSH z podanym hostem, odczytuje `~/bpp-deploy/.env`
1318
i streamuje pojedyncze archiwum `tar.gz` zawierające:
1419

1520
1. `~/bpp-deploy/` — repozytorium deploy (pliki compose, `Makefile`, `.env`)
1621
2. Katalog wskazany przez zmienną `BPP_CONFIGS_DIR` z `~/bpp-deploy/.env`
17-
konfiguracje instancji, sekrety, override'y compose, dane stanu
22+
pliki konfiguracji instancji, sekrety, override'y compose, szablony i
23+
pliki środowiskowe wymagane przez `docker compose up`
24+
25+
### Czego backup **NIE** zawiera
26+
27+
- dumpu bazy PostgreSQL ani żadnych innych baz danych
28+
- wolumenów Dockera (dane uploadów, Redis, RabbitMQ, Prometheus, Grafana,
29+
Solr itp.) — nawet jeśli niektóre leżą fizycznie gdzieś na zdalnym hoście,
30+
**skrypt ich nie rusza**
31+
- systemu operacyjnego, `/etc`, pakietów, użytkowników
32+
- logów aplikacji ani logów kontenerów
33+
- obrazów Dockera (są odtwarzane z rejestru przy `docker compose pull`)
34+
35+
Do backupu danych (baza, wolumeny) służą osobne mechanizmy opisane
36+
w [iplweb/bpp-deploy](https://github.com/iplweb/bpp-deploy)
37+
(np. `docker-compose.backup.yml` / target `make backup`). Ten skrypt jest
38+
komplementarny: pozwala odtworzyć **jak** instancja była skonfigurowana,
39+
a nie **co** w niej było.
1840

1941
Archiwum trafia na maszynę lokalną (nigdy nie powstaje plik pośredni na
2042
zdalnym hoście), pod nazwą
@@ -80,7 +102,10 @@ tar -xzf /sciezka/do/backup-host-projekt-TS.tar.gz
80102
```
81103

82104
Następnie katalogi należy umieścić z powrotem w `$HOME/bpp-deploy` oraz
83-
w miejscu wskazywanym przez `BPP_CONFIGS_DIR` na docelowym hoście.
105+
w miejscu wskazywanym przez `BPP_CONFIGS_DIR` na docelowym hoście. Po
106+
przywróceniu uzyskuje się **gotową do uruchomienia konfigurację** — baza
107+
danych i wolumeny muszą zostać odtworzone osobno (z własnych backupów),
108+
zanim wystartujesz `docker compose up`.
84109

85110
## Licencja
86111

0 commit comments

Comments
 (0)