summaryrefslogtreecommitdiff
path: root/README.md
blob: d1b0982d3ee27f21b935ea71e0cf1841334d7830 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# bakonf

[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/iustin/bakonf/CI)](https://github.com/iustin/bakonf/actions/workflows/ci.yml)
[![Codecov](https://img.shields.io/codecov/c/github/iustin/bakonf)](https://codecov.io/gh/iustin/bakonf)
[![Read the Docs](https://img.shields.io/readthedocs/bakonf)](https://bakonf.readthedocs.io/en/latest/?badge=latest)
[![GitHub issues](https://img.shields.io/github/issues/iustin/bakonf)](https://github.com/iustin/bakonf/issues)
![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/iustin/bakonf)
![GitHub release (latest by date)](https://img.shields.io/github/v/release/iustin/bakonf)
![GitHub Release Date](https://img.shields.io/github/release-date/iustin/bakonf)
![GitHub commits since latest release](https://img.shields.io/github/commits-since/iustin/bakonf/latest)
![GitHub last commit](https://img.shields.io/github/last-commit/iustin/bakonf)

**NOTE**: This repository is archived, as there's no need for such a tool
anymore, given how many proper backup solutions exist nowadays.

_bakonf_ is a small script designed to make minimal backups of the
*configuration* files of a GNU/Linux or Unix-like system. Its aim is
to use various methods to reduce the size of the backup to a
reasonable minimum, in order to be useful for remote/unattended
servers, while still backing up enough to recreate the system (with
effort) in a blank state. The actual user data backup/restore is a
separate matter, which bakonf doesn't deal with.

The contents of the archives created contain enough information so
that the system admininistrator can restore the system to a working,
but blank state.  Beside the actual information from the file system,
it can store output of arbitrary commands, for example:

- list of installed packages
- partition table
- various /proc information
- pci & usb device list

Requirements:

- Python 3.6+ (for Python 2.7, use version 0.6)
- PyYaml
- bsdd3

For more information, see the user manual in the doc directory, or
read the documentation [online](https://bakonf.readthedocs.io/).

Iustin Pop, <[email protected]>.