README
¶
RotomNG (MITM Connection Manager)
RotomNG is a service that connects applications to MITM workers.
Documentation
- Getting Started - Configuration and setup guide
- HTTP API Reference - REST API endpoints for managing devices, controllers, jobs, and system configuration
- Migration Guide (OG to NG) - Differences between Rotom OG and Rotom NG for those upgrading
Directories
¶
| Path | Synopsis |
|---|---|
|
apps
|
|
|
rotom-ng
command
RotomNG is a distributed MITM proxy system.
|
RotomNG is a distributed MITM proxy system. |
|
rotom-ng/app
Package app implements the RotomNG application server.
|
Package app implements the RotomNG application server. |
|
rotom-ng/app/config
Package config provides application configuration loading and validation for RotomNG.
|
Package config provides application configuration loading and validation for RotomNG. |
|
rotom-ng/app/factories
Package factories provides factory functions for creating connection types.
|
Package factories provides factory functions for creating connection types. |
|
rotom-ng/app/handlers
Package handlers provides HTTP and WebSocket request handlers for the RotomNG application.
|
Package handlers provides HTTP and WebSocket request handlers for the RotomNG application. |
|
rotom-ng/app/httpserver
Package httpserver provides the HTTP/API server for RotomNG.
|
Package httpserver provides the HTTP/API server for RotomNG. |
|
rotom-ng/app/stats
Package stats provides Prometheus-based metrics collection for RotomNG.
|
Package stats provides Prometheus-based metrics collection for RotomNG. |
|
rotom-ng/app/version
Package version provides the application version information.
|
Package version provides the application version information. |
|
libs
|
|
|
api
Package api provides types and converters for the RotomNG HTTP API responses.
|
Package api provides types and converters for the RotomNG HTTP API responses. |
|
auth
Package auth provides authentication middleware for HTTP handlers.
|
Package auth provides authentication middleware for HTTP handlers. |
|
bufferpool
Package bufferpool provides a sync.Pool-based buffer pool with size limits.
|
Package bufferpool provides a sync.Pool-based buffer pool with size limits. |
|
connections
Package connections manages the relationships between devices, workers, and controllers.
|
Package connections manages the relationships between devices, workers, and controllers. |
|
controller
Package controller implements the controller connection lifecycle and proxying.
|
Package controller implements the controller connection lifecycle and proxying. |
|
errorutil
Package errorutil provides shared error types and WebSocket close codes.
|
Package errorutil provides shared error types and WebSocket close codes. |
|
ginutil
Package ginutil provides Gin middleware and engine utilities.
|
Package ginutil provides Gin middleware and engine utilities. |
|
gitutil
Package gitutil provides utilities for extracting git build information.
|
Package gitutil provides utilities for extracting git build information. |
|
handlers
Package handlers provides WebSocket and HTTP request handlers for RotomNG.
|
Package handlers provides WebSocket and HTTP request handlers for RotomNG. |
|
jobs
Package jobs manages job definitions and execution on devices.
|
Package jobs manages job definitions and execution on devices. |
|
logging
Package logging provides structured logging configuration and handlers for slog.
|
Package logging provides structured logging configuration and handlers for slog. |
|
mitm
Package mitm provides types and utilities for managing MITM proxy workers and device connections.
|
Package mitm provides types and utilities for managing MITM proxy workers and device connections. |
|
prom
Package prom provides Prometheus metric utilities including namespace wrapping.
|
Package prom provides Prometheus metric utilities including namespace wrapping. |
|
protos
Package protos provides generated Protocol Buffer types and utility functions for the MITM communication protocol.
|
Package protos provides generated Protocol Buffer types and utility functions for the MITM communication protocol. |
|
rotom_ui
Package rotom_ui provides embedded static files for the RotomNG web UI.
|
Package rotom_ui provides embedded static files for the RotomNG web UI. |
|
selector
Package selector implements worker selection and load balancing strategies.
|
Package selector implements worker selection and load balancing strategies. |
|
services
Package services provides HTTP and WebSocket server implementations.
|
Package services provides HTTP and WebSocket server implementations. |
|
settings
Package settings provides a generic, thread-safe container for validated configuration values.
|
Package settings provides a generic, thread-safe container for validated configuration values. |
|
stats
Package stats provides time-windowed statistics collection and aggregation.
|
Package stats provides time-windowed statistics collection and aggregation. |
|
testutil
Package testutil provides test utilities and builders for integration testing.
|
Package testutil provides test utilities and builders for integration testing. |
|
timeutil
Package timeutil provides time-related utility functions.
|
Package timeutil provides time-related utility functions. |
|
tracking
Package tracking provides a generic, concurrency-safe request tracker for correlating outbound requests with their responses.
|
Package tracking provides a generic, concurrency-safe request tracker for correlating outbound requests with their responses. |
|
ws
Package ws provides WebSocket connection utilities including reading, writing, and lifecycle management.
|
Package ws provides WebSocket connection utilities including reading, writing, and lifecycle management. |
Click to show internal directories.
Click to hide internal directories.