Skip to content

Commit

Permalink
refactor: integrations page
Browse files Browse the repository at this point in the history
  • Loading branch information
manuel-rw committed Dec 11, 2023
1 parent 912fdf8 commit ba49e51
Show file tree
Hide file tree
Showing 14 changed files with 405 additions and 470 deletions.
2 changes: 0 additions & 2 deletions docs/management/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,2 @@
{
"label": "Managment",
"position": 5
}
File renamed without changes.
9 changes: 9 additions & 0 deletions docs/management/index.mdx
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.
2 changes: 0 additions & 2 deletions docs/management/integrations/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,2 @@
{
"label": "Integrations",
"position": 4
}
30 changes: 30 additions & 0 deletions docs/management/integrations/containers.mdx
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`
46 changes: 46 additions & 0 deletions docs/management/integrations/dns.mdx
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>
6 changes: 6 additions & 0 deletions docs/management/integrations/hardware.mdx
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)
Loading

0 comments on commit ba49e51

Please sign in to comment.