mirror of
https://github.com/yusing/godoxy.git
synced 2026-02-18 14:57:49 +01:00
6da7227f9b
This is a large-scale refactoring across the codebase that replaces the custom `gperr.Error` type with Go's standard `error` interface. The changes include: - Replacing `gperr.Error` return types with `error` in function signatures - Using `errors.New()` and `fmt.Errorf()` instead of `gperr.New()` and `gperr.Errorf()` - Using `%w` format verb for error wrapping instead of `.With()` method - Replacing `gperr.Subject()` calls with `gperr.PrependSubject()` - Converting error logging from `gperr.Log*()` functions to zerolog's `.Err().Msg()` pattern - Update NewLogger to handle multiline error message - Updating `goutils` submodule to latest commit This refactoring aligns with Go idioms and removes the dependency on custom error handling abstractions in favor of standard library patterns.
cmd
Main entry point package for GoDoxy, a lightweight reverse proxy with WebUI for Docker containers.
Overview
This package contains the main.go entry point that initializes and starts the GoDoxy server. It coordinates the initialization of all core components including configuration loading, API server, authentication, and monitoring services.
Architecture
graph TD
A[main] --> B[Init Profiling]
A --> C[Init Logger]
A --> D[Parallel Init]
D --> D1[DNS Providers]
D --> D2[Icon Cache]
D --> D3[System Info Poller]
D --> D4[Middleware Compose Files]
A --> E[JWT Secret Setup]
A --> F[Create Directories]
A --> G[Load Config]
A --> H[Start Proxy Servers]
A --> I[Init Auth]
A --> J[Start API Server]
A --> K[Debug Server]
A --> L[Uptime Poller]
A --> M[Watch Changes]
A --> N[Wait Exit]
Main Function Flow
The main() function performs the following initialization steps:
- Profiling Setup: Initializes pprof endpoints for performance monitoring
- Logger Initialization: Configures zerolog with memory logging
- Parallel Initialization: Starts DNS providers, icon cache, system info poller, and middleware
- JWT Secret: Ensures API JWT secret is set (generates random if not provided)
- Directory Preparation: Creates required directories for logs, certificates, etc.
- Configuration Loading: Loads YAML configuration and reports any errors
- Proxy Servers: Starts HTTP/HTTPS proxy servers based on configuration
- Authentication: Initializes authentication system with access control
- API Server: Starts the REST API server with all configured routes
- Debug Server: Starts the debug page server (development mode)
- Monitoring: Starts uptime and system info polling
- Change Watcher: Starts watching for Docker container and configuration changes
- Graceful Shutdown: Waits for exit signal with configured timeout
Configuration
The main configuration is loaded from config/config.yml. Required directories include:
logs/- Log filesconfig/- Configuration directorycerts/- SSL certificatesproxy/- Proxy-related files
Environment Variables
API_JWT_SECRET- Secret key for JWT authentication (optional, auto-generated if not set)
Dependencies
internal/api- REST API handlersinternal/auth- Authentication and ACLinternal/config- Configuration managementinternal/dnsproviders- DNS provider integrationinternal/homepage- WebUI dashboardinternal/logging- Logging infrastructureinternal/metrics- System metrics collectioninternal/route- HTTP routing and middlewaregithub.com/yusing/goutils/task- Task lifecycle management