Version main

Installation

Several installation methods are available depending on your operating system. Choose the method that best suits your environment.

Developer Version

This is the developer version of Plakar and it can only be installed from source. Only stable versions have distributed assets that can be installed using other OS specific methods

To build Plakar from source. You will need:

  • Go (Golang)
  • make (available by default on most Linux distributions; on macOS, install the Xcode command line tools with xcode-select --install; on Windows, use WSL or a tool like GnuWin32 Make)

Clone the repository and run make:

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

This produces a plakar binary in the current directory.

To build a specific release version, check out the corresponding tag before running make:

git checkout v1.1.0
make

Verifying the Installation

Verify the installation by running:

plakar version

This should return the expected version number, for example plakar/v1.1.0.

Downloading Specific Versions

All release versions of plakar are available directly from GitHub on the project’s release page.

For each release, check under the “Assets” section for a list of pre-built packages. They follow the naming convention plakar_<version>_<os>_<arch>.<format>.

Installation Troubleshooting

If you encounter any issues during installation, or notice that this documentation is out of date:

  • Ensure you are following the instructions for the correct version of plakar.
  • Open an issue on the GitHub issue tracker.

Next Steps: Getting Started

Now that you have plakar installed, we recommend proceeding to the Quickstart guide to set up your first backup.

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