From fb8f95b29535ee77ed4645dd1bed066f0045cd19 Mon Sep 17 00:00:00 2001 From: Endial Fang Date: Tue, 8 Sep 2020 10:09:04 +0800 Subject: [PATCH] =?UTF-8?q?[fix]=E6=9B=B4=E6=96=B0README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Dockerfile | 2 +- README.md | 29 +++++++++++++++-------------- 2 files changed, 16 insertions(+), 15 deletions(-) diff --git a/Dockerfile b/Dockerfile index 2c39a14..5525a97 100644 --- a/Dockerfile +++ b/Dockerfile @@ -10,7 +10,7 @@ ARG apt_source=default # 外部指定应用版本信息，如 "--build-arg app_ver=6.0.0" ARG app_ver=5.0.8 -# 编译镜像时指定本地服务器地址，如 "--build-arg local_url=http://172.29.14.108/dist-files/" +# 编译镜像时指定用于加速的本地服务器地址 ARG local_url="" # 定义应用基础常量信息，该常量在容器内可使用 diff --git a/README.md b/README.md index 9128685..b92eaaf 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ **镜像信息** -* 镜像地址：colovu/appname:latest +* 镜像地址：colovu/imgname:latest @@ -21,13 +21,13 @@ Docker 快速启动命令： ```shell -$ docker run -d --name appname colovu/appname:latest +$ docker run -d colovu/imgname ``` Docker-Compose 快速启动命令： ```shell -$ curl -sSL https://raw.githubusercontent.com/colovu/docker-appname/master/docker-compose.yml > docker-compose.yml +$ curl -sSL https://raw.githubusercontent.com/colovu/docker-imgname/master/docker-compose.yml > docker-compose.yml $ docker-compose up -d ``` @@ -46,17 +46,18 @@ $ docker-compose up -d ### 数据卷 -镜像默认提供以下数据卷定义，默认数据分别存储在自动生成的应用名对应`AppName`子目录中： +镜像默认提供以下数据卷定义，默认数据分别存储在自动生成的应用名对应`imgname`子目录中： ```shell -/var/datalog # 数据操作日志文件 -/srv/conf # 配置文件 -/srv/data # 数据文件，主要存放应用数据 -/var/log # 日志输出 -/var/run # 系统运行时文件，如 PID 文件 +/var/datalog # 数据操作日志文件 +/srv/conf # 配置文件 +/srv/data # 数据文件，主要存放应用数据 +/srv/cert # 证书文件存放目录 +/var/log # 日志输出 +/var/run # 系统运行时文件，如 PID 文件 ``` -如果需要持久化存储相应数据，需要**在宿主机建立本地目录**，并在使用镜像初始化容器时进行映射。宿主机相关的目录中如果不存在对应应用`AppName`的子目录或相应数据文件，则容器会在初始化时创建相应目录及文件。 +如果需要持久化存储相应数据，需要**在宿主机建立本地目录**，并在使用镜像初始化容器时进行映射。宿主机相关的目录中如果不存在对应应用`imgname`的子目录或相应数据文件，则容器会在初始化时创建相应目录及文件。 @@ -65,7 +66,7 @@ $ docker-compose up -d 在初始化 `AppName` 容器时，如果没有预置配置文件，可以在命令行中设置相应环境变量对默认参数进行修改。类似命令如下： ```shell -$ docker run -d -e "APP_INIT_LIMIT=10" --name appname colovu/appname:latest +$ docker run -d -e "APP_ENV_KEY_NAME=key_value" colovu/imgname ``` @@ -109,14 +110,14 @@ ALLOW_EMPTY_PASSWORD=yes 通过配置环境变量`APPNAME_PASSWORD`，可以启用基于密码的用户认证功能。命令行使用参考： ```shell -$ docker run -d -e APPNAME_PASSWORD=colovu colovu/appname:latest +$ docker run -d -e APPNAME_PASSWORD=colovu colovu/imgname ``` 使用 Docker-Compose 时，`docker-compose.yml`应包含类似如下配置： ```yaml services: - appname: + imgname: ... environment: - APPNAME_PASSWORD=colovu @@ -131,7 +132,7 @@ services: ## 注意事项 -- 容器中启动参数不能配置为后台运行，如果应用使用后台方式运行，则容器的启动命令会在运行后自动退出，从而导致容器退出；只能使用前台运行方式，如：`daemonize no` +- 容器中启动参数不能配置为后台运行，如果应用使用后台方式运行，则容器的启动命令会在运行后自动退出，从而导致容器退出