From 537c2fc108f92c45a64905e62ddf3f57bc76bf0b Mon Sep 17 00:00:00 2001 From: MemoryShadow Date: Mon, 29 Jul 2024 06:35:06 +0000 Subject: [PATCH] perf: Use the.env file instead to modify docker-compose.yml --- .env.example | 13 ++++++++++ .gitignore | 1 + docker-compose.yml | 40 +++++++++++++++---------------- docs/quickstart/docker-install.md | 23 +++++++++++++----- 4 files changed, 51 insertions(+), 26 deletions(-) create mode 100644 .env.example diff --git a/.env.example b/.env.example new file mode 100644 index 00000000..fcb6a56f --- /dev/null +++ b/.env.example @@ -0,0 +1,13 @@ +SERVICE_PORT=1081 +VOLUME_BASE=/data/orion-visor-space/docker-volumes +MYSQL_HOST=mysql +MYSQL_PORT=3306 +MYSQL_DATABASE=orion_visor +MYSQL_USER=orion +MYSQL_PASSWORD=Data@123456 +MYSQL_ROOT_PASSWORD=Data@123456 + +REDIS_HOST=redis +REDIS_PASSWORD=Data@123456 + +SECRET_KEY=uQeacXV8b3isvKLK \ No newline at end of file diff --git a/.gitignore b/.gitignore index c8088e13..35246529 100644 --- a/.gitignore +++ b/.gitignore @@ -33,3 +33,4 @@ build/ ### VS Code ### .vscode/ +.env diff --git a/docker-compose.yml b/docker-compose.yml index be588b1c..14f8a5e0 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -4,19 +4,19 @@ services: image: registry.cn-hangzhou.aliyuncs.com/lijiahangmax/orion-visor-service:2.1.2 privileged: true ports: - - 1081:80 + - ${SERVICE_PORT:-1081}:80 environment: - - MYSQL_HOST=mysql - - MYSQL_PORT=3306 - - MYSQL_DATABASE=orion_visor - - MYSQL_USER=root - - MYSQL_PASSWORD=Data@123456 - - REDIS_HOST=redis - - REDIS_PASSWORD=Data@123456 - - SECRET_KEY=uQeacXV8b3isvKLK - - DEMO_MODE=false + - MYSQL_HOST=${MYSQL_HOST:-mysql} + - MYSQL_PORT=${MYSQL_PORT:-3306} + - MYSQL_DATABASE=${MYSQL_DATABASE:-orion_visor} + - MYSQL_USER=${MYSQL_USER:-root} + - MYSQL_PASSWORD=${MYSQL_PASSWORD:-Data@123456} + - REDIS_HOST=${REDIS_HOST:-redis} + - REDIS_PASSWORD=${REDIS_PASSWORD:-Data@123456} + - SECRET_KEY=${SECRET_KEY:-uQeacXV8b3isvKLK} + - DEMO_MODE=${DEMO_MODE:-false} volumes: - - /data/orion-visor-space/docker-volumes/service/root-orion:/root/orion + - ${VOLUME_BASE:-/data/orion-visor-space/docker-volumes}/service/root-orion:/root/orion healthcheck: test: [ "CMD", "curl", "http://127.0.0.1:9200/orion-visor/api/server/bootstrap/health" ] interval: 3s @@ -37,14 +37,14 @@ services: ports: - 3307:3306 environment: - - MYSQL_DATABASE=orion_visor - - MYSQL_USER=orion - - MYSQL_PASSWORD=Data@123456 - - MYSQL_ROOT_PASSWORD=Data@123456 + - MYSQL_DATABASE=${MYSQL_DATABASE:-orion_visor} + - MYSQL_USER=${MYSQL_USER:-orion} + - MYSQL_PASSWORD=${MYSQL_PASSWORD:-Data@123456} + - MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD:-Data@123456} volumes: - - /data/orion-visor-space/docker-volumes/mysql/var-lib-mysql:/var/lib/mysql - - /data/orion-visor-space/docker-volumes/mysql/var-lib-mysql-files:/var/lib/mysql-files - - /data/orion-visor-space/docker-volumes/mysql/etc-mysql:/etc/mysql + - ${VOLUME_BASE:-/data/orion-visor-space/docker-volumes}/mysql/var-lib-mysql:/var/lib/mysql + - ${VOLUME_BASE:-/data/orion-visor-space/docker-volumes}/mysql/var-lib-mysql-files:/var/lib/mysql-files + - ${VOLUME_BASE:-/data/orion-visor-space/docker-volumes}/mysql/etc-mysql:/etc/mysql healthcheck: test: [ "CMD", "bash", "-c", "cat < /dev/null > /dev/tcp/127.0.0.1/3306" ] interval: 3s @@ -57,9 +57,9 @@ services: ports: - 6380:6379 environment: - - REDIS_PASSWORD=Data@123456 + - REDIS_PASSWORD=${REDIS_PASSWORD:-Data@123456} volumes: - - /data/orion-visor-space/docker-volumes/redis/data:/data + - ${VOLUME_BASE:-/data/orion-visor-space/docker-volumes}/redis/data:/data command: sh -c "redis-server /usr/local/redis.conf --requirepass $${REDIS_PASSWORD}" healthcheck: test: [ "CMD", "redis-cli", "--raw", "incr", "ping" ] diff --git a/docs/quickstart/docker-install.md b/docs/quickstart/docker-install.md index 1dc4f3fd..568e59a9 100644 --- a/docs/quickstart/docker-install.md +++ b/docs/quickstart/docker-install.md @@ -31,12 +31,23 @@ git clone https://gitee.com/lijiahangmax/orion-visor ``` # 进入仓库目录 cd orion-visor -# 修改 docker-compose.yml (建议修改) - # MYSQL_USER mysql 用户名 - # MYSQL_PASSWORD mysql 用户密码 - # MYSQL_ROOT_PASSWORD mysql root 密码 - # REDIS_PASSWORD redis 密码 - # SECRET_KEY 加密密钥 +# 创建名为 .env 的 .env.example 副本 +cp .env.example .env +# 将其中的值删除以保持默认或将其修改为你喜欢的值 + # SERVICE_PORT 你希望服务监听的端口 + # VOLUME_BASE 你希望数据持久化保存的目录, 如果不提前创建将以 docker 进程宿主身份创建(通常是 root) + + # MYSQL_HOST mysql 服务所在的主机, 如果你没有现有的 MySQL 请保持值为 mysql, 如果你有自部署的请在 docker-compose.yml 中移除 services.mysql 以节约性能 + # MYSQL_PORT mysql 监听的端口 + # MYSQL_DATABASE mysql 数据库 + # MYSQL_USER mysql 用户名 + # MYSQL_PASSWORD mysql 用户密码 + # MYSQL_ROOT_PASSWORD mysql root 密码 + + # REDIS_HOST redis 服务所在的主机, 如果你没有现有的 Redis 请保持值为 redis, 如果你有自部署的请在 docker-compose.yml 中移除 services.redis 以节约性能 + # REDIS_PASSWORD redis 密码 + + # SECRET_KEY 加密密钥 ``` ### 启动