mirror of
https://github.com/pgbackrest/pgbackrest.git
synced 2025-01-18 04:58:51 +02:00
181 lines
7.5 KiB
HTML
181 lines
7.5 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<title>PgBackRest - Simple Postgres Backup & Restore</title>
|
|
<link rel="stylesheet" href="default.css" type="text/css"></link>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"></meta>
|
|
<meta http-equiv="Content-Type" content="text/html;charset=utf-8"></meta>
|
|
</head>
|
|
<body>
|
|
<!-- HEADER -->
|
|
<div class="header">
|
|
<div class="header-title">PgBackRest</div>
|
|
<div class="header-subtitle">Simple Postgres Backup & Restore</div>
|
|
</div>
|
|
|
|
<!-- MENU -->
|
|
<div class="menu-set">
|
|
<div class="menu-first">[<a class="menu-link" href="#install">Install</a>]</div>
|
|
<div class="menu">[<a class="menu-link" href="#configure">Configure</a>]</div>
|
|
</div>
|
|
|
|
<!-- INTRO -->
|
|
<doc-intro>
|
|
Some intro text here.
|
|
</doc-intro>
|
|
|
|
<!-- INSTALL -->
|
|
<doc-install>
|
|
<doc-install-header><a id="install">Install</a></doc-install-header>
|
|
|
|
Something.</br></br>
|
|
</doc-install>
|
|
|
|
<!-- CONFIGURE -->
|
|
<doc-configure>
|
|
<doc-configure-header><a id="configure">Configure</a></doc-configure-header>
|
|
|
|
PgBackRest takes some command-line parameters, but depends on a configuration file for most of the settings. The default location for the configuration file is <doc-file>/etc/pg_backrest.conf</doc-file>.
|
|
|
|
<!-- CONFIGURE - COMMAND SECTION -->
|
|
<doc-configure-section>
|
|
<doc-configure-section-header><doc-id>command</doc-id> section</doc-configure-section-header>
|
|
|
|
The <doc-id>command</doc-id> section defines the location external commands that are used by PgBackRest.
|
|
|
|
<!-- CONFIGURE - COMMAND SECTION - PSQL KEY -->
|
|
<doc-configure-key>
|
|
<doc-configure-key-header><doc-id>psql</doc-id> key</doc-configure-key-header>
|
|
|
|
Defines the full path to <doc-file>psql</doc-file>. <doc-file>psql</doc-file> is used to call <doc-function>pg_start_backup()</doc-function> and <doc-function>pg_stop_backup()</doc-function>.
|
|
|
|
<doc-code-block>
|
|
required: y<br/>
|
|
example: psql=/usr/bin/psql
|
|
</doc-code-block>
|
|
</doc-configure-key>
|
|
|
|
<!-- CONFIGURE - COMMAND SECTION - REMOTE KEY -->
|
|
<doc-configure-key>
|
|
<doc-configure-key-header><doc-id>remote</doc-id> key</doc-configure-key-header>
|
|
|
|
Defines the file path to pg_backrest_remote.pl.
|
|
|
|
Required only if the path to <doc-file>pg_backrest_remote.pl</doc-file> is different on the local and remote systems. If not defined, the remote path will be assumed to be the same as the local path.
|
|
|
|
<doc-code-block>
|
|
required: n<br/>
|
|
example: remote=/home/postgres/backrest/bin/pg_backrest_remote.pl
|
|
</doc-code-block>
|
|
</doc-configure-key>
|
|
</doc-configure-section>
|
|
|
|
<!-- CONFIGURE - COMMAND-OPTION SECTION -->
|
|
<doc-configure-section>
|
|
<doc-configure-section-header><doc-id>command-option</doc-id> section</doc-configure-section-header>
|
|
|
|
The <doc-id>command-option</doc-id> section allows abitrary options to be passed to any command in the <doc-id>command</doc-id> section.
|
|
|
|
<!-- CONFIGURE - COMMAND-OPTION SECTION - PSQL KEY -->
|
|
<doc-configure-key>
|
|
<doc-configure-key-header><doc-id>psql</doc-id> key</doc-configure-key-header>
|
|
|
|
Allows command line parameters to be passed to <doc-file>psql</doc-file>.
|
|
|
|
<doc-code-block>
|
|
required: no<br/>
|
|
example: psql=--port=5433
|
|
</doc-code-block>
|
|
</doc-configure-key>
|
|
</doc-configure-section>
|
|
|
|
<!-- CONFIGURE - LOG SECTION -->
|
|
<doc-configure-section>
|
|
<doc-configure-section-header><doc-id>log</doc-id> section</doc-configure-section-header>
|
|
|
|
The <doc-id>log</doc-id> section defines logging-related settings. The following log levels are supported:<br/>
|
|
|
|
<ul>
|
|
<li><doc-id>off </doc-id> - No logging at all (not recommended)</li>
|
|
<li><doc-id>error</doc-id> - Log only errors</li>
|
|
<li><doc-id>warn </doc-id> - Log warnings and errors</li>
|
|
<li><doc-id>info </doc-id> - Log info, warnings, and errors</li>
|
|
<li><doc-id>debug</doc-id> - Log debug, info, warnings, and errors</li>
|
|
<li><doc-id>trace</doc-id> - Log trace (very verbose debugging), debug, info, warnings, and errors</li>
|
|
</ul>
|
|
|
|
<!-- CONFIGURE - LOG SECTION - LEVEL-FILE KEY -->
|
|
<doc-configure-key>
|
|
<doc-configure-key-header><doc-id>level-file</doc-id> key</doc-configure-key-header>
|
|
|
|
Sets file log level.
|
|
|
|
<doc-code-block>
|
|
default: info</br>
|
|
example: level-file=debug
|
|
</doc-code-block>
|
|
</doc-configure-key>
|
|
|
|
<!-- CONFIGURE - LOG SECTION - LEVEL-CONSOLE KEY -->
|
|
<doc-configure-key>
|
|
<doc-configure-key-header><doc-id>level-console</doc-id> key</doc-configure-key-header>
|
|
|
|
Sets console log level.
|
|
|
|
<doc-code-block>
|
|
default: warn</br>
|
|
example: level-console=info
|
|
</doc-code-block>
|
|
</doc-configure-key>
|
|
</doc-configure-section>
|
|
|
|
<!-- CONFIGURE - GENERAL SECTION -->
|
|
<doc-configure-section>
|
|
<doc-configure-section-header><doc-id>general</doc-id> section</doc-configure-section-header>
|
|
|
|
The <doc-id>general</doc-id> section defines settings that are shared between multiple operations.
|
|
|
|
<!-- CONFIGURE - GENERAL SECTION - BUFFER_SIZE KEY -->
|
|
<doc-configure-key>
|
|
<doc-configure-key-header><doc-id>buffer-size</doc-id> key</doc-configure-key-header>
|
|
|
|
Set the buffer size used for copy, compress, and uncompress functions. A maximum of 3 buffers will be in use at a time per thread. An additional maximum of 256K per thread may be used for zlib buffers.
|
|
|
|
<doc-detail-block>
|
|
<doc-detail>default:<doc-detail-value>1048576</doc-detail-value></doc-detail>
|
|
<doc-detail>allowed:<doc-detail-value>4096 - 8388608</doc-detail-value></doc-detail>
|
|
<doc-detail>example:<doc-detail-value>buffer-size=8192</doc-detail-value></doc-detail>
|
|
</doc-detail-block>
|
|
</doc-configure-key>
|
|
|
|
<!-- CONFIGURE - LOG SECTION - COMPRESS-LEVEL KEY -->
|
|
<doc-configure-key>
|
|
<doc-configure-key-header><doc-id>compress-level</doc-id> key</doc-configure-key-header>
|
|
|
|
Sets the zlib level to be used for file compression when `compress=y`.
|
|
|
|
<doc-detail-block>
|
|
<doc-detail>default:<doc-detail-value>6</doc-detail-value></doc-detail>
|
|
<doc-detail>allowed:<doc-detail-value>0-9</doc-detail-value></doc-detail>
|
|
<doc-detail>override:<doc-detail-value>backup, archive</doc-detail-value></doc-detail>
|
|
<doc-detail>example:<doc-detail-value>compress-level=9</doc-detail-value></doc-detail>
|
|
</doc-detail-block>
|
|
</doc-configure-key>
|
|
|
|
<!-- CONFIGURE - LOG SECTION - COMPRESS-LEVEL-NETWORK KEY -->
|
|
<doc-configure-key>
|
|
<doc-configure-key-header><doc-id>compress-level-network</doc-id> key</doc-configure-key-header>
|
|
|
|
Sets the zlib level to be used for protocol compression when <doc-setting>compress=n</doc-setting> and the database is not on the same host as the backup. Protocol compression is used to reduce network traffic but can be disabled by setting <doc-setting>compress-level-network=0</doc-setting>. When <doc-setting>compress=y</doc-setting> the <doc-setting>compress-level-network</doc-setting> setting is ignored and <doc-setting>compress-level</doc-setting> is used instead so that the file is only compressed once. SSH compression is always disabled.
|
|
|
|
<doc-detail-block>
|
|
<doc-detail>default:<doc-detail-value>6</doc-detail-value></doc-detail>
|
|
<doc-detail>allowed:<doc-detail-value>0-9</doc-detail-value></doc-detail>
|
|
<doc-detail>override:<doc-detail-value>backup, archive</doc-detail-value></doc-detail>
|
|
<doc-detail>example:<doc-detail-value>compress-level=9</doc-detail-value></doc-detail>
|
|
</doc-detail-block>
|
|
</doc-configure-key>
|
|
</doc-configure-section>
|
|
</doc-configure>
|
|
</body>
|
|
</html> |