PG-2312 - Reorganize Docker installation instructions#957
PG-2312 - Reorganize Docker installation instructions#957
Conversation
This PR updates and reorganizes the instructions and content in docker.md for easier flow and user readability.
There was a problem hiding this comment.
@Andriciuc thanks for working on this. I haven't finished reviewing all content but let's start with addressing these comments first.
|
|
||
| * `container-name` is the name you assign to your container | ||
| * `POSTGRES_PASSWORD` is the superuser password | ||
| * `{{dockertag}}` is the tag specifying the version you need. Docker identifies the architecture (x86_64 or ARM64) and pulls the respective image. See the [full list of tags :octicons-link-external-16:](https://hub.docker.com/r/percona/percona-distribution-postgresql/tags/). |
There was a problem hiding this comment.
| * `{{dockertag}}` is the tag specifying the version you need. Docker identifies the architecture (x86_64 or ARM64) and pulls the respective image. See the [full list of tags :octicons-link-external-16:](https://hub.docker.com/r/percona/percona-distribution-postgresql/tags/). | |
| * `{{dockertag}}` is the tag specifying the version you need. Docker identifies the architecture (amd64 or arm64) and pulls the respective image. See the [full list of tags :octicons-link-external-16:](https://hub.docker.com/r/percona/percona-distribution-postgresql/tags/). |
Perhaps we could use the same arch identifiers as appear in docker hub.
| !!! note | ||
|
|
||
| Some extensions require server startup configuration and must be loaded via `shared_preload_libraries` before PostgreSQL starts. |
There was a problem hiding this comment.
I don't think this is a good location for this note. The reader still has no context about extensions at this point.
Also, I probably would not put this inside a note and would make it part of the first paragraph of section 2.
|
|
||
| ## 2. Enable extensions | ||
|
|
||
| Extensions must be explicitly loaded when starting the container using the `shared_preload_libraries` parameter, then enabled per database: |
There was a problem hiding this comment.
Not all extensions require to be set using shared_preload_libraries . I would use the above note text here to motivate the need of using the shared_preload_libraries.
| docker run --name container-name --env-file ./.my-pg.env -d percona/percona-distribution-postgresql:{{dockertag}} | ||
| ``` | ||
|
|
||
| ## 2. Enable extensions |
There was a problem hiding this comment.
Maybe before going into extensions, it would be nice to show how to connect to the server using the postgresql client psql. Similar to what we have in the current documentation.
This PR updates and reorganizes the instructions and content in docker.md for easier flow and user readability.