feat: add README
This commit is contained in:
22
src/postgres/README.md
Normal file
22
src/postgres/README.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# Postgres
|
||||
|
||||
[English](./README.md) | [中文](./README.zh.md)
|
||||
|
||||
This service deploys a PostgreSQL database.
|
||||
|
||||
## Services
|
||||
|
||||
- `postgres`: The PostgreSQL database service.
|
||||
|
||||
## Configuration
|
||||
|
||||
- `POSTGRES_VERSION`: The version of the PostgreSQL image, default is `17.6`.
|
||||
- `POSTGRES_USER`: The database username, default is `postgres`.
|
||||
- `POSTGRES_PASSWORD`: The database password, default is `postgres`.
|
||||
- `POSTGRES_DB`: The database name, default is `postgres`.
|
||||
- `POSTGRES_PORT`: The host port for PostgreSQL, default is `5432`.
|
||||
|
||||
## Volumes
|
||||
|
||||
- `postgres_data`: A volume for storing PostgreSQL data.
|
||||
- `init.sql`: Optional initialization script (mount to `/docker-entrypoint-initdb.d/init.sql`).
|
||||
22
src/postgres/README.zh.md
Normal file
22
src/postgres/README.zh.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# Postgres
|
||||
|
||||
[English](./README.md) | [中文](./README.zh.md)
|
||||
|
||||
此服务用于部署一个 PostgreSQL 数据库。
|
||||
|
||||
## 服务
|
||||
|
||||
- `postgres`: PostgreSQL 数据库服务。
|
||||
|
||||
## 配置
|
||||
|
||||
- `POSTGRES_VERSION`: PostgreSQL 镜像的版本,默认为 `17.6`。
|
||||
- `POSTGRES_USER`: 数据库用户名,默认为 `postgres`。
|
||||
- `POSTGRES_PASSWORD`: 数据库密码,默认为 `postgres`。
|
||||
- `POSTGRES_DB`: 数据库名称,默认为 `postgres`。
|
||||
- `POSTGRES_PORT`: PostgreSQL 的主机端口,默认为 `5432`。
|
||||
|
||||
## 卷
|
||||
|
||||
- `postgres_data`: 用于存储 PostgreSQL 数据的卷。
|
||||
- `init.sql`: 可选的初始化脚本(挂载到 `/docker-entrypoint-initdb.d/init.sql`)。
|
||||
Reference in New Issue
Block a user