Browse Source

Add README

Emmanuel Bouthenot 5 years ago
parent
commit
8cef630214
1 changed files with 33 additions and 0 deletions
  1. 33 0
      Readme.md

+ 33 - 0
Readme.md

@@ -0,0 +1,33 @@
+# AutoPostgreSQLBackup
+
+AutoPostgreSQLBackup is a shell script (usually executed from a cron job) designed to provide a fully automated tool to make periodic backups of PostgreSQL databases.
+AutoPostgreSQLBackup extract databases into flat files in a daily, weekly or monthly basis.
+It supports:
+ * Email notification
+ * Compression
+ * Encryption
+ * Rotation
+ * Databases exclusion
+ * Pre and Post scripts
+ * Local configuration
+
+# Usage
+
+On Debian derived operating systems:
+Install it : `apt install autopostgresqlbackup`
+If the default options are not suitable for you, change then: `$EDITOR /etc/default/autopostgresqlbackup`
+That's it!
+
+## History
+
+ * 2005: AutoPostgreSQLBackup was written by AutoPostgreSQLBackup (with some contributions of Friedrich Lobenstock)
+   * Project webpage was http://autopgsqlbackup.frozenpc.net/ (offline)
+ * 2011: AutoPostgreSQLBackup was included in Debian
+ * Since 2011: Various patches (fixes and new features) were added in the Debian package
+ * 2019: Creation of a fork/standelone project on Github (https://github.com/k0lter/autopostgresqlbackup)
+
+# Authors
+
+ * Aaron Axelsen (Original author)
+ * Friedrich Lobenstock (Contributions)
+ * Emmanuel Bouthenot (Current maintainer)