mirror of
https://github.com/gethomepage/homepage.git
synced 2025-12-07 09:35:54 -08:00
d8e45a2fbc
Add technitium widget documentation Update "en" common translation file Update home widget files to include the technitium widget Update service-helpers to allow 'range' field for technitium widget Lint
29 lines
1.2 KiB
Markdown
29 lines
1.2 KiB
Markdown
---
|
|
title: Technitium DNS Server
|
|
description: Technitium DNS Server Widget Configuration
|
|
---
|
|
|
|
Learn more about [Technitium DNS Server](https://technitium.com/dns/).
|
|
|
|
Allowed fields (up to 4): `["totalQueries","totalNoError","totalServerFailure","totalNxDomain","totalRefused","totalAuthoritative","totalRecursive","totalCached","totalBlocked","totalDropped","totalClients"]`.
|
|
|
|
Defaults to: `["totalQueries", "totalAuthoritative", "totalCached", "totalServerFailure"]`
|
|
|
|
```yaml
|
|
widget:
|
|
type: technitium
|
|
url: <url to dns server>
|
|
key: biglongapitoken
|
|
range: LastDay # optional, defaults to LastHour
|
|
```
|
|
|
|
#### API Key
|
|
|
|
This can be generated via the Technitium DNS Dashboard, and should be generated from a special API specific user.
|
|
|
|
#### Range
|
|
|
|
`range` value determines how far back of statistics to pull data for. The value comes directly from Technitium API documentation found [here](https://github.com/TechnitiumSoftware/DnsServer/blob/master/APIDOCS.md#dashboard-api-calls), defined as `"type"`. The value can be one of: `LastHour`, `LastDay`, `LastWeek`, `LastMonth`, `LastYear`.
|
|
|
|
**NOTE:** The value of `Custom` as specified in the API documentation is _NOT_ supported.
|