[feat]优化说明文档
This commit is contained in:
@@ -13,9 +13,11 @@
|
||||
**镜像信息:**
|
||||
|
||||
* 镜像地址:
|
||||
- 国内镜像仓库:registry.cn-shenzhen.aliyuncs.com/colovu/imgname
|
||||
- Aliyun仓库:registry.cn-shenzhen.aliyuncs.com/colovu/imgname
|
||||
- DockerHub:colovu/imgname
|
||||
|
||||
> 后续相关命令行默认使用`[Docker Hub](https://hub.docker.com)`镜像服务器做说明
|
||||
|
||||
|
||||
|
||||
## TL;DR
|
||||
@@ -30,7 +32,6 @@ $ docker run -d -e ALLOW_ANONYMOUS_LOGIN=yes colovu/imgname:1.0
|
||||
$ docker run -d -e ALLOW_ANONYMOUS_LOGIN=yes registry.cn-shenzhen.aliyuncs.com/colovu/imgname:1.0
|
||||
```
|
||||
|
||||
- 后续相关命令行默认使用 Docker Hub 镜像服务器做说明
|
||||
|
||||
|
||||
|
||||
@@ -59,6 +60,8 @@ $ docker-compose up -d
|
||||
|
||||
- xx:端口用途
|
||||
|
||||
|
||||
|
||||
### 数据卷
|
||||
|
||||
镜像默认提供以下数据卷定义,默认数据分别存储在自动生成的应用名对应`imgname`子目录中:
|
||||
@@ -68,6 +71,7 @@ $ docker-compose up -d
|
||||
/srv/conf # 配置文件
|
||||
/srv/data # 数据文件,主要存放应用数据
|
||||
/srv/cert # 证书文件存放目录
|
||||
|
||||
/var/log # 日志输出
|
||||
/var/run # 系统运行时文件,如 PID 文件
|
||||
```
|
||||
@@ -78,7 +82,7 @@ $ docker-compose up -d
|
||||
|
||||
## 容器配置
|
||||
|
||||
在初始化 `AppName` 容器时,如果没有预置配置文件,可以在命令行中设置相应环境变量对默认参数进行修改。类似命令如下:
|
||||
在初始化 `AppName` 容器时,如果没有预置配置文件,可以在命令行中设置相应环境变量对默认参数进行修改。类似命令如下(配置环境变量`APP_ENV_KEY_NAME`的值为`key_value`):
|
||||
|
||||
```shell
|
||||
$ docker run -d -e "APP_ENV_KEY_NAME=key_value" colovu/imgname
|
||||
@@ -117,24 +121,31 @@ max_wal_size = '400MB'
|
||||
+ `___` ==> `-` : 环境变量中的`三下划线`会被转义为设置属性中的`中划线`
|
||||
|
||||
|
||||
|
||||
### 常规配置参数
|
||||
|
||||
常规配置参数用来配置容器基本属性,一般情况下需要设置,主要包括:
|
||||
|
||||
-
|
||||
|
||||
|
||||
|
||||
### 常规可选参数
|
||||
|
||||
如果没有必要,可选配置参数可以不用定义,直接使用对应的默认值,主要包括:
|
||||
|
||||
- `ENV_DEBUG`:默认值:**false**。设置是否输出容器调试信息。可选值:1、true、yes
|
||||
|
||||
|
||||
|
||||
### 集群配置参数
|
||||
|
||||
配置服务为集群工作模式时,通过以下参数进行配置:
|
||||
|
||||
-
|
||||
|
||||
|
||||
|
||||
### TLS配置参数
|
||||
|
||||
配置服务使用 TLS 加密时,通过以下参数进行配置:
|
||||
@@ -170,6 +181,8 @@ services:
|
||||
...
|
||||
```
|
||||
|
||||
|
||||
|
||||
### 容器安全
|
||||
|
||||
本容器默认使用应用对应的运行时用户及用户组运行应用,以加强容器的安全性。在使用非`root`用户运行容器时,相关的资源访问会受限;应用仅能操作镜像创建时指定的路径及数据。使用`Non-root`方式的容器,更适合在生产环境中使用。
|
||||
|
||||
Reference in New Issue
Block a user