Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/loveduckie/sspak-docker
A Docker container image for capturing or restoring backups of Silverstripe installations using SSPak.
https://github.com/loveduckie/sspak-docker
alpine-linux backup docker dockerfile silverstripe silverstripe-4 silverstripe-backup
Last synced: 11 days ago
JSON representation
A Docker container image for capturing or restoring backups of Silverstripe installations using SSPak.
- Host: GitHub
- URL: https://github.com/loveduckie/sspak-docker
- Owner: LoveDuckie
- License: mit
- Created: 2021-07-08T18:41:49.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-30T20:18:36.000Z (about 2 years ago)
- Last Synced: 2024-11-16T08:26:22.371Z (2 months ago)
- Topics: alpine-linux, backup, docker, dockerfile, silverstripe, silverstripe-4, silverstripe-backup
- Language: Shell
- Homepage: https://lucshelton.com/projects/personal/silverstripe-docker-backup
- Size: 38.1 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SSPak Docker
A Docker container image for capturing or restoring backups of Silverstripe installations using SSPAK.
[Read more about this repository here.](https://lucshelton.com/blog/backing-up-silverstripe-in-docker)
## Run
```bash
#!/bin/bash
docker run --rm -i portfolio/sspak-docker:development /bin/bash
```
## Purpose
Conveniently capture and restore backups of a [SilverStripe](https://silverstripe.org/) installation that are timestamped and kept organized at a path mounted inside of a container. This Docker image utilizes `sspak`, a command-line tool developed by the [SilverStripe](https://silverstripe.org/) team that can capture the contents of the database, and website's upload `/public/assets/Uploads` directory, so that it can be conveniently restored.
- Keeps a maximum of 5 backups.
- Timestamps each backup.
- Updates the `latest.tgz` archive with the latest on each backup.
- Enables for remote restoration and capturing of backups if `docker --context` is configured.
## Guide
A few explanations on how to use this.
### Configuration
- `BACKUPS_PATH`
- The root path within the container for capturing backups
### Restoring Backups
Backups can be restored manually to either a remote or the default/local Docker context.
```shell
#!/bin/bash
sspak-docker.sh -o restore
```
```bash
#!/bin/bash
sspak-docker.sh -o restore
```
### Capturing Backups
Backups can be manually captured when there is a running instance of SilverStripe, and the supporting SQL database server.
```bash
sspak-docker.sh -o backup
```
### Scheduled Backups
This Docker image supports the ability to schedule backups using CRON jobs that are configured inside the container. The container makes use of Alpine Linux.
## Special Thanks
[Thanks to this particular GitHub repository for the inspiration.](https://github.com/databacker/mysql-backup)
## Links
Find below some relevant links.
- **SSPak**
- The official repository for the tool that this Docker image uses.
- [GitHub Repository](https://github.com/silverstripe/sspak)
- **Blog**
- An article explaining what this Docker image does, and how to use it.
- [Docker SilverStripe Backup](https://lucshelton.com/projects/personal/silverstripe-tool-docker-backup/)