You're reading the open-source Community docs. Plakar also offers Control Plane, the enterprise version. It's a virtual appliance with a web-based interface for centralized backup management across your infrastructure. View Control Plane docs →

Guides

#

This page gathers a collection of practical guides to help you use Plakar effectively. Each guide focuses on a specific topic, from basic setup to advanced configurations, so you can quickly find the instructions you need.

Scheduling Tasks

Learn how to configure and run the Plakar scheduler to automate backups.

Importing Configurations

Learn how to import configurations for stores, sources, and destinations in Plakar using the import command.

Creating a Kloset Store

Create a Kloset Store on the filesystem using Plakar.

Serving a Kloset Store over the Network

Expose a Kloset Store over HTTP using the plakar server command.

Excluding files from a backup

Learn how to exclude files from a backup in Plakar

Retrieving secrets via external command

The passphrase for accessing an encrypted Kloset Store can be stored in the environment, a file, or in the configuration. It can also be retrieved via an external command, for example your password manager.

Creating a custom connector

Step-by-step guide to implement and install your own Plakar connector (importer) in Go.

Logging In to Plakar

Log in to unlock optional features like pre-built package installation and alerting.

Managing packages

How to install, upgrade, and remove Plakar integration packages.

Pruning snapshots

Remove old snapshots from a Kloset store using age, tags, or retention policies.

Using Plakar UI

Learn how to start and use the Plakar UI to browse snapshots, restore files, manage integrations, and view alerts.

Managing passphrases

How Kloset store passphrases work in Plakar and how to change the passphrase used by a Kloset store.

MySQL

Guides on backing up and restoring MySQL database

PostgreSQL

Guides on backing up and restoring PostgreSQL databases

OVHcloud

Guides on running backups in OVHcloud

Exoscale

Guides on running backups in Exoscale