Kopia
guide-by-example
WORK IN PROGRESS
WORK IN PROGRESS
WORK IN PROGRESS
Content
Purpose & Overview
Backups.
Kopia is a new open source backup utility with basically all modern features.
Cross-platform, deduplication, encryption, compression, multithreaded speed,
native cloud storage support, repository replication, snapshots mounting,
GUI versions, server version,...
Written in golang.
Embedded webGUI for server mode is done in React. KopiaUI comes with electron.
Ways to use Kopia
- cli - Command line.
You call the kopia binary passing some commands, it executes stuff, done.
Deployment requires extra work - scripts with configs, scheduling. - Kopia Server - kopia binary runs in the server mode.
Runs in the background, with its web server answering at url:localhost:51515
Through the web GUI the management is easier than using cli. As an addition to normal backup functions, the server mode can also act as a centralized repository for other machines running kopia instances.
Deployment requires extra work similar to cli, but actual use is through web GUI. - KopiaUI - GUI version.
KopiaUI comes packaged with electron to provide the feel of a standalone desktop app.
Good for simple deployment where average user just wants to backup stuff.
Benefits over cli or server is easier setup and management.
Drawback is that it runs under one user and only when that user is logged in. - Kopia in Docker - Kopia Server running in docker
Can fulfill two needs:- Backup docker-host stuff to a cloud or a mounted network storage. Managed through webgui instead of cli.
- A centralized kopia repository where other machines on the network, that also use kopia, backup their data.
Some aspects of Kopia
Official Getting Started Guide
Kopia Build Architecture
Official Features
- Kopia is a single ~35MB binary file.
- Backups are stored in a repository that needs to be created first,
and is always encrypted.
Before any action, Kopia needs to connect to a repo. - Snapshots, apart from typical meaning, kopia also uses the term for targets(paths) that are being backed up.
- Policy is a term used to define behavior of the backup/repo, like backups retention, what to ignore, logging, scheduling(server/UI), actions before and after backup,...
- Policies are stored inside a repo and can apply at various levels and
can inherit from each other
- Global policy, the default that comes predefined during repo creation, can be edited like any other.
- Per user policy, per machine policy.
- Snapshot level policy, only applying for that one path.
- Maintenance is automatic
- During snapshots Kopia uses local cache, location varies depending on the OS.
Default max size is 5GB, but it gets swept periodically every few minutes.
Useful commands arekopia cache infoandkopia cache clear - Here's
how retention works under the hood.
- ..
Kopia on a linux machine
cli version of kopia will be used to periodically backup to a mounted network storage.
The backup script will be executed using systemd-timers for scheduling.
Install Kopia
For arch linux, kopia is on AUR yay kopia-bin
The initial steps and general use commands
- repo creation
mkdir -p /mnt/mirror/KOPIA/docker_host_kopia
sudo kopia repo create filesystem --path /mnt/mirror/KOPIA/docker_host_kopia
sudo kopia repo connect filesystem --path /mnt/mirror/KOPIA/docker_host_kopia
sudo kopia repo status
- the policy info and change
sudo kopia policy get --global
sudo kopia policy list
sudo kopia policy set --global --keep-annual 2 --keep-monthly 6 --keep-weekly 4 --keep-daily 14 --keep-hourly 0 --keep-latest 3
- manual run
sudo kopia snapshot create /home/spravca/docker /etc
sudo kopia snapshot list
- mounting a backup
sudo kopia mount all /mnt/tmp & - mounts all snapshots
sudo kopia snapshot list
sudo kopia mount k7e2b0a503edd7604ff61c68655cd5ad7 /mnt/tmp &
sudo umount /mnt/tmp
The backup script
In linux, passing multiple paths separated by space seems to work fine.
So both /home and /etc are set to be backed up.
/opt/kopia-backup-home-etc.sh
#!/bin/bash
# initialize repository
# sudo kopia repo create filesystem --path /mnt/mirror/KOPIA/docker_host_kopia
# adjust global policy
# sudo kopia policy set --global --keep-annual 2 --keep-monthly 6 --keep-weekly 4 --keep-daily 14 --keep-hourly 0 --keep-latest 3
REPOSITORY_PATH='/mnt/mirror/KOPIA/docker_host_kopia'
BACKUP_THIS='/home /etc'
KOPIA_PASSWORD='aaa'
kopia repository connect filesystem --path $REPOSITORY_PATH --password $KOPIA_PASSWORD
kopia snapshot create $BACKUP_THIS
kopia repository disconnect
make the script executable
sudo chmod +x /opt/kopia-backup-home-etc.sh
Scheduled backups using systemd
Usually cron is used, but systemd provides better logging and control,
so better get used to using it.
Heres
some discussion on unit files.
ntfy can be used for notifications,
more info here
sudo micro /etc/systemd/system/kopia-home-etc.service
kopia-home-etc.service
[Unit]
Description=kopia backup
Wants=network-online.target
After=network-online.target
ConditionACPower=true
# OnFailure=ntfy@failure-%p.service
# OnSuccess=ntfy@success-%p.service
[Service]
Type=oneshot
# Lower CPU and I/O priority.
Nice=19
CPUSchedulingPolicy=batch
IOSchedulingPriority=7
IPAccounting=true
PrivateTmp=true
Environment="HOME=/root"
ExecStart=/opt/kopia-backup-home-etc.sh
sudo micro /etc/systemd/system/kopia-home-etc.timer
kopia-home-etc.timer
[Unit]
Description=Run kopia backup
[Timer]
OnCalendar=*-*-* 02:00:00
RandomizedDelaySec=10min
Persistent=true
[Install]
WantedBy=timers.target
sudo systemctl enable --now kopia-home-etc.timersystemctl status kopia-home-etc.timerjournalctl -u kopia-home-etc.timer- see history
Mounting network storage using systemd
- files are placed in
/etc/systemd/system - the name of mount and automount files MUST correspond with the path
replacing/with a-, but otherwise it must be the mounting path in the name - for mounting that does not fail on boot if there are network issues,
and mounts the target only on request - enable
automountfile, notmountfile, so:
sudo systemctl enable mnt-mirror.automount
mnt-mirror.mount
[Unit]
Description=3TB truenas mirror mount
[Mount]
What=//10.0.19.11/Mirror
Where=/mnt/mirror
Type=cifs
Options=rw,username=kopia,password=aaa,file_mode=0644,dir_mode=0755,uid=1000,gid=1000
[Install]
WantedBy=multi-user.target
mnt-mirror.automount
[Unit]
Description=3TB truenas mirror mount
[Automount]
Where=/mnt/mirror
[Install]
WantedBy=multi-user.target
Kopia on a Windows machine
Kopia Server on Windows
- Download this repo, keep
kopia_server_deploy_winfolder, delete rest. - Run
DEPLOY.cmd, it will:- Removes powershell scripts restriction.
- Creates folder
C:\Kopiaand kopies files there - Imports a task schedule that will start
C:\Kopia\kopia_server_start.cmd
Can edit flags used for the server. - Places kopia.url on the current user desktop
- visit in browser
localhost:51515 - setup repo
- setup what to backup and schedule
Kopia should now run on boot and be easy to manage through web GUI.
Be it creating backup jobs, mounting old snapshots, or just looking around
if all works as it should.
It is also popular to use nssm to start up and manage kopia as a service.
While Kopia runs now in server mode, the fact that we pass --insecure flag
means it cant serve as a repository for other kopia instances.
For that look at docker deployment section or in to making changes too.
Kopia cli on Windows
Written before I realiezed I could be using kopia server.
Also, at the moment its the only way I know how to make actions work for VSS snapshots.
While KopiaUI version seems like the way to go I really dislike the idea of not having trust in kopia if using it on servers that run with users logged out. Since KopiaUI works only if user is logged in.
- Download this repo, keep
kopia_cli_deploy_winfolder, delete rest. - Run
DEPLOY.cmd, it will:- Removes powershell scripts restriction.
- kopies kopia.exe in to
C:\Windows\System32 - Creates folder
C:\Kopiaand kopies there
kopia_backup_scipt.ps1and the VSS ps1 before and after files. - imports a task schedule
- Open the
kopia_backup_scipt.ps1and follow the instructions there.
Which is just to create repo before running the script.
kopia repo create filesystem --path C:\kopia_repo --password aaa - edit the scheduled task to the prefered time, default is daily at 21:19
- run scheduled task manually
- check if it worked
kopia repo statuskopia snap list --all
VSS snapshots
To make use of VSS snapshots before running backup execute these two commands,
replacing C:\Test with the snapshot target path.
kopia policy set C:\Test --before-folder-action "powershell -WindowStyle Hidden C:\Kopia\win_vss_before.ps1"kopia policy set C:\Test --after-folder-action "powershell -WindowStyle Hidden C:\Kopia\win_vss_after.ps1"
Note the use of --enable-actions in the backup script kopia_backup_scipt.ps1,
which is required for actions to work.
Kopia install using scoop, machine-wide
Just something to have note of, if decided to switch to heavy scoop use.
- open terminal as admin
Set-ExecutionPolicy Bypassiex "& {$(irm get.scoop.sh)} -RunAsAdmin"scoop install sudo --globalsudo scoop install kopia --global
Kopia in Docker
Files and directory structure
/mnt/
└── mirror/
/home/
└── ~/
└── docker/
└── kopia/
├── kopia_config/
├── kopia_cache/
├── kopia_logs/
├── some_data/
├── kopia_repository/
├── kopia_tmp/
├── .env
└── docker-compose.yml
/mnt/mirror/...- a mounted network storage sharekopia_config/- repository.config and ui-preferences.jsonkopia_cache/- cachekopia_logs/- logssome_data/- some data to be backed upkopia_repository/- repository locationkopia_tmp/- temp used for snapshots.env- a file containing environment variables for docker composedocker-compose.yml- a docker compose file, telling docker how to run the containers
docker-compose
The data to be backed up are mounted in read only mode.
To be able to mount snapshots, extra privilages are required and fuse access.
services:
kopia:
image: kopia/kopia:latest
container_name: kopia
hostname: kopia
restart: unless-stopped
env_file: .env
privileged: true
cap_add:
- SYS_ADMIN
security_opt:
- apparmor:unconfined
devices:
- /dev/fuse:/dev/fuse:rwm
ports:
- "51515:51515"
command:
- server
- start
- --tls-generate-cert
- --disable-csrf-token-checks
- --address=0.0.0.0:51515
- --server-username=$USERNAME
- --server-password=$KOPIA_PASSWORD
volumes:
# Mount local folders needed by kopia
- ./kopia_config:/app/config
- ./kopia_cache:/app/cache
- ./kopia_logs:/app/logs
# Mount local folders to snapshot
- ./some_data:/data:ro
# Mount repository location
- /mnt/mirror/kopia_repository:/repository
# Mount path for browsing mounted snaphots
- ./kopia_tmp:/tmp:shared
networks:
default:
name: $DOCKER_MY_NETWORK
external: true
.env
DOCKER_MY_NETWORK=caddy_net
TZ=Europe/Bratislava
# KOPIA
USERNAME=admin
KOPIA_PASSWORD=aaa
All containers must be on the same network.
Which is named in the .env file.
If one does not exist yet: docker network create caddy_net
Reverse proxy
Caddy is used, details
here.
To function as a repository server, Kopia must be setup with https,
which is achieved by using --tls-generate-cert flag and removal
of --insecure flag.
So now Kopia sits behind Caddy, but caddy needs to be told the traffic is https and to ignore that the certificate is not valid.
Caddyfile
kopia.{$MY_DOMAIN} {
reverse_proxy kopia:51515 {
transport http {
tls
tls_insecure_skip_verify
}
}
}
First run
- visit kopia.example.com
- create new repository as
Local Directory or NAS, set path to/repository, set password
Now this container can do backups of mounted stuff in to other mounted places or cloud, while managed through webgui.
To also make it function as a repository server a user account needs to be added. The users are stored in the repo.
- exec in to the container
docker container exec -it kopia /bin/bash - add user@machine and set the password
kopia server user add user1@machine1 - on another machine test with koppiaUI, on the first run:
- Pick
Kopia Repository Server - Server address:
https://kopia.example.com:443 - Trusted server certificate fingerprint (SHA256)
can be left empty, or if you put something there, it gives you error where it tells you fingerprints of the server to pick from. - In advanced option one can override user@machine with the one set when exec-ed in to the docker container. Or exec again there and add another one.
- Pick
Troubleshooting
- check kopia docker container logs, I like using ctop
nslookup kopia.example.comcheck if you are getting to you server from client- Make sure you use port 443 in server address.






