diff --git a/README.md b/README.md index b8746ce..dde00ab 100644 --- a/README.md +++ b/README.md @@ -8,34 +8,28 @@ **版本信息：** -- 12.4、latest -- 10 +- 13 **镜像信息：** * 镜像地址： - - 阿里云: registry.cn-shenzhen.aliyuncs.com/colovu/postgres:12.4 - - DockerHub：colovu/postgres:12.4 - * 依赖镜像：debian:buster - -> 后续相关命令行默认使用`[Docker Hub](https://hub.docker.com)`镜像服务器做说明 + - 阿里云: registry.cn-shenzhen.aliyuncs.com/colovu/postgresql:latest + - DockerHub：colovu/postgresql:latest + - Colovu Registry: docker.colovu.com/colovu/postgresql:latest + - 依赖镜像：colovu/debian:12 +> 后续相关命令行默认使用`[Colovu Registry](https://docker.colovu.com)`镜像服务器做说明 ## TL;DR Docker 快速启动命令： ```shell -# 从 Docker Hub 服务器下载镜像并启动 -$ docker run -d -e ALLOW_ANONYMOUS_LOGIN=yes --name imgname colovu/colovu/postgres:12.4 - -# 从 Aliyun 服务器下载镜像并启动 -$ docker run -d -e ALLOW_ANONYMOUS_LOGIN=yes registry.cn-shenzhen.aliyuncs.com/colovu/postgres:12.4 +# 从 Registry 服务器下载镜像并启动 +$ docker run -d -e ALLOW_ANONYMOUS_LOGIN=yes --name imgname docker.colovu.com/colovu/postgresql:latest ``` -- `colovu/imgname:`：镜像名称及版本标签；标签不指定时默认使用`latest` - - +- `docker.colovu.com/colovu/postgresql:`：镜像名称及版本标签 TAG；标签不指定时默认使用`latest` Docker-Compose 快速启动命令： @@ -47,15 +41,12 @@ $ curl -sSL -o https://gitee.com/colovu/docker-postgres/raw/master/docker-compos # 从 Github 下载 Compose 文件 $ curl -sSL https://raw.githubusercontent.com/colovu/docker-postgres/master/docker-compose.yml +# 创建并启动容器 $ docker-compose up -d ``` - - --- - - ## 默认对外声明 ### 端口 @@ -102,8 +93,6 @@ services: > 注意：应用需要使用的子目录会自动创建。 - - ## 使用说明 ### 启动容器 @@ -111,19 +100,17 @@ services: #### 通过默认方式启动 ```shell -$ docker run --name some-postgres -e POSTGRES_PASSWORD=mysecretpassword -d colovu/postgres:12.4 +$ docker run --name some-postgres -e POSTGRES_PASSWORD=mysecretpassword -d docker.colovu.com/colovu/postgresql:latest ``` -- 由容器执行默认的`entrypoint.sh`脚本，并生成默认的用户及数据文件 +- 由容器执行默认的`entry.sh`脚本，并生成默认的用户及数据文件 - `some-postgres`：容器名；命名后，可以直接使用该名字进行操作 - `mysecretpassword`：数据库密码 - - #### 通过`psql`命令方式启动 ```shell -$ docker run -it --rm --network some-network colovu/postgres:12.4 psql -h some-postgres -U postgres +$ docker run -it --rm --network some-network docker.colovu.com/colovu/postgresql:latest psql -h some-postgres -U postgres psql (10.12.0) Type "help" for help. @@ -134,8 +121,6 @@ postgres=# SELECT 1; (1 row) ``` - - #### 通过`docker-compose`方式启动 docker-cpmpose.yml 参考: @@ -148,7 +133,7 @@ version: '3.1' services: db: - image: colovu/postgres:12.4 + image: docker.colovu.com/colovu/postgresql:latest restart: always environment: POSTGRES_PASSWORD: example @@ -160,11 +145,9 @@ services: - 8080:8080 ``` - - ## 镜像扩展使用 -有多种方式可以扩展使用`postgres`镜像；这里仅列举部分，在实际使用时，不一定需要全部使用。 +有多种方式可以扩展使用`postgresql`镜像；这里仅列举部分，在实际使用时，不一定需要全部使用。 ### 环境变量 @@ -234,25 +217,21 @@ $ docker run -d \ -e POSTGRES_PASSWORD=mysecretpassword \ -e PGDATA=/var/lib/postgresql/data/pgdata \ -v /custom/mount:/var/lib/postgresql/data \ - colovu/postgres:12.4 + docker.colovu.com/colovu/postgresql:latest ``` 该变量并不是为Docker定义的数据卷，而是由`postgres`服务本身使用（参考 [PostgreSQL docs](https://www.postgresql.org/docs/11/app-postgres.html#id-1.9.5.14.7)），entrypoing.sh脚本只是传输该值。 - - ### 容器安全 作为敏感信息通过环境变量传输的可选替代方案，可以增加`_FILE`在部分环境变量末尾，以使容器的初始化脚本通过加载文件的方式，获取相关变量。例如，可以通过加载文件的方式加载密码： ```shell -$ docker run --name some-postgres -e POSTGRES_PASSWORD_FILE=/run/secrets/postgres-passwd -d colovu/postgres:12.4 +$ docker run --name some-postgres -e POSTGRES_PASSWORD_FILE=/run/secrets/postgres-passwd -d docker.colovu.com/colovu/postgresql:latest ``` 支持该方式的变量为： `POSTGRES_INITDB_ARGS`, `POSTGRES_PASSWORD`, `POSTGRES_USER`, `POSTGRES_DB`。 - - ### 初始化脚本 如果需要在使用当前镜像时，增加一些附加的初始化操作，可以将相应的`*.sql`、 `*.sql.gz` 或 `*.sh`脚本文件放置在`initdb.d`目录中（使用数据卷映射方式时，可先创建相应的目录）。在`entrypoint.sh`调用`initdb`创建默认的`postgres`用户及数据库时，会执行所有在`initdb.d`目录下的`*.sql`及可执行`*.sh`脚本，并source所有不可执行的`*.sh`脚本，执行完成后，启动postgres服务。 @@ -261,8 +240,6 @@ $ docker run --name some-postgres -e POSTGRES_PASSWORD_FILE=/run/secrets/postgre > > - 在`initdb.d`目录下的脚本，仅在数据库存储目录为空时才会执行。如果部分脚本执行失败（会导致容器退出），则可能数据库目录已经存在；此时，重新启动容器，则不会继续执行`initdb.d`目录下的初始化脚本。 - - ### 数据库配置 有多种方式可以配置PostgreSQL服务器。详细信息可参考相关[docs](https://www.postgresql.org/docs/current/static/runtime-config.html)文档。部分常用配置项如下： @@ -271,19 +248,19 @@ $ docker run --name some-postgres -e POSTGRES_PASSWORD_FILE=/run/secrets/postgre ```shell $ # 获取配置文件模板，存储为当前目录的my-postgres.conf - $ docker run -i --rm colovu/postgres:12.4 cat /usr/share/postgresql/postgresql.conf.sample > my-postgres.conf + $ docker run -i --rm docker.colovu.com/colovu/postgresql:latest cat /usr/share/postgresql/postgresql.conf.sample > my-postgres.conf $ # 个性化修改配置信息，至少增加`listen_addresses='*'`以确保其他容器可以访问 $ echo "listen_addresses='*'" >> my-postgres.conf $ # 使用定制后的配置文件启动容器 - $ docker run -d --name some-postgres -v "$PWD/my-postgres.conf":/etc/postgresql/postgresql.conf -e POSTGRES_PASSWORD=mysecretpassword colovu/postgres:12.4 -c 'config_file=/etc/postgresql/postgresql.conf' + $ docker run -d --name some-postgres -v "$PWD/my-postgres.conf":/etc/postgresql/postgresql.conf -e POSTGRES_PASSWORD=mysecretpassword docker.colovu.com/colovu/postgresql:latest -c 'config_file=/etc/postgresql/postgresql.conf' ``` - 在命令行中设置相应参数。entrypoint.sh基本会将所有的启动时传递给Docker的配置参数传递给postgres服务进程。从官方 [docs](https://www.postgresql.org/docs/current/static/app-postgres.html)文档可以看出，所有在 `.conf`文件中的配置项都可以使用`-c`进行设置。 ```shell - $ docker run -d --name some-postgres -e POSTGRES_PASSWORD=mysecretpassword colovu/postgres:12.4 -c 'shared_buffers=256MB' -c 'max_connections=200' + $ docker run -d --name some-postgres -e POSTGRES_PASSWORD=mysecretpassword docker.colovu.com/colovu/postgresql:latest -c 'shared_buffers=256MB' -c 'max_connections=200' ``` > 注意：配置文件至少修改`listen_addresses='*'`以确保其他容器可以访问 @@ -293,52 +270,44 @@ $ docker run --name some-postgres -e POSTGRES_PASSWORD_FILE=/run/secrets/postgre - 基于Linux系列的镜像，默认配置文件在容器内为：`/usr/share/postgresql/postgresql.conf.sample` - 基于Alpine系统的镜像，默认配置文件在容器内为：`/usr/local/share/postgresql/postgresql.conf.sample` - - 导出模板文件： ```shell -docker run -i --rm colovu/postgres:12.4 cat /usr/share/postgresql/postgresql.conf.sample > my-postgres.conf +docker run -i --rm docker.colovu.com/colovu/postgresql:latest cat /usr/share/postgresql/postgresql.conf.sample > my-postgres.conf ``` - 使用的镜像：colovu/postgres:12.4 - 原始文件：/usr/share/postgresql/postgresql.conf.sample - 导出后文件：my-postgres.conf - - ### 个性化配置Locale PostgreSQL镜像使用的Ubuntu基础镜像默认的Locale配置为`en_US.UTF-8`，可以使用一个简单的 Dockerfile来设置为不同的Locale。比如设置为 `de_DE.utf8`: ```dockerfile -FROM colovu/postgres:12.4 +FROM docker.colovu.com/colovu/postgresql:latest RUN localedef -i de_DE -c -f UTF-8 -A /usr/share/locale/locale.alias de_DE.UTF-8 ENV LANG de_DE.utf8 ``` 因为数据库仅在容器启动时创建，使用这种方式，可以在创建数据库前设置默认语言。 - - ### 扩展功能模块 使用默认的镜像时，安装扩展功能模块比较简单，可以参考文档 [github.com/postgis/docker-postgis](https://github.com/postgis/docker-postgis/blob/4eb614133d6aa87bfc5c952d24b7eb1f499e5c7c/12-3.0/Dockerfile) 。 使用基于Alpine的镜像时，没有在 [postgres-contrib](https://www.postgresql.org/docs/10/static/contrib.html) 列明的模块需要自己在镜像中编译，参见文档 [github.com/postgis/docker-postgis](https://github.com/postgis/docker-postgis/blob/4eb614133d6aa87bfc5c952d24b7eb1f499e5c7c/12-3.0/alpine/Dockerfile) 。 - - ## 变参 --user 说明 本镜像允许使用变参`--user`指定运行时的用户信息。但需要注意的是，`postgres`可以允许使用任何UID执行（只需要与数据库目录所属账户一致），`initdb`需要确保该UID实际存在（指定的用户需要在容器的`/etc/passwd`文件中存在）： ```shell -$ docker run -it --rm --user www-data -e POSTGRES_PASSWORD=mysecretpassword colovu/postgres:12.4 +$ docker run -it --rm --user www-data -e POSTGRES_PASSWORD=mysecretpassword docker.colovu.com/colovu/postgresql:latest The files belonging to this database system will be owned by user "www-data". ... -$ docker run -it --rm --user 1000:1000 -e POSTGRES_PASSWORD=mysecretpassword colovu/postgres:12.4 +$ docker run -it --rm --user 1000:1000 -e POSTGRES_PASSWORD=mysecretpassword docker.colovu.com/colovu/postgresql:latest initdb: could not look up effective user ID 1000: user does not exist ``` @@ -349,7 +318,7 @@ initdb: could not look up effective user ID 1000: user does not exist 2. 如果宿主系统存在相应的用户，可以使用只读绑定将`/etc/passwd`文件映射为容器内对应文件： ```shell - $ docker run -it --rm --user "$(id -u):$(id -g)" -v /etc/passwd:/etc/passwd:ro -e POSTGRES_PASSWORD=mysecretpassword colovu/postgres:12.4 + $ docker run -it --rm --user "$(id -u):$(id -g)" -v /etc/passwd:/etc/passwd:ro -e POSTGRES_PASSWORD=mysecretpassword docker.colovu.com/colovu/postgresql:latest The files belonging to this database system will be owned by user "jsmith". ... ``` @@ -358,22 +327,20 @@ initdb: could not look up effective user ID 1000: user does not exist ```shell $ docker volume create pgdata - $ docker run -it --rm -v pgdata:/var/lib/postgresql/data -e POSTGRES_PASSWORD=mysecretpassword colovu/postgres:12.4 + $ docker run -it --rm -v pgdata:/var/lib/postgresql/data -e POSTGRES_PASSWORD=mysecretpassword docker.colovu.com/colovu/postgresql:latest The files belonging to this database system will be owned by user "postgres". ... ( once it's finished initializing successfully and is waiting for connections, stop it ) $ docker run -it --rm -v pgdata:/var/lib/postgresql/data colovu/postgres:latest bash chown -R 1000:1000 /var/lib/postgresql/data - $ docker run -it --rm --user 1000:1000 -v pgdata:/var/lib/postgresql/data colovu/postgres:12.4 + $ docker run -it --rm --user 1000:1000 -v pgdata:/var/lib/postgresql/data docker.colovu.com/colovu/postgresql:latest LOG: database system was shut down at 2017-01-20 00:03:23 UTC LOG: MultiXact member wraparound protections are now enabled LOG: autovacuum launcher started LOG: database system is ready to accept connections ``` - - ## 使用预警 如果不存在数据库，容器启动时，会花费一定时间创建默认的数据库，在创建期间，容器不接受访问链接。如果使用`docker-compose`方式同时启动多个容器时，可能会产生问题。 @@ -382,8 +349,6 @@ initdb: could not look up effective user ID 1000: user does not exist 在Swarm模式中使用overlay网络模式时，针对长时间运行的IDLE链接，可能会遇到`IPVS connection timeouts`错误，可以参照以下信息解决： ["IPVS connection timeout issue" in the Docker Success Center](https://success.docker.com/article/ipvs-connection-timeout-issue) 。 - - ## 如何存储数据 **重要**：针对运行在Docker容器中的应用，有几种不同的数据存储方式。如： @@ -403,8 +368,6 @@ initdb: could not look up effective user ID 1000: user does not exist 其中，`-v /absolute/host/datadir:/container/volume/dir`参数部分，会将宿主机的`/absolute/host/datadir`目录挂载为容器中的`/var/lib/postgresql/data`目录。 - - ## 安全 ### 用户及密码 @@ -441,20 +404,15 @@ services: 如果需要切换为`root`方式运行应用，可以在启动命令中增加`-u root`以指定运行的用户。 - - ## 注意事项 - 容器中应用的启动参数不能配置为后台运行，如果应用使用后台方式运行，则容器的启动命令会在运行后自动退出，从而导致容器退出 - - ## 更新记录 +- 2023/8/17: 变更应用版本为 v13.11 - 2021/1/1 (1.0): 初始版本 - - ## 参考 - [官方Docker](https://hub.docker.com/_/postgres?tab=description)