Skip to content

Commit 162dab7

Browse files
committed
docs(tasks): add page with configurable job intervals and option to disable
1 parent c459de5 commit 162dab7

File tree

3 files changed

+42
-0
lines changed

3 files changed

+42
-0
lines changed
8.77 KB
Loading
92.9 KB
Loading

docs/management/tasks/index.mdx

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
tags:
3+
- Background
4+
- Jobs
5+
- Tasks
6+
---
7+
8+
# Tasks
9+
10+
Homarr has background jobs for various tasks, most of them are for realtime widget updates.
11+
The tasks page allows you to run background jobs manually and configure them.
12+
13+
![Tasks page](./img/tasks.png)
14+
15+
## Opening the certificates page
16+
17+
Navigate to `Management` > `Tools` > `Tasks`.
18+
The page is only accessible to users with admin permission.
19+
20+
## Actions
21+
22+
You can find different actions for each task on the right side of a task item.
23+
24+
### Run Manually
25+
26+
To run a task manually, click the "Play" button, which will execute the task immediately.
27+
During the exection the badge will show `Running`.
28+
29+
### Disabling / Enabling
30+
31+
You can disable a task by clicking the "Power" button, which will change it to a "Power-Off" button.
32+
When a task is disabled, it will not run automatically according to its schedule.
33+
You can enable it again by clicking the "Power-Off" button, which will change it back to a "Power" button.
34+
Running a task manually is still possible when it is disabled.
35+
36+
### Settings
37+
38+
The settings button (gear icon) allows you to configure the task's interval.
39+
Different intervals are available, such as `1 minute`, `5 minutes`, `10 minutes`, `30 minutes`, and `1 hour`.
40+
All intervals are cron expressions, which means it will run the next time the cron expression matches the current time.
41+
42+
![Task settings](./img/settings.png)

0 commit comments

Comments
 (0)