Skip to content

Commit b8b0530

Browse files
authored
Merge pull request #198 from pitschi/network-controller-initial
2 parents a7fd526 + cef3e85 commit b8b0530

File tree

3 files changed

+82
-0
lines changed

3 files changed

+82
-0
lines changed

docs/integrations/network.mdx

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: Network
3+
tags:
4+
- Integrations
5+
- Configuration
6+
- Network
7+
- Unifi Controller
8+
---
9+
10+
# Network
11+
12+
Homarr allows the integration of network controllers to display their stats.
13+
Multiple network controllers can be added at the same time.
14+
15+
## Unifi Controller
16+
The Unifi Controller integration enables you to see basic stats with the help of the [Network Controller widget](/docs/next/widgets/network-controller). It is created to support the normal and pro variants of the Unifi Controller.
17+
18+
It is used to show some metrics like www ping, the number of users in different kinds of networks like LAN and WiFi.
19+
20+
For a successful integration you have to make sure of the following:
21+
22+
* Remember that the internal address should not have a path, only the fqdn on SSL (``https://unifi.local``). In this case it would mean to remove anything of the likes of "`/api`" from the link you would usually use.
23+
* Since the Unifi Controller only runs on SSL, it usually creates a self-signed certificate on the fqdn `unifi.local`. You will have to:
24+
* put in your own certificate into the Unifi Controller if you use another fqdn
25+
* **OR**
26+
* make sure your Unifi Controller can be reached through the fqdn `unifi.local`
27+
* get your certificate from the Unifi Controller with a browser by downloading it
28+
* [add the certificate](/docs/management/certificates) to the Homarr instance
29+
* You have to create a user (can be *Restrict*ed *to Local Access Only*) with at least the following permissions:
30+
* Network: Full Management
31+
* Control Plane: View Only
32+
33+
**NOTICE**: The integration does currently **NOT** support the "*Unifi Network API*" with the "*Control Plane API keys*".
34+
35+
<details>
36+
<summary>
37+
Available configuration options
38+
</summary>
39+
<div>
40+
41+
| Field | Type | Description |
42+
| -------- | ------- | ----------- |
43+
| Username | Public | Username used for authentication |
44+
| Password | Private | Password used for authentication |
45+
46+
</div>
47+
</details>
16.5 KB
Loading
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: Network Controller
3+
tags:
4+
- Widgets
5+
- Configuration
6+
- Network
7+
- Unifi Controller
8+
---
9+
10+
If you're running a Unifi Controller instance, you might want to display statistics on your dashboard.
11+
It uses the [node-unifi](https://www.npmjs.com/package/node-unifi) library under the hood, which supports
12+
CloudKey Gen1, CloudKey Gen2, UnifiOS-based UDM-Pro controllers as well as self-hosted UniFi controllers.
13+
14+
There are two variations of the widget:
15+
- **Summary of the systems**: Shows information whether your WAN is connected, Wi-Fi is active and several other information
16+
- **Network information**: Connected users and connected guest devices on wired or wireless networks
17+
18+
It requires the [Unifi Controller integration](/docs/next/integrations/network) to be configured.
19+
20+
![](./img/screenshot.png)
21+
22+
## Adding the widget
23+
Please check out our documentation on [how to add a widget](/docs/getting-started/after-the-installation#embed-integration-data-using-widgets).
24+
25+
## Configuration
26+
27+
### Controller summary
28+
29+
This widget does not have any additional configuration.
30+
31+
### Network status
32+
33+
| Configuration | Description | Values | Default Value |
34+
|----------------|--------------------------------|---------------------------------------|---------------|
35+
| Widget Content | Select network being displayed | <ul><li>Wired</li><li>Wi-Fi</li></ul> | Wired |

0 commit comments

Comments
 (0)