docs: add Beszel, SQLite backup, and Custom widgets documentation (#5930)
This commit is contained in:
1 parent
d16571d4c4
commit
7567842c4c
23 files changed
+726
-8
No files matched your search
Binary file not shown.
|
After Width: | Height: | Size: 107 KiB |
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: 'Beszel Systems (Grid)'
|
||||
description: 'Card grid view of all Beszel-monitored systems with real-time metrics.'
|
||||
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 { beszelSystemGridWidget } from '.';
|
||||
import { beszelIntegration } from '@site/docs/integrations/beszel';
|
||||
|
||||
import beszelSystemGrid from './img/beszel-system-grid.png';
|
||||
|
||||
<WidgetHeader
|
||||
widget={beszelSystemGridWidget}
|
||||
categories={['System Monitoring']}
|
||||
/>
|
||||
|
||||
This widget displays all your Beszel-monitored systems as a responsive card grid. Each card shows real-time metrics like CPU, memory, disk, network, temperature, and more. Cards adapt their layout based on available space.
|
||||
|
||||
### Screenshots
|
||||
|
||||
<img src={beszelSystemGrid} alt="Beszel System Grid widget showing system cards with metrics" />
|
||||
|
||||
### Supported Integrations
|
||||
|
||||
<WidgetIntegrations items={[{
|
||||
integration: beszelIntegration,
|
||||
note: "Displays all monitored systems as a card grid"
|
||||
}]} />
|
||||
|
||||
### Adding the widget
|
||||
|
||||
<AddingWidget />
|
||||
|
||||
### Configuration
|
||||
<WidgetConfig configuration={beszelSystemGridWidget.configuration} />
|
||||
@@ -0,0 +1,88 @@
|
||||
import { WidgetDefinition } from "@site/src/types";
|
||||
import { IconLayoutGrid } from "@tabler/icons-react";
|
||||
|
||||
export const beszelSystemGridWidget: WidgetDefinition = {
|
||||
icon: IconLayoutGrid,
|
||||
name: "Beszel Systems (Grid)",
|
||||
description: "Card grid view of all Beszel-monitored systems with real-time metrics.",
|
||||
path: "../../widgets/beszel-system-grid",
|
||||
configuration: {
|
||||
items: [
|
||||
{
|
||||
name: "Status filter",
|
||||
description: "Filter systems by their current status",
|
||||
values: {
|
||||
type: "select",
|
||||
options: ["All Systems", "Up", "Down", "Paused"],
|
||||
},
|
||||
defaultValue: "All Systems",
|
||||
},
|
||||
{
|
||||
name: "Show CPU",
|
||||
description: "Displays CPU usage on each system card",
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "yes",
|
||||
},
|
||||
{
|
||||
name: "Show memory",
|
||||
description: "Displays memory usage on each system card",
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "yes",
|
||||
},
|
||||
{
|
||||
name: "Show disk",
|
||||
description: "Displays disk usage on each system card",
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "yes",
|
||||
},
|
||||
{
|
||||
name: "Show GPU",
|
||||
description: "Displays GPU usage on each system card",
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "yes",
|
||||
},
|
||||
{
|
||||
name: "Show load average",
|
||||
description: "Displays system load average",
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "yes",
|
||||
},
|
||||
{
|
||||
name: "Show network",
|
||||
description: "Displays network throughput",
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "yes",
|
||||
},
|
||||
{
|
||||
name: "Show temperature",
|
||||
description: "Displays system temperature",
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "yes",
|
||||
},
|
||||
{
|
||||
name: "Show battery",
|
||||
description: "Displays battery level (if available)",
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "yes",
|
||||
},
|
||||
{
|
||||
name: "Show services",
|
||||
description: "Displays running Docker services count",
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "yes",
|
||||
},
|
||||
{
|
||||
name: "Show uptime",
|
||||
description: "Displays system uptime",
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "yes",
|
||||
},
|
||||
{
|
||||
name: "Show agent version",
|
||||
description: "Displays the Beszel agent version",
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "yes",
|
||||
},
|
||||
],
|
||||
},
|
||||
};
|
||||
Reference in new issue
Block a user