Kopia

https://kopia.io/docs
Admin
Kopia is a fast and secure open-source backup and restore tool that creates encrypted snapshots of...
Tokens:116,499
Snippets:872
Trust Score:9.8
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install KopiaUI with winget

Source: https://kopia.io/docs/installation

Installs the KopiaUI GUI using winget on Windows.

```powershell
> winget install Kopia.KopiaUI
```

--------------------------------

### Install KopiaUI with Homebrew

Source: https://kopia.io/docs/installation

Installs the KopiaUI GUI on macOS using Homebrew.

```bash
$ brew install kopiaui
```

--------------------------------

### Install Kopia and KopiaUI via APT

Source: https://kopia.io/docs/installation

Installs the Kopia CLI and KopiaUI GUI packages using apt on Debian/Ubuntu.

```bash
sudo apt install kopia
sudo apt install kopia-ui
```

--------------------------------

### Install Kopia with go install

Source: https://kopia.io/docs/installation

Builds Kopia from source using Go 1.16 or newer. The resulting binary is placed in $HOME/go/bin and lacks HTML-based UI support.

```bash
$ go install github.com/kopia/kopia@latest
```

--------------------------------

### Start Kopia server

Source: https://kopia.io/docs/reference/command-line/common/server-start

Launches the Kopia server with default settings. The server listens on http://127.0.0.1:51515 by default and starts with the UI and control API enabled.

```bash
$ kopia server start
```

--------------------------------

### Build full Kopia binary with make install

Source: https://kopia.io/docs/installation

Builds the full Kopia binary with HTML-based UI support. Requires downloading the source from GitHub first.

```bash
$ make install
```

--------------------------------

### Install Kopia package on FreeBSD (pkg install)

Source: https://kopia.io/docs/installation

Install the Kopia package on FreeBSD using pkg. Both commands are equivalent; the first specifies the full port path, the second uses the package name.

```bash
pkg install sysutils/kopia
pkg install kopia
```

--------------------------------

### Add Scoop bucket and install Kopia CLI

Source: https://kopia.io/docs/installation

Adds the official Scoop bucket and installs the Kopia CLI on Windows. Run these commands in order.

```powershell
> scoop bucket add kopia https://github.com/kopia/scoop-bucket.git
> scoop install kopia
```

--------------------------------

### Install Kopia CLI with Homebrew

Source: https://kopia.io/docs/installation

Installs the Kopia CLI on macOS using Homebrew.

```bash
$ brew install kopia
```

--------------------------------

### Install Kopia test-builds TAP with Homebrew

Source: https://kopia.io/docs/installation

Installs the latest unreleased version of Kopia CLI using the test-builds TAP on macOS.

```bash
$ brew install kopia/test-builds/kopia
```

--------------------------------

### Start repository server with auto-generated TLS certificate

Source: https://kopia.io/docs/repository-server

Starts the Kopia repository server for the first time, generating a TLS certificate and key stored at the provided paths. Prints the certificate SHA256 fingerprint. On subsequent starts, omit --tls-generate-cert or the server will fail to start.

```bash
KOPIA_PASSWORD="<password-for-the-repository>" \
KOPIA_SERVER_CONTROL_PASSWORD="<server-control-password>" \
  kopia server start \
    --tls-generate-cert \
    --tls-cert-file ~/my.cert \
    --tls-key-file ~/my.key \
    --address 0.0.0.0:51515 \
    --server-control-username control

```

--------------------------------

### kopia repository upgrade begin command

Source: https://kopia.io/docs/reference/command-line/advanced/repository-upgrade-begin

Starts the repository upgrade process. The command is 'kopia repository upgrade begin'.

```bash
$ kopia repository upgrade begin
```

--------------------------------

### Install Kopia and KopiaUI via YUM

Source: https://kopia.io/docs/installation

Installs the Kopia CLI and KopiaUI GUI packages using yum on RedHat/CentOS/Fedora.

```bash
sudo yum install kopia
sudo yum install kopia-ui
```

--------------------------------

### Install GPG signing key for APT repository

Source: https://kopia.io/docs/installation

Downloads and installs the GPG signing key used to verify Kopia releases for APT-based Linux distributions.

```bash
curl -s https://kopia.io/signing-key | sudo gpg --dearmor -o /etc/apt/keyrings/kopia-keyring.gpg
```

--------------------------------

### Install Kopia binary via AUR (kopia-bin)

Source: https://kopia.io/docs/installation

Install the pre-compiled binary version of Kopia on Arch-based distributions using the AUR package 'kopia-bin'. The first block clones the AUR repository and runs makepkg -si; the second uses the yay AUR helper as an alternative.

```bash
git clone https://aur.archlinux.org/kopia-bin.git
cd kopia-bin
makepkg -si
```

```bash
yay -S kopia-bin
```

--------------------------------

### Format blob JSON example

Source: https://kopia.io/docs/advanced/encryption

Example of the serialized format blob containing repository configuration parameters, including encryption algorithm and encrypted block format.

```json
{
  "tool": "https://github.com/kopia/kopia",
  "buildVersion": "v0.3.0",
  "buildInfo": "unknown",
  "uniqueID": "bm90IGEgZ29vZCByYW5kb20gaW5pdGlhbCB2YWx1ZQ==",
  "keyAlgo": "scrypt-65536-8-1",
  "version": "1",
  "encryption": "AES256_GCM",
  "encryptedBlockFormat": "ZSxqt/gXwVPS6pNvFZOOHlCKr18TmziuUnN8nnuvwQ/+mjbcvEHUfKS11RJl/sWrIOyiYqpSwAZt
BzOxQAUWQt7vHc2ZT4Y75ODrPHhzd0CcBlqHa3HSx8pxIXqpgMy5K3xDvIkBN1qdb/cTyU5s9lZ2
J+rBh2CGQ3phIlKFCCuS3lgB+rnYRrExGg5rm4BUmZZWHfBPQ7QiOJNg86PK+n///dejsAA/+FBj
qIODf7Gr3ppaGZeAHYJuz0BkRSPC4XIAgFj1yPo="
}
```

--------------------------------

### Build Kopia from FreeBSD ports

Source: https://kopia.io/docs/installation

Build and install Kopia from the FreeBSD ports tree. Run this command from the ports directory for sysutils/kopia.

```bash
cd /usr/ports/sysutils/kopia/ && make install clean
```

--------------------------------

### Install Kopia from source via AUR (kopia)

Source: https://kopia.io/docs/installation

Build and install Kopia from source on Arch-based distributions using the AUR package 'kopia'. The first block clones the AUR repository and runs makepkg -si; the second uses the yay AUR helper as an alternative.

```bash
git clone https://aur.archlinux.org/kopia.git
cd kopia
makepkg -si
```

```bash
yay -S kopia
```

--------------------------------

### Create repository in a B2 bucket

Source: https://kopia.io/docs/reference/command-line/common/repository-create-b2

Creates a new repository in a B2 bucket. The command is deprecated. The example shows the required flags: --bucket, --key-id, and --key.

```bash
$ kopia repository create b2 \
        --bucket=... \
        --key-id=... \
        --key=...

```

--------------------------------

### Server certificate SHA256 fingerprint output

Source: https://kopia.io/docs/repository-server

Example output from starting the server with --tls-generate-cert, showing the certificate SHA256 fingerprint used later for client connection.

```text
SERVER CERT SHA256: 48537cce585fed39fb26c639eb8ef38143592ba4b4e7677a84a31916398d40f7

```

--------------------------------

### Connect to repository server from client

Source: https://kopia.io/docs/repository-server

Connects a client to the repository server using the server's URL and certificate fingerprint (without colons). After connection, snapshot and policy commands work, but low-level commands like 'repo status' fail.

```bash
kopia repository connect server --url https://<address>:51515 \
  --server-cert-fingerprint 48537cce585fed39fb26c639eb8ef38143592ba4b4e7677a84a31916398d40f7

```

--------------------------------

### Mount entire repository with kopia mount all

Source: https://kopia.io/docs/mounting

Creates a mount point, mounts the whole repository with its latest snapshot version using `kopia mount all`, then lists the mounted directory contents. The output shows the repository files and directories visible through the mount point.

```bash
$ mkdir /tmp/mnt
$ kopia mount all /tmp/mnt &
$ ls -l /tmp/mnt/
total 119992
-rw-r--r--  1 jarek  staff      1101 May  9 22:33 CONTRIBUTING.md
-rw-r--r--  1 jarek  staff     11357 May  9 22:33 LICENSE
-rw-r--r--  1 jarek  staff      1613 Jun 22 19:01 Makefile
-rw-r--r--  1 jarek  staff      2286 May  9 22:33 README.md
drwxr-xr-x  1 jarek  staff     11264 May  9 22:33 assets
drwxr-xr-x  1 jarek  staff      6275 Jun  2 23:08 cli2md
-rw-r--r--  1 jarek  staff      3749 May 14 19:00 config.toml
drwxr-xr-x  1 jarek  staff      11264 May  9 22:33 assets
drwxr-xr-x  1 jarek  staff      6275 Jun  2 23:08 cli2md
-rw-r--r--  1 jarek  staff      3749 May 14 19:00 config.toml

```

--------------------------------

### Sample benchmark output for compression variants

Source: https://kopia.io/docs/advanced/compression

Example output from the benchmark command on a highly compressible 466MB file with an AMD Ryzen 7 CPU. It lists each compression variant with its compressed size, throughput, and memory usage.

```text
Repeating 1 times per compression method (total 466.7 MiB).

     Compression                Compressed   Throughput   Memory Usage
------------------------------------------------------------------------------------------------
  0. s2-default                 127.1 MiB    4 GiB/s      3126   375.4 MiB
  1. s2-better                  120.1 MiB    3.4 GiB/s    2999   351.7 MiB
  2. s2-parallel-8              127.1 MiB    2.8 GiB/s    2981   362.2 MiB
  3. s2-parallel-4              127.1 MiB    2.3 GiB/s    2951   344.1 MiB
  4. pgzip-best-speed           96.7 MiB     2.1 GiB/s    4127   324.1 MiB
  5. pgzip                      86.3 MiB     1.2 GiB/s    4132   298.7 MiB
  6. zstd-fastest               79.8 MiB     356.2 MiB/s  22503  246 MiB
  7. zstd                       76.8 MiB     323.7 MiB/s  22605  237.8 MiB
  8. deflate-best-speed         96.7 MiB     220.8 MiB/s  45     310.8 MiB
  9. gzip-best-speed            94.9 MiB     165 MiB/s    40     305.2 MiB
 10. deflate-default            86.3 MiB     143.1 MiB/s  34     311 MiB
 11. zstd-better-compression    74.2 MiB     104 MiB/s    22496  251.4 MiB
 12. pgzip-best-compression     83 MiB       55.9 MiB/s   4359   299.1 MiB
 13. gzip                       83.6 MiB     40.5 MiB/s   69     304.8 MiB
 14. zstd-best-compression      68.9 MiB     19.2 MiB/s   22669  303.4 MiB
 15. deflate-best-compression   83 MiB       5.6 MiB/s    134    311 MiB
 16. gzip-best-compression      83 MiB       5.1 MiB/s    137    304.8 MiB
```

--------------------------------

### Create B2 repository with Kopia CLI

Source: https://kopia.io/docs/repositories

Creates a new Backblaze B2 repository from the command line. Requires the B2 bucket name, Key ID, application Key, and a repository password. The password encrypts your data, so choose a secure one.

```bash
kopia repository create b2 --bucket=BUCKET_NAME --key=KEY_ID --token=APPLICATION_KEY
```

--------------------------------

### Create SFTP repository with key file

Source: https://kopia.io/docs/repositories

Use this command to create an SFTP repository using a key file for authentication. You will be prompted to enter a repository password, which is used for encryption and should be different from your SFTP password.

```bash
$ kopia repository create sftp \
        --path=... \
        --host=... \
        --username=... \
        --keyfile=...
```

--------------------------------

### LVM snapshot before hook

Source: https://kopia.io/docs/advanced/actions

Creates an LVM snapshot with lvcreate, mounts it, and outputs KOPIA_SNAPSHOT_PATH. Requires sufficient free space in the volume group; snapshot size must match requirements.

```shell
#!/bin/sh
set -e
VG_NAME=vg0
LV_NAME=lv-root
SNAPSHOT_SIZE=10G
lvcreate -L ${SNAPSHOT_SIZE} -s -n $KOPIA_SNAPSHOT_ID $VG_NAME/$LV_NAME
mkdir -p /mnt/$KOPIA_SNAPSHOT_ID
mount /dev/$VG_NAME/$KOPIA_SNAPSHOT_ID /mnt/$KOPIA_SNAPSHOT_ID
echo KOPIA_SNAPSHOT_PATH=/mnt/$KOPIA_SNAPSHOT_ID

```

--------------------------------

### Install Kopia package on OpenBSD (pkg_add kopia)

Source: https://kopia.io/docs/installation

Install the Kopia package on OpenBSD using pkg_add. The package is built from ports for amd64, arm64, mips64, and i386.

```bash
# pkg_add kopia
```

--------------------------------

### Install Kopia CLI with winget

Source: https://kopia.io/docs/installation

Installs the Kopia CLI using winget, which is preinstalled on Windows 11 (21H2 and later) and available on Windows 10 via Microsoft Store.

```powershell
> winget install Kopia.KopiaCLI
```

--------------------------------

### Start Kopia server on unix socket with TLS

Source: https://kopia.io/docs/repository-server

Starts the Kopia server listening on a unix domain socket with TLS certificates, for use with the nginx unix socket proxy configuration.

```bash
kopia server start --address unix:/tmp/kopia.sock --tls-cert-file ~/my.cert --tls-key-file ~/my.key

```

--------------------------------

### Start Kopia server with TLS for reverse proxy

Source: https://kopia.io/docs/repository-server

Starts the Kopia server with TLS certificates on port 51515, required for reverse proxy usage. The --insecure flag does not work because gRPC needs TLS.

```bash
kopia server start --address 0.0.0.0:51515 --tls-cert-file ~/my.cert --tls-key-file ~/my.key

```

--------------------------------

### Make binary executable and move to PATH

Source: https://kopia.io/docs/installation

Commands to make the downloaded Kopia binary executable and move it to /usr/local/bin for easy access. Only for Linux/macOS.

```bash
# make the file executable
$ chmod u+x path/to/kopia
# move to a location in system path
$ sudo mv path/to/kopia /usr/local/bin/kopia
```

--------------------------------

### List repository blobs with kopia blob ls

Source: https://kopia.io/docs/getting-started

Lists files in a repository. Shows that contents are grouped into pack files (starting with p) and indexed using index files (starting with n). Both index and pack files are encrypted.

```bash
$ kopia blob ls
kopia.repository                           636 2019-06-22 20:03:25 PDT
n16f6b7257610be4826396ce2be1fb302       667941 2019-06-22 20:05:30 PDT
n71861ad243bea4c2010001cf5cba1fbe          110 2019-06-22 20:03:29 PDT
p0b31020332e1fe97856faf8aa9c5cf4c     21015032 2019-06-22 20:05:13 PDT
p0df646619c8d1a25415b1b9dc9329d19     22659618 2019-06-22 20:04:36 PDT
p1bde010809b285b657cc130c34c01687     21606909 2019-06-22 20:04:30 PDT
p4dd3b780360b6889e172776fa65be836     23688119 2019-06-22 20:04:23 PDT
p549295a15c0f481ab46f4e4f18372bfc      6936758 2019-06-22 20:05:30 PDT
p61418c5b66c2ca06a51c4af3205e7006         4232 2019-06-22 20:03:29 PDT
p8a6e4f70c0fbbfda99b2e1100647606f     22930102 2019-06-22 20:04:43 PDT
p8f482528fff99ad5c23264873582545f     21261488 2019-06-22 20:05:21 PDT
p946d1fe528bde84d826cf177168d07b3     21015794 2019-06-22 20:04:15 PDT
pa0223f20fc6776b24d25b122cc9ac5f3     26497385 2019-06-22 20:05:07 PDT
pca01737879ac83f9e613c11f52d58349     21520893 2019-06-22 20:04:59 PDT
pcc4bc6fc2b960091755dc0c4704669f1     21656682 2019-06-22 20:05:27 PDT
pdec2a5b599acef1e1ce13ace25e914cd     21332440 2019-06-22 20:04:02 PDT
pf0239202fea978abf1cae4ca45d395b1     23756797 2019-06-22 20:03:54 PDT
pf1d1f00141f830ee34c89797e56011c2     23663212 2019-06-22 20:04:09 PDT
pfbaba06c70b6aed2c0ed3aa9c709dc47     22823458 2019-06-22 20:04:50 PDT

```

--------------------------------

### Register APT repository and update

Source: https://kopia.io/docs/installation

Adds the Kopia APT repository to the system and updates package lists. The stable channel is used by default.

```bash
echo "deb [signed-by=/etc/apt/keyrings/kopia-keyring.gpg] http://packages.kopia.io/apt/ stable main" | sudo tee /etc/apt/sources.list.d/kopia.list
sudo apt update
```

--------------------------------

### Connect to repository from config file

Source: https://kopia.io/docs/reference/command-line/common/repository-connect-from-config

Connects to a repository using the provided configuration file. The command is `kopia repository connect from-config`. The table lists flags such as --cache-directory, --content-cache-size-limit-mb, --file, and others that configure cache, updates, and repository metadata.

```bash
$ kopia repository connect from-config

```

--------------------------------

### ZFS point-in-time snapshot before hook

Source: https://kopia.io/docs/advanced/actions

Creates a ZFS snapshot, mounts it, and outputs KOPIA_SNAPSHOT_PATH so Kopia snapshots the mounted directory. Uses $KOPIA_SNAPSHOT_ID for the snapshot name.

```shell
#!/bin/sh
set -e
ZPOOL_NAME=tank
zfs snapshot $ZPOOL_NAME@$KOPIA_SNAPSHOT_ID
mkdir -p /mnt/$KOPIA_SNAPSHOT_ID
mount -t zfs $ZPOOL_NAME@$KOPIA_SNAPSHOT_ID /mnt/$KOPIA_SNAPSHOT_ID
echo KOPIA_SNAPSHOT_PATH=/mnt/$KOPIA_SNAPSHOT_ID

```

--------------------------------

### Connect to a filesystem repository

Source: https://kopia.io/docs/reference/command-line/common/repository-connect-filesystem

Connects to a repository stored on a local filesystem. The --path flag specifies the location of the repository.

```bash
$ kopia repository connect filesystem \
        --path=...
```

--------------------------------

### kopia snapshot create command syntax

Source: https://kopia.io/docs/reference/command-line/common/snapshot-create

Displays the command-line syntax for creating a snapshot of a local directory or file with kopia.

```bash
$ kopia snapshot create [source]
```

--------------------------------

### Delete other policies with --delete-other-policies

Source: https://kopia.io/docs/getting-started

Deletes all policies that are not imported. In this example, any policy besides (global) and foo@bar:/home/foobar would be deleted.

```bash
$ kopia policy import --from-file import.json --delete-other-policies "(global)" "foo@bar:/home/foobar"

```

--------------------------------

### Get repository throttle parameters

Source: https://kopia.io/docs/reference/command-line/common/repository-throttle-get

Displays the current throttling parameters for the repository. Use the `--json` flag to output the result in JSON format to stdout.

```bash
$ kopia repository throttle get
```
Tokens:
Raw