Skip to content

Commit fe69f60

Browse files
authored
docs: 完善计划任务相关文档 (#20)
1 parent 529e358 commit fe69f60

File tree

1 file changed

+128
-25
lines changed

1 file changed

+128
-25
lines changed

docs/user_manual/cronjobs.md

Lines changed: 128 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,155 @@
1-
## 1 计划任务
1+
## 功能说明
22

33
!!! Abstract ""
44
主要用于管理需要定时执行的任务,如定期执行某shell脚本、定期备份、定期访问url等,同时支持手动执行。
55

66
![img.png](../img/cronjobs/cronjob_create.png)
77

8-
## 2 Shell 脚本
8+
## 任务类型
9+
10+
### 1 Shell 脚本
11+
12+
!!! Abstract "配置说明"
13+
- 执行周期:选择当前计划任务的执行时间,可以同时配置多个执行周期;
14+
- 在容器中执行:勾选后可以选择某个容器,在容器中执行指定的脚本;
15+
- 脚本内容:具体需要执行的脚本内容;
16+
- 是否告警(✨专业版):定时任务执行失败时可以触发告警通知;
17+
- 保留份数:执行记录及执行日志的保留份数,默认保存为7份;
18+
19+
### 2 备份应用
20+
21+
!!! Abstract "配置说明"
22+
23+
- 执行周期:选择当前计划任务的执行时间,可以同时配置多个执行周期;
24+
- 备份应用:选择需要备份的应用,可以选择指定的应用备份,也可以备份所有应用;
25+
- 备份账号:备份数据的存放位置,可以保存在当前服务器磁盘,或面板设置中配置的对象存储、FTP 等外部存储服务中;
26+
- 压缩密码:备份数据压缩包的保护密码;
27+
- 默认下载地址:当选择了多个备份账号,用于下载备份文件时默认使用的备份账号;
28+
- 是否告警(✨专业版):定时任务执行失败时可以触发告警通知;
29+
- 保留份数:默认保存为7份,保留就近备份文件的数量,可以减少备份所使用的空间;
30+
- 排除规则:备份数据压缩包中需要排除的文件,例如日志文件、临时目录等,支持配置多个排除规则;
31+
32+
### 3 备份网站
33+
34+
!!! Abstract "配置说明"
35+
36+
- 执行周期:选择当前计划任务的执行时间,可以同时配置多个执行周期;
37+
- 备份网站:选择需要备份的网站,可以选择指定的网站备份,也可以备份所有网站;
38+
- 备份账号:备份数据的存放位置,可以保存在当前服务器磁盘,或面板设置中配置的对象存储、FTP 等外部存储服务中;
39+
- 压缩密码:备份数据压缩包的保护密码;
40+
- 默认下载地址:当选择了多个备份账号,用于下载备份文件时默认使用的备份账号;
41+
- 是否告警(✨专业版):定时任务执行失败时可以触发告警通知;
42+
- 保留份数:默认保存为7份,保留就近备份文件的数量,可以减少备份所使用的空间;
43+
- 排除规则:备份数据压缩包中需要排除的文件,例如日志文件、临时目录等,支持配置多个排除规则;
44+
45+
### 4 备份数据库
46+
47+
!!! Abstract "配置说明"
48+
49+
- 执行周期:选择当前计划任务的执行时间,可以同时配置多个执行周期;
50+
- 备份数据库:选择需要备份的数据库,可以选择指定的数据库备份,也可以备份所有数据库;
51+
- 备份账号:备份数据的存放位置,可以保存在当前服务器磁盘,或面板设置中配置的对象存储、FTP 等外部存储服务中;
52+
- 压缩密码:备份数据压缩包的保护密码;
53+
- 默认下载地址:当选择了多个备份账号,用于下载备份文件时默认使用的备份账号;
54+
- 是否告警(✨专业版):定时任务执行失败时可以触发告警通知;
55+
- 保留份数:默认保存为7份,保留就近备份文件的数量,可以减少备份所使用的空间;
56+
- 排除规则:备份数据压缩包中需要排除的文件,例如日志文件、临时目录等,支持配置多个排除规则;
57+
58+
## 5 备份目录
59+
60+
!!! Abstract "配置说明"
61+
62+
- 执行周期:选择当前计划任务的执行时间,可以同时配置多个执行周期;
63+
- 备份目录:选择需要备份的目录;
64+
- 备份账号:备份数据的存放位置,可以保存在当前服务器磁盘,或面板设置中配置的对象存储、FTP 等外部存储服务中;
65+
- 压缩密码:备份数据压缩包的保护密码;
66+
- 默认下载地址:当选择了多个备份账号,用于下载备份文件时默认使用的备份账号;
67+
- 是否告警(✨专业版):定时任务执行失败时可以触发告警通知;
68+
- 保留份数:默认保存为7份,保留就近备份文件的数量,可以减少备份所使用的空间;
69+
- 排除规则:备份数据压缩包中需要排除的文件,例如日志文件、临时目录等,支持配置多个排除规则;
70+
71+
## 6 备份日志
972

1073
!!! Abstract ""
11-
输入任务名称,选择执行周期,输入执行的脚本内容。
1274

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

15101
!!! Abstract ""
16102

17-
- 执行周期,选择备份网站的执行时间;
18-
- 选择需要备份的网站,可以选择指定的网站备份,也可以备份所有网站;
19-
- 备份地点这里可以选择你安装存储相关的插件。如阿里云OSS、亚马逊 S3 云存储、MINIO、SFTP,和当前服务器磁盘;
20-
- 备份保留数量,默认保存为7份,保留就近备份文件的数量,可以减少备份所使用的空间;
21-
- 若是备份到服务器磁盘,则默认备份路径路径为 [安装目录]/1panel/backup/website。
103+
计划任务执行时会将指定网站的日志进行切割,将之前产生的日志保存在备份目录下。
104+
105+
!!! Abstract "配置说明"
106+
107+
- 执行周期:选择当前计划任务的执行时间,可以同时配置多个执行周期;
108+
- 网站:选择需要进行日志切割的网站,可以选择指定的网站,也可以选择所有网站;
109+
- 是否告警(✨专业版):定时任务执行失败时可以触发告警通知;
110+
- 保留份数:默认保存为7份,保留就近切割后日志文件的数量;
22111

23-
## 4 备份数据库
112+
## 9 缓存清理
24113

25114
!!! Abstract ""
26115

27-
- 执行周期,选择备份网站的执行时间;
28-
- 选择需要备份的数据库,可以选择指定的数据库备份,也可以备份所有数据库;
29-
- 备份地点这里可以选择你安装存储相关的插件。如阿里云OSS、亚马逊 S3 云存储、MINIO、SFTP,和当前服务器磁盘;
30-
- 备份保留数量,默认保存为7份,保留就近备份文件的数量,可以减少备份所使用的空间;
31-
- 若是备份到服务器磁盘,则默认备份路径路径为 [安装目录]/1panel/backup/database。
116+
定时执行面板 `工具箱` 菜单中的 `缓存清理` 任务。
32117

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

35126
!!! Abstract ""
36127

37-
- 执行周期,选择备份网站的执行时间;
38-
- 选择需要备份的文件目录;
39-
- 备份地点这里可以选择你安装存储相关的插件。如阿里云OSS、亚马逊 S3 云存储、MINIO、SFTP,和当前服务器磁盘;
40-
- 备份保留数量,默认保存为7份,保留就近备份文件的数量,可以减少备份所使用的空间;
41-
- 若是备份到服务器磁盘,则默认备份路径路径为/www/backup/database;
42-
- 支持设置排除文件,但是系统要求必须以换行符分隔,一行一个。
128+
定时执行面板 `面本设置`-`快照` 菜单中的 [`创建快照`](../settings/#5) 任务,。
129+
130+
!!! Abstract "配置说明"
43131

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

46142
!!! Abstract ""
47-
用于自动执行URL地址访问,设置任务名称、执行周期和访问地址就可以计划访问URL地址了。
48143

49-
## 7 计划报告
144+
定时从 `工具箱`-`快速设置` 页面配置的 NTP 服务器进行时间同步。
145+
146+
!!! Abstract "配置说明"
147+
148+
- 执行周期:选择当前计划任务的执行时间,可以同时配置多个执行周期;
149+
- 是否告警(✨专业版):定时任务执行失败时可以触发告警通知;
150+
- 保留份数:执行记录及执行日志的保留份数,默认保存为7份;
151+
152+
## 执行报告
50153

51154
!!! Abstract ""
52155
显示该任务产生的所有报告详情,支持时间、状态筛选,如果计划任务为备份,则可通过报告详情的下载按钮直接下载。

0 commit comments

Comments
 (0)