mirror of
https://github.com/gethomepage/homepage.git
synced 2025-12-24 05:48:08 +08:00
0dcd25d5ad
Some checks failed
Crowdin Action / Crowdin Sync (push) Has been cancelled
Docker CI / Linting Checks (push) Has been cancelled
Docker CI / Docker Build & Push (push) Has been cancelled
Repository Maintenance / Stale (push) Has been cancelled
Repository Maintenance / Lock Old Threads (push) Has been cancelled
Repository Maintenance / Close Answered Discussions (push) Has been cancelled
Repository Maintenance / Close Outdated Discussions (push) Has been cancelled
Repository Maintenance / Close Unsupported Feature Requests (push) Has been cancelled
Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com>
30 lines
955 B
Markdown
30 lines
955 B
Markdown
---
|
|
title: Pangolin
|
|
description: Pangolin Widget Configuration
|
|
---
|
|
|
|
Learn more about [Pangolin](https://github.com/fosrl/pangolin).
|
|
|
|
This widget shows sites (online/total), resources (healthy/total), targets (healthy/total), and traffic statistics for a Pangolin organization. A resource is considered healthy if at least one of its targets is healthy, or if it has no targets.
|
|
|
|
Allowed fields: `["sites", "resources", "targets", "traffic", "in", "out"]` (maximum of 4).
|
|
|
|
```yaml
|
|
widget:
|
|
type: pangolin
|
|
url: https://api.pangolin.net
|
|
key: your-api-key
|
|
org: your-org-id
|
|
```
|
|
|
|
Find your organization ID in the URL when logged in (e.g., `https://app.pangolin.net/{org-id}/...`).
|
|
|
|
## API Key Setup
|
|
|
|
Create an API key with the following permissions:
|
|
|
|
- **List Sites**
|
|
- **List Resources**
|
|
|
|
**Self-Hosted:** Enable the [Integration API](https://docs.pangolin.net/self-host/advanced/integration-api) in your Pangolin configuration before creating the key.
|