diff --git a/docs/widgets/services/index.md b/docs/widgets/services/index.md index 3462fef3..4789f766 100644 --- a/docs/widgets/services/index.md +++ b/docs/widgets/services/index.md @@ -123,6 +123,7 @@ You can also find a list of all available service widgets in the sidebar navigat - [Transmission](transmission.md) - [TrueNAS](truenas.md) - [TubeArchivist](tubearchivist.md) +- [Twingate](twingate.md) - [UniFi Controller](unifi-controller.md) - [Unmanic](unmanic.md) - [Uptime Kuma](uptime-kuma.md) diff --git a/docs/widgets/services/twingate.md b/docs/widgets/services/twingate.md new file mode 100644 index 00000000..da030308 --- /dev/null +++ b/docs/widgets/services/twingate.md @@ -0,0 +1,20 @@ +--- +title: Twingate +description: Twingate Widget Configuration +--- + +Learn more about [Twingate](https://www.twingate.com/). + +You will need to generate an API key from the [API settings](https://amagi.twingate.com/settings/api) on the Twingate settings dashboard. + +For URL use your network subdomain like - `https://.twingate.com` + +Allowed fields: `["networks", "devices", "resources", "users", "groups", "connectors"]`. + +```yaml +widget: + type: twingate + url: https://amagi.twingate.com + key: + fields: ["networks", "devices", "resources", "users", "groups", "connectors"] +``` diff --git a/mkdocs.yml b/mkdocs.yml index 1b3afd62..9a2b8ede 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -145,6 +145,7 @@ nav: - widgets/services/traefik.md - widgets/services/transmission.md - widgets/services/truenas.md + - widgets/services/twingate.md - widgets/services/tubearchivist.md - widgets/services/unifi-controller.md - widgets/services/unmanic.md