|
| 1 | +pg_rman |
| 2 | +======= |
| 3 | + |
| 4 | +pg_rman is a backup and recovery manager for PostgreSQL servers able to do |
| 5 | +incremental, archive and full backup as well as restore a cluster to a |
| 6 | +state defined by a given recovery target. It is designed to perform |
| 7 | +periodic backups of an existing PostgreSQL server, combined with WAL |
| 8 | +archives to provide a way to recover a server in case of failure of |
| 9 | +server because of a reason or another. Its incremental and archive backup |
| 10 | +facilities reduces the amount of data necessary to be taken between |
| 11 | +two consecutive backups. |
| 12 | + |
| 13 | +Download |
| 14 | +-------- |
| 15 | + |
| 16 | +The latest version of this software can be found on the project website at |
| 17 | +https://github.com/michaelpq/pg_rman. |
| 18 | + |
| 19 | +Installation |
| 20 | +------------ |
| 21 | + |
| 22 | +Compiling pg_rman requires a PostgreSQL installation and can be done in |
| 23 | +two ways: |
| 24 | + |
| 25 | +1. Put pg_rman project directory inside PostgreSQL source tree as |
| 26 | +contrib/pg_rman, and use "make" to compile |
| 27 | + |
| 28 | +or |
| 29 | + |
| 30 | +2. Keep the project directory as-is and use the PGXS development |
| 31 | +infrastructure provided by a PostgreSQL installation to perform the |
| 32 | +compilation: "make USE_PGXS=1" |
| 33 | + |
| 34 | +In addition, you must have pg_config in $PATH. |
| 35 | + |
| 36 | +The current version of pg_rman is compatible with PostgreSQL 9.3 and |
| 37 | +upper versions. |
| 38 | + |
| 39 | +Documentation |
| 40 | +------------- |
| 41 | + |
| 42 | +All the documentation is written and maintained in pg_rman.txt. |
| 43 | + |
| 44 | +Regression tests |
| 45 | +---------------- |
| 46 | + |
| 47 | +The test suite of pg_rman is available in the code tree and can be |
| 48 | +launched in a way similar to common PostgreSQL extensions and modules: |
| 49 | + |
| 50 | +1) "make check" or "make installcheck" if the project directory is |
| 51 | +located in PostgreSQL code tree. |
| 52 | + |
| 53 | +2) "make installcheck" on an already installed server if project |
| 54 | +directory is kept as-is. |
| 55 | + |
| 56 | +License |
| 57 | +------- |
| 58 | + |
| 59 | +pg_rman can be distributed under the PostgreSQL license. See COPYRIGHT |
| 60 | +file for more information. |
