feat(docs): migrate documentation site into monorepo (#5912)

This commit is contained in:
Thomas authored and GitHub committed 2026-06-11 18:48:39 +02:00
1 parent 3e464a76f2
commit 9e421c67bd
605 files changed
+26764 -219

No files matched your search

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

@@ -0,0 +1,51 @@
---
title: 'Docker stats'
description: 'Stats of your containers'
hide_title: true
---
import { WidgetHeader } from '@site/src/components/widgets/header';
import { AddingWidget } from '@site/src/components/widgets/adding';
import { WidgetConfig } from '@site/src/components/widgets/configuration';
import { WidgetIntegrations } from '@site/src/components/widgets/integrations';
import { IconAd } from "@tabler/icons-react";
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import { dockerContainersWidget } from '.';
import { dockerIntegration } from '@site/docs/integrations/docker';
<WidgetHeader
widget={dockerContainersWidget}
categories={['Containers']}
/>
This widget displays the resource usage of your Docker containers and allows you to manage them.
:::info
This widget can only be used with administrator privileges.
:::
### Screenshots
import dockerTable from './img/table.png';
<img src={dockerTable} alt="docker-stats table docker-containers" width={128 * 3} height={128 * 2} />
### Supported Integrations
<WidgetIntegrations items={[{
integration: dockerIntegration,
}]} />
### Interactions
Each container row has an action menu (accessible via the three-dot icon) with the following options:
- **View logs** — opens a dedicated terminal page streaming the container's logs
- **Start** / **Stop** / **Restart** — manage the container's state
- **Remove** — remove the container
- **Add to Homarr** — create a bookmark app from the container
### Adding the widget
<AddingWidget />
@@ -0,0 +1,34 @@
import { WidgetDefinition } from "@site/src/types";
import { IconBrandDocker } from "@tabler/icons-react";
export const dockerContainersWidget: WidgetDefinition = {
icon: IconBrandDocker,
name: "Docker stats",
description: "Stats of your containers",
path: "../../widgets/docker-containers",
configuration: {
items: [
{
name: "Enable items sorting",
description: "Allows to sort containers by clicking on the column headers",
values: { type: "boolean" },
defaultValue: "No",
},
{
name: "Column used for sorting by default",
description: "Select which column to use for sorting the containers when the widget is loaded",
values: {
type: "select",
options: ["Name", "State", "CPU usage", "Memory usage"],
},
defaultValue: "Name",
},
{
name: "Invert sorting",
description: "Invert the sorting order (ascending / descending) for the default sorting column",
values: { type: "boolean" },
defaultValue: "No",
},
],
},
};