docs: 完善注释

docker/docker-compose.yml

@@ -1,6 +1,6 @@
 version: '3'
 
-# 创建一个名为 "youlai-boot" 的桥接网络
+# 创建一个名为 "youlai-boot" 的桥接网络，在同一个网络中的容器可以通过容器名互相访问
 networks:
   youlai-boot:
     driver: bridge

docker/run.md

@@ -1,5 +1,5 @@
 
-# MySQL
+#  Docker Compose 安装中间件 MySQL、Redis、Minio、Xxl-Job
 
 ## 安装
 
@@ -7,7 +7,7 @@
 docker-compose -f docker-compose.yml -p youlai-boot up -d
 ```
 
-- p youlai-boot 指定命名空间，避免与其他容器冲突
+- p youlai-boot 指定命名空间，避免与其他容器冲突，这里方便管理，统一管理和卸载
 
 ## 卸载
 ```bash

src/main/java/com/youlai/boot/YouLaiBootApplication.java

@@ -12,8 +12,8 @@ import org.springframework.scheduling.annotation.EnableScheduling;
  * @since 0.0.1
  */
 @SpringBootApplication
-@ConfigurationPropertiesScan
+@ConfigurationPropertiesScan // 开启配置属性绑定
-@EnableScheduling
+@EnableScheduling // 开启定时任务
 public class YouLaiBootApplication {
 
     public static void main(String[] args) {

src/main/resources/application-dev.yml

@@ -96,6 +96,7 @@ security:
   unsecured-urls:
     - ${springdoc.swagger-ui.path}
     - /doc.html
+    - /swagger-ui/**
     - /v3/api-docs/**
     - /webjars/**
 
@@ -180,16 +181,17 @@ xxl:
     # 定时任务开关
     enabled: false
     admin:
-      # 多个地址使用,分割
+      # 调度中心地址,多个逗号分隔
       addresses: http://127.0.0.1:8080/xxl-job-admin
     accessToken: default_token
+    # 执行器配置
     executor:
-      appname: xxl-job-executor-${spring.application.name}
+      appname: xxl-job-executor-${spring.application.name} # 执行器AppName
-      address:
+      address: # 执行器注册地址，默认为空，多网卡时可手动设置
-      ip:
+      ip: # 执行器IP，默认为空，多网卡时可手动设置
-      port: 9999
+      port: 9999 # 执行器通讯端口
-      logpath: /data/applogs/xxl-job/jobhandler
+      logpath: /data/applogs/xxl-job/jobhandler # 任务运行日志文件存储磁盘路径
-      logretentiondays: 30
+      logretentiondays: 30 # 日志保存天数，值大于3时生效
 
 # 验证码配置
 captcha:

src/main/resources/application-prod.yml

@@ -95,6 +95,7 @@ security:
   unsecured-urls:
     - ${springdoc.swagger-ui.path}
     - /doc.html
+    - /swagger-ui/**
     - /v3/api-docs/**
     - /webjars/**
 
@@ -179,7 +180,7 @@ xxl:
     enabled: false
     admin:
       # 多个地址使用,分割
-      addresses: http://127.0.0.1:8080/xxl-job-admin
+      addresses: http://127.0.0.1:8686/xxl-job-admin
     accessToken: default_token
     executor:
       appname: xxl-job-executor-${spring.application.name}