Documentation

This is the official documentation for MCSBackup, consider this a living document, it will change without warning and was last updated December 12, 2023. We will however do our best to not introduce breaking changes unless theres a new major release, in which case we will probably fork and freeze the documentation for the old major release.

Loading table of content…

Introduction

What is MCSBackup (and what is it not!)

Philosophy, system design and difficult choices

Terminology

ZFS Crash course / cheat sheet

Disclaimer

This chapter is ment for hobbyist to be able to setup a MCSBackup installation without much prior knowledge to ZFS, please don’t run a production system with any kind of important data if this has been your only source of knowledge about ZFS, to be qualified for that you need a good and deep understanding about ZFS, Linux and system management in general.

Anything you do with this software and the knowledge you gain from this documentation is your own responsebility, you may loose all your (customers) data, break up your parrents life-long marrige or start world-war 4 (or how far we’ve gotten when you read this) by using this software and it will be all your and only your fault, so please proceeed with caution!

Creating your first pool

Creating, deleting and renaming datasets

Creating, deleting and accessing snapshots

Getting started with MCSBackup

Installing and setting up on Debian / Ubuntu

Setting up you first job and running your first job

Reference of functionality

Point a

Pont b

Point c

Security

A few guidelines:

  • Don’t put MCSBackup on any public facing ip adresses without thorough firewalling, even though the web interface has a login-promt, dont assume it is secure. If you need remote access, please set up a vpn solution(we recommend OpenVPN)