Skip to content

Commit

Permalink
PXC-4457 Doc bug: default encrypt value incorrect
Browse files Browse the repository at this point in the history
 On branch pxc-4457
	modified:   docs/xtrabackup-sst.md
  • Loading branch information
patrickbirch committed Jul 18, 2024
1 parent 045f464 commit 78a6447
Showing 1 changed file with 16 additions and 13 deletions.
29 changes: 16 additions & 13 deletions docs/xtrabackup-sst.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,24 +95,27 @@ for socat encryption based on OpenSSL.
| Parameter | Description |
| -------------- | ------------------ |
| Values: | 0, 4 |
| Default: | 4 |
| Default: | 0 |
| Match: | Yes |

Enables SST encryption mode in Percona XtraBackup:

* Set `encrypt=0` to disable SST encryption.
You can control whether Percona XtraBackup encrypts data during State Snapshot Transfer (SST) using the `encrypt` option in your configuration.

* Set `encrypt=4` for SST encryption with SSL files generated by MySQL. This is the recommended value.
* **Encryption Disabled (Default):**
* Set `encrypt=0` to disable encryption. This is the default setting.
* Data transferred during SST won't be encrypted.
* **Encryption Enabled (Recommended):**
* Set `encrypt=4` to enable encryption. This is recommended for security.
* Percona XtraBackup will use key and certificate files generated with OpenSSL to encrypt the data during SST.

Considering that you have all three necessary files:
An example with the necessary files:

```{.text .no-copy}
[sst]
encrypt=4
ssl-ca=ca.pem
ssl-cert=server-cert.pem
ssl-key=server-key.pem
```
```{.text .no-copy}
[sst]
encrypt=4
ssl-ca=ca.pem
ssl-cert=server-cert.pem
ssl-key=server-key.pem
```

For more information, see [Encrypting PXC Traffic](encrypt-traffic.md#encrypt-traffic).

Expand Down

0 comments on commit 78a6447

Please sign in to comment.