Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions docs/integrations/beszel/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: 'Beszel'
description: "Beszel is a simple, lightweight server monitoring tool."
hide_title: true
---

import { IntegrationHeader } from '@site/src/components/integrations/header';
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
import { AddingIntegration } from '@site/src/components/integrations/adding';
import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
import { IconAd, IconDeviceGamepad } from "@tabler/icons-react";
import { beszelIntegration } from '.';
import { systemUsageWidget } from '@site/docs/widgets/system-usage';

<IntegrationHeader
integration={beszelIntegration}
categories={['System monitoring']}
/>

### Widgets & Capabilities
<IntegrationCapabilites
items={[{
widget: systemUsageWidget,
}]}
/>

### Adding the integration
<AddingIntegration />

### Secrets
<IntegrationSecrets secrets={[{
credentials: ['username', 'password'],
steps: []
}]} />
8 changes: 8 additions & 0 deletions docs/integrations/beszel/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import { IntegrationDefinition } from '@site/src/types';

export const beszelIntegration: IntegrationDefinition = {
name: 'Beszel',
description: 'Simple, lightweight server monitoring tool',
iconUrl: 'https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/beszel.svg',
path: '../../integrations/beszel',
};
Binary file added docs/widgets/system-usage/img/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
43 changes: 43 additions & 0 deletions docs/widgets/system-usage/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: 'System Usage'
description: 'CPU, Memory, Disk and other hardware usage of your system.'
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 { systemUsageWidget } from '.';
import { dashDotIntegration } from '@site/docs/integrations/dash-dot';
import { openMediaVaultIntegration } from '@site/docs/integrations/open-media-vault';
import { proxmoxIntegration } from '@site/docs/integrations/proxmox';


<WidgetHeader
widget={systemUsageWidget}
categories={['CPU', 'RAM', 'Memory', 'Network', 'Disk']}
/>

Shows percentage usage of system resources like CPU, Memory and Disk. Inspired by Beszel's grid view.

### Screenshots

import screenshot from './img/image.png';
import { beszelIntegration } from '@site/docs/integrations/beszel';

<img src={screenshot} alt="system-usage-widget" width={256} height={256} />

### Supported Integrations

<WidgetIntegrations items={[{
integration: beszelIntegration
}]} />

### Adding the widget

<AddingWidget />

### Configuration

<WidgetConfig configuration={systemUsageWidget.configuration} />
28 changes: 28 additions & 0 deletions docs/widgets/system-usage/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import { WidgetDefinition } from '@site/src/types';
import { IconServer } from '@tabler/icons-react';

export const systemUsageWidget: WidgetDefinition = {
icon: IconServer,
name: 'System Usage',
description: 'CPU, Memory, Disk and other hardware usage of your system',
path: '../../widgets/system-usage',
configuration: {
items: [
{
name: 'System',
description: 'Select the system you want to be monitored.',
values: 'One of the systems from Beszel',
defaultValue: '-',
},
{
name: 'Visible items',
description: 'Select which usage items to display in the widget.',
values: {
type: 'select',
options: ['CPU', 'Memory', 'Disk', 'GPU', 'Load', 'Network', 'Temperature', 'Agent'],
},
defaultValue: 'All items',
},
],
},
};