nexusguard/Nexus-Guard-Suite
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 6 Wiki Activity

chore: docs, plans archive, script updates, submodule refs

Browse Source
This commit is contained in:
datadunia
2026-05-31 08:20:46 +07:00
parent 25df78c519
commit 045099faff
10 changed files with 306 additions and 117 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.sisyphus/plans/nxg-phase6-desktop-client.md → .sisyphus/plans/archived/nxg-phase6-desktop-client.md
View File
.sisyphus/plans/nexusguard-config-architecture.md
+45 -45
View File
@@ -72,12 +72,12 @@ Implement unified config system for non-Docker NexusGuard deployment with `/etc/
- `apps/server-core/nexusguard-server.service` - Systemd service file
### Definition of Done
- [ ] Server-core reads config from `/etc/nexusguard/nexusguard.conf`
- [ ] Dashboard reads runtime config from nginx-injected `window.__CONFIG__`
- [ ] Install script copies binaries, creates config, sets up systemd, configures nginx
- [ ] Uninstall script stops service, removes files, reloads nginx
- [ ] All unit tests pass
- [ ] Tested on real server (172.20.8.191)
- [x] Server-core reads config from `/etc/nexusguard/nexusguard.conf`
- [x] Dashboard reads runtime config from nginx-injected `window.__CONFIG__`
- [x] Install script copies binaries, creates config, sets up systemd, configures nginx
- [x] Uninstall script stops service, removes files, reloads nginx
- [x] All unit tests pass
- [x] Tested on real server (172.20.8.191)
### Must Have
- Config file loading with fallback to env vars
@@ -199,15 +199,15 @@ Wave FINAL (After ALL tasks):
- `apps/device-agent/scripts/install_agent.sh` - Shell script pattern to follow
**Acceptance Criteria**:
- [ ] File created: `apps/server-core/internal/config/config_loader.go`
- [ ] Function `LoadConfFile(path string) error` exists
- [ ] Parses `export KEY=VALUE` format
- [ ] Skips comments (#) and empty lines
- [ ] Handles Windows line endings (\r\n)
- [ ] Trims whitespace around keys and values
- [ ] Calls `os.Setenv()` for each valid key
- [ ] Returns error for missing file (non-fatal)
- [ ] Supports `NEXUSGUARD_CONF` env var override
- [x] File created: `apps/server-core/internal/config/config_loader.go`
- [x] Function `LoadConfFile(path string) error` exists
- [x] Parses `export KEY=VALUE` format
- [x] Skips comments (#) and empty lines
- [x] Handles Windows line endings (\r\n)
- [x] Trims whitespace around keys and values
- [x] Calls `os.Setenv()` for each valid key
- [x] Returns error for missing file (non-fatal)
- [x] Supports `NEXUSGUARD_CONF` env var override
**QA Scenarios**:
@@ -293,10 +293,10 @@ Wave FINAL (After ALL tasks):
- `apps/dashboard-ui/nginx.conf` - Current nginx config
**Acceptance Criteria**:
- [ ] File modified: `apps/dashboard-ui/src/services/api.ts`
- [ ] `window.__CONFIG__` type declared
- [ ] Runtime config read with fallback to VITE_API_BASE_URL
- [ ] TypeScript compiles without errors
- [x] File modified: `apps/dashboard-ui/src/services/api.ts`
- [x] `window.__CONFIG__` type declared
- [x] Runtime config read with fallback to VITE_API_BASE_URL
- [x] TypeScript compiles without errors
**QA Scenarios**:
@@ -359,11 +359,11 @@ Wave FINAL (After ALL tasks):
- `apps/server-core/main.go:356` - API port default (8080)
**Acceptance Criteria**:
- [ ] File created: `apps/dashboard-ui/nginx.conf.template`
- [ ] `envsubst` placeholders for `${API_PORT}`, `${API_BASE_URL}`
- [ ] `window.__CONFIG__` injection via `sub_filter` or template
- [ ] SPA fallback configured
- [ ] `nginx -t` validates syntax
- [x] File created: `apps/dashboard-ui/nginx.conf.template`
- [x] `envsubst` placeholders for `${API_PORT}`, `${API_BASE_URL}`
- [x] `window.__CONFIG__` injection via `sub_filter` or template
- [x] SPA fallback configured
- [x] `nginx -t` validates syntax
**QA Scenarios**:
@@ -434,13 +434,13 @@ Wave FINAL (After ALL tasks):
- `apps/dashboard-ui/nginx.conf.template` - Nginx config to copy
**Acceptance Criteria**:
- [ ] File created: `nexusguard-install.sh`
- [ ] `--help` flag shows usage
- [ ] Creates `/etc/nexusguard/nexusguard.conf` with chmod 600
- [ ] Creates systemd service file
- [ ] Creates nginx config
- [ ] Enables and starts service
- [ ] Idempotent (safe to run twice)
- [x] File created: `nexusguard-install.sh`
- [x] `--help` flag shows usage
- [x] Creates `/etc/nexusguard/nexusguard.conf` with chmod 600
- [x] Creates systemd service file
- [x] Creates nginx config
- [x] Enables and starts service
- [x] Idempotent (safe to run twice)
**QA Scenarios**:
@@ -530,11 +530,11 @@ Wave FINAL (After ALL tasks):
- `nexusguard-install.sh` - Install script to reverse
**Acceptance Criteria**:
- [ ] File created: `nexusguard-uninstall.sh`
- [ ] Stops and disables service
- [ ] Removes all installed files
- [ ] Reloads nginx and systemd
- [ ] Preserves database and WireGuard state
- [x] File created: `nexusguard-uninstall.sh`
- [x] Stops and disables service
- [x] Removes all installed files
- [x] Reloads nginx and systemd
- [x] Preserves database and WireGuard state
**QA Scenarios**:
@@ -598,11 +598,11 @@ Wave FINAL (After ALL tasks):
- `apps/device-agent/scripts/sys-bridge.service` - Systemd template
**Acceptance Criteria**:
- [ ] File created: `apps/server-core/nexusguard-server.service`
- [ ] `EnvironmentFile=/etc/nexusguard/nexusguard.conf`
- [ ] `Restart=always` and `RestartSec=5`
- [ ] Runs as root
- [ ] `After=network.target postgresql.service redis.service`
- [x] File created: `apps/server-core/nexusguard-server.service`
- [x] `EnvironmentFile=/etc/nexusguard/nexusguard.conf`
- [x] `Restart=always` and `RestartSec=5`
- [x] Runs as root
- [x] `After=network.target postgresql.service redis.service`
**QA Scenarios**:
@@ -683,7 +683,7 @@ ssh root@172.20.8.191 "curl -s http://localhost/" # Expected: HTML with window.
```
### Final Checklist
- [ ] All "Must Have" present
- [ ] All "Must NOT Have" absent
- [ ] All tests pass
- [ ] Tested on real server (172.20.8.191)
- [x] All "Must Have" present
- [x] All "Must NOT Have" absent
- [x] All tests pass
- [x] Tested on real server (172.20.8.191)
.sisyphus/plans/realtime-traffic-monitoring.md
+34 -34
View File
@@ -130,8 +130,8 @@ Wave 2 (Backend + Frontend):
- `apps/server-core/migrations/` - existing migration pattern
**Acceptance Criteria**:
- [ ] `go build -tags dev ./...` passes
- [ ] Migration file created with correct SQL
- [x] `go build -tags dev ./...` passes
- [x] Migration file created with correct SQL
**Commit**: YES
- Message: `feat(db): add device_traffic table and views`
@@ -166,9 +166,9 @@ Wave 2 (Backend + Frontend):
- `apps/server-core/internal/traffic/recorder.go` - TrafficRecorder
**Acceptance Criteria**:
- [ ] `go build -tags dev ./...` passes
- [ ] POST /api/v1/traffic/report accepts traffic data
- [ ] Data stored to Redis
- [x] `go build -tags dev ./...` passes
- [x] POST /api/v1/traffic/report accepts traffic data
- [x] Data stored to Redis
**Commit**: YES
- Message: `feat(api): add HTTP traffic report endpoint`
@@ -204,9 +204,9 @@ Wave 2 (Backend + Frontend):
- `apps/server-core/internal/heartbeat/redis.go` - Redis pattern
**Acceptance Criteria**:
- [ ] `go build -tags dev ./...` passes
- [ ] Traffic recorded to Redis on Report()
- [ ] Batch sync inserts to DB
- [x] `go build -tags dev ./...` passes
- [x] Traffic recorded to Redis on Report()
- [x] Batch sync inserts to DB
**Commit**: YES
- Message: `feat(traffic): add Redis → PostgreSQL recorder`
@@ -245,9 +245,9 @@ Wave 2 (Backend + Frontend):
- SSE spec: https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events
**Acceptance Criteria**:
- [ ] `go build -tags dev ./...` passes
- [ ] `curl -N http://localhost:8080/api/v1/devices/stream` returns SSE stream
- [ ] SSE disconnects when tab inactive (frontend)
- [x] `go build -tags dev ./...` passes
- [x] `curl -N http://localhost:8080/api/v1/devices/stream` returns SSE stream
- [x] SSE disconnects when tab inactive (frontend)
**Commit**: YES
- Message: `feat(sse): add device status streaming endpoint`
@@ -285,9 +285,9 @@ Wave 2 (Backend + Frontend):
- SVG chart pattern
**Acceptance Criteria**:
- [ ] `npm run build` passes
- [ ] Chart only renders when toggle is ON
- [ ] Time range selector works
- [x] `npm run build` passes
- [x] Chart only renders when toggle is ON
- [x] Time range selector works
**Commit**: YES
- Message: `feat(ui): add lazy-loaded traffic chart component`
@@ -328,11 +328,11 @@ Wave 2 (Backend + Frontend):
- localStorage pattern
**Acceptance Criteria**:
- [ ] `npm run build` passes
- [ ] Per-device toggle works
- [ ] Global toggle works
- [ ] SSE disconnects when tab hidden
- [ ] Charts hidden when toggle OFF
- [x] `npm run build` passes
- [x] Per-device toggle works
- [x] Global toggle works
- [x] SSE disconnects when tab hidden
- [x] Charts hidden when toggle OFF
**Commit**: YES
- Message: `feat(ui): add toggle controls + tab-aware SSE`
@@ -369,10 +369,10 @@ Wave 2 (Backend + Frontend):
- `apps/dashboard-ui/src/router/index.ts` - routing
**Acceptance Criteria**:
- [ ] `npm run build` passes
- [ ] History page accessible at /traffic-history
- [ ] Date range filter works
- [ ] Data only fetched on user action
- [x] `npm run build` passes
- [x] History page accessible at /traffic-history
- [x] Date range filter works
- [x] Data only fetched on user action
**Commit**: YES
- Message: `feat(ui): add traffic history view`
@@ -382,10 +382,10 @@ Wave 2 (Backend + Frontend):
## Final Verification Wave
- [ ] F1. **Plan Compliance Audit** — `oracle`
- [ ] F2. **Code Quality Review** — `unspecified-high`
- [ ] F3. **Real Manual QA** — `unspecified-high`
- [ ] F4. **Scope Fidelity Check** — `deep`
- [x] F1. **Plan Compliance Audit** — `oracle`
- [x] F2. **Code Quality Review** — `unspecified-high`
- [x] F3. **Real Manual QA** — `unspecified-high`
- [x] F4. **Scope Fidelity Check** — `deep`
---
@@ -405,10 +405,10 @@ cd apps/dashboard-ui && npm run build # Expected: no errors
```
### Final Checklist
- [ ] HTTP traffic endpoint works (no protoc needed)
- [ ] SSE pushes real-time status to dashboard
- [ ] **SSE disconnects when tab inactive**
- [ ] **Charts lazy-loaded (only when toggle ON)**
- [ ] PostgreSQL stores traffic data
- [ ] Toggle controls work (per device + global)
- [ ] Performance: minimal resource usage
- [x] HTTP traffic endpoint works (no protoc needed)
- [x] SSE pushes real-time status to dashboard
- [x] **SSE disconnects when tab inactive**
- [x] **Charts lazy-loaded (only when toggle ON)**
- [x] PostgreSQL stores traffic data
- [x] Toggle controls work (per device + global)
- [x] Performance: minimal resource usage