diff --git a/agent/pkg/agent/README.md b/agent/pkg/agent/README.md index 884c6956..86815b58 100644 --- a/agent/pkg/agent/README.md +++ b/agent/pkg/agent/README.md @@ -1,4 +1,4 @@ -# Agent Package +# agent/pkg/agent The `agent` package provides the client-side implementation for interacting with GoDoxy agents. It handles agent configuration, secure communication via TLS, and provides utilities for agent deployment and management. diff --git a/agent/pkg/agent/stream/README.md b/agent/pkg/agent/stream/README.md index 720d713f..a194af21 100644 --- a/agent/pkg/agent/stream/README.md +++ b/agent/pkg/agent/stream/README.md @@ -1,4 +1,4 @@ -# Stream proxy protocol +# agent/pkg/agent/stream This package implements a small header-based handshake that allows an authenticated client to request forwarding to a `(host, port)` destination. It supports both TCP-over-TLS and UDP-over-DTLS transports. diff --git a/goutils b/goutils index 494ab85a..860d05e8 160000 --- a/goutils +++ b/goutils @@ -1 +1 @@ -Subproject commit 494ab85a33aea48b8be5bcd08a506596727248f4 +Subproject commit 860d05e804133d14bd0baa1c3229e9edfea9e65a diff --git a/internal/acl/README.md b/internal/acl/README.md index b01c2722..bf52efb1 100644 --- a/internal/acl/README.md +++ b/internal/acl/README.md @@ -1,4 +1,4 @@ -# ACL (Access Control List) +# internal/acl Access control at the TCP connection level with IP/CIDR, timezone, and country-based filtering. diff --git a/internal/agentpool/README.md b/internal/agentpool/README.md index 08b260a8..1f7fffad 100644 --- a/internal/agentpool/README.md +++ b/internal/agentpool/README.md @@ -1,4 +1,4 @@ -# Agent Pool +# internal/agentpool Thread-safe pool for managing remote Docker agent connections. diff --git a/internal/api/v1/README.md b/internal/api/v1/README.md index 55a8147c..5dfae985 100644 --- a/internal/api/v1/README.md +++ b/internal/api/v1/README.md @@ -1,4 +1,4 @@ -# API v1 Package +# internal/api/v1 Implements the v1 REST API handlers for GoDoxy, exposing endpoints for managing routes, Docker containers, certificates, metrics, and system configuration. diff --git a/internal/auth/README.md b/internal/auth/README.md index aa340207..2de1aec1 100644 --- a/internal/auth/README.md +++ b/internal/auth/README.md @@ -1,4 +1,4 @@ -# Authentication +# internal/auth Authentication providers supporting OIDC and username/password authentication with JWT-based sessions. diff --git a/internal/autocert/README.md b/internal/autocert/README.md index 496e2e76..8b33943a 100644 --- a/internal/autocert/README.md +++ b/internal/autocert/README.md @@ -1,4 +1,4 @@ -# Autocert Package +# internal/autocert Automated SSL certificate management using the ACME protocol (Let's Encrypt and compatible CAs). diff --git a/internal/config/README.md b/internal/config/README.md index 3fe95604..d73c6df7 100644 --- a/internal/config/README.md +++ b/internal/config/README.md @@ -1,4 +1,4 @@ -# Configuration Management +# internal/config Centralized YAML configuration management with thread-safe state access and provider initialization. diff --git a/internal/config/query/README.md b/internal/config/query/README.md index c10b3c07..b74cee3a 100644 --- a/internal/config/query/README.md +++ b/internal/config/query/README.md @@ -1,4 +1,4 @@ -# Configuration Query +# internal/config/query Read-only access to the active configuration state, including route providers and system statistics. @@ -149,7 +149,7 @@ No metrics are currently exposed. ## Performance Characteristics - O(n) where n is number of providers for provider queries -- O(n * m) where m is routes per provider for route search +- O(n \* m) where m is routes per provider for route search - O(n) for statistics aggregation - No locking required (uses atomic load) diff --git a/internal/dnsproviders/README.md b/internal/dnsproviders/README.md index 0d79a718..b2cb7f39 100644 --- a/internal/dnsproviders/README.md +++ b/internal/dnsproviders/README.md @@ -1,4 +1,4 @@ -# DNS Providers +# internal/dnsproviders DNS provider integrations for Let's Encrypt certificate management via the lego library. diff --git a/internal/docker/README.md b/internal/docker/README.md index 3cb2e89f..9b2fb9aa 100644 --- a/internal/docker/README.md +++ b/internal/docker/README.md @@ -1,4 +1,4 @@ -# Docker Integration +# internal/docker Docker container discovery, connection management, and label-based route configuration. diff --git a/internal/entrypoint/README.md b/internal/entrypoint/README.md index 0380f976..053a16a5 100644 --- a/internal/entrypoint/README.md +++ b/internal/entrypoint/README.md @@ -1,4 +1,4 @@ -# Entrypoint +# internal/entrypoint The entrypoint package provides the main HTTP entry point for GoDoxy, handling domain-based routing, middleware application, short link matching, access logging, and HTTP server lifecycle management. diff --git a/internal/health/check/README.md b/internal/health/check/README.md index bd27f498..f0162cd4 100644 --- a/internal/health/check/README.md +++ b/internal/health/check/README.md @@ -1,4 +1,4 @@ -# Health Check Package +# internal/health/check Low-level health check implementations for different protocols and services in GoDoxy. diff --git a/internal/health/monitor/README.md b/internal/health/monitor/README.md index e8e8d614..43acdd6a 100644 --- a/internal/health/monitor/README.md +++ b/internal/health/monitor/README.md @@ -1,4 +1,4 @@ -# Health Monitor Package +# internal/health/monitor Route health monitoring with configurable check intervals, retry policies, and notification integration. diff --git a/internal/homepage/README.md b/internal/homepage/README.md index 8e572ea7..5df0b49d 100644 --- a/internal/homepage/README.md +++ b/internal/homepage/README.md @@ -1,4 +1,4 @@ -# Homepage +# internal/homepage The homepage package provides the GoDoxy WebUI dashboard with support for categories, favorites, widgets, dynamic item configuration, and icon management. diff --git a/internal/homepage/icons/README.md b/internal/homepage/icons/README.md index 012dd545..8b6d1efa 100644 --- a/internal/homepage/icons/README.md +++ b/internal/homepage/icons/README.md @@ -1,4 +1,4 @@ -# Icons Package +# internal/homepage/icons Icon URL parsing, fetching, and listing for the homepage dashboard. diff --git a/internal/homepage/integrations/qbittorrent/README.md b/internal/homepage/integrations/qbittorrent/README.md index 5d06ee7a..1b85a138 100644 --- a/internal/homepage/integrations/qbittorrent/README.md +++ b/internal/homepage/integrations/qbittorrent/README.md @@ -1,4 +1,4 @@ -# qBittorrent Integration Package +# internal/homepage/integrations/qbittorrent This package provides a qBittorrent widget for the GoDoxy homepage dashboard, enabling real-time monitoring of torrent status and transfer statistics. diff --git a/internal/homepage/types/README.md b/internal/homepage/types/README.md deleted file mode 100644 index a74a6010..00000000 --- a/internal/homepage/types/README.md +++ /dev/null @@ -1,13 +0,0 @@ -# Types Package - -Configuration types for the homepage package. - -## Config - -```go -type Config struct { - UseDefaultCategories bool `json:"use_default_categories"` -} - -var ActiveConfig atomic.Pointer[Config] -``` diff --git a/internal/homepage/widgets/README.md b/internal/homepage/widgets/README.md index e2a2b719..46e540c0 100644 --- a/internal/homepage/widgets/README.md +++ b/internal/homepage/widgets/README.md @@ -1,4 +1,4 @@ -# Homepage Widgets Package +# internal/homepage/widgets > [!WARNING] > diff --git a/internal/idlewatcher/README.md b/internal/idlewatcher/README.md index f73eb0d1..2a2aeda6 100644 --- a/internal/idlewatcher/README.md +++ b/internal/idlewatcher/README.md @@ -1,4 +1,4 @@ -# Idlewatcher +# internal/idlewatcher Manages container lifecycle based on idle timeout, automatically stopping/pausing containers and waking them on request. diff --git a/internal/idlewatcher/provider/README.md b/internal/idlewatcher/provider/README.md index fb42ba67..8a207565 100644 --- a/internal/idlewatcher/provider/README.md +++ b/internal/idlewatcher/provider/README.md @@ -1,4 +1,4 @@ -# Idlewatcher Provider +# internal/idlewatcher/provider Implements container runtime abstractions for Docker and Proxmox LXC backends. diff --git a/internal/jsonstore/README.md b/internal/jsonstore/README.md index 7c091173..3d33ee8b 100644 --- a/internal/jsonstore/README.md +++ b/internal/jsonstore/README.md @@ -1,4 +1,4 @@ -# JSON Store +# internal/jsonstore The jsonstore package provides persistent JSON storage with namespace support, using thread-safe concurrent maps and automatic loading/saving. diff --git a/internal/logging/README.md b/internal/logging/README.md index b9c204fb..04f0d7c5 100644 --- a/internal/logging/README.md +++ b/internal/logging/README.md @@ -1,4 +1,4 @@ -# Logging Package +# internal/logging Structured logging capabilities for GoDoxy, including application logging, HTTP access logging, and in-memory log streaming. diff --git a/internal/logging/accesslog/README.md b/internal/logging/accesslog/README.md index 66ee8511..1a5efdb2 100644 --- a/internal/logging/accesslog/README.md +++ b/internal/logging/accesslog/README.md @@ -1,4 +1,4 @@ -# Access Logging +# internal/logging/accesslog Provides HTTP access logging with file rotation, log filtering, and multiple output formats for request and ACL event logging. diff --git a/internal/logging/memlogger/README.md b/internal/logging/memlogger/README.md index 980b6bd1..f5d07fd6 100644 --- a/internal/logging/memlogger/README.md +++ b/internal/logging/memlogger/README.md @@ -1,4 +1,4 @@ -# In-Memory Logger +# internal/logging/memlogger Provides a thread-safe in-memory circular buffer logger with WebSocket-based real-time streaming for log data. diff --git a/internal/maxmind/README.md b/internal/maxmind/README.md index f98b3369..788421e3 100644 --- a/internal/maxmind/README.md +++ b/internal/maxmind/README.md @@ -1,4 +1,4 @@ -# MaxMind +# internal/maxmind The maxmind package provides MaxMind GeoIP database integration for IP geolocation, including automatic database downloading and updates. diff --git a/internal/metrics/README.md b/internal/metrics/README.md index 60b3a740..b1623fb7 100644 --- a/internal/metrics/README.md +++ b/internal/metrics/README.md @@ -1,4 +1,4 @@ -# Metrics Package +# internal/metrics System monitoring and metrics collection for GoDoxy with time-series storage and REST/WebSocket APIs. diff --git a/internal/metrics/period/README.md b/internal/metrics/period/README.md index c2058808..9dc1de62 100644 --- a/internal/metrics/period/README.md +++ b/internal/metrics/period/README.md @@ -1,4 +1,4 @@ -# Period Metrics +# internal/metrics/period Provides time-bucketed metrics storage with configurable periods, enabling historical data aggregation and real-time streaming. @@ -453,7 +453,7 @@ for { - O(1) add to circular buffer - O(1) get (returns slice view) - O(n) serialization where n = total entries -- Memory: O(5 * 100 * sizeof(T)) = fixed overhead +- Memory: O(5 _ 100 _ sizeof(T)) = fixed overhead - JSON load/save: O(n) where n = total entries ## Testing Notes diff --git a/internal/metrics/systeminfo/README.md b/internal/metrics/systeminfo/README.md index 7573d668..a021adab 100644 --- a/internal/metrics/systeminfo/README.md +++ b/internal/metrics/systeminfo/README.md @@ -1,4 +1,4 @@ -# System Info +# internal/metrics/systeminfo Collects and aggregates system metrics including CPU, memory, disk, network, and sensor data with configurable aggregation modes. @@ -367,7 +367,7 @@ curl "http://localhost:8080/api/metrics/system?period=1h&aggregate=disks_read_sp ```javascript const ws = new WebSocket( - "ws://localhost:8080/api/metrics/system?period=1m&interval=5s&aggregate=cpu_average" + "ws://localhost:8080/api/metrics/system?period=1m&interval=5s&aggregate=cpu_average", ); ws.onmessage = (event) => { diff --git a/internal/metrics/uptime/README.md b/internal/metrics/uptime/README.md index 65e7bbd0..93c5ca4c 100644 --- a/internal/metrics/uptime/README.md +++ b/internal/metrics/uptime/README.md @@ -1,4 +1,4 @@ -# Uptime +# internal/metrics/uptime Tracks and aggregates route health status over time, providing uptime/downtime statistics and latency metrics. diff --git a/internal/net/README.md b/internal/net/README.md index f2fa745b..b1ddc061 100644 --- a/internal/net/README.md +++ b/internal/net/README.md @@ -1,4 +1,4 @@ -# Network Utilities +# internal/net The net package provides network utility functions for GoDoxy, including TCP connection testing and network-related helpers. diff --git a/internal/net/gphttp/README.md b/internal/net/gphttp/README.md index 0115d176..8fc0e111 100644 --- a/internal/net/gphttp/README.md +++ b/internal/net/gphttp/README.md @@ -1,4 +1,4 @@ -# gphttp +# internal/net/gphttp HTTP utilities package providing transport configuration, default HTTP client, and a wrapper around `http.ServeMux` with panic recovery. diff --git a/internal/net/gphttp/loadbalancer/README.md b/internal/net/gphttp/loadbalancer/README.md index 58425276..2d2e3a67 100644 --- a/internal/net/gphttp/loadbalancer/README.md +++ b/internal/net/gphttp/loadbalancer/README.md @@ -1,4 +1,4 @@ -# Load Balancer +# internal/net/gphttp/loadbalancer Load balancing package providing multiple distribution algorithms, sticky sessions, and server health management. diff --git a/internal/net/gphttp/middleware/README.md b/internal/net/gphttp/middleware/README.md index b649c4fc..8c3a4666 100644 --- a/internal/net/gphttp/middleware/README.md +++ b/internal/net/gphttp/middleware/README.md @@ -1,4 +1,4 @@ -# Middleware +# internal/net/gphttp/middleware HTTP middleware framework providing request/response processing, middleware chaining, and composition from YAML files. diff --git a/internal/net/gphttp/middleware/captcha/README.md b/internal/net/gphttp/middleware/captcha/README.md index 7e5d7650..242c3e9e 100644 --- a/internal/net/gphttp/middleware/captcha/README.md +++ b/internal/net/gphttp/middleware/captcha/README.md @@ -1,4 +1,4 @@ -# Captcha Middleware +# internal/net/gphttp/middleware/captcha CAPTCHA verification middleware package providing session-based captcha challenge and verification. diff --git a/internal/net/gphttp/middleware/errorpage/README.md b/internal/net/gphttp/middleware/errorpage/README.md index deffa311..e5f8f408 100644 --- a/internal/net/gphttp/middleware/errorpage/README.md +++ b/internal/net/gphttp/middleware/errorpage/README.md @@ -1,4 +1,4 @@ -# Error Page Middleware +# internal/net/gphttp/middleware/errorpage Custom error page serving middleware that replaces default HTTP error responses with styled custom pages. @@ -233,16 +233,16 @@ flowchart TD ```html - + Service Unavailable - - - + + +
-

503 - Service Unavailable

-

The service is temporarily unavailable. Please try again later.

+

503 - Service Unavailable

+

The service is temporarily unavailable. Please try again later.

- + ``` diff --git a/internal/notif/README.md b/internal/notif/README.md index c10bf03c..179d7626 100644 --- a/internal/notif/README.md +++ b/internal/notif/README.md @@ -1,4 +1,4 @@ -# Notifications +# internal/notif The notif package provides a notification dispatching system for GoDoxy, supporting multiple providers (Webhook, Gotify, Ntfy) with retry logic and exponential backoff. diff --git a/internal/proxmox/README.md b/internal/proxmox/README.md index 58fb648e..66764b65 100644 --- a/internal/proxmox/README.md +++ b/internal/proxmox/README.md @@ -1,4 +1,4 @@ -# Proxmox +# internal/proxmox The proxmox package provides Proxmox VE integration for GoDoxy, enabling management of Proxmox LXC containers. diff --git a/internal/route/README.md b/internal/route/README.md index b1c5c68a..5e8c402a 100644 --- a/internal/route/README.md +++ b/internal/route/README.md @@ -1,4 +1,4 @@ -# Route +# internal/route Provides HTTP routing, reverse proxy, file serving, and TCP/UDP stream proxying for GoDoxy. diff --git a/internal/route/provider/README.md b/internal/route/provider/README.md index be206abe..56bcafd0 100644 --- a/internal/route/provider/README.md +++ b/internal/route/provider/README.md @@ -1,4 +1,4 @@ -# Route Provider +# internal/route/provider Discovers and loads routes from Docker containers, YAML files, and remote agents. diff --git a/internal/route/rules/README.md b/internal/route/rules/README.md index 1b1d917f..dbb4b358 100644 --- a/internal/route/rules/README.md +++ b/internal/route/rules/README.md @@ -1,4 +1,4 @@ -# Route Rules +# internal/route/rules Implements a rule engine for HTTP request/response processing, enabling conditional routing, header manipulation, authentication, and more. diff --git a/internal/route/rules/presets/README.md b/internal/route/rules/presets/README.md index 7e3e1d15..030c95eb 100644 --- a/internal/route/rules/presets/README.md +++ b/internal/route/rules/presets/README.md @@ -1,4 +1,4 @@ -# Rule Presets +# internal/route/rules/presets Provides embedded, pre-configured rule sets for common routing patterns. diff --git a/internal/route/stream/README.md b/internal/route/stream/README.md index 67e4544f..fed29b44 100644 --- a/internal/route/stream/README.md +++ b/internal/route/stream/README.md @@ -1,4 +1,4 @@ -# Stream Handling +# internal/route/stream Implements TCP and UDP stream proxying for non-HTTP protocols. diff --git a/internal/serialization/README.md b/internal/serialization/README.md index 45aa3c16..e5b01d0a 100644 --- a/internal/serialization/README.md +++ b/internal/serialization/README.md @@ -1,4 +1,4 @@ -# Serialization Package +# internal/serialization Flexible, type-safe serialization/deserialization with validation support for GoDoxy configuration. diff --git a/internal/watcher/README.md b/internal/watcher/README.md index 29efd8f2..312289c8 100644 --- a/internal/watcher/README.md +++ b/internal/watcher/README.md @@ -1,4 +1,4 @@ -# Watcher +# internal/watcher Provides file and Docker event watching capabilities for GoDoxy, enabling dynamic configuration updates. diff --git a/socket-proxy/pkg/reverseproxy/README.md b/socket-proxy/pkg/reverseproxy/README.md index bb0dafea..f2cadc1b 100644 --- a/socket-proxy/pkg/reverseproxy/README.md +++ b/socket-proxy/pkg/reverseproxy/README.md @@ -1,4 +1,4 @@ -# Socket Proxy Reverse Proxy +# socket-proxy/pkg/reverseproxy This package provides an HTTP reverse proxy implementation for proxying requests to Unix sockets (typically Docker sockets). It is based on Go's `net/http/httputil.ReverseProxy` with simplifications for socket proxying use cases. @@ -16,7 +16,6 @@ This package provides an HTTP reverse proxy implementation for proxying requests 1. **Director only**: Only the `Director` function is supported. The stdlib's `Rewrite` type and `ModifyResponse` hook are removed. 2. **Context-aware body copying**: Uses `ioutils.CopyCloseWithContext` which: - - Respects request context for cancellation - Uses `Content-Length` for optimal copying when available - Properly handles trailer headers