An open API service indexing awesome lists of open source software.

https://github.com/not-first/tailscale-glance-extension

View devices on a tailnet and their connection status within Glance
https://github.com/not-first/tailscale-glance-extension

docker glance tailscale

Last synced: 2 months ago
JSON representation

View devices on a tailnet and their connection status within Glance

Awesome Lists containing this project

README

          

# Tailscale Glance Extension
> [!IMPORTANT]
> Due to improvements in Glance's custom-api widget API, running a seperate extension is no longer needed to render this widget. To use the new version, simply use the Tailscale devices widget found in the [community widgets repo](https://github.com/glanceapp/community-widgets).

_An extension widget API for the [Glance](https://github.com/glanceapp/glance) dashboard._

![Widget usage example](https://github.com/user-attachments/assets/911ec731-765b-479d-86b1-fdddd8df1bf3)

A widget that displays the devices on your [Tailscale](https://tailscale.com/) tailnet, as well as their connected status, availability of updates.

This is another, more simple, visual option to the wonderful extension [glance.tailscale](https://github.com/fifty-six/glance.tailscale) by [fifty-six](https://github.com/fifty-six).

## Setup
### Docker Compose
Add the following to your existing glance docker compose
```yml
services:
glance:
image: glanceapp/glance
# ...

tailscale-extension:
image: ghcr.io/not-first/tailscale-glance-extension
ports:
- '8677:8677'
restart: unless-stopped
env_file: .env
```
#### Environment Variables
This widget must be set up by providing an environment variable, which can be added to your existing glance .env file:
```env
TAILSCALE_API_KEY=tskey-api-xxxxxxxxxxxxxxxxxxxxxxxxx
```

### Glance Config
Next, add the extension widget into your glance page by adding this to your `glance.yml`.
```yml
- type: extension
title: Uptime Status
url: http://tailscale-extension:8677/
cache: 10m
allow-potentially-dangerous-html: true
```
#### Parameters (all optional)
```yml
parameters:
show-updates: false
show-user: false
```

`show-updates`: If available Tailscale updates for each device should be indicated. Defaults to true

`show-user`: If each device's user should be shown below its name, next to its OS. Defaults to true

---