Skip to content

Commit 5bd1a81

Browse files
committed
docs(guide): 更新 XXL-JOB 安装部署文档并优化 Docker 配置
1 parent bc514fb commit 5bd1a81

File tree

3 files changed

+30
-14
lines changed

3 files changed

+30
-14
lines changed

doc/XXL-JOB官方文档.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1826,13 +1826,18 @@ git clone --branch "$(curl -s https://api.github.com/repos/xuxueli/xxl-job/relea
18261826
mvn clean package -Dmaven.test.skip=true
18271827
```
18281828

1829-
- 第三步:启动 XXL-JOB
1829+
- 第三步:配置 XXL-JOB
18301830
```
1831+
// 注意:前往docker目录,自定义 .env 配置;如修改 MYSQL_PATH 配置设置Mysql数据持久化目录;
1832+
cd ./docker
1833+
cat .env
1834+
```
1835+
1836+
- 第四步:启动 XXL-JOB
1837+
```
1838+
// 启动
18311839
docker compose down
18321840
docker compose up -d
1833-
1834-
// 其他:如需调整环境配置,如Mysql密码、端口等,可以在docker-compose.yml中修改;另外,如果需要修改Mysql数据持久化目录,可以通过 MYSQL_PATH 变量在启动时快速设置;
1835-
MYSQL_PATH={自定义数据库持久化目录} docker compose up -d
18361841
```
18371842

18381843
### 5.25 优雅停机
@@ -2753,8 +2758,11 @@ public void execute() {
27532758
git clone --branch "$(curl -s https://api.github.com/repos/xuxueli/xxl-job/releases/latest | jq -r .tag_name)" https://github.com/xuxueli/xxl-job.git
27542759
// 构建 XXL-JOB
27552760
mvn clean package -Dmaven.test.skip=true
2761+
// 配置 XXL-JOB(前往docker目录,自定义 .env)
2762+
cd ./docker
2763+
cat .env
27562764
// 启动 XXL-JOB
2757-
MYSQL_PATH={自定义数据库持久化目录} docker compose up -d
2765+
docker compose up -d
27582766
// 停止 XXL-JOB
27592767
docker compose down
27602768
```

docker/.env

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
2+
# admin
3+
XXL_JOB_ADMIN_PORT=8080
4+
5+
# database
6+
MYSQL_ROOT_PASSWORD=root_pwd
7+
MYSQL_PATH=/Users/admin/program/docker/instance/mysql2
Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,18 @@ services:
77
container_name: xxl-job-mysql
88
environment:
99
# 1、数据库密码设置,需要与Admin中配置一致:
10-
MYSQL_ROOT_PASSWORD: root_pwd
10+
MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASSWORD}
1111
# 2、数据库实例名称,需要与Admin中配置一致;
1212
MYSQL_DATABASE: xxl_job
1313
ports:
1414
- "3306:3306"
1515
volumes:
1616
# 说明:仅数据库首次初始化时执行;
17-
- ./doc/db/tables_xxl_job.sql:/docker-entrypoint-initdb.d/tables_xxl_job.sql:ro
17+
- ../doc/db/tables_xxl_job.sql:/docker-entrypoint-initdb.d/tables_xxl_job.sql:ro
1818
# 3、数据库持久化目录位置,建议自定义:
19-
- ${MYSQL_PATH:-/Users/admin/program/docker/instance/mysql}/conf:/etc/mysql/conf.d
20-
- ${MYSQL_PATH:-/Users/admin/program/docker/instance/mysql}/logs:/var/log/mysql
21-
- ${MYSQL_PATH:-/Users/admin/program/docker/instance/mysql}/data:/var/lib/mysql
19+
- ${MYSQL_PATH}/conf:/etc/mysql/conf.d
20+
- ${MYSQL_PATH}/logs:/var/log/mysql
21+
- ${MYSQL_PATH}/data:/var/lib/mysql
2222
command: >-
2323
--character-set-server=utf8mb4
2424
--collation-server=utf8mb4_unicode_ci
@@ -34,17 +34,17 @@ services:
3434
#image: xuxueli/xxl-job-admin:{version}
3535
image: xuxueli/xxl-job-admin:local
3636
build:
37-
context: ./xxl-job-admin
37+
context: ../xxl-job-admin
3838
dockerfile: Dockerfile
3939
container_name: xxl-job-admin
4040
environment:
4141
# 5、数据库密码设置,需要与上文Mysql中保持一致:
4242
PARAMS: >-
4343
--spring.datasource.url=jdbc:mysql://mysql:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
4444
--spring.datasource.username=root
45-
--spring.datasource.password=root_pwd
45+
--spring.datasource.password=${MYSQL_ROOT_PASSWORD}
4646
ports:
47-
- "8080:8080"
47+
- "8080:${XXL_JOB_ADMIN_PORT}"
4848
depends_on:
4949
mysql:
5050
condition: service_healthy
@@ -58,7 +58,8 @@ services:
5858
dockerfile: Dockerfile
5959
container_name: xxl-job-executor-sample-springboot
6060
environment:
61-
PARAMS: "--xxl.job.admin.addresses=http://xxl-job-admin:8080/xxl-job-admin"
61+
PARAMS: >-
62+
--xxl.job.admin.addresses=http://xxl-job-admin:${XXL_JOB_ADMIN_PORT}/xxl-job-admin
6263
ports:
6364
- "9999:9999"
6465
depends_on:

0 commit comments

Comments
 (0)