Skip to content

Commit

Permalink
Removed docker.io references
Browse files Browse the repository at this point in the history
  • Loading branch information
rgaudin authored Mar 21, 2023
1 parent 617d824 commit 79f3594
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Kiwix's backup companion
========================

[![CodeFactor](https://www.codefactor.io/repository/github/kiwix/borg-backup/badge)](https://www.codefactor.io/repository/github/kiwix/borg-backup)
[![Docker](https://img.shields.io/docker/v/kiwix/borg-backup?label=docker&sort=semver)](https://hub.docker.com/r/kiwix/borg-backup)
[![Docker](https://img.shields.io/badge/docker-latest-blue)](https://ghcr.io/kiwix/borg-backup)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

A [Docker image](https://hub.docker.com/r/kiwix/borg-backup) to easily backup your services' data into [BorgBase](https://www.borgbase.com/).
Expand All @@ -17,7 +17,7 @@ Example:
# running your imaginary service
docker run -v /data/www:/var/www/html -d nginx
# running your backup companion
docker run -v /data/www:/storage:ro kiwix/borg-backup backup --name nginx --every 1h
docker run -v /data/www:/storage:ro ghcr.io/kiwix/borg-backup backup --name nginx --every 1h
```

In this example, the content of `/data/www` on the host will be securely backed-up to BorgBase every hour.
Expand Down Expand Up @@ -86,7 +86,7 @@ This command is intended to be run from your local machine so you don't have to
This tool is **interactive** and will ask for your Bitwarden master API ClientID, API Secret, password and your BorgBase token (both you should have created in *Accounts setup*).

```sh
docker run -it kiwix/borg-backup setup-new-repo \
docker run -it ghcr.io/kiwix/borg-backup setup-new-repo \
--name <repo-name> \
--bitwarden <bitwarden-master-email> \
--alert-days <nb-days>
Expand Down Expand Up @@ -116,7 +116,7 @@ docker run -v <some-folder>:/storage:ro \
-e BW_CLIENTID=<bitwarden-readonly-apikey-clientid> \
-e BW_CLIENTSECRET=<bitwarden-readonly-apikey-secret> \
-e BW_PASSWORD=<bitwarden-readonly-password> \
kiwix/borg-backup backup --name <repo-name> --every <period>
ghcr.io/kiwix/borg-backup backup --name <repo-name> --every <period>
```

- `<repo-name>` is the *repository* name configured in the setup step.
Expand Down Expand Up @@ -148,7 +148,7 @@ docker run -v <some-folder>:/storage:ro \
-e BW_CLIENTID=<bitwarden-readonly-apikey-clientid> \
-e BW_CLIENTSECRET=<bitwarden-readonly-apikey-secret> \
-e BW_PASSWORD=<bitwarden-readonly-password> \
kiwix/borg-backup single-backup --name <repo-name>
ghcr.io/kiwix/borg-backup single-backup --name <repo-name>
```

### Custom command back-up (cli-mode)
Expand All @@ -169,7 +169,7 @@ docker run \
-e BORGBASE_NAME=<repo-name> \
-e CLI_MODE=y \
-v $HOME/.kube/config:/root/.kube/config:ro \
kiwix/borg-backup kube-dump all > /storage/
ghcr.io/kiwix/borg-backup kube-dump all > /storage/
```

**Note**: [`kube-dump`](https://github.com/WoozyMasta/kube-dump) is installed in the image.
Expand All @@ -186,7 +186,7 @@ docker run \
-e BW_CLIENTID=<bitwarden-readonly-apikey-clientid> \
-e BW_CLIENTSECRET=<bitwarden-readonly-apikey-secret> \
-e BW_PASSWORD=<bitwarden-readonly-password> \
kiwix/borg-backup restore --name <repo-name> --list
ghcr.io/kiwix/borg-backup restore --name <repo-name> --list
```

This will list all the available archives. Note the name of the one you'll want to extract.
Expand All @@ -197,7 +197,7 @@ docker run \
-e BW_CLIENTID=<bitwarden-readonly-apikey-clientid> \
-e BW_CLIENTSECRET=<bitwarden-readonly-apikey-secret> \
-e BW_PASSWORD=<bitwarden-readonly-password> \
kiwix/borg-backup restore --name <repo-name> --extract "<archive-name>"
ghcr.io/kiwix/borg-backup restore --name <repo-name> --extract "<archive-name>"
```

This will extract the content of the archive into `/restore` (which you should have mounted accordingly on the host).
Expand Down Expand Up @@ -226,7 +226,7 @@ Yes, just mount them as subfolders inside `/storage`:
docker run \
-v /data/media/images:/storage/images:ro \
-v /data/attachments:/storage/attachments:ro \
kiwix/borg-backup backup --name myservice --every 1h
ghcr.io/kiwix/borg-backup backup --name myservice --every 1h
```

### Can I backup both a database and files at the same time?
Expand Down

0 comments on commit 79f3594

Please sign in to comment.