[feat]更新脚本组织结构

This commit is contained in:
2020-12-17 11:00:05 +08:00
parent 2156409165
commit ec23acf9bc
24 changed files with 575 additions and 364 deletions
+35 -4
View File
@@ -4,7 +4,7 @@
使用说明可参照:[官方说明]()
<img src="img/AppName-logo.png" alt="AppName-logo" style="zoom: 33%;" />
**版本信息:**
@@ -12,7 +12,7 @@
**镜像信息:**
* 镜像地址:colovu/imgname:latest
* 镜像地址:registry.cn-shenzhen.aliyuncs.com/colovu/imgname
@@ -21,7 +21,7 @@
Docker 快速启动命令:
```shell
$ docker run -d colovu/imgname
$ docker run -d -e ALLOW_ANONYMOUS_LOGIN=yes colovu/imgname
```
Docker-Compose 快速启动命令:
@@ -71,6 +71,37 @@ $ docker run -d -e "APP_ENV_KEY_NAME=key_value" colovu/imgname
### 自动变量替换
针对配置文件中的配置项,支持环境变量名自动替换,该类环境变量定义规则为:`APP_CFG_*=<val>`
- `APP_CFG_`:环境变量自动替换标识,具备该前缀的环境变量会被自动处理并更新至配置文件
- `*`:配置文件中对应的配置项名,特殊字符替换规则
- `<val>`:配置项对应值
例如:
```shell
# 设置配置文件中配置项 max_wal_size,传入容器的变量为(两者都可以):
PG_CFG_max_wal_size=400MB
PG_CFG_max_wal_size="400MB"
# 容器启动后,应用配置文件中对应配置项生效,且设置为相应值:
max_wal_size = '400MB'
```
**特殊字符替换规则**
- 针对使用`xml`格式的配置文件
+ `_` ==> `.` : 环境变量中的`下划线`会被转义为设置属性中的`半角点`
+ `__` ==> `_` : 环境变量中的`双下划线`会被转义为设置属性中的`单下划线`
+ `___` ==> `-` : 环境变量中的`三下划线`会被转义为设置属性中的`中划线`
- 针对使用`key-val`格式的配置文件
+ `_` ==> `_` : 环境变量中的`下划线`不会被替换
+ `__` ==> `.` : 环境变量中的`双下划线`会被转义为设置属性中的`半角点`
+ `___` ==> `-` : 环境变量中的`三下划线`会被转义为设置属性中的`中划线`
### 常规配置参数
常规配置参数用来配置容器基本属性,一般情况下需要设置,主要包括:
@@ -104,7 +135,7 @@ $ docker run -d -e "APP_ENV_KEY_NAME=key_value" colovu/imgname
`AppName`镜像默认禁用了无密码访问功能,在实际生产环境中建议使用用户名及密码控制访问;如果为了测试需要,可以使用以下环境变量启用无密码访问功能:
```shell
ALLOW_EMPTY_PASSWORD=yes
ALLOW_ANONYMOUS_LOGIN=yes
```
通过配置环境变量`APPNAME_PASSWORD`,可以启用基于密码的用户认证功能。命令行使用参考: