From 59eee8e1029e8ef8d9052c78a7a2ef3ef54659de Mon Sep 17 00:00:00 2001 From: Anastasia Alexandrova Date: Wed, 22 Jan 2025 12:12:47 +0200 Subject: [PATCH] PG-1280 Adeed some clearance to Docker steps (#400) --- documentation/docs/install.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/documentation/docs/install.md b/documentation/docs/install.md index daea87d4..0c69de0a 100644 --- a/documentation/docs/install.md +++ b/documentation/docs/install.md @@ -64,11 +64,11 @@ Install `pg_tde` using one of available installation methods: !!! note - The steps below are for the `pg_tde` community version. + The steps below are for the PostgreSQL Community version of `pg_tde`. It provides the `tde_heap_basic` access method for data encryption. - To run `pg_tde` version for Percona Server for PostgreSQL, [use the Percona Distribution for PostgreSQL Docker image :octicons-link-external-16:](https://docs.percona.com/postgresql/17/docker.html). + To run the `pg_tde` version for Percona Server for PostgreSQL, [use the Percona Distribution for PostgreSQL Docker image :octicons-link-external-16:](https://docs.percona.com/postgresql/17/docker.html). - You can find Docker images built from the current main branch on [Docker Hub](https://hub.docker.com/r/perconalab/pg_tde). Images are built on top of [postgres:16](https://hub.docker.com/_/postgres) official image. + You can find Docker images on [Docker Hub](https://hub.docker.com/r/perconalab/pg_tde). Images are built on top of [postgres:16](https://hub.docker.com/_/postgres) official image. To run `pg_tde` in Docker, use the following command: @@ -76,9 +76,11 @@ Install `pg_tde` using one of available installation methods: docker run --name pg-tde -e POSTGRES_PASSWORD=mysecretpassword -d perconalab/pg_tde ``` - It builds and adds `pg_tde` extension to PostgreSQL 16. The `postgresql.conf` contains the required modifications. The `pg_tde` extension is added to `template1` so that all new databases automatically have the `pg_tde` extension loaded. + It builds and adds the `pg_tde` extension to PostgreSQL 16. The `postgresql.conf` contains the required modifications. The `pg_tde` extension is added to `template1` so that all new databases automatically have the `pg_tde` extension loaded. - Keys are not created automatically. You must configure a key provider and a principal key for each database where you wish to use encrypted tables. See the instructions in the [Setup](setup.md) section, starting with the 4th point, as the first 3 steps are already completed in the Docker image. + Keys are not created automatically. You must configure a key provider and a principal key for each database where you wish to use encrypted tables. + + Connect to the container and establish the `psql` session there. Then, see the instructions in the [Setup](setup.md) section, starting with the 4th point, as the first 3 steps are already completed in the Docker image. See [Docker Docs](https://hub.docker.com/_/postgres) on usage.