Skip to content

Commit e0a1660

Browse files
authored
feat: update doc for cronjob (#38)
1 parent 12257cb commit e0a1660

File tree

8 files changed

+54
-106
lines changed

8 files changed

+54
-106
lines changed

docs/img/cronjobs/app.png

90.6 KB
Loading

docs/img/cronjobs/backup_list.png

175 KB
Loading

docs/img/cronjobs/cronjob_create.png

-258 KB
Binary file not shown.

docs/img/cronjobs/cronjob_record.png

-344 KB
Binary file not shown.

docs/img/cronjobs/dir.png

98.6 KB
Loading

docs/img/cronjobs/record.png

284 KB
Loading

docs/img/cronjobs/shell.png

112 KB
Loading

docs/user_manual/cronjobs.md

Lines changed: 54 additions & 106 deletions
Original file line numberDiff line numberDiff line change
@@ -1,158 +1,106 @@
11

22

33
!!! note ""
4-
主要用于管理需要定时执行的任务,如定期执行某shell脚本、定期备份、定期访问url等,同时支持手动执行。
5-
6-
![img.png](../img/cronjobs/cronjob_create.png)
7-
{: .original}
4+
主要用于管理需要定时执行的任务,如定期执行某 shell 脚本、定期备份、定期访问 URL 等,同时支持手动执行。
5+
6+
基础概念:
7+
8+
- 任务类型:支持 Shell 脚本、备份应用、备份网站、备份数据库、备份目录 / 文件、备份日志、访问 URL、切割网站日志、缓存清理、系统快照、同步服务器时间;
9+
- 分组:将不同的计划任务设置为不同的分组,便于计划任务的快速筛选;
10+
- 执行周期:自定义执行周期仅支持【 分 时 日 月 周 】格式,如 0 0 * * * ,可参考 https://crontab.guru/ 修改执行周期。选择或输入完执行周期后,可以点击行末预览查看最近 5 次执行时间;
11+
- 保留份数:为防止备份或者日志的无限制增加,可设置保留份数保留最新成功的 n 份;
12+
- 备份账号:需要将备份文件上传的位置,在 [面板设置 - 备份账号] 中维护,支持多选,可同时备份到多个备份账号;
13+
- 默认下载地址:备份账号中需要设置一个固定的备份账号提供下载和获取文件大小操作,当该备份账号上传失败时,任务将失败,而非默认下载地址的其他备份账号上传失败时,会被忽略并继续;
14+
- 压缩密码:应用备份或者网站备份使用 tar 进行压缩,支持设置压缩密码,压缩加密使用 openssl,默认为不设置密码;
15+
- 排除规则:备份过程中,可设置特定的文件排除规则,忽略不希望加入备份压缩的目录;
16+
- 是否告警(✨专业版): 定时任务执行失败时可以触发告警通知,当前支持短信及邮箱告警;
17+
- 忽略错误:当任务中需要备份多个内容时,如备份所有数据库或应用,执行过程中出现错误是否需要忽略并且继续备份其他内容;
18+
- 超时时间:任务的执行超时时间;
19+
- 失败重试次数:失败后重试次数设置;
820

921
## 1 任务类型
1022

1123
### 1.1 Shell 脚本
1224

1325
!!! note "配置说明"
1426

15-
- 执行周期:选择当前计划任务的执行时间,可以同时配置多个执行周期
16-
- 在容器中执行:勾选后可以选择某个容器,在容器中执行指定的脚本
17-
- 脚本内容:具体需要执行的脚本内容
18-
- 是否告警(✨专业版):定时任务执行失败时可以触发告警通知
19-
- 保留份数:执行记录及执行日志的保留份数,默认保存为7份
20-
21-
### 1.2 备份应用
22-
23-
!!! note "配置说明"
27+
- 在容器中执行:勾选后可以选择某个容器,在容器中执行指定的脚本,支持选择容器用户及命令执行器;
28+
- 解释器:选择不同的解释器执行脚本内容,系统预设 bash python sh,支持自定义;
29+
- 脚本内容:具体需要执行的脚本内容,支持编辑、选择脚本库以及选择服务器脚本执行;
2430

25-
- 执行周期:选择当前计划任务的执行时间,可以同时配置多个执行周期
26-
- 备份应用:选择需要备份的应用,可以选择指定的应用备份,也可以备份所有应用
27-
- 备份账号:备份数据的存放位置,可以保存在当前服务器磁盘,或面板设置中配置的对象存储、FTP 等外部存储服务中
28-
- 压缩密码:备份数据压缩包的保护密码
29-
- 默认下载地址:当选择了多个备份账号,用于下载备份文件时默认使用的备份账号
30-
- 是否告警(✨专业版):定时任务执行失败时可以触发告警通知
31-
- 保留份数:默认保存为7份,保留就近备份文件的数量,可以减少备份所使用的空间
32-
- 排除规则:备份数据压缩包中需要排除的文件,例如日志文件、临时目录等,支持配置多个排除规则
31+
![img.png](../img/cronjobs/shell.png)
32+
{: .original}
3333

34-
### 1.3 备份网站
34+
### 2 备份应用 | 备份网站 | 备份数据库
3535

3636
!!! note "配置说明"
3737

38-
- 执行周期:选择当前计划任务的执行时间,可以同时配置多个执行周期
39-
- 备份网站:选择需要备份的网站,可以选择指定的网站备份,也可以备份所有网站
40-
- 备份账号:备份数据的存放位置,可以保存在当前服务器磁盘,或面板设置中配置的对象存储、FTP 等外部存储服务中
41-
- 压缩密码:备份数据压缩包的保护密码
42-
- 默认下载地址:当选择了多个备份账号,用于下载备份文件时默认使用的备份账号
43-
- 是否告警(✨专业版):定时任务执行失败时可以触发告警通知
44-
- 保留份数:默认保存为7份,保留就近备份文件的数量,可以减少备份所使用的空间
45-
- 排除规则:备份数据压缩包中需要排除的文件,例如日志文件、临时目录等,支持配置多个排除规则
46-
47-
### 1.4 备份数据库
48-
49-
!!! note "配置说明"
38+
备份应用、备份网站备份数据库大体相同,直接选择对应的备份内容,支持备份所有。
5039

51-
- 执行周期:选择当前计划任务的执行时间,可以同时配置多个执行周期
52-
- 备份数据库:选择需要备份的数据库,可以选择指定的数据库备份,也可以备份所有数据库
53-
- 备份账号:备份数据的存放位置,可以保存在当前服务器磁盘,或面板设置中配置的对象存储、FTP 等外部存储服务中
54-
- 压缩密码:备份数据压缩包的保护密码
55-
- 默认下载地址:当选择了多个备份账号,用于下载备份文件时默认使用的备份账号
56-
- 是否告警(✨专业版):定时任务执行失败时可以触发告警通知
57-
- 保留份数:默认保存为7份,保留就近备份文件的数量,可以减少备份所使用的空间
58-
- 排除规则:备份数据压缩包中需要排除的文件,例如日志文件、临时目录等,支持配置多个排除规则
40+
![img.png](../img/cronjobs/app.png)
41+
{: .original}
5942

60-
## 2 备份目录
43+
### 3 备份目录
6144

6245
!!! note "配置说明"
6346

64-
- 执行周期:选择当前计划任务的执行时间,可以同时配置多个执行周期
65-
- 备份目录:选择需要备份的目录
66-
- 备份账号:备份数据的存放位置,可以保存在当前服务器磁盘,或面板设置中配置的对象存储、FTP 等外部存储服务中
67-
- 压缩密码:备份数据压缩包的保护密码
68-
- 默认下载地址:当选择了多个备份账号,用于下载备份文件时默认使用的备份账号
69-
- 是否告警(✨专业版):定时任务执行失败时可以触发告警通知
70-
- 保留份数:默认保存为7份,保留就近备份文件的数量,可以减少备份所使用的空间
71-
- 排除规则:备份数据压缩包中需要排除的文件,例如日志文件、临时目录等,支持配置多个排除规则
47+
备份文件或目录,支持直接选择需要备份的多个文件,或者指定单个目录。
48+
49+
![img.png](../img/cronjobs/dir.png)
50+
{: .original}
7251

73-
## 3 备份日志
52+
### 4 备份日志
7453

7554
!!! note ""
7655
备份以下日志内容:
7756

78-
- 1Panel 系统日志
79-
- 服务器的 SSH 登录日志
80-
- 所有网站日志
81-
82-
!!! note "配置说明"
83-
84-
- 执行周期:选择当前计划任务的执行时间,可以同时配置多个执行周期
85-
- 备份账号:备份数据的存放位置,可以保存在当前服务器磁盘,或面板设置中配置的对象存储、FTP 等外部存储服务中
86-
- 压缩密码:备份数据压缩包的保护密码
87-
- 默认下载地址:当选择了多个备份账号,用于下载备份文件时默认使用的备份账号
88-
- 是否告警(✨专业版):定时任务执行失败时可以触发告警通知
89-
- 保留份数:默认保存为7份,保留就近备份文件的数量,可以减少备份所使用的空间
90-
91-
## 4 访问 URL
57+
- 1Panel 系统日志;
58+
- 服务器的 SSH 登录日志;
59+
- 所有网站日志;
9260

93-
!!! note "配置说明"
61+
### 5 访问 URL
9462

95-
- 执行周期:选择当前计划任务的执行时间,可以同时配置多个执行周期
96-
- 是否告警(✨专业版):定时任务执行失败时可以触发告警通知
97-
- 保留份数:执行记录及执行日志的保留份数,默认保存为7份
98-
- URL 地址:需要定时访问的 URL 地址
63+
!!! note ""
64+
URL 地址:需要定时访问的 URL 地址;
9965

100-
## 5 切割网站日志
66+
### 6 切割网站日志
10167

10268
!!! note ""
10369

10470
计划任务执行时会将指定网站的日志进行切割,将之前产生的日志保存在备份目录下。
10571

106-
!!! note "配置说明"
107-
108-
- 执行周期:选择当前计划任务的执行时间,可以同时配置多个执行周期
109-
- 网站:选择需要进行日志切割的网站,可以选择指定的网站,也可以选择所有网站
110-
- 是否告警(✨专业版):定时任务执行失败时可以触发告警通知
111-
- 保留份数:默认保存为7份,保留就近切割后日志文件的数量
112-
113-
## 6 缓存清理
72+
### 7 缓存清理
11473

11574
!!! note ""
11675

11776
定时执行面板 `工具箱` 菜单中的 `缓存清理` 任务。
11877

119-
!!! note "配置说明"
120-
121-
- 执行周期:选择当前计划任务的执行时间,可以同时配置多个执行周期
122-
- 是否告警(✨专业版):定时任务执行失败时可以触发告警通知
123-
- 保留份数:执行记录及执行日志的保留份数,默认保存为7份
124-
125-
## 7 系统快照
78+
### 8 系统快照
12679

12780
!!! note ""
12881
定时执行面板 `面本设置`-`快照` 菜单中的 `创建快照` 任务。
12982

130-
!!! note "配置说明"
131-
132-
- 执行周期:选择当前计划任务的执行时间,可以同时配置多个执行周期
133-
- 备份账号:备份数据的存放位置,可以保存在当前服务器磁盘,或面板设置中配置的对象存储、FTP 等外部存储服务中
134-
- 压缩密码:备份数据压缩包的保护密码
135-
- 默认下载地址:当选择了多个备份账号,用于下载备份文件时默认使用的备份账号
136-
- 是否告警(✨专业版):定时任务执行失败时可以触发告警通知
137-
- 保留份数:默认保存为7份,保留就近备份文件的数量,可以减少备份所使用的空间
138-
- 排除规则:备份数据压缩包中需要排除的文件,例如日志文件、临时目录等,支持配置多个排除规则
139-
140-
## 8 同步服务器时间
83+
### 9 同步服务器时间
14184

14285
!!! note ""
14386
定时从 `工具箱`-`快速设置` 页面配置的 NTP 服务器进行时间同步。
14487

145-
!!! note "配置说明"
88+
## 执行报告
14689

147-
- 执行周期:选择当前计划任务的执行时间,可以同时配置多个执行周期
148-
- 是否告警(✨专业版):定时任务执行失败时可以触发告警通知
149-
- 保留份数:执行记录及执行日志的保留份数,默认保存为7份
90+
### 下载与查看
91+
!!! note ""
92+
备份类型的计划任务,可在计划任务列表直接查看备份文件份数,并支持下载操作。
15093

151-
## 9 执行报告
94+
![img.png](../img/cronjobs/backup_list.png)
95+
{: .original}
15296

15397
!!! note ""
98+
显示该任务产生的所有报告详情,支持时间、状态筛选。
15499

155-
显示该任务产生的所有报告详情,支持时间、状态筛选,如果计划任务为备份,则可通过报告详情的下载按钮直接下载。
156-
157-
![img.png](../img/cronjobs/cronjob_record.png)
100+
![img.png](../img/cronjobs/record.png)
158101
{: .original}
102+
103+
## 导入导出
104+
105+
!!! note ""
106+
计划任务支持通过 json 文件一键导入或导出操作,导入计划任务时,如果存在相关内容关联异常的情况将修改计划任务状态为待编辑,如果导入计划任务名称已存在将被忽略。

0 commit comments

Comments
 (0)