diff --git a/.eleventy.js b/.eleventy.js index 1b5f48b..cc5d9f1 100644 --- a/.eleventy.js +++ b/.eleventy.js @@ -32,6 +32,8 @@ module.exports = function(eleventyConfig) { .use(markdownItReplaceLink) ); + eleventyConfig.addPassthroughCopy({"docs/static": "static"}); + return { templateFormats: [ "md", diff --git a/README.md b/README.md index e1ec7f8..0f841a0 100644 --- a/README.md +++ b/README.md @@ -2,68 +2,71 @@ title: borgmatic permalink: index.html --- -![Build Status](https://build.torsion.org/api/badges/witten/borgmatic/status.svg?ref=refs/heads/master) -## Overview +## It's your data. Keep it that way. -borgmatic logo +borgmatic logo borgmatic is simple, configuration-driven backup software for servers and -workstations. Backup all of your machines from the command-line or scheduled -jobs. No GUI required. Built atop [Borg Backup](https://www.borgbackup.org/), -borgmatic initiates a backup, prunes any old backups according to a retention -policy, and validates backups for consistency. borgmatic supports specifying -your settings in a declarative configuration file, rather than having to put -them all on the command-line, and handles common errors. +workstations. Protect your files with client-side encryption. Backup your +databases too. Monitor it all with integrated third-party services. -Here's an example config file: +Here's an example configuration file: ```yaml location: - # List of source directories to backup. Globs are expanded. + # List of source directories to backup. source_directories: - /home - /etc - - /var/log/syslog* # Paths to local or remote repositories. repositories: - user@backupserver:sourcehostname.borg - # Any paths matching these patterns are excluded from backups. - exclude_patterns: - - /home/*/.cache - retention: - # Retention policy for how many backups to keep in each category. + # Retention policy for how many backups to keep. keep_daily: 7 keep_weekly: 4 keep_monthly: 6 consistency: - # List of consistency checks to run: "repository", "archives", etc. + # List of checks to run to validate your backups. checks: - repository - archives hooks: - # Preparation scripts to run, databases to dump, and monitoring to perform. + # Custom preparation scripts to run. before_backup: - prepare-for-backup.sh + + # Databases to dump and include in backups. postgresql_databases: - name: users + + # Third-party services to notify you if backups aren't happening. healthchecks: https://hc-ping.com/be067061-cf96-4412-8eae-62b0c50d6a8c ``` -borgmatic is hosted at with [source code -available](https://projects.torsion.org/witten/borgmatic). It's also mirrored -on [GitHub](https://github.com/witten/borgmatic) for convenience. - Want to see borgmatic in action? Check out the screencast. +borgmatic is powered by [Borg Backup](https://www.borgbackup.org/). + +## Integrations + +PostgreSQL +MySQL +MariaDB +Healthchecks +Cronitor +Cronhub +rsync.net +BorgBase + ## How-to guides @@ -117,6 +120,10 @@ Other questions or comments? Contact . ### Contributing +borgmatic is hosted at with [source code +available](https://projects.torsion.org/witten/borgmatic). It's also mirrored +on [GitHub](https://github.com/witten/borgmatic) for convenience. + If you'd like to contribute to borgmatic development, please feel free to submit a [Pull Request](https://projects.torsion.org/witten/borgmatic/pulls) or open an [issue](https://projects.torsion.org/witten/borgmatic/issues) first @@ -126,3 +133,6 @@ your thing. In general, contributions are very welcome. We don't bite! Also, please check out the [borgmatic development how-to](https://torsion.org/borgmatic/docs/how-to/develop-on-borgmatic/) for info on cloning source code, running tests, etc. + +![Build Status](https://build.torsion.org/api/badges/witten/borgmatic/status.svg?ref=refs/heads/master) + diff --git a/docs/static/borgbase.png b/docs/static/borgbase.png new file mode 100644 index 0000000..cee519d Binary files /dev/null and b/docs/static/borgbase.png differ diff --git a/static/borgmatic.png b/docs/static/borgmatic.png similarity index 100% rename from static/borgmatic.png rename to docs/static/borgmatic.png diff --git a/static/borgmatic.svg b/docs/static/borgmatic.svg similarity index 100% rename from static/borgmatic.svg rename to docs/static/borgmatic.svg diff --git a/docs/static/cronhub.png b/docs/static/cronhub.png new file mode 100644 index 0000000..a4be582 Binary files /dev/null and b/docs/static/cronhub.png differ diff --git a/docs/static/cronitor.png b/docs/static/cronitor.png new file mode 100644 index 0000000..4b87607 Binary files /dev/null and b/docs/static/cronitor.png differ diff --git a/docs/static/healthchecks.png b/docs/static/healthchecks.png new file mode 100644 index 0000000..7b5694a Binary files /dev/null and b/docs/static/healthchecks.png differ diff --git a/docs/static/mariadb.png b/docs/static/mariadb.png new file mode 100644 index 0000000..c44bc48 Binary files /dev/null and b/docs/static/mariadb.png differ diff --git a/docs/static/mysql.png b/docs/static/mysql.png new file mode 100644 index 0000000..73b55bd Binary files /dev/null and b/docs/static/mysql.png differ diff --git a/docs/static/postgresql.png b/docs/static/postgresql.png new file mode 100644 index 0000000..657b402 Binary files /dev/null and b/docs/static/postgresql.png differ diff --git a/docs/static/rsyncnet.png b/docs/static/rsyncnet.png new file mode 100644 index 0000000..3c027be Binary files /dev/null and b/docs/static/rsyncnet.png differ