Vykar Backup

https://vykar.borgbase.com/
Admin
Vykar is a fast, encrypted, deduplicated backup tool written in Rust. It’s centered around a simple...
Tokens:57,040
Snippets:779
Trust Score:9.3
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install libxdo for bare binary

Source: https://vykar.borgbase.com/gui

Install the libxdo library on Debian/Ubuntu systems before running the bare `vykar-gui` binary.

```bash
# Debian/Ubuntu
sudo apt install libxdo3
```

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

### Repository Configuration Example

Source: https://vykar.borgbase.com/architecture

Example configuration for repository settings, including minimum and maximum pack sizes.

```yaml
__
repositories:
  - url: /backups/repo
    min_pack_size: 33554432     # 32 MiB (floor, default)
    max_pack_size: 201326592    # 192 MiB (default)


```

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

### Daemon Configuration Example

Source: https://vykar.borgbase.com/daemon

Example configuration for the Vykar daemon's scheduling. It shows how to set a fixed interval for backups.

```yaml
__
schedule:
  enabled: true
  every: "6h"                  # fixed interval
  # cron: "0 3 * * *"         # OR 5-field cron (mutually exclusive with every)
  on_startup: false
  jitter_seconds: 0


```

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

### Install Vykar Borgbase

Source: https://vykar.borgbase.com/quickstart

Run the install script to install Vykar Borgbase. Alternatively, download a pre-built binary or use the Docker image.

```bash
curl -fsSL https://vykar.borgbase.com/install.sh | sh
```

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

### Pack File Configuration Example

Source: https://vykar.borgbase.com/print

Illustrates how to configure minimum and maximum pack sizes for repository backups.

```yaml
__
repositories:
  - url: /backups/repo
    min_pack_size: 33554432     # 32 MiB (floor, default)
    max_pack_size: 201326592    # 192 MiB (default)

```

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

### Client Configuration Example

Source: https://vykar.borgbase.com/print

This is an example of a client configuration file for Vykar Borgbase, specifying repository details such as label, URL, and access token.

```yaml
__
repositories:
  - label: server
    url: https://backup.example.com
    access_token: "secret-token-here"

```

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

### Enable and Start Vykar Service

Source: https://vykar.borgbase.com/daemon

Commands to reload the systemd manager configuration and then enable and start the Vykar service. This ensures the service starts on boot and is running.

```bash
systemctl daemon-reload
systemctl enable --now vykar
```

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

### .env File Content Example

Source: https://vykar.borgbase.com/configuration

Example content for a .db.env file, defining database credentials as key-value pairs.

```dotenv
DB_USER=myuser
DB_PASSWORD=s3cret
DB_DATABASE=myapp
```

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

### Database Backup Hook Example

Source: https://vykar.borgbase.com/goals

This example demonstrates how to use hooks to capture database dumps before a backup and clean them up afterward. It illustrates Vykar's flexible approach to handling various data sources.

```yaml
__
sources:
  - label: databases
    path: /var/backups/db
    hooks:
      before: "pg_dump -Fc mydb > /var/backups/db/mydb.dump"
      after:  "rm -f /var/backups/db/mydb.dump"

```

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

### Build Vykar GUI from Source

Source: https://vykar.borgbase.com/gui

Install necessary development headers and build the Vykar GUI release using Cargo.

```bash
# Debian/Ubuntu
sudo apt install libxdo-dev libgtk-3-dev libxkbcommon-dev libayatana-appindicator3-dev
cargo build --release -p vykar-gui
```

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

### Using Hooks for Database Backup

Source: https://vykar.borgbase.com/print

Example of using 'before' and 'after' hooks to dump and clean up a database before and after a backup.

```yaml
sources:
  - label: databases
    path: /var/backups/db
    hooks:
      before: "pg_dump -Fc mydb > /var/backups/db/mydb.dump"
      after:  "rm -f /var/backups/db/mydb.dump"
```

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

### Build Vykar GUI from Source

Source: https://vykar.borgbase.com/print

Install necessary development headers and build the vykar-gui component using Cargo.

```bash
__
sudo apt install libxdo-dev libgtk-3-dev libxkbcommon-dev libayatana-appindicator3-dev
cargo build --release -p vykar-gui

```

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

### Vykar Docker Configuration Example

Source: https://vykar.borgbase.com/install

Example of a vykar.yaml configuration file for Docker deployments, specifying S3 repository, local data sources, encryption, and schedule.

```yaml
repositories:
  - url: s3://my-bucket/backups
    access_key_id: "..."
    secret_access_key: "..."

sources:
  - /data/documents
  - /data/photos

encryption:
  passphrase: "change-me"

retention:
  keep_daily: 7
  keep_weekly: 4

schedule:
  enabled: true
  every: "24h"
  on_startup: true
```

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

### Hook Commands Example

Source: https://vykar.borgbase.com/configuration

Example of defining hook commands for 'failed' and 'after_backup' events. Placeholders like {command} and {error} are supported and automatically shell-escaped.

```yaml
hooks:
  failed:
    - 'notify-send "vykar {command} failed: {error}"'
  after_backup:
    - 'echo "Backed up {source_label} to {repository}"'
```

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

### Install FUSE 2 or Use Fallback for AppImage

Source: https://vykar.borgbase.com/print

Install the FUSE 2 library if AppImages fail to run, or use the environment variable to extract and run without FUSE.

```bash
__
# Install FUSE 2 (Ubuntu 24.04+)
sudo apt install libfuse2t64

# Or run without FUSE
APPIMAGE_EXTRACT_AND_RUN=1 ./vykar-gui-*-x86_64.AppImage

```

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

### Install Apprise for Notifications

Source: https://vykar.borgbase.com/recipes

Install the Apprise CLI tool using pip for sending notifications to over 100 services. This is useful for Vykar hooks.

```shell
pip install apprise
```

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

### Basic Repository and Sources Configuration

Source: https://vykar.borgbase.com/goals

This snippet shows the basic structure for defining backup repositories and the sources to be backed up. It's a starting point for version-controlled backup strategies.

```yaml
__
repositories:
  - url: /backups/myrepo
sources:
  - path: /home/user/documents
  - path: /home/user/photos

```

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

### Install Ansible Role

Source: https://vykar.borgbase.com/install

Use this command to install the official Ansible role for automated deployment.

```bash
ansible-galaxy role install borgbase.vykar
```

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

### Reloading and Enabling Systemd Service

Source: https://vykar.borgbase.com/print

Commands to reload the systemd daemon, enable the vykar-server service to start on boot, and immediately start the service.

```bash
__
sudo systemctl daemon-reload
sudo systemctl enable --now vykar-server.service
sudo systemctl status vykar-server.service

```

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

### Verify Vykar Installation

Source: https://vykar.borgbase.com/install

Check the installed Vykar version to confirm the installation was successful.

```bash
vykar --version
```

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

### Install FUSE 2 for AppImage

Source: https://vykar.borgbase.com/gui

Install the FUSE 2 library on Ubuntu 24.04+ if you encounter FUSE-related errors when running the AppImage.

```bash
# Install FUSE 2 (Ubuntu 24.04+)
sudo apt install libfuse2t64
```

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

### Run Vykar Server with CLI Flags

Source: https://vykar.borgbase.com/server-setup

Start the Vykar server directly from the command line, specifying the data directory, enabling append-only mode, and setting a storage quota. The authentication token is provided via an environment variable.

```bash
__
export VYKAR_TOKEN="some-secret-token"
vykar-server --data-dir /var/lib/vykar --append-only --quota 10G


```

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

### Client Repository Configuration

Source: https://vykar.borgbase.com/server-internals

Example configuration for a Vykar repository pointing to a remote server. Ensure the URL and access token are correctly set.

```yaml
__
repositories:
  - label: server
    url: https://backup.example.com
    access_token: "secret-token-here"


```

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

### Vykar Client Repository Configuration

Source: https://vykar.borgbase.com/server-setup

Example configuration file for a Vykar client, specifying the server URL, access token, encryption mode, and local sources to back up. This allows the client to connect to and use the Vykar backup server.

```yaml
__
repositories:
  - label: "server"
    url: "https://backup.example.com"
    access_token: "some-secret-token"

encryption:
  mode: "auto"

sources:
  - "/home/user/documents"


```

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

### Reload and Enable Vykar Systemd Service

Source: https://vykar.borgbase.com/server-setup

Commands to reload the systemd daemon after creating or modifying a service file, enable the Vykar server service to start on boot, and start it immediately. Also shows how to check the service status.

```bash
__
sudo systemctl daemon-reload
sudo systemctl enable --now vykar-server.service
sudo systemctl status vykar-server.service


```

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

### Cron Schedule Configuration

Source: https://vykar.borgbase.com/configuration

Example of configuring the daemon scheduler using a cron expression for daily backups at 3:00 AM with a 60-second jitter.

```yaml
schedule:
  enabled: true
  cron: "0 3 * * *"          # daily at 3:00 AM
  jitter_seconds: 60
```

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

### Enable HTTP Interface

Source: https://vykar.borgbase.com/daemon

Starts the Vykar daemon with an HTTP listener enabled on a specific address and port. This allows for monitoring the daemon's status via a web interface.

```bash
__
vykar daemon --http-listen 127.0.0.1:7575


```

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

### Systemd Service for Vykar Server

Source: https://vykar.borgbase.com/server-setup

Set up a systemd service unit file to manage the Vykar backup server. This includes specifying user, group, environment file, and security-related configurations. It ensures the server starts on boot and restarts on failure.

```systemd
__
[Unit]
Description=Vykar backup REST server
After=network-online.target
Wants=network-online.target

[Service]
Type=simple
User=vykar
Group=vykar
EnvironmentFile=/etc/vykar/vykar-server.env
ExecStart=/usr/local/bin/vykar-server --data-dir /var/lib/vykar --append-only
Restart=on-failure
RestartSec=2
NoNewPrivileges=true
PrivateTmp=true
ProtectSystem=full
ProtectHome=true
ReadWritePaths=/var/lib/vykar

[Install]
WantedBy=multi-user.target


```

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

### Storage Object Operations

Source: https://vykar.borgbase.com/print

Standard operations for interacting with storage objects (keys). Supports GET, HEAD, PUT, DELETE, and listing with a prefix.

```APIDOC
## GET /{path}

### Description
Retrieves an object by its path. Supports range requests.

### Method
GET

### Endpoint
`/{*path}`

### Parameters
#### Query Parameters
- **list** (boolean) - Optional - If present, lists keys matching the prefix.

#### Headers
- **Range** (string) - Optional - For ranged reads, e.g., `bytes=0-499`.

### Response
#### Success Response (200)
- **body** (bytes) - The content of the object.
#### Success Response (206)
- **body** (bytes) - The content of the object within the specified range.
#### Error Response (404)
- Object not found.

## HEAD /{path}

### Description
Checks for the existence of an object and retrieves its metadata.

### Method
HEAD

### Endpoint
`/{*path}`

### Response
#### Success Response (200)
- **headers** (object) - Metadata about the object.
#### Error Response (404)
- Object not found.

## PUT /{path}

### Description
Uploads or updates an object. Supports content verification via `X-Content-BLAKE2b` header.

### Method
PUT

### Endpoint
`/{*path}`

### Parameters
#### Request Body
- **data** (bytes) - The raw bytes of the object.
#### Headers
- **X-Content-BLAKE2b** (string) - Optional - The BLAKE2b hash of the object content for verification.

### Response
#### Success Response (200)
- Object successfully written.
#### Error Response (403)
- Rejected in append-only mode unless the key is on the mutable-allowlist.

## DELETE /{path}

### Description
Deletes an object.

### Method
DELETE

### Endpoint
`/{*path}`

### Response
#### Success Response (204)
- Object successfully deleted.
#### Error Response (404)
- Object not found.
#### Error Response (403)
- Rejected in append-only mode.
```

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

### Search Under a Subtree with Case-Insensitive Name Matching

Source: https://vykar.borgbase.com/print

Performs a case-insensitive search for files starting with 'report' under the 'sub' directory, modified within the last 7 days.

```bash
vykar snapshot find sub --iname 'report*' --since 7d
```

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

### Systemd Service Management

Source: https://vykar.borgbase.com/print

Commands to manage the Vykar systemd service. This includes reloading the systemd daemon, enabling and starting the service, reloading the service configuration, and checking its status and logs.

```bash
systemctl daemon-reload
systemctl enable --now vykar
```

```bash
systemctl reload vykar
```

```bash
systemctl status vykar
journalctl -u vykar -f
```

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

### Validate Repository Structure

Source: https://vykar.borgbase.com/print

Use the `GET /?verify-structure` endpoint to validate the repository's directory structure, pack shard naming, and pack file integrity without requiring encryption keys. This complements client-side verification.

```http
GET /?verify-structure
```

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

### Verify Repository and Perform First Backup

Source: https://vykar.borgbase.com/init-setup

Confirms the repository has been created successfully and then runs the initial backup. It also shows how to list the contents of the backup.

```bash
vykar info
vykar backup
vykar list
```

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

### Create Vykar Configuration

Source: https://vykar.borgbase.com/print

Generate a starter configuration file for Vykar. The configuration can be written to a specific destination path.

```bash
__
vykar config

```

```bash
__
vykar config --dest ~/.config/vykar/config.yaml

```

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

### Initialize Specific Repository

Source: https://vykar.borgbase.com/init-setup

Initializes a single repository from a configuration file that contains multiple repository definitions. Use the --repo flag to specify which one.

```bash
vykar init --repo main
```

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

### Listing Snapshots by Label and Restoring Latest

Source: https://vykar.borgbase.com/print

Demonstrates how to list snapshots associated with a specific label and how to restore the latest snapshot from a source.

```bash
vykar list -S databases --last 5
vykar restore --source personal latest
```

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

### VM Filesystem Freeze/Thaw Hooks

Source: https://vykar.borgbase.com/recipes

Use hooks to freeze and thaw the guest filesystem before and after backing up a VM disk image. Requires QEMU guest agent and socat.

```yaml
__
sources:
  - label: vm-images
    path: /var/lib/libvirt/images
    hooks:
      before: >
        echo '{"execute":"guest-fsfreeze-freeze"}' |
        socat - unix-connect:/tmp/qga.sock
      finally: >
        echo '{"execute":"guest-fsfreeze-thaw"}' |
        socat - unix-connect:/tmp/qga.sock

```

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

### Get Snapshot Information

Source: https://vykar.borgbase.com/restore

Retrieve detailed information about a specific snapshot using the `vykar snapshot info` command.

```bash
vykar snapshot info a1b2c3d4
```

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

### Generate Vykar Config

Source: https://vykar.borgbase.com/quickstart

Generate a starter configuration file. You will need to edit this file to specify your repository path and source directories.

```bash
vykar config
```

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

### Creating vykar-server Environment File

Source: https://vykar.borgbase.com/print

This sequence sets up a secure environment file for the vykar-server, storing the authentication token and restricting file permissions. It ensures the token is not exposed in process arguments.

```bash
__
sudo mkdir -p /etc/vykar
echo 'VYKAR_TOKEN=some-secret-token' | sudo tee /etc/vykar/vykar-server.env
sudo chmod 600 /etc/vykar/vykar-server.env
sudo chown vykar:vykar /etc/vykar/vykar-server.env

```

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

### Create Vykar Backup

Source: https://vykar.borgbase.com/quickstart

Create a backup of all configured sources. You can also back up a specific folder directly.

```bash
vykar backup
```

```bash
vykar backup ~/Documents
```

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

### HTTP Repository Configuration with Insecure HTTP

Source: https://vykar.borgbase.com/configuration

Configure a remote repository using HTTP, explicitly allowing insecure connections for local or development setups.

```yaml
__
repositories:
  - url: "http://localhost:8484"
    allow_insecure_http: true
```

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

### Environment Variable Expansion in Config

Source: https://vykar.borgbase.com/configuration

Demonstrates using environment variable placeholders in configuration values, with support for default values.

```yaml
repositories:
  - url: "${VYKAR_REPO_URL:-/backup/repo}"
    # access_token: "${VYKAR_ACCESS_TOKEN}"
```

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

### Configure Vykar via Ansible

Source: https://vykar.borgbase.com/install

Example Ansible playbook to configure Vykar using the `vykar_config` variable. This maps directly to Vykar's YAML configuration.

```yaml
- hosts: myserver
  roles:
    - role: vykar
      vars:
        vykar_config:
          repositories:
            - url: "/backup/repo"
          encryption:
            passphrase: "mysuperduperpassword"
          sources:
            - "/home"
            - "/etc"
          schedule:
            enabled: true
            every: "24h"
```

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

### Initialize Vykar Repository

Source: https://vykar.borgbase.com/quickstart

Initialize the Vykar repository. This command will prompt for a passphrase if the repository is encrypted.

```bash
vykar init
```

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

### Run AppImage on Linux

Source: https://vykar.borgbase.com/print

Make the AppImage executable and run it. Ensure your system meets the glibc version requirements.

```bash
__
chmod +x vykar-gui-*-x86_64.AppImage
./vykar-gui-*-x86_64.AppImage

```

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

### Configure Repository and Backup Sources

Source: https://vykar.borgbase.com/print

Define the repository URL and the directories to be backed up in the Vykar configuration file.

```yaml
__
repositories:
  - label: "main"
    url: "/backup/repo"

sources:
  - "/home/user/documents"
  - "/home/user/photos"


```

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

### Simple Source Paths

Source: https://vykar.borgbase.com/configuration

Define filesystem paths to back up. Multiple paths are grouped into a single source with a default label.

```yaml
sources:
  - "/home/user/documents"
  - "/home/user/photos"
  # Windows:
  # - 'C:\Users\me\Documents'
  # - 'C:\Users\me\Photos'
```

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

### Re-including a File After Exclusion

Source: https://vykar.borgbase.com/configuration

Use the '!' prefix to override an earlier exclude rule and re-include a specific file or directory. This example keeps 'important.log' even though '*.log' is excluded.

```yaml
exclude_patterns:
  - "*.log"
  - "!important.log"
```

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

### List Backups with New Docker Container

Source: https://vykar.borgbase.com/install

Runs a new Vykar container to list backups, utilizing the entrypoint and mounting the configuration.

```bash
docker run --rm \
  -v /path/to/vykar.yaml:/etc/vykar/config.yaml:ro \
  -v vykar-cache:/cache \
  ghcr.io/borgbase/vykar list
```

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

### Preview Compaction

Source: https://vykar.borgbase.com/print

Previews the repacking process for blob data, showing what would be repacked without actually reclaiming space.

```bash
vykar compact --dry-run
```

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

### Compaction Threshold Configuration

Source: https://vykar.borgbase.com/configuration

Configure the compaction threshold to trigger repackaging of repository data. This example sets the threshold to 30%, meaning repackaging will occur when unused space reaches this percentage.

```yaml
compact:
  threshold: 30
```

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

### Set Default Object Lock Retention Policy

Source: https://vykar.borgbase.com/backends

Configure a default retention rule for the bucket. This example sets a GOVERNANCE mode with a 30-day retention period, suitable for backup repositories.

```bash
aws s3api put-object-lock-configuration \
  --bucket my-backup-bucket \
  --object-lock-configuration '{ \
    "ObjectLockEnabled": "Enabled", \
    "Rule": { \
      "DefaultRetention": { \
        "Mode": "GOVERNANCE", \
        "Days": 30 \
      } \
    } \
  }'
```

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

### Linux: Before Backup Hook for Multiple WiFi Networks (NetworkManager)

Source: https://vykar.borgbase.com/recipes

Configure a `before_backup` hook on Linux using NetworkManager to allow backups on either 'HomeNetwork' or 'OfficeNetwork'.

```shell
hooks:
  before_backup: >-
    nmcli -t -f active,ssid dev wifi
    | grep -qE '^yes:(HomeNetwork|OfficeNetwork)$'
```

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

### Vykar Server Health Check Response

Source: https://vykar.borgbase.com/server-setup

Example JSON response from the Vykar server's health check endpoint, indicating the server's status and version. This confirms the server is operational.

```json
__
{"status":"ok","version":"0.1.0"}


```

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

### Run a Full Backup

Source: https://vykar.borgbase.com/backup

Backs up all configured sources to all configured repositories. Vykar preserves filesystem extended attributes by default.

```bash
vykar backup
```

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

### Health Check Vykar Server via HTTP

Source: https://vykar.borgbase.com/server-setup

Perform a health check on the Vykar server by sending an HTTP GET request to the health endpoint. This is useful for verifying the server is running and accessible.

```bash
__
# No auth required
curl http://localhost:8585/health


```

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

### Run Vykar GUI AppImage

Source: https://vykar.borgbase.com/gui

Make the AppImage executable and run it. This is for x86_64 Linux distributions with glibc 2.39+.

```bash
chmod +x vykar-gui-*-x86_64.AppImage
./vykar-gui-*-x86_64.AppImage
```

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

### Correct Exclude Pattern Anchored to Source Root

Source: https://vykar.borgbase.com/configuration

Use relative paths anchored to the source root for exclude patterns. This example shows the correct way to exclude a directory named 'TV' within the source path.

```yaml
exclude_patterns:
  - "/home/user/videos/TV"
sources:
  - path: "/home/user/videos"
    exclude:
      - "/TV"
```

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

### Run Vykar Daemon in Docker

Source: https://vykar.borgbase.com/daemon

Example of running the Vykar daemon in a Docker container. It maps port 7575, sets environment variables for the HTTP listen address and public access, and mounts the configuration directory read-only.

```bash
docker run -d --name vykar-daemon \
  -p 7575:7575 \
  -e VYKAR_HTTP_LISTEN=0.0.0.0:7575 \
  -e VYKAR_HTTP_ALLOW_PUBLIC=1 \
  -v /etc/vykar:/etc/vykar:ro \
  vykar
```

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

### Listing and Restoring Snapshots by Label

Source: https://vykar.borgbase.com/goals

These commands show how to list recent snapshots for a specific source label and restore the latest snapshot for another. Labels help in managing and accessing backups.

```bash
__
vykar list -S databases --last 5
vykar restore --source personal latest

```

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

### List Vykar Snapshots

Source: https://vykar.borgbase.com/quickstart

List all available snapshots in the repository.

```bash
vykar list
```

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

### Snapshot Retention Policy

Source: https://vykar.borgbase.com/configuration

Define a retention policy to manage the number of snapshots kept. This example specifies keeping 7 daily, 4 weekly, and 6 monthly snapshots, plus all snapshots within the last 2 days.

```yaml
retention:
  keep_daily: 7
  keep_weekly: 4
  keep_monthly: 6
  keep_within: "2d"
```

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

### List Snapshot Files with Details

Source: https://vykar.borgbase.com/print

Displays detailed information about files within a snapshot, including type, permissions, size, and modification time.

```bash
vykar snapshot list a1b2c3d4 --long
```

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

### Local Repository Configuration

Source: https://vykar.borgbase.com/configuration

Configure a local backup repository by specifying its label and file path.

```yaml
__
repositories:
  - label: "local"
    url: "/backups/repo"
    # Windows: url: 'D:\\Backups\\repo'
```

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

### Nginx Reverse Proxy Configuration for Vykar Server

Source: https://vykar.borgbase.com/server-setup

Configure nginx as a reverse proxy to handle TLS termination and allow large request bodies for the Vykar server. This setup is crucial for secure external access and handling large backup files.

```nginx
__
server {
    listen 443 ssl http2;
    server_name backup.example.com;

    ssl_certificate     /etc/letsencrypt/live/backup.example.com/fullchain.pem;
    ssl_certificate_key /etc/letsencrypt/live/backup.example.com/privkey.pem;

    client_max_body_size    600m;
    proxy_request_buffering off;

    location / {
        proxy_pass http://127.0.0.1:8585;
    }
}


```

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

### Systemd Unit File for Vykar Daemon

Source: https://vykar.borgbase.com/daemon

This is the systemd unit file configuration for the Vykar backup daemon. It specifies service dependencies, execution commands, security hardening options, and installation targets. Ensure local repository paths are added to `ReadWritePaths` if used.

```systemd
[Unit]
Description=Vykar Backup Daemon
After=network-online.target
Wants=network-online.target

[Service]
Type=simple
ExecStartPre=+/bin/mkdir -p %h/.cache/vykar %h/.config/vykar
ExecStart=/usr/local/bin/vykar --config /etc/vykar/config.yaml daemon
ExecReload=/bin/kill -HUP $MAINPID
Restart=on-failure
RestartSec=60

# Security hardening
NoNewPrivileges=true
ProtectSystem=strict
ProtectHome=read-only
ReadWritePaths=%h/.cache/vykar %h/.config/vykar
# If backing up to a local path, add it here too, e.g.:
# ReadWritePaths=%h/.cache/vykar %h/.config/vykar /mnt/backup/vykar
PrivateTmp=true
PrivateDevices=true

# Passphrase via environment file (optional)
# EnvironmentFile=/etc/vykar/env

[Install]
WantedBy=multi-user.target

```

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

### Apprise Docker Image

Source: https://vykar.borgbase.com/print

Use the 'latest-apprise' Docker tag if you are using the Docker image, as it comes with Apprise pre-installed.

```bash
latest-apprise
```

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

### Configure S3-Compatible Backend (Custom Endpoint)

Source: https://vykar.borgbase.com/print

Store backups in an S3-compatible service like MinIO. The endpoint is the URL host, and the first path segment is the bucket.

```yaml
__
repositories:
  - label: "minio"
    url: "s3://minio.local:9000/my-bucket/vykar"
    region: "us-east-1"
    access_key_id: "minioadmin"
    secret_access_key: "minioadmin"


```

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

### Configure Simple Sources

Source: https://vykar.borgbase.com/backup

Defines sources as a list of paths. Multiple simple string entries are grouped into one source, creating a single snapshot for the group.

```yaml
sources:
  - /home/user/documents
  - /home/user/photos
```

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

### Configuration Options for Source Directories

Source: https://vykar.borgbase.com/configuration

This snippet shows various configuration options for source directories, including skipping directories containing marker files, controlling filesystem traversal, respecting .gitignore, and handling extended attributes.

```yaml
exclude_if_present:
  - ".nobackup"
  - "CACHEDIR.TAG"
one_file_system: false
git_ignore: false
xattrs:
  enabled: true
```

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

### Backup SQLite Database with Hooks

Source: https://vykar.borgbase.com/print

Use hooks to back up an SQLite database. The `before` hook creates a backup, and the `after` hook cleans up the backup directory.

```yaml
__
sources:
  - label: app-database
    path: /var/backups/sqlite
    hooks:
      before: >
        mkdir -p /var/backups/sqlite &&
        sqlite3 /var/lib/myapp/app.db ".backup '/var/backups/sqlite/app.db'"
      after: "rm -rf /var/backups/sqlite"

```

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

### Backup Session Workflow

Source: https://vykar.borgbase.com/print

Details the step-by-step process of a backup session, from session ID generation to item serialization and snapshot creation.

```text
__
generate session_id (128-bit random hex)
register_session() → write sessions/<session_id>.json, probe for active lock
open repo (full index loaded once)
begin_write_session(session_id) → journal key = sessions/<session_id>.index
  → prune stale local file-cache entries
  → recover own sessions/<session_id>.index if present (batch-verify packs, promote into dedup structures)
  → enable tiered dedup mode (mmap cache + xor filter, fallback to dedup HashMap)
  → derive upload/pipeline limits from `limits.connections` + `limits.threads`
  → execute `command_dumps` first:
    → stream each command's stdout directly into chunk storage
    → add virtual items under `vykar-dumps/` to the item stream
    → abort backup on non-zero exit or timeout
  → walk sources with excludes + one_file_system + exclude_if_present
    → cache-hit path: reuse cached ChunkRefs and bump refs
    → cache-miss path:
      → pipeline path (if effective worker threads > 1):
        → walk emits regular files and segmented large files
          (segmentation applies when file_size > 64 MiB;
           segment size is min(64 MiB, pipeline_buffer_bytes))
        → worker threads read/chunk/hash and classify each chunk:
          - xor prefilter says "maybe present" → hash-only chunk
          - xor prefilter miss (or no filter) → compress + encrypt prepacked chunk
        → sequential consumer validates segment order, performs dedup checks
          (persistent dedup tier + pending pack writers), commits new chunks,
          and handles xor false positives via inline transform
        → ByteBudget enforces pipeline_buffer_bytes as a hard in-flight memory cap
          (64 MiB × effective threads, clamped to 64 MiB..1 GiB)
      → sequential fallback path (effective worker threads == 1)
  → serialize items incrementally into item-stream chunks (tree packs)
  → pack SnapshotMeta in memory (do not write snapshots/<id> yet)

```
Tokens:
Raw