-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
14 changed files
with
405 additions
and
470 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,2 @@ | ||
{ | ||
"label": "Managment", | ||
"position": 5 | ||
} |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
sidebar_position: 0 | ||
title: Management Pages | ||
--- | ||
|
||
# About the management pages | ||
|
||
The management pages allow users to manage resources on their Aparr server. | ||
Every logged in user has access to these pages. However, some pages can only be accessed by administrators. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,2 @@ | ||
{ | ||
"label": "Integrations", | ||
"position": 4 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# 🐋 Containers | ||
## Docker | ||
|
||
Homarr allows you to interact with Docker containers running on your system. | ||
|
||
You can **restart**, **stop**, **start**, **refresh** and **remove** containers as well as **add** them to the Homarr dashboard | ||
|
||
![Docker Core Features](img/docker-core-features.png) | ||
|
||
Additionally, if you have a lot of containers you can search and filter them by **container** or **image** name | ||
|
||
![Container and Image Search](img/container-and-image-search.png) | ||
|
||
View the state of each container (**created**, **running** or **stopped**) | ||
|
||
![Container States](img/container-states.png) | ||
|
||
And also check what ports the container has exposed (container port:external port) | ||
|
||
![Exposed Ports](img/exposed-ports.png) | ||
|
||
|
||
### Before you begin | ||
In order for Homarr to be able to interact with your Docker instance you must tell Homarr the path to your Docker socket. You do this by adding the following to the Docker command when you first run Homarr: | ||
|
||
`-v /var/run/docker.sock:/var/run/docker.sock` | ||
|
||
If you are running Docker Desktop on Windows 10, use the following path to your Docker socket: | ||
|
||
`-v //var/run/docker.sock:/var/run/docker.sock` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# ⚙️ DNS | ||
|
||
Homarr allows the integration of DHS-holes to control them and display their stats. | ||
Multiple DNS-holes can be added at the same time. | ||
Currently, only PiHole and AdGuard Home are supported. | ||
|
||
## PiHole | ||
The PiHole integration enables you to see basic stats like the number of queries in the day and how many are blocked. | ||
|
||
You can also disable and enable it using the dns-hole control widget. | ||
|
||
For a successful integration, remember that the internal address should not have a path, only the IP and the port (http://IP:port). | ||
|
||
In this case it would mean to remove anything of the likes of "/admin" from the link you would usually use. | ||
|
||
<details> | ||
<summary> | ||
Available configuration options | ||
</summary> | ||
<div> | ||
|
||
| Field | Type | Description | | ||
| -------- | ------- | ----------- | | ||
| ApiToken | Private | Token used for authentication | | ||
|
||
</div> | ||
</details> | ||
|
||
## AdGuard Home | ||
The Adguard Home integration enables you to see basic stats like the number of queries in the day and how many are blocked. | ||
|
||
You can also disable and enable it using the dns-hole control widget. | ||
|
||
<details> | ||
<summary> | ||
Available configuration options | ||
</summary> | ||
<div> | ||
|
||
| Field | Type | Description | | ||
| -------- | ------- | ----------- | | ||
| Username | Private | Username used for authentication | | ||
| Password | Private | Password used for authentication | | ||
|
||
</div> | ||
</details> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# 🖥️ Hardware | ||
|
||
## Dash. | ||
|
||
The Dash. integration can be used to monitor the performance and used system resources of your machine. | ||
Dash. will be used in the [Dash.](/docs/widgets/dashdot-widget) |
Oops, something went wrong.