Plakar

https://docs.plakar.io/
Admin
Plakar is the open-source standard for efficient, secure backups, while Plakar Control Plane...
Tokens:172,487
Snippets:2,836
Trust Score:7.5
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install a Pre-built Package

Source: https://docs.plakar.io/docs/community/main/guides/managing-packages

Installs a package from the official plugin registry. Ensure you are logged in first. Example shows installing the S3 integration.

```bash
$ plakar pkg add s3
```

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

### Install Go Kloset SDK

Source: https://docs.plakar.io/docs/community/main/references/sdk

Install the Go Kloset SDK using the go get command. This is the first step to building Plakar integrations.

```bash
$ go get github.com/PlakarKorp/go-kloset-sdk
```

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

### Install Pre-Built Packages

Source: https://docs.plakar.io/docs/community/main/guides/logging-in-to-plakar

Install pre-built integration packages hosted on Plakar's servers after logging in. Examples include 's3', 'sftp', and 'rclone'.

```bash
$ plakar pkg add s3
$ plakar pkg add sftp
$ plakar pkg add rclone
```

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

### Backup Using Custom Connector

Source: https://docs.plakar.io/docs/community/main/guides/creating-a-custom-connector

Perform a backup using your newly installed custom connector. The path after 'example://' might be ignored if the connector uses a hardcoded path.

```bash
plakar at /var/backups backup example://

```

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

### Install Kapsul

Source: https://docs.plakar.io/posts/2025-07-07/kapsul-a-tool-to-create-and-manage-deduplicated-compressed-and-encrypted-ptar-vaults

Install the Kapsul tool using the Go package manager. Ensure you have Go installed.

```bash
$ go install github.com/PlakarKorp/kapsul@v0.0.0-beta.10
go: downloading github.com/PlakarKorp/kapsul v0.0.0-beta.10
```

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

### Install Plakar v1.1.0-beta

Source: https://docs.plakar.io/posts/2026-01-26/plakar-v1.1.0-beta-the-foundation-for-whats-next

Use this command to install the beta version of Plakar. Ensure you have Go installed and configured.

```bash
$ go install github.com/PlakarKorp/plakar@v1.1.0-beta.3
```

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

### Install Plakar on Backup VPS

Source: https://docs.plakar.io/docs/community/main/guides/ovhcloud/ovhcloud-as-a-dedicated-backup-server

SSH into your backup VPS and follow the Plakar Installation Guide to install the Plakar software.

```bash
ssh ubuntu@your-vps-ip
```

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

### Install the .ptar development build

Source: https://docs.plakar.io/posts/2025-06-30/technical-deep-dive-into-.ptar-replacing-.tgz-for-petabyte-scale-s3-archives

Install the latest development build of plakar using go install. Ensure you have Go installed and configured.

```bash
go install github.com/PlakarKorp/plakar@v1.0.3-devel.c7a66f1
```

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

### Install Plakar Beta

Source: https://docs.plakar.io/posts/2025-03-08/plakar-beta.4-and-upcoming-features

Installs the latest beta version of Plakar using go install. Ensure you have Go installed and configured.

```bash
$ go install github.com/PlakarKorp/plakar/cmd/plakar@v1.0.0-beta.4
```

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

### gopass Example for Passphrase Command

Source: https://docs.plakar.io/docs/community/main/guides/retrieve-passphrase-kloset-store

Example of setting the `passphrase_cmd` to use `gopass` for retrieving a store passphrase.

```bash
$ passphrase_cmd='gopass show mystore/passphrase'
```

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

### Example Import Method Implementation

Source: https://docs.plakar.io/docs/community/main/references/sdk

An example implementation of the Import method for a custom importer. It demonstrates deferring the closure of the records channel and sending a file record.

```go
func (i *MyImporter) Import(ctx context.Context, records chan<- *connectors.Record, results <-chan *connectors.Result) error {
  defer close(records)

  info, _ := os.Stat(path)
  fi := objects.FileInfo{
    Lname:    filepath.Base(path),
    Lsize:    info.Size(),
    Lmode:    info.Mode(),
    LmodTime: info.ModTime(),
    Ldev:     1,
  }

  records <- connectors.NewRecord(path, "", fi, nil, func() (io.ReadCloser, error) {
    return os.Open(path)
  })

  return nil
}
```

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

### Example of Registering an Importer

Source: https://docs.plakar.io/docs/community/main/references/sdk

An example demonstrating how to register a custom importer using its protocol name and constructor function within an init() function.

```go
func init() {
  importer.Register("myprotocol", 0, NewImporter)
}
```

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

### Install Plakar via Installer Script

Source: https://docs.plakar.io/posts/2025-06-03/plakar-v1.0.2-was-released-mostly-s3-improvements

Download and execute the installation script to install Plakar. This process includes downloading signature and release files, verifying the signature, and installing the package.

```bash
$ curl https://plakar.io/install.sh | sh
Downloading plakar 1.0.2 signature file...
Downloading plakar 1.0.2 release file...
Downloading plakar 1.0.2 public key...
Verifying plakar 1.0.2 signature...
Signature Verified
plakar-1.0.2.tar.gz: OK
Extracting plakar 1.0.2 release...
Installing plakar 1.0.2...
```

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

### Start Plakar UI on Default Store

Source: https://docs.plakar.io/docs/community/main/guides/using-plakar-ui

Run 'plakar ui' in a Kloset repository to start the UI. If no store is specified, it defaults to '~/.plakar'.

```bash
plakar at /var/backups ui
```

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

### Install PostgreSQL Client

Source: https://docs.plakar.io/docs/community/main/guides/ovhcloud/backup-ovhcloud-managed-postgres

Installs the PostgreSQL client tools required for database operations. Ensure your system's package list is updated before installation.

```bash
$ sudo apt update
$ sudo apt install postgresql-client
```

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

### Install Plakar Connector Dependencies

Source: https://docs.plakar.io/docs/community/main/guides/creating-a-custom-connector

Install the necessary Go dependencies for building Plakar connectors.

```bash
go get github.com/PlakarKorp/kloset
go get github.com/PlakarKorp/go-kloset-sdk
```

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

### Start Development Servers

Source: https://docs.plakar.io/posts/2026-05-25/plakar-ui-pnpm-turborepo

Use this command to start both application development servers in parallel. Local packages are resolved directly from the 'packages/' directory.

```bash
pnpm run dev
```

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

### Start Plakar Web UI

Source: https://docs.plakar.io/docs/community/main/quickstart/first-backup

Run this command to launch the Plakar web interface for viewing and managing your backups.

```bash
$ plakar at $HOME/backups ui
```

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

### Install WebDAV Package

Source: https://docs.plakar.io/docs/community/main/integrations/webdav

Installs the WebDAV package using pre-built binaries. Ensure you have authenticated to Plakar first.

```bash
$ plakar pkg add webdav
```

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

### Start Local MinIO Instance

Source: https://docs.plakar.io/docs/community/main/quickstart/synchronize-copies

Starts a local MinIO instance using Docker for S3-compatible storage. This instance will be accessible at http://localhost:9000.

```bash
$ docker run -d --name minio -p 9000:9000 -p 9001:9001 quay.io/minio/minio server /data --console-address ":9001"
```

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

### Install Plugin

Source: https://docs.plakar.io/docs/community/main/guides/creating-a-custom-connector

Install the packaged plugin using the 'plakar pkg add' command, followed by the .ptar filename.

```bash
plakar pkg add example-v0.1.0.ptar

```

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

### Sample recipe.yaml for 'fs' plugin

Source: https://docs.plakar.io/docs/community/main/references/commands/plakar-pkg-recipe.yaml

This is a basic example of a recipe.yaml file used to build the 'fs' plugin. It specifies the plugin name, version, and the git repository URL.

```yaml
# recipe.yaml
name: fs
version: v1.0.0
repository: https://github.com/PlakarKorp/integrations-fs
```

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

### Install Notion Package from Local Archive

Source: https://docs.plakar.io/docs/community/main/integrations/notion

Installs the Notion package from a locally built archive file. Use this after building from source.

```bash
$ plakar pkg add ./notion_v1.0.0_darwin_arm64.ptar
```

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

### Build and Install OCI Package

Source: https://docs.plakar.io/posts/2026-02-07/storing-backups-in-an-oci-registry

Build the OCI integration package from source and install the resulting ptar file.

```bash
$ plakar pkg build oci
/usr/bin/make -C /var/folders/9x/9k0f6mc10sbd0_kfx63__fvc0000gn/T/build-oci-v1.1.0-beta.4-510526837
48317f2d: OK ✓ /
48317f2d: OK ✓ /manifest.yaml
48317f2d: OK ✓ /ociStorage
Plugin created successfully: oci_v1.1.0-beta.4_darwin_arm64.ptar

$ plakar pkg add ./oci_v1.1.0-beta.4_darwin_arm64.ptar
```

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

### Install Plakar Beta

Source: https://docs.plakar.io/posts/2026-02-07/storing-backups-in-an-oci-registry

Install the beta version of Plakar required for OCI registry integration.

```bash
$ go install github.com/PlakarKorp/plakar@v1.1.0-beta.4
```

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

### Install a Specific Package Version

Source: https://docs.plakar.io/docs/community/main/guides/managing-packages

Installs a package from the official plugin registry, specifying an exact version. Ensure you are logged in first.

```bash
$ plakar pkg add s3@v1.0.0
```

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

### Install MySQL Client

Source: https://docs.plakar.io/docs/community/main/guides/exoscale/backup-exoscale-managed-mysql

Installs the MySQL client utility on Debian-based systems. This is required to interact with the MySQL database.

```bash
$ sudo apt update
$ sudo apt install mysql-client
```

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

### Install WebDAV Package from Local Archive

Source: https://docs.plakar.io/docs/community/main/integrations/webdav

Installs the WebDAV package from a locally built archive file.

```bash
$ plakar pkg add ./webdav_v1.0.0_darwin_arm64.ptar
```

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

### Verify Installation

Source: https://docs.plakar.io/docs/community/main/guides/creating-a-custom-connector

Check if your plugin is installed correctly by listing all installed packages with 'plakar pkg show'.

```bash
plakar pkg show

```

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

### Install CalDAV Package

Source: https://docs.plakar.io/docs/community/main/integrations/caldav

Installs the CalDAV package using pre-built binaries. Ensure Plakar authentication is set up prior to installation.

```bash
$ plakar pkg add caldav
```

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

### Example Exporter Export Method

Source: https://docs.plakar.io/docs/community/main/references/sdk

An example implementation of the Export method for a custom Exporter. It demonstrates deferring the closing of the results channel and processing records from the input channel.

```go
func (e *MyExporter) Export(ctx context.Context, records <-chan *connectors.Record, results chan<- *connectors.Result) error {
  defer close(results)

  for record := range records {
    if record.Reader != nil {
      // Process record content
      io.Copy(destination, record.Reader)
    }

    results <- record.Ok()
  }

  return nil
}
```

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

### Launch Plakar UI

Source: https://docs.plakar.io/posts/2025-07-17/back-up-notion-yes-you-can.

Start the Plakar graphical user interface. This provides a visual way to manage your backups and restores.

```bash
$ plakar ui
```

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

### Install Built MySQL/MariaDB Package

Source: https://docs.plakar.io/docs/community/main/integrations/mysql

Installs the MySQL/MariaDB integration package after building it from source.

```bash
$ plakar pkg add ./mysql_v1.0.0_linux_amd64.ptar
```

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

### List Installed Packages

Source: https://docs.plakar.io/docs/community/main/integrations/proxmox

Verifies the installation of the Proxmox integration package by listing all installed Plakar packages.

```bash
$ plakar pkg list

```

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

### Install SFTP Package from Local Archive

Source: https://docs.plakar.io/docs/community/main/integrations/sftp

Installs the SFTP integration package from a locally built archive file. Use this after building the package from source.

```bash
$ plakar pkg add ./sftp_v1.0.0_darwin_arm64.ptar
```

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

### Install PostgreSQL Package from Archive

Source: https://docs.plakar.io/docs/community/main/integrations/postgres

Installs the PostgreSQL package from a locally built archive file.

```bash
$ plakar pkg add ./postgresql_v1.0.0_darwin_arm64.ptar
```

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

### Start a Plakar Server Locally

Source: https://docs.plakar.io/docs/community/main/references/commands/plakar-server

Starts a Plakar server instance on the local machine. This is the default behavior when no specific address or options are provided.

```bash
$ plakar server
```

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

### Install Google Cloud Storage Package

Source: https://docs.plakar.io/docs/community/main/integrations/gcs

Installs the Google Cloud Storage package using the Plakar package manager. This is the simplest installation method for pre-built packages.

```bash
$ plakar pkg add gcs
```

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

### 1Password CLI Example for Passphrase Command

Source: https://docs.plakar.io/docs/community/main/guides/retrieve-passphrase-kloset-store

Example of setting the `passphrase_cmd` to use the 1Password CLI for retrieving a store passphrase.

```bash
$ passphrase_cmd='op read "op://Personal/mystore/password"'
```

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

### HashiCorp Vault Example for Passphrase Command

Source: https://docs.plakar.io/docs/community/main/guides/retrieve-passphrase-kloset-store

Example of setting the `passphrase_cmd` to use HashiCorp Vault CLI for retrieving a store passphrase.

```bash
$ passphrase_cmd='vault kv get -field=password secret/mystore'
```

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

### Install PostgreSQL Package

Source: https://docs.plakar.io/docs/community/main/guides/postgres/pg-base-backup

Installs the necessary PostgreSQL package for Plakar.

```bash
$ plakar pkg add postgresql
```

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

### Start Plakar Scheduler

Source: https://docs.plakar.io/docs/community/main/guides/ovhcloud/ovhcloud-as-a-dedicated-backup-server

Start the Plakar scheduler with the specified task configuration.

```bash
$ plakar scheduler start -tasks ~/scheduler.yaml
```

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

### Install etcd Package from Archive

Source: https://docs.plakar.io/docs/community/main/integrations/etcd

Installs the etcd package from a locally built archive file.

```bash
$ plakar pkg add ./etcd_v1.0.0_darwin_arm64.ptar
```

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

### Install Plakar v1.1.3

Source: https://docs.plakar.io/posts/2026-06-16/plakar-v1.1.3-is-here

Installs the Plakar binary version 1.1.3 using Go's package manager.

```bash
$ go install github.com/PlakarKorp/plakar@v1.1.3
```

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

### Install Proxmox Package from Local Archive

Source: https://docs.plakar.io/docs/community/main/integrations/proxmox

Installs the Proxmox integration package from a locally built archive file.

```bash
$ plakar pkg add ./proxmox_v1.0.0_darwin_arm64.ptar

```

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

### Build Plakar from Source

Source: https://docs.plakar.io/docs/community/main/quickstart/installation

Clone the Plakar repository and run 'make' to build the developer version from source. Ensure you have Go and make installed.

```bash
$ git clone https://github.com/PlakarKorp/plakar.git
$ cd plakar
$ make
```

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

### Install a Package from Local Archive

Source: https://docs.plakar.io/docs/community/main/guides/managing-packages

Installs a package that has been built locally from source. The archive file is generated in the current directory after a successful build.

```bash
$ plakar pkg add ./s3_v1.0.0_darwin_arm64.ptar
```

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

### List Installed Plakar Integrations

Source: https://docs.plakar.io/docs/community/main/quickstart/synchronize-copies

Confirms that the S3 integration has been successfully installed.

```bash
$ plakar pkg list
s3@v1.0.7
```

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

### Implement Custom Connector in Go

Source: https://docs.plakar.io/docs/community/main/guides/creating-a-custom-connector

This Go code defines a custom connector named 'example' that imports a single local file. It registers itself with the importer and implements the necessary methods for Plakar's connector interface.

```go
package connector

import (
	"context"
	"io"
	"os"
	"path/filepath"

	"github.com/PlakarKorp/kloset/connectors"
	"github.com/PlakarKorp/kloset/connectors/importer"
	"github.com/PlakarKorp/kloset/location"
	"github.com/PlakarKorp/kloset/objects"
)

const FILE = "/home/user/Documents/notes.md"

func init() {
	importer.Register("example", location.FLAG_LOCALFS, NewImporter)
}

type testConnector struct{}

func NewImporter(ctx context.Context, opts *connectors.Options, proto string, config map[string]string) (importer.Importer, error) {
	return &testConnector{}, nil
}

func (f *testConnector) Root() string              { return filepath.Dir(FILE) }
func (f *testConnector) Origin() string            { return "localhost" }
func (f *testConnector) Type() string              { return "example" }
func (f *testConnector) Flags() location.Flags     { return location.FLAG_LOCALFS }
func (f *testConnector) Ping(_ context.Context) error  { return nil }
func (f *testConnector) Close(_ context.Context) error { return nil }

func (f *testConnector) Import(ctx context.Context, records chan<- *connectors.Record, results <-chan *connectors.Result) error {
	defer close(records)

	info, err := os.Stat(FILE)
	if err != nil {
		return err
	}

	fi := objects.FileInfo{
		Lname:    filepath.Base(FILE),
		Lsize:    info.Size(),
		Lmode:    info.Mode(),
		LmodTime: info.ModTime(),
		Ldev:     1,
	}

	records <- connectors.NewRecord(FILE, "", fi, nil, func() (io.ReadCloser, error) {
		return os.Open(FILE)
	})

	return nil
}

```

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

### Install Go CDC Chunkers v1.1.0

Source: https://docs.plakar.io/posts/2026-06-14/go-cdc-chunkers-v1.1.0-faster-leaner-and-provably-correct

Use this command to get the latest version of the Go CDC Chunkers library.

```bash
go get github.com/PlakarKorp/go-cdc-chunkers@v1.1.0
```

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

### Start Plakar HTTP Server

Source: https://docs.plakar.io/docs/community/main/guides/serving-a-kloset-store-over-the-network

Expose a local Kloset Store located at `/var/backups` over HTTP. By default, it listens on `http://localhost:9876`.

```bash
$ plakar at /var/backups server
```

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

### Install Notion Package

Source: https://docs.plakar.io/docs/community/main/integrations/notion

Installs the Notion package using the Plakar package manager. This is the recommended method for most users.

```bash
$ plakar pkg add notion
```

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

### Add a Plakar Package

Source: https://docs.plakar.io/posts/2025-09-16/release-v1.0.4-a-new-milestone-for-plakar

Use this command to install integrations as plugins. For example, to add S3 support, use 'plakar pkg add s3'.

```bash
plakar pkg add <integration>
```

```bash
plakar pkg add s3
```

```bash
plakar pkg add sftp
```

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

### Create a Backup with Plakar

Source: https://docs.plakar.io/posts/2025-02-26/plakar-beta-release

Use this command to create a backup. Ensure Plakar is installed and configured.

```bash
plakar backup
```

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

### Install MySQL Package

Source: https://docs.plakar.io/docs/community/main/guides/mysql/sqldump

Installs the necessary MySQL package for Plakar. This is a prerequisite for using the MySQL/MariaDB connectors.

```bash
$ plakar pkg add mysql
```

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

### Install Azure Blob Storage Package from Archive

Source: https://docs.plakar.io/docs/community/main/integrations/azblob

Installs the Azure Blob Storage package from a local archive file.

```bash
$ plakar pkg add ./azblob_v1.0.0_darwin_arm64.ptar
```

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

### Register, Initialize, and Backup to GCS Store (Storage Connector)

Source: https://docs.plakar.io/docs/community/main/integrations/gcs

Registers Google Cloud Storage as a Kloset store backend, initializes it, and performs a backup. Replace 'bucket_name' and '<PATH_TO_CREDENTIALS_FILE>' with your specific details.

```bash
$ plakar store add my-gcs-store \
  gcs://bucket_name \
  credentials_file=<PATH_TO_CREDENTIALS_FILE>

$ plakar at "@my-gcs-store" create
$ plakar at "@my-gcs-store" backup /var/www
```

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

### Install SFTP Integration for Plakar

Source: https://docs.plakar.io/docs/community/main/guides/exoscale/exoscale-compute-as-a-dedicated-backup-server

Installs the SFTP integration package for Plakar, enabling backups from source servers via SFTP.

```bash
$ plakar pkg add sftp
```

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

### Install Plakar via Go

Source: https://docs.plakar.io/posts/2025-06-03/plakar-v1.0.2-was-released-mostly-s3-improvements

Use this command to install the latest Plakar version using the Go package manager.

```bash
$ go install github.com/PlakarKorp/plakar@v1.0.2
```

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

### Start Temporary Database Container

Source: https://docs.plakar.io/docs/control-plane/administration/backup-and-restore/restore

Creates a temporary PostgreSQL container on a dedicated network to receive the restored database dumps.

```bash
docker network create restore-net
docker run -d --rm -ti -v /data/database_runtime:/var/lib/postgresql/data -e POSTGRES_PASSWORD=postgres --name restore-db --network restore-net postgres:16
sleep 5
```

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

### Start Local OCI Registry

Source: https://docs.plakar.io/docs/community/main/integrations/oci

Starts a local OCI-compliant registry using Docker for testing purposes. This registry will be accessible at `localhost:5000`.

```bash
docker run -d --name oci-registry \
  -p 5000:5000 \
  -v $(pwd)/registry-data:/var/lib/registry \
  registry:2
```

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

### Create a Simple Backup with Plakar

Source: https://docs.plakar.io/docs/community/main/quickstart/first-backup

Use this command to back up a specified directory to a designated Kloset Store. Replace the example paths with your desired locations.

```bash
$ plakar at $HOME/backups backup $HOME/Documents
```

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

### Install etcd Package

Source: https://docs.plakar.io/docs/community/main/integrations/etcd

Installs the etcd package using the Plakar package manager. Requires Plakar authentication.

```bash
$ plakar pkg add etcd
```

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

### Initialize OCI Store and Backup

Source: https://docs.plakar.io/docs/community/main/integrations/oci

Initializes a new Plakar Kloset store in an OCI registry and performs a backup. Replace `localhost:5000/my-org/plakar-store` with your registry details.

```bash
plakar at oci://localhost:5000/my-org/plakar-store create
plakar at oci://localhost:5000/my-org/plakar-store backup /var/www
```

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

### Initialize and Backup with Azure Blob Storage Connector

Source: https://docs.plakar.io/docs/community/main/integrations/azblob

Initializes the Kloset store using Azure Blob Storage and performs a backup of local data.

```bash
$ plakar at "@my-az-store" create
$ plakar at "@my-az-store" backup /var/www
```

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

### Install Azure Blob Storage Package

Source: https://docs.plakar.io/docs/community/main/integrations/azblob

Installs the Azure Blob Storage package using the Plakar package manager.

```bash
$ plakar pkg add azblob
```

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

### Verify Plakar Installation

Source: https://docs.plakar.io/docs/community/main/quickstart/installation

Run the 'plakar version' command to verify that the installation was successful and to check the installed version number.

```bash
$ plakar version
```

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

### Install Kubernetes Package from Local Archive

Source: https://docs.plakar.io/docs/community/main/integrations/kubernetes

Installs the Kubernetes integration package from a locally built archive file. This follows a source build process.

```bash
plakar pkg add ./k8s_v1.1.0-beta.6_darwin_arm64.ptar
```

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

### Install Kubernetes Package

Source: https://docs.plakar.io/docs/community/main/integrations/kubernetes

Installs the Kubernetes integration package using the Plakar package manager. Requires Plakar v1.1.0-beta or later.

```bash
plakar pkg add k8s
```

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

### Install Plakar S3 Integration

Source: https://docs.plakar.io/docs/community/main/quickstart/synchronize-copies

Installs the S3 integration package for Plakar. Use the -u flag to update if already installed.

```bash
$ plakar pkg add s3
```

```bash
$ plakar pkg add -u s3
```

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

### Build Plugin with Makefile

Source: https://docs.plakar.io/docs/community/main/guides/creating-a-custom-connector

Use this Makefile to build your Go plugin. Ensure the output executable name matches your plugin's entrypoint.

```makefile
build:
	go build -o example-importer ./importer

```

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

### Verify OCI Registry Installation

Source: https://docs.plakar.io/docs/community/main/integrations/oci

Verifies that the OCI Registry package has been successfully installed. This command lists all installed Plakar packages.

```bash
plakar pkg list
```

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

### Install Rclone Plakar Package

Source: https://docs.plakar.io/docs/community/main/integrations/dropbox

Installs the Rclone package for Plakar. Ensure Rclone is installed and configured with a Dropbox remote beforehand.

```bash
$ plakar pkg add rclone
```

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

### Install Built Proxmox Plakar Package

Source: https://docs.plakar.io/posts/2026-03-16/backing-up-proxmox-with-plakar-a-third-party-integration-built-in-a-few-days

Installs the Proxmox integration package after it has been built locally. Use the path to the generated .ptar file.

```bash
$ plakar pkg add ./proxmox_v1.1.0-rc.1_darwin_arm64.ptar
```

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

### Create a Snapshot on a Remote Kloset Store

Source: https://docs.plakar.io/docs/community/main/references/commands/plakar

Use this command to create a backup snapshot of the current directory and upload it to the specified remote Kloset store (@mys3bucket in this example).

```bash
$ plakar at @mys3bucket backup
```

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

### Start a Plakar Server on a Specific Address and Port

Source: https://docs.plakar.io/docs/community/main/references/commands/plakar-server

Starts a Plakar server instance listening on a specific IP address and port. This is useful for controlling network access.

```bash
$ plakar server -listen 127.0.0.1:12345
```

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

### Start Plakar UI Without Spawning Browser

Source: https://docs.plakar.io/docs/community/main/guides/using-plakar-ui

Use the '-no-spawn' flag to start the UI server without automatically opening the browser.

```bash
plakar at /var/backups ui -no-spawn
```

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

### Configure SFTP Storage Connector

Source: https://docs.plakar.io/docs/community/main/integrations/sftp

Configure, initialize, list, check, and backup to an SFTP storage connector. Use this to host Kloset stores on SFTP servers.

```bash
# Configure the Kloset store
$ plakar store add sftp_store sftp://sftp-prod/backups

# Initialize the Kloset store
$ plakar at "@sftp_store" create

# List snapshots in the Kloset store
$ plakar at "@sftp_store" ls

# Verify integrity of the Kloset store
$ plakar at "@sftp_store" check

# Backup a local folder to the Kloset store
$ plakar at "@sftp_store" backup /etc

# Backup a source configured in Plakar to the Kloset store
$ plakar at "@sftp_store" backup "@my_source"
```

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

### Install Plakar Development Release

Source: https://docs.plakar.io/posts/2025-07-15/go-kloset-sdk-is-live

Install the latest development release of Plakar to access the new integration features. This command installs version v1.0.3-devel.455ca52.

```bash
$ go install github.com/PlakarKorp/plakar@v1.0.3-devel.455ca52
```

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

### Run Backup from Nextcloud Source

Source: https://docs.plakar.io/docs/community/main/integrations/webdav

Initiates a backup from the registered Nextcloud source to a Kloset store.

```bash
$ plakar at /var/backups backup "@nextcloud"
```

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

### Install OCI Registry Package

Source: https://docs.plakar.io/docs/community/main/integrations/oci

Installs the OCI Registry package using the Plakar package manager. This is the simplest installation method for common platforms.

```bash
plakar pkg add oci
```

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

### Install Built Package Archive

Source: https://docs.plakar.io/docs/community/main/integrations/gcs

Installs a locally built Google Cloud Storage package archive. Replace the filename with the actual archive name generated during the build process.

```bash
$ plakar pkg add ./gcs_v1.0.0_darwin_arm64.ptar
```

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

### Start a HTTPS Plakar Server

Source: https://docs.plakar.io/docs/community/main/references/commands/plakar-server

Starts a Plakar server instance with HTTPS enabled, listening on a specific address and port. Requires certificate and key files for secure connections.

```bash
$ plakar server -listen backup.example.com:12345 -cert fullchain.pem -key privkey.pem
```

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

### Initialize Kloset Store on Exoscale SOS

Source: https://docs.plakar.io/docs/community/main/guides/exoscale/exoscale-compute-as-a-dedicated-backup-server

Initializes a new Plakar Kloset store on the previously configured Exoscale SOS backup location.

```bash
$ plakar at "@exoscale-sos-backups" create
```

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

### Install CalDAV Package from Archive

Source: https://docs.plakar.io/docs/community/main/integrations/caldav

Installs the CalDAV package from a locally built archive. Replace the filename with the actual archive name generated during the build process.

```bash
$ plakar pkg add ./caldav_v1.0.0_darwin_arm64.ptar
```

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

### Plakar Source Configuration Example

Source: https://docs.plakar.io/docs/community/main/guides/importing-configurations

Defines two named source configurations: 'myapp' for local directory backup with exclusions and 'database' for a PostgreSQL database. Exclusions can be comma-separated.

```yaml
myapp:
  location: /var/www/myapp
  excludes: "*.log,*.tmp"

database:
  location: postgresql://user:pass@localhost/mydb
```

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

### Configure Rclone for Dropbox

Source: https://docs.plakar.io/docs/community/main/integrations/dropbox

Run this command to start the Rclone configuration process for Dropbox. Follow the prompts to set up a new remote.

```bash
$ rclone config
```

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

### Install Built OCI Registry Package

Source: https://docs.plakar.io/docs/community/main/integrations/oci

Installs a locally built OCI Registry package archive. The archive name will vary based on the platform and version.

```bash
plakar pkg add ./oci_v1.0.0_darwin_arm64.ptar
```

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

### Run Backup to WebDAV Source

Source: https://docs.plakar.io/docs/community/main/integrations/webdav

Initiates a backup from the registered WebDAV source to a Kloset store.

```bash
$ plakar at /var/backups backup "@my-webdav"
```

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

### Initialize Plakar Kloset Store on Rclone

Source: https://docs.plakar.io/docs/community/main/integrations/dropbox

Create a new Kloset store on the configured Rclone remote. The '@mydrive' syntax refers to the imported Rclone remote.

```bash
# Initialize the Kloset store
$ plakar at "@mydrive" create
```

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

### Install Plakar Development Release

Source: https://docs.plakar.io/posts/2025-07-17/back-up-notion-yes-you-can.

Install the latest development release of Plakar to enable the Notion backup integration. This command fetches the specified version from GitHub.

```bash
$ go install github.com/PlakarKorp/plakar@v1.0.3-devel.889b4b6
```

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

### Store Interface Methods

Source: https://docs.plakar.io/docs/community/main/references/sdk

Defines the methods available for the Store interface. These include methods for creating, opening, pinging, retrieving origin, type, root, flags, mode, size, listing, putting, getting, deleting, and closing the storage.

```go
type Store interface {
  Create(ctx context.Context, config []byte) error
  Open(ctx context.Context) ([]byte, error)
  Ping(ctx context.Context) error

  Origin() string
  Type() string
  Root() string
  Flags() location.Flags

  Mode(ctx context.Context) (Mode, error)
  Size(ctx context.Context) (int64, error)
  List(ctx context.Context, StorageResource) ([]objects.MAC, error)
  Put(ctx context.Context, StorageResource, objects.MAC, io.Reader) (int64, error)
  Get(ctx context.Context, StorageResource, objects.MAC, *Range) (io.ReadCloser, error)
  Delete(ctx context.Context, StorageResource, objects.MAC) error

  Close(ctx context.Context) error
}
```

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

### Install a Plakar Plugin

Source: https://docs.plakar.io/docs/community/main/references/commands/plakar-pkg-add

Adds a local or remote plugin. If the plugin name matches a local file, it's installed directly. Otherwise, it's treated as a recipe name and downloaded from the Plakar plugin server.

```bash
plakar pkg add plugin ...
```

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

### Backup to Rclone-hosted Kloset Store

Source: https://docs.plakar.io/docs/community/main/integrations/googledrive

Examples of backing up local directories or Plakar sources to a Kloset store hosted on an Rclone remote. Ensure the store is initialized and accessible.

```bash
$ plakar at "@mydrive" backup /etc
$ plakar at "@mydrive" backup "@my_source"
```

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

### Install Proxmox Package

Source: https://docs.plakar.io/docs/community/main/integrations/proxmox

Installs the Proxmox integration package using the Plakar package manager.

```bash
$ plakar pkg add proxmox

```

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

### Create a Kloset store using the default location

Source: https://docs.plakar.io/docs/community/main/guides/create-kloset-repository

If no path is specified, `plakar create` defaults to using `~/.plakar` for the store location.

```bash
$ plakar create
```

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

### Vault Path Adjustment Example

Source: https://docs.plakar.io/docs/control-plane/infrastructure/secret-providers/vault

Shows how to adjust a Vault configuration path by removing the 'data' section and appending the desired field.

```text
#access_key
```

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

### Start Plakar UI on Specific Address and Port

Source: https://docs.plakar.io/docs/community/main/guides/using-plakar-ui

Specify a custom address and port for the UI to listen on using the '-addr' flag.

```bash
plakar at /var/backups ui -addr localhost:9090
```

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

### List Installed Packages

Source: https://docs.plakar.io/docs/community/main/guides/managing-packages

Use this command to view all packages currently installed in your Plakar environment.

```bash
$ plakar pkg list
```

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

### Import Destination Configurations from YAML File

Source: https://docs.plakar.io/docs/community/main/guides/importing-configurations

Import destination configurations from a YAML file. This is useful for replicating or migrating destination setups.

```bash
$ plakar destination import -config my-destinations.yaml
```

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

### Log in using Email

Source: https://docs.plakar.io/docs/community/main/guides/logging-in-to-plakar

Initiate login with your email address. Replace 'myemail@domain.com' with your actual email.

```bash
$ plakar login -email myemail@domain.com
```

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

### Add MySQL Source and Backup

Source: https://docs.plakar.io/docs/community/main/integrations/mysql

Examples of adding MySQL sources to Plakar for backup. This includes backing up a single database, all databases, or schema only.

```bash
# Back up a single database
$ plakar source add mydb mysql://dbuser:secret@db.example.com/mydb
$ plakar at /var/backups backup "@mydb"
```

```bash
# Back up all databases
$ plakar source add alldb mysql://root:secret@db.example.com
$ plakar at /var/backups backup "@alldb"
```

```bash
# Schema only
$ plakar source add mydb mysql://dbuser:secret@db.example.com/mydb \
  no_data=true
$ plakar at /var/backups backup "@mydb"
```

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

### Creating a .tgz Archive

Source: https://docs.plakar.io/posts/2025-06-30/technical-deep-dive-into-.ptar-replacing-.tgz-for-petabyte-scale-s3-archives

A common command-line example for creating a gzipped tar archive. This is the traditional method that .ptar aims to improve upon for large-scale storage.

```bash
tar -czf archive.tgz /some/folder
```

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

### Vault Path Format Example

Source: https://docs.plakar.io/docs/control-plane/infrastructure/secret-providers/vault

Illustrates the required format for referencing secrets stored in HashiCorp Vault, including the secret engine, path, and specific field.

```text
{secret_engine}/{path}#{field}
```

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

### Initialize and Manage Kloset Store on Rclone

Source: https://docs.plakar.io/docs/community/main/integrations/googledrive

Commands to initialize, list, and check the integrity of a Kloset store hosted on an Rclone remote. Assumes the Rclone remote is already configured.

```bash
$ plakar at "@mydrive" create
$ plakar at "@mydrive" ls
$ plakar at "@mydrive" check
```

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

### Install a Specific Version of a Plakar Plugin

Source: https://docs.plakar.io/docs/community/main/references/commands/plakar-pkg-add

Installs a specific version of a plugin by using the name@version syntax.

```bash
plakar pkg add plugin@version ...
```

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

### Update Plakar Plugins

Source: https://docs.plakar.io/docs/community/main/references/commands/plakar-pkg-add

Updates specific installed plugins. If no plugins are specified, it attempts to update all installed plugins.

```bash
plakar pkg add -u plugin ...
```

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

### Initialize Plakar Kloset Store on Proton Drive

Source: https://docs.plakar.io/docs/community/main/integrations/protondrive

Create a new Kloset store on the Rclone remote configured for Proton Drive. The '@mydrive' notation refers to the imported Rclone storage.

```bash
$ plakar at "@mydrive" create
```

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

### Import rclone Store Configurations

Source: https://docs.plakar.io/docs/community/main/guides/importing-configurations

Import rclone store configurations directly into Plakar. This avoids manual credential duplication by leveraging existing rclone remote setups.

```bash
$ rclone config show -secrets | plakar store import -rclone koofr
```

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

### Build Google Cloud Storage Package from Source

Source: https://docs.plakar.io/docs/community/main/integrations/gcs

Builds the Google Cloud Storage package from source. This is useful when pre-built packages are unavailable or customization is needed. Ensure you have a compatible Go toolchain installed.

```bash
$ plakar pkg build gcs
```

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

### Plakar Backup with Environment Variables

Source: https://docs.plakar.io/docs/community/main/integrations/postgres

Example of adding a PostgreSQL RDS source using environment variables for AWS credentials and then performing a backup. This method is suitable for local testing.

```bash
export AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE
export AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
export AWS_REGION=eu-west-3

$ plakar source add myrds \
  postgres+aws://myuser@mydb.cluster-xyz.eu-west-3.rds.amazonaws.com/myapp \
  region=eu-west-3 ssl_mode=require
$ plakar at /var/backups backup "@myrds"
```

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

### Plakar Store Configuration Example

Source: https://docs.plakar.io/docs/community/main/guides/importing-configurations

Defines two named store configurations: 'mystorage' for S3 and 'localbackup' for local storage. Ensure S3 credentials are provided for remote storage.

```yaml
mystorage:
  location: s3://mybucket
  access_key: myaccesskey
  secret_access_key: mysecretkey

localbackup:
  location: /var/backups
```

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

### Build WebDAV Package from Source

Source: https://docs.plakar.io/docs/community/main/integrations/webdav

Builds the WebDAV package from source code. Requires a compatible Go toolchain.

```bash
$ plakar pkg build webdav
```

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

### Initialize Kloset Store via HTTP

Source: https://docs.plakar.io/docs/community/main/integrations/http

Initializes a Kloset store at a specified HTTP endpoint. The `location` option is required.

```bash
# Initialize a Kloset store at the HTTP endpoint
$ plakar at http://example.com/data create
```

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

### Run PostgreSQL with Qcow2 Overlay

Source: https://docs.plakar.io/posts/2026-01-11/researching-a-postgresql-viewer-for-plakar

Launches a PostgreSQL Docker container, mounting the qcow2 overlay filesystem as its data directory. This demonstrates PostgreSQL operating with block-level storage.

```bash
$ docker run --name pg --rm -ti -v ./mnt:/var/lib/postgresql/data postgres
```

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

### Go Entrypoint for Importer Connector

Source: https://docs.plakar.io/docs/community/main/guides/creating-a-custom-connector

Sets up the main entrypoint for an importer connector using the Plakar SDK. This function initializes the importer with provided arguments and a constructor for the custom importer.

```go
package main

import (
	"os"

	sdk "github.com/PlakarKorp/go-kloset-sdk"
	connector "github.com/yourorg/plakar-myimporter"
)

func main() {
	sdk.EntrypointImporter(os.Args, connector.NewImporter)
}
```

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

### Add and Create a Kloset Store

Source: https://docs.plakar.io/docs/community/main/guides/setup-scheduler-daily-backups

Configure a Plakar store with a passphrase and then create the store. This is a prerequisite for scheduling backups.

```bash
$ plakar store add mybackups /var/backups passphrase=mysuperpassphrase
$ plakar at "@mybackups" create
```

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

### Show installed plugins

Source: https://docs.plakar.io/docs/community/main/references/commands/plakar-pkg-rm

Lists the currently installed Plakar plugins. This is often used before removing a plugin to confirm its name.

```bash
$ plakar pkg show
```

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

### Manage systemd Timers and Services

Source: https://docs.plakar.io/docs/community/main/guides/setup-scheduler-daily-backups

Commands to reload systemd, enable and start the timer, inspect timer status, view service logs, and manually trigger a service run for testing.

```bash
sudo systemctl daemon-reload
sudo systemctl enable --now plakar-backup.timer
```

```bash
systemctl list-timers plakar-backup.timer   # see the next run time
```

```bash
journalctl -u plakar-backup.service         # read the backup logs
```

```bash
sudo systemctl start plakar-backup.service  # trigger a run immediately to test
```

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

### Build a Specific Release Version

Source: https://docs.plakar.io/docs/community/main/quickstart/installation

To build a specific release version, fetch all tags, checkout the desired tag, and then run 'make'.

```bash
$ git fetch --tags
$ git checkout tags/v1.1.3
$ make
```

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

### Build a Package from Source

Source: https://docs.plakar.io/docs/community/main/guides/managing-packages

Builds a package locally from its source code. This requires a working Go toolchain and 'make'. It does not require you to be logged into Plakar.

```bash
$ plakar pkg build s3
```

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

### Upgrade All Installed Packages

Source: https://docs.plakar.io/docs/community/main/guides/managing-packages

Upgrades all packages currently installed in Plakar to their latest available versions. Existing configurations are preserved.

```bash
$ plakar pkg add -u
```

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

### Create Overlay Qcow2 Image with Backing Storage

Source: https://docs.plakar.io/posts/2026-01-11/researching-a-postgresql-viewer-for-plakar

Creates an overlay qcow2 image that uses the previously created base image as its backing file. This enables block-level copy-on-write.

```bash
$ qemu-img create -f qcow2 -b base.qcow2 -F qcow2 overlay.qcow2
$ qemu-nbd --connect /dev/nbd0 ./overlay.qcow2
$ mount /dev/nbd0 ./mnt
```

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

### Log in using GitHub

Source: https://docs.plakar.io/docs/community/main/guides/logging-in-to-plakar

Use this command to initiate the login process via GitHub authentication.

```bash
$ plakar login -github
```

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

### Sample manifest.yaml for 'fs' plugin

Source: https://docs.plakar.io/docs/community/main/references/commands/plakar-pkg-manifest.yaml

This is a sample manifest.yaml file used to package the 'fs' plugin. It includes details like name, display name, description, homepage, license, tags, API version, plugin version, and connector configurations.

```yaml
# manifest.yaml
name: fs
display_name: file system connector
description: file storage but as external plugin
homepage: https://github.com/PlakarKorp/integrations/fs
license: ISC
tags: [ fs, filesystem, "local files" ]
api_version: 1.0.0
version: 1.0.0
connectors:
- type: importer
  executable: fs-importer
  protocols: [fs]
- type: exporter
  executable: fs-exporter
  protocols: [fs]
- type: storage
  executable: fs-store
  protocols: [fs]

```

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

### Install Rclone Plakar Package from Archive

Source: https://docs.plakar.io/docs/community/main/integrations/dropbox

Installs the Rclone package from a locally built archive file. Use this after building the package from source.

```bash
$ plakar pkg add ./rclone_v1.0.0_darwin_arm64.ptar
```

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

### View Plakar Help

Source: https://docs.plakar.io/docs/community/main/quickstart/synchronize-copies

Run this command to see all available commands and options for Plakar.

```bash
plakar help
```

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

### Execute Build Command

Source: https://docs.plakar.io/docs/community/main/guides/creating-a-custom-connector

Run the 'make build' command to compile your plugin according to the Makefile.

```bash
make build

```

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

### Create a Local Kloset Store

Source: https://docs.plakar.io/docs/community/main/quickstart/first-backup

Use this command to create a local Kloset Store on your filesystem. This location will store your backup snapshots. Ensure you choose a secure and appropriate location for your backups.

```bash
$ plakar at $HOME/backups create
```

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

### Create Snapshot with Tags

Source: https://docs.plakar.io/docs/community/main/references/commands/plakar-backup

Create a snapshot of the current directory and apply tags for organization. Use this when you need to categorize backups with specific labels.

```bash
$ plakar backup -tag daily-backup,production
```

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

### Build MySQL/MariaDB Package from Source

Source: https://docs.plakar.io/docs/community/main/integrations/mysql

Builds the MySQL/MariaDB integration package from source. Requires a compatible Go toolchain.

```bash
$ plakar pkg build mysql
```

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

### Install Plakar Beta Version

Source: https://docs.plakar.io/posts/2026-03-16/backing-up-proxmox-with-plakar-a-third-party-integration-built-in-a-few-days

Installs the latest beta version of Plakar, required for the Proxmox integration. Ensure you are using version v1.1.0-beta.7 or later.

```bash
$ go install github.com/PlakarKorp/plakar@v1.1.0-beta.7
```

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

### Test Manual Backup

Source: https://docs.plakar.io/docs/community/main/guides/exoscale/exoscale-compute-as-a-dedicated-backup-server

Run a manual backup to verify the configuration with Exoscale SOS. Supports single or multiple sources.

```bash
# Single source
$ plakar at "@exoscale-sos-backups" backup "@web-server-1"

# Multiple sources
$ plakar at "@exoscale-sos-backups" backup "@web-server-1" "@web-server-2"
```

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

### Vault Secret Path Example

Source: https://docs.plakar.io/docs/control-plane/infrastructure/secret-providers/vault

Provides a concrete example of a Vault secret path, specifying the 'secret' engine, 'production/aws' path, and the 'access_key' field.

```text
secret/production/aws#access_key
```

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

### Initialize and Use Chunker with FastCDC

Source: https://docs.plakar.io/posts/2025-07-11/introducing-go-cdc-chunkers-chunk-and-deduplicate-everything

Demonstrates how to initialize a Chunker with the 'fastcdc' algorithm and iterate through data chunks. Ensure proper error handling for chunker initialization and chunk retrieval. The loop breaks when io.EOF is encountered.

```go
chunker, err := chunkers.NewChunker("fastcdc", rd)
if err != nil {
	log.Fatal(err)
}

offset := 0
for {
	chunk, err := chunker.Next()
	if err != nil && err != io.EOF {
		log.Fatal(err)
	}

	chunkLen := len(chunk)
	fmt.Println(offset, chunkLen)

	if err == io.EOF {
		// no more chunks to read
		break
	}
	offset += chunkLen
}
```

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

### Add Notion Plugin to Plakar

Source: https://docs.plakar.io/posts/2025-07-17/back-up-notion-yes-you-can.

Add the newly built Notion plugin to your Plakar installation. This command uses the generated .ptar file to install the plugin.

```bash
$ plakar pkg add ./notion-v0.1.0-devel.b66af0a_darwin_arm64.ptar
```

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

### Create a Kloset store with a filesystem path

Source: https://docs.plakar.io/docs/community/main/guides/create-kloset-repository

Use this command to create a new Kloset store at a specified filesystem path. Plakar will prompt for an encryption passphrase.

```bash
$ plakar at /var/backups create
```

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

### Build SFTP Package from Source

Source: https://docs.plakar.io/docs/community/main/integrations/sftp

Builds the SFTP integration package from source code. This is useful when pre-built packages are not available or customization is needed. Requires a compatible Go toolchain.

```bash
$ plakar pkg build sftp
```

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

### Initial Connection to Compute Instance

Source: https://docs.plakar.io/docs/community/main/guides/exoscale/exoscale-compute-as-a-dedicated-backup-server

Connect to the provisioned Exoscale compute instance using SSH. Replace `<instance-ip>` with the actual public IP address of your instance.

```bash
$ ssh ubuntu@<instance-ip>
```

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

### Install Plakar S3 Integration

Source: https://docs.plakar.io/docs/community/main/guides/exoscale/backup-exoscale-managed-mysql

Installs the Plakar S3 integration package, enabling Plakar to interact with S3-compatible storage services like Exoscale Object Storage.

```bash
$ plakar login -email you@example.com
$ plakar pkg add s3
```

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

### Launch Kapsul UI

Source: https://docs.plakar.io/posts/2025-07-07/kapsul-a-tool-to-create-and-manage-deduplicated-compressed-and-encrypted-ptar-vaults

Use the `ui` command to launch the Kapsul user interface for managing archives. You will be prompted for the repository passphrase.

```bash
$ kapsul -f /tmp/bleh.ptar ui
repository passphrase:

```

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

### Import Store Configurations from YAML File

Source: https://docs.plakar.io/docs/community/main/guides/importing-configurations

Use this command to import store configurations defined in a YAML file. Ensure the YAML file has the correct structure for store configurations.

```yaml
minio:
  access_key: minioadmin
  location: s3://localhost:9000/kloset
  passphrase: superpassphrase
  secret_access_key: minioadmin
  use_tls: "false"
```

```bash
$ plakar store import -config my-stores.yaml
```

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

### Import Source Configurations from YAML File

Source: https://docs.plakar.io/docs/community/main/guides/importing-configurations

Import source configurations by specifying a YAML file using the -config option. The file should contain source-specific configuration details.

```bash
$ plakar source import -config my-sources.yaml
```

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

### Verify Plakar Installation and Importers/Exporters

Source: https://docs.plakar.io/posts/2025-07-17/back-up-notion-yes-you-can.

Verify that the Plakar installation is successful and check the list of available importers, exporters, and klosets. The output should include 'notion' among the importers and exporters.

```bash
$ plakar version
plakar/v1.0.3-devel

importers: fs, ftp, notion, s3, sftp, stdin, tar, tar+gz, tgz
exporters: fs, ftp, notion, s3, sftp, stderr, stdout
klosets: fs, http, https, ptar, ptar+http, ptar+https, s3, sftp, sqlite
```

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

### Initialize Go Module for Connector

Source: https://docs.plakar.io/docs/community/main/guides/creating-a-custom-connector

Create a new Go module and initialize it for your custom Plakar connector project.

```bash
mkdir plakar-myimporter
cd plakar-myimporter
go mod init github.com/yourorg/plakar-myimporter
```

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

### Create Scheduler Configuration

Source: https://docs.plakar.io/docs/community/main/guides/ovhcloud/ovhcloud-as-a-dedicated-backup-server

Create a scheduler configuration file in YAML format to define backup tasks.

```yaml
$ cat > ~/scheduler.yaml << 'EOF'
agent:
  tasks:
    - name: Backup web-server-1
      repository: "@ovhcloud-s3-backups"
      backup:
        path: "@web-server-1"
        interval: 24h
        check: true

    - name: Backup web-server-2
      repository: "@ovhcloud-s3-backups"
      backup:
        path: "@web-server-2"
        interval: 24h
        check: true
EOF
```

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

### Start SSH Agent and Add Private Key

Source: https://docs.plakar.io/docs/community/main/integrations/sftp

If your private key is encrypted, start an SSH agent and add the key to it. This allows you to use the key without re-entering the passphrase repeatedly.

```bash
$ eval "$(ssh-agent -s)"
$ ssh-add ~/.ssh/id_ed25519_plakar
```

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

### Add PostgreSQL Source

Source: https://docs.plakar.io/docs/community/main/guides/postgres/pgdump

Configure a Plakar source to connect to your PostgreSQL database. Replace placeholders with your actual database credentials and host.

```bash
$ plakar source add mypg postgres://postgres:secret@db.example.com/myapp
```

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

### Initialize a Plakar Kloset Store

Source: https://docs.plakar.io/docs/community/main/quickstart/synchronize-copies

Initializes a new Kloset Store at a specified S3 location. This command creates the necessary bucket and structure for storing backups. Use '@' for aliases and double quotes on Windows if needed.

```bash
$ plakar at "@s3-backups" create
```

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

### Example Chunk Sizes for File Inference

Source: https://docs.plakar.io/posts/2025-03-19/plakar-1.0.1-beta.13-out

An attacker can simulate chunking on known files to generate a list of chunk sizes. If they can observe repository traffic and identify present chunk sizes, they can infer the existence of specific files, such as '/bin/bash' in this example.

```plaintext
88320
106844
79623
86182
109251
122564
88059
75087
66823
82371
85138
68684
115906
119036
```
Tokens:
Raw