Skip to content

Latest commit

 

History

History
271 lines (183 loc) · 12.9 KB

README.md

File metadata and controls

271 lines (183 loc) · 12.9 KB
Raw

Kiwix's backup companion

CodeFactor Docker License: GPL v3

A Docker image to easily backup your services' data into BorgBase.

What's this?

This tool is a Docker image that you launch along your other Docker services, sharing the data volume with it (read-only).

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 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.

How it works

There are three main components to this tool:

  • BorgBase is an affordable backup hosting service. We use it to store encrypted backups. You can use the free plan which is limited to two repositories or use a paid plan.
  • Bitwarden is a secured password management service. We only use features from the free plan.
  • Borg is an FOSS backup tool that creates and transmits encrypted backups.

In BorgBase, everything revolves around the concept of a repository. It's a place (~folder) in which your data goes (encrypted). For every datasource that you want to backup, you'll have one BorgBase repository and one companion container.

This tool generates an SSH keypair for your repo, configures BorgBase to allow backups using this key (with append-only restriction) and stores the keypair in your Bitwarden account so you don't have to worry much about credentials.

What do I need?

  • Mandatory: One BorgBase account (free or paid)
  • Mandatory: A Bitwarden accounts (a master)
  • Optional: A second Bitwarden account (a backuper one without the credential to create/read BorgBase repositories)

Accounts setup (to do once)

This is the annoying part. You'll have to manually create a couple of accounts and do some manipulations. This is a one-time thing, no matter how many repos you'll setup.

BorgBase

  1. Create an account at BorgBase (or reuse one)
  2. Once logged it, go to Acounts » API then New Token.
  3. Choose a name (kiwix-backup?) and make sure you select Create only (important!)
  4. Securely keep a reference to that created token, you'll need that every time you setup a new repository.

Bitwarden

In order to store what we need in Bitwarden (SSH keypairs, BorgBase token) but without exposing our Bitwarden token to the backup companion, we'll use two different accounts:

  • one that is used solely to setup repo. That's the master account.
  • one that is used when backing-up. This backuper one will have read-only access to the items in the vault.

Note: You can use only one account if you want. But using two accounts is safer. That said, it doesn't mean the read-only account should be considered public. Keep it safe!

  1. Create one master Bitwarden account (email/password)
  2. Create an Organization from that account's UI
  3. Create a single Collection to be shared accross this organization
  4. Invite a member to this organization, with:
  • the email adress you'll use to create that second Bitwarden account in a minute
  • choosing User mode
  • choising selected-collections only
  • check the collection you created earlier
  • check read-only (but not hide password)
  1. using the invitation link your received on that email address, create one backup Bitwarden account (email/password)
  2. login to Bitwarden UI using master account and confirm membership

We'll be using an API Key to connect to your read-only bitwarden account so from the bitwarden UI, goto Settings and View API Key. Note the value for client_id and client_secret. Those will be referred to later as BW_CLIENTID and BW_CLIENTSECRET.

Usage

Every repository or service you want to backup needs to be initialized once before you start backing-up your data. This is a quick step that is separated from the backup one in order to keep your master Bitwarden credentials from being moved around.

Setting up

This command is intended to be run from your local machine so you don't have to insert your credentials on any other system.

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).

docker run -it ghcr.io/kiwix/borg-backup setup-new-repo \
    --name <repo-name> \
    --bitwarden <bitwarden-master-email> \
    --alert-days <nb-days>
    --quota <max-storage>
    --region <region>

Choosing a repo-name

We suggest you use reverse-FQDN notation for your repo names as the Bitwarden matching is done using a search query meaning that if you have two repositories named my-service and my-service2, the first one will fail, receiving two results instead of one.

Optional values:

  • <nb-days>: periodicity of BorgBase e-mail alert in day(s) (default : 1)
  • <max-storage>: quota in MB (default: no quota)
  • <region>: BorgBase server region (eu or us) (default : eu)

That's it. You should now have a repoitory ready to receive backups.

Backing-up

The following is unattended and should be configured along your service. It runs forever, backing-up at the given interval.

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> \
    ghcr.io/kiwix/borg-backup backup --name <repo-name> --every <period>
  • <repo-name> is the repository name configured in the setup step.
  • <period> is the interval to launch backup on: units are m for minutes (1-30), h for hours (1-30), d for days (1-14), M for months (1-6).

Other parameters can be configured via Docker environment variables:

  • Retention options:
    • KEEP_WITHIN: keep all archives less than this old (no used by default)
    • KEEP_DAILY: keep last archive of this many latest days (default: 7)
    • KEEP_WEEKLY: keep last archive of this many latest weeks (default: 5)
    • KEEP_MONTHLY: keep last archive of this many latest months (default: 12)
    • KEEP_YEARLY: keep last archive of this many latest years (default: 1)
  • Databases backup:
    • DATABASES: DSNs of the database to backup.
    • DATABASES_OPTIONS: Options passed to all databases hookd. eg: --ignore-table=wp1.too_large_table

Database DSN should be in the form: type://user:password@host:port/dbname. It only supports mysql, postgresql and mongodb. dbname can be all to backup all databases of that host/connexion.

Note: Bitwarden will send you a New Device Logged In From Linux email every time you launch that container.

Single back-up

If you want to rely on your own scheduling tool, you can use the single-backup command which just runs the backup once and exits.

Note that contrary to the regular backup command, there is no interactive request for missing credentials. As for invalid credentials, this will simply fail the container.

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> \
    ghcr.io/kiwix/borg-backup single-backup --name <repo-name>

Custom command back-up (cli-mode)

If you need to execute a command to prepare your backup data you can enable cli-mode.

By setting the CLI_MODE variable, you are instructing the tool to run your passed command and, should it succeed, start a single-backup.

  • It requires passing all backup-related conf via environment variables.
  • It can be combined with regular data (/storage or databases).
  • It is restricted to single-backup. Container exits after your command and single-backup finishes.
docker run \
    -e BW_CLIENTID=<bitwarden-readonly-apikey-clientid> \
    -e BW_CLIENTSECRET=<bitwarden-readonly-apikey-secret> \
    -e BW_PASSWORD=<bitwarden-readonly-password> \
    -e BORGBASE_NAME=<repo-name> \
    -e CLI_MODE=y \
    -v $HOME/.kube/config:/root/.kube/config:ro \
    ghcr.io/kiwix/borg-backup kube-dump all > /storage/

Note: kube-dump is installed in the image.

Restoring data

Using the extract tool

Your backups are composed of archives or versions of your data. Use this tool to list and extract them with ease.

docker run \
    -v /data/temp:/restore:rw \
    -e BW_CLIENTID=<bitwarden-readonly-apikey-clientid> \
    -e BW_CLIENTSECRET=<bitwarden-readonly-apikey-secret> \
    -e BW_PASSWORD=<bitwarden-readonly-password> \
    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.

docker run \
    -v /data/temp:/restore:rw \
    -e BW_CLIENTID=<bitwarden-readonly-apikey-clientid> \
    -e BW_CLIENTSECRET=<bitwarden-readonly-apikey-secret> \
    -e BW_PASSWORD=<bitwarden-readonly-password> \
    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).

--extract accepts a special value of latest that gets the lasted archive from the list.

Manually

As your backup as just regular borg backups, you can follow these docs to restore your data manually.

Restoring requires your SSH keypair stored in bitwarden. In your Bitwarden vault, you'll find one item for each of your repository. In this item, you'll find:

  • username: that's your SSH public key. Save it as ~/.ssh/<myrepo>.pub
  • password: that's your SSH private key. Save it as ~/.ssh/<myrepo>
  • BORGBASE_TOKEN: that's your borgbase token. You don't need it for restoring.

You can now list, retrieve and extract any borg archive using regular tools.

FAQ

Can I specify multiple folders to backup?

Yes, just mount them as subfolders inside /storage:

docker run \
    -v /data/media/images:/storage/images:ro \
    -v /data/attachments:/storage/attachments:ro \
    ghcr.io/kiwix/borg-backup backup --name myservice --every 1h

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

Yes, if you specify DATABASES env, it's added on top of the mounted volume.

⚠️ There is an important constraint when backing up both databases and files: your /storage mounted volume must be a single volume. You can not mount any other folder under /storage and expect its files to be included. Those will silently be ignored.

If you would like to mount several volumes inside /storage and also backup databases, there is a trick: you can do it by setting the CROSS_FS_GLOB envrionment variable. Note that there are two catches:

Can I backup several databases at the same time?

Yes, beside the all trick mentionned above, if you need to backup a list of databases or databases on different hosts or of different kinds, just concatenate the DSNs into the DATABASES env, separating them with |||.

-e DATABASES="mysql://root:root@db:3306/all|||mysql://user:pass@prod:3306/clients"

Can I replace BorgBase with another host?

No, at the moment, we use their API so it can't be replaced with another service.

What if my Bitwarden is compromised?

Don't panic! If your read-only Bitwarden credentials are compromised, you won't loose any data:

  • Bitwarden items can't be modified by this account
  • The SSH keypairs stored in Bitwarden are now compromised but it can only do much on BorgBase:
    • append new data to your repos (but cannot delete those you backed-up)
    • read backuped data (check and delete those if that happened)

You should now manually remove the keypairs from BorgBase and remove post-incident archives from your repo (read this documentation on append-only first).

Can I use a single Bitwarden account?

Yes, but we highly discourage it.

The sole account is thus the read-write one (master) and it means it it gets compromised, one could delete items from your Bitwarden account. As your SSH keypairs are only stored in Bitwarden, loosing them mean you won't be able to retrieve nor decrypt your backups.