dominik/homepage-plus
1
0
Fork 0
mirror of https://github.com/DI0IK/homepage-plus.git synced 2025-07-16 09:49:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

add mkdocs

Browse source
This commit is contained in:
Ben Phelps 2023-09-29 21:01:11 +03:00
parent b215843b26
commit 47765ee05e
144 changed files with 4219 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

23
docs/widgets/services/urbackup.md Normal file
View file

@ -0,0 +1,23 @@
---
title: UrBackup
description: UrBackup Widget Configuration
---
The UrBackup widget retrieves the total number of clients that currently have no errors, have errors, or haven't backed up recently. Clients are considered "Errored" or "Out of Date" if either the file or image backups for that client have errors/are out of date, unless the client does not support image backups.
The default number of days that can elapse before a client is marked Out of Date is 3, but this value can be customized by setting the `maxDays` value in the config.
Optionally, the widget can also report the total amount of disk space consumed by backups. This is disabled by default, because it requires a second API call.
Note: client status is only shown for backups that the specified user has access to. Disk Usage shown is the total for all backups, regardless of permissions.
Allowed fields: `["ok", "errored", "noRecent", "totalUsed"]`. _Note that `totalUsed` will not be shown unless explicitly included in `fields`._
```yaml
widget:
type: urbackup
username: urbackupUsername
password: urbackupPassword
url: http://urbackupUrl:55414
maxDays: 5 # optional
```