Skip to content
This repository was archived by the owner on Jun 16, 2026. It is now read-only.

Commit 847a739

Browse files
docs: add tracearr integration (#494)
1 parent cfe6828 commit 847a739

6 files changed

Lines changed: 135 additions & 0 deletions

File tree

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: 'Tracearr'
3+
description: "Tracearr is a comprehensive media monitoring solution that tracks streams, user activity, and policy violations in your media server (including Plex, Jellyfin, Emby)."
4+
hide_title: true
5+
---
6+
7+
import { IntegrationHeader } from '@site/src/components/integrations/header';
8+
import { IntegrationCapabilites } from '@site/src/components/integrations/widgets';
9+
import { AddingIntegration } from '@site/src/components/integrations/adding';
10+
import {IntegrationSecrets} from '@site/src/components/integrations/secrets';
11+
import { tracearrIntegration } from '.';
12+
import { tracearrWidget } from '@site/docs/widgets/tracearr';
13+
14+
15+
<IntegrationHeader
16+
integration={tracearrIntegration}
17+
categories={['Media Monitoring']}
18+
/>
19+
20+
### Widgets & Capabilities
21+
<IntegrationCapabilites
22+
items={[
23+
{ widget: tracearrWidget }
24+
]}
25+
/>
26+
27+
### Adding the integration
28+
<AddingIntegration />
29+
30+
### Secrets
31+
<IntegrationSecrets secrets={[{
32+
credentials: ['apiKey'],
33+
steps: [
34+
<span>
35+
In Tracearr, go to <strong>Settings → API</strong> and generate or copy your API key.
36+
</span>
37+
]
38+
}]} />
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
import { IntegrationDefinition } from '@site/src/types';
2+
export const tracearrIntegration: IntegrationDefinition = {
3+
name: 'Tracearr',
4+
description:
5+
'Tracearr is a comprehensive media monitoring solution that tracks streams, user activity, and policy violations in your media server.',
6+
iconUrl: 'https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/tracearr.svg',
7+
path: '../../integrations/tracearr',
8+
};
78.4 KB
Loading
146 KB
Loading

docs/widgets/tracearr/index.mdx

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
title: 'Tracearr'
3+
description: 'Monitor media server streams, user activity, and policy violations.'
4+
hide_title: true
5+
---
6+
7+
import { AddingWidget } from '@site/src/components/widgets/adding';
8+
import { WidgetConfig } from '@site/src/components/widgets/configuration';
9+
import { WidgetHeader } from '@site/src/components/widgets/header';
10+
import { WidgetIntegrations } from '@site/src/components/widgets/integrations';
11+
import { tracearrWidget } from '.';
12+
import { tracearrIntegration } from '@site/docs/integrations/tracearr';
13+
14+
15+
<WidgetHeader
16+
widget={tracearrWidget}
17+
categories={['Media Monitoring']}
18+
/>
19+
20+
The Tracearr widget provides a real-time monitoring dashboard for your media server activity. It displays active streams, user statistics, recent watching history, and policy violations.
21+
22+
### Sections
23+
24+
| Section | Description |
25+
|---|---|
26+
| **Stats Bar** | Displays Active Streams, Total Users, Transcode Count, and Total Bandwidth at a glance. |
27+
| **Active Streams** | Shows currently playing media with poster art, user info, progress bar, resolution, and transcoding status (Direct Play or Transcode). |
28+
| **Recent Activity** | A paginated list of watching history with user avatars and watched status. |
29+
| **Violations** | Alerts for policy violations (e.g., concurrent stream limits) with severity levels. |
30+
31+
### Screenshots
32+
33+
import widgetOverview from './img/widget-overview.png';
34+
import streamsAndStats from './img/streams-and-stats.png';
35+
36+
<div className="flex flex-col gap-2">
37+
<img src={widgetOverview} alt="tracearr-widget-overview" width={128 * 4} />
38+
<img src={streamsAndStats} alt="tracearr-streams-and-stats" width={128 * 4} />
39+
</div>
40+
41+
### Adding the widget
42+
43+
<AddingWidget />
44+
45+
### Supported Integrations
46+
47+
<WidgetIntegrations items={[{
48+
integration: tracearrIntegration,
49+
}]} />
50+
51+
### Configuration
52+
<WidgetConfig configuration={tracearrWidget.configuration} />

docs/widgets/tracearr/index.ts

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
import { WidgetDefinition } from '@site/src/types';
2+
import { IconActivity } from '@tabler/icons-react';
3+
4+
export const tracearrWidget: WidgetDefinition = {
5+
icon: IconActivity,
6+
name: 'Tracearr',
7+
description: 'Monitor media server streams, user activity, and policy violations.',
8+
path: '../../widgets/tracearr',
9+
configuration: {
10+
items: [
11+
{
12+
name: 'Show Streams',
13+
description: 'Display the active streams section.',
14+
values: { type: 'boolean' },
15+
defaultValue: 'yes',
16+
},
17+
{
18+
name: 'Show Stats',
19+
description: 'Display the stats bar with active streams, total users, transcode count, and bandwidth.',
20+
values: { type: 'boolean' },
21+
defaultValue: 'yes',
22+
},
23+
{
24+
name: 'Show Recent Activity',
25+
description: 'Display the recent activity list with user watch history.',
26+
values: { type: 'boolean' },
27+
defaultValue: 'yes',
28+
},
29+
{
30+
name: 'Show Violations',
31+
description: 'Display the violations alerts for policy breaches.',
32+
values: { type: 'boolean' },
33+
defaultValue: 'yes',
34+
},
35+
],
36+
},
37+
};

0 commit comments

Comments
 (0)