diff --git a/doc/appendix-signatures.sgml b/doc/appendix-signatures.sgml new file mode 100644 index 00000000..30a8ef1b --- /dev/null +++ b/doc/appendix-signatures.sgml @@ -0,0 +1,5 @@ + + Verifying digital signatures + + WIP + diff --git a/doc/filelist.sgml b/doc/filelist.sgml index c7dd189e..4f596da2 100644 --- a/doc/filelist.sgml +++ b/doc/filelist.sgml @@ -13,6 +13,8 @@ + + + + + + + diff --git a/doc/install-packages.sgml b/doc/install-packages.sgml new file mode 100644 index 00000000..d0721ed1 --- /dev/null +++ b/doc/install-packages.sgml @@ -0,0 +1,32 @@ + + Installing &repmgr; from packages + +We recommend installing `repmgr` using the available packages for your +system. + + + + RedHat/Fedora/CentOS + + RPM packages for `repmgr` are available via Yum through + the PostgreSQL Global Development Group RPM repository + ( http://yum.postgresql.org/). + Follow the instructions for your distribution (RedHat, CentOS, + Fedora, etc.) and architecture as detailed at yum.postgresql.org. + + + 2ndQuadrant also provides its own RPM packages which are made available + at the same time as each `repmgr` release, as it can take some days for + them to become available via the main PGDG repository. See here for details: + http://repmgr.org/yum-repository.html + + + + Debian/Ubuntu + .deb packages for `repmgr` are available from the + PostgreSQL Community APT repository (http://apt.postgresql.org/ ). + Instructions can be found in the APT section of the PostgreSQL Wiki + (https://wiki.postgresql.org/wiki/Apt ). + + + diff --git a/doc/install-requirements.sgml b/doc/install-requirements.sgml new file mode 100644 index 00000000..f7829fb3 --- /dev/null +++ b/doc/install-requirements.sgml @@ -0,0 +1,67 @@ + + Requirements for installing repmgr + + repmgr is developed and tested on Linux and OS X, but should work on any + UNIX-like system supported by PostgreSQL itself. There is no support for + Microsoft Windows. + + + + From version 4.0, repmgr is compatible with all PostgreSQL versions from 9.4, including PostgreSQL 10. + + + PostgreSQL 9.3 is supported by repmgr 3.3. + + + + +If upgrading from `repmgr 3`, please see the separate upgrade guide +`doc/upgrading-from-repmgr3.md`. + + + + + All servers in the replication cluster must be running the same major version of + PostgreSQL, and we recommend that they also run the same minor version. + + + + `repmgr` must be installed on each server in the replication cluster. + If installing repmgr from packages, the package version must match the PostgreSQL + version. If installing from source, repmgr must be compiled against the same + major version. + + + + A dedicated system user for `repmgr` is *not* required; as many `repmgr` and + `repmgrd` actions require direct access to the PostgreSQL data directory, + these commands should be executed by the `postgres` user. + + + + + Passwordless `ssh` connectivity between all servers in the replication cluster + is not required, but is necessary in the following cases: + + + if you need `repmgr` to copy configuration files from outside the PostgreSQL + data directory (in which case `rsync` is also required) + + + to perform switchover operations + + + when executing `repmgr cluster matrix` and `repmgr cluster crosscheck` + + + + + + + We recommend using a session multiplexer utility such as `screen` or + `tmux` when performing long-running actions (such as cloning a database) + on a remote server - this will ensure the `repmgr` action won't be prematurely + terminated if your `ssh` session to the server is interrupted or closed. + + + diff --git a/doc/install-source.sgml b/doc/install-source.sgml new file mode 100644 index 00000000..7019b21b --- /dev/null +++ b/doc/install-source.sgml @@ -0,0 +1,139 @@ + + Installing &repmgr; from source + + + Prerequisites for installing from source + + To install &repmgr; the prerequisites for compiling + &postgres; must be installed. These are described in &postgres;'s + documentation + on build requirements + and build requirements for documentation. + + + + Most mainstream Linux distributions and other UNIX variants provide simple + ways to install the prerequisites from packages. + + + + Debian and Ubuntu: First + add the apt.postgresql.org + repository to your sources.list if you + have not already done so. Then install the pre-requisites for + building PostgreSQL with: + + sudo apt-get update + sudo apt-get build-dep postgresql-9.6 + + + + + + RHEL or CentOS 6.x or 7.x: install the appropriate repository RPM + for your system from + yum.postgresql.org. Then install the prerequisites for building + PostgreSQL with: + + sudo yum check-update + sudo yum groupinstall "Development Tools" + sudo yum install yum-utils openjade docbook-dtds docbook-style-dsssl docbook-style-xsl + sudo yum-builddep postgresql96 + + + + + + + + + Select the appropriate PostgreSQL versions for your target repmgr version. + + + + + + + Getting &repmgr; source code + + + There are two ways to get the &repmgr; source code: with git, or by downloading tarballs of released versions. + + + + Using <application>git</application> to get the &repmgr; sources + + + Use git if you expect + to update often, you want to keep track of development or if you want to contribute + changes to &repmgr;. There is no reason not to use git + if you're familiar with it. + + + + The source for &repmgr; is maintained at + https://github.com/2ndQuadrant/repmgr. + + + + There are also tags for each &repmgr; release, e.g. REL4_0_STABLE. + + + + Clone the source code using git: + + git clone https://github.com/2ndQuadrant/repmgr + + + + + For more information on using git see + git-scm.org. + + + + + + Downloading release source tarballs + + + Official release source code is uploaded as tarballs to the + &repmgr; website along with a tarball checksum and a matching GnuPG + signature. See + http://repmgr.org/ + for the download information. See + for information on verifying digital signatures. + + + + You will need to download the repmgr source, e.g. repmgr-4.0.tar.gz. + You may optionally verify the package checksums from the + .md5 files and/or verify the GnuPG signatures + per . + + + + After you unpack the source code archives using tar xf + the installation process is the same as if you were installing from a git + clone. + + + + + + + + Installation of &repmgr; from source + + To installing &repmgr; from source, simply execute: + + + ./configure && make install + + + Ensure `pg_config` for the target PostgreSQL version is in `$PATH`. + + + + diff --git a/doc/install.sgml b/doc/install.sgml new file mode 100644 index 00000000..52b827e1 --- /dev/null +++ b/doc/install.sgml @@ -0,0 +1,24 @@ + + Installation + + + &repmgr; can be installed from binary packages provided by your operating + system's packaging system, or from source. + + + In general we recommend using binary packages, unless unavailable for your operating system. + + + Source installs are mainly useful if you want to keep track of the very + latest repmgr development and contribute to development. They're also the + only option if there are no packages for your operating system yet. + + + Before installing &repmgr; make sure you satisfy the . + + + &install-requirements; + &install-packages; + &install-source; + + diff --git a/doc/repmgr.sgml b/doc/repmgr.sgml index 75e05c4a..e42a878a 100644 --- a/doc/repmgr.sgml +++ b/doc/repmgr.sgml @@ -63,9 +63,9 @@ Getting started &overview; - + &install; - + &appendix-signatures; ]]>