You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Implemented Traffic gear with features for traffic source analysis, GeoIP enrichment, and network visualization.
- Created settings page for configuring traffic analysis options including GeoIP and top sources count.
- Added HTTP handlers for rendering the traffic analysis page and managing permissions.
- Introduced SVG icon for the traffic gear in the sidebar.
- Developed JavaScript functions for toggling settings and managing UI interactions for traffic and other gears.
- Updated existing configuration files and added new JavaScript files for enhanced functionality across various gears.
Copy file name to clipboardExpand all lines: CLAUDE.md
+21-21Lines changed: 21 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,25 +4,25 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
4
4
5
5
## Project Overview
6
6
7
-
This repository contains **Gearbox**, a general-purpose monitoring and management platform with a plugin-based architecture.
7
+
This repository contains **Gearbox**, a general-purpose monitoring and management platform with a gear-based architecture.
8
8
9
9
### What is Gearbox?
10
10
11
-
A plugin-based server monitoring and management platform designed for DevOps. Provides real-time visibility into servers, services, and infrastructure through purpose-built plugin pages.
11
+
A gear-based server monitoring and management platform designed for DevOps. Provides real-time visibility into servers, services, and infrastructure through purpose-built gear pages.
12
12
13
13
**Architecture:**
14
14
15
15
-**gearbox-agent** - Go binary installed on monitored servers/workstations to gather data and expose secure API/WebSocket
16
16
-**gearbox** - Web dashboard (port 3000) for monitoring multiple servers
17
-
-**Plugins** - Self-contained modules providing pages, API handlers, and functionality (HAProxy, Metrics, Logs, Services, Certificates, Traffic, Alerts, OS Updates)
17
+
-**Gears** - Self-contained modules providing pages, API handlers, and functionality (HAProxy, Metrics, Logs, Services, Certificates, Traffic, Alerts, OS Updates)
18
18
19
19
**Key Principles:**
20
20
21
-
-Plugin-based architecture with shared framework components
21
+
-Gear-based architecture with shared framework components
22
22
- gearbox-agent can run on ANY Linux system (servers, workstations, HAProxy hosts, TrueNAS, Docker hosts)
23
23
- Multi-server support: gearbox talks to many different gearbox-agent instances
24
24
- Configuration via web UI
25
-
- HAProxy monitoring is ONE plugin, not the core purpose
25
+
- HAProxy monitoring is ONE gear, not the core purpose
26
26
27
27
## Dual-App Architecture
28
28
@@ -41,7 +41,7 @@ When troubleshooting, **ALWAYS check both codebases** and understand which serve
41
41
42
42
### Gearbox Dashboard (`gearbox/`)
43
43
44
-
Web application for monitoring multiple servers. Plugin-based architecture.
44
+
Web application for monitoring multiple servers. Gear-based architecture.
45
45
46
46
**Post-Change Workflow:**
47
47
@@ -56,13 +56,13 @@ cd gearbox && make templ-generate && make build
56
56
**Key directories:**
57
57
58
58
-`internal/framework/` - Shared services and building blocks
8 plugins: HAProxy, Metrics, Logs, Services, Certificates, Traffic, Alerts, OS Updates. Each plugin is self-contained in `internal/plugins/`. Framework provides shared services in `internal/framework/`.
84
+
8 gears: HAProxy, Metrics, Logs, Services, Certificates, Traffic, Alerts, OS Updates. Each gear is self-contained in `internal/gears/`. Framework provides shared services in `internal/framework/`.
85
85
86
-
See [docs/plugins.md](docs/plugins.md) for complete plugin architecture documentation.
86
+
See [docs/gears.md](docs/gears.md) for complete gear architecture documentation.
87
87
88
88
## GitHub-Driven Workflow
89
89
@@ -166,15 +166,15 @@ TASKS.md is a **scratch pad only** — not a tracking system. The GitHub Project
166
166
- Run `make dev` in gearbox (user typically has this running already)
167
167
- Edit generated `*_templ.go` files directly
168
168
- Skip running `make templ-generate` after template changes
169
-
- Add business logic to framework (belongs in plugins)
169
+
- Add business logic to framework (belongs in gears)
0 commit comments