> Main
Version main

Plakar: Developer branch


Getting Started

This section provides a quick overview to help you get started with Plakar. Whether you’re new to backup solutions or just new to Plakar, these resources will guide you through the initial setup and basic operations.


Overview

A powerful backup tool with deduplication, end-to-end encryption, and flexible integrations for most data sources.

Installation

Install Plakar and verify your installation.

Quickstart

Get started with plakar: create your first backup, verify integrity, restore, and use the UI.

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.

Integrations

Plakar can be extended through integrations that enable storing backups or backing up and restoring data from external services. Each integration may act as a store, a source, a destination, or any combination of these roles, depending on its capabilities.

Below is a list of links to the documentation for each supported integration.


S3

Back up and restore S3 buckets with Plakar.

Notion

Back up and restore your Notion workspace with Plakar.

Explanations

This section provides background and context to help you understand how Plakar works and why certain design choices exist. These pages focus on concepts, trade‑offs, and best practices rather than step‑by‑step instructions.

If you’re looking for practical instructions, see the Guides section.


How Plakar Works

Understand the core architecture and data processing pipeline behind Plakar, including Kloset stores, chunking, deduplication, compression, encryption, and snapshot management.

Should you push or pull backups?

Understand the difference between push and pull backup models, and how Plakar supports both.

References

Reference docs for Plakar

Community

How to engage with the Plakar community: where to talk, collaborate, follow updates, and read the rules.

Found a bug or mistake in the documentation? Create an issue on GitHub