1
0
mirror of https://github.com/garraflavatra/docker-volume-s3-backup.git synced 2025-05-17 13:14:38 +00:00

Update documentation

This commit is contained in:
Romein van Buren 2025-05-04 18:03:24 +02:00
parent cc24a7d123
commit 044ddcdbda
No known key found for this signature in database

View File

@ -42,22 +42,19 @@ services:
### Restore ### Restore
> [!NOTE]
> The restore command is yet to be ported from the original restore script from [`eeshugerman/postgres-backup-s3`](https://github.com/eeshugerman/postgres-backup-s3). Contributions are welcome :)
> [!CAUTION] > [!CAUTION]
> DATA LOSS! All folder content will be dropped and re-created. > All existing files will be replaced by the backup content!
#### ... from latest backup #### From latest backup
```sh ```sh
docker exec <container_name> sh restore.sh docker exec <container_name> sh restore.sh
``` ```
> [!NOTE] > [!NOTE]
> If your bucket has more than a 1000 files, the latest may not be restored -- only one S3 `ls` command is used > If your bucket has over 1000 files, the latest may not be restored the S3 `ls` command is issued only once.
#### ... from specific backup #### From specific backup
```sh ```sh
docker exec <container_name> sh restore.sh <timestamp> docker exec <container_name> sh restore.sh <timestamp>
@ -65,7 +62,8 @@ docker exec <container_name> sh restore.sh <timestamp>
## Development ## Development
### Run a simple test environment with Docker Compose You can use the Docker Compose file in the root with your own S3 bucket for development and testing.
```sh ```sh
cp .env.example .env cp .env.example .env
# fill out your secrets/params in .env # fill out your secrets/params in .env