mirror of https://github.com/yusing/godoxy.git synced 2026-01-11 22:30:47 +01:00

Files

yusing 74f97a6621 refactor(homepage): reorganize icons into dedicated package structure

Split the monolithic `internal/homepage` icons functionality into a structured package hierarchy:

- `internal/homepage/icons/` - Core types (URL, Key, Meta, Provider, Source, Variant)
- `internal/homepage/icons/fetch/` - Icon fetching logic (content.go, fetch.go, route.go)
- `internal/homepage/icons/list/` - Icon listing and search (list_icons.go, list_icons_test.go)

Moved icon-related code from `internal/homepage/`:
- `icon_url.go` → `icons/url.go` (+ url_test.go)
- `content.go` → `icons/fetch/content.go`
- `route.go` → `icons/fetch/route.go`
- `list_icons.go` → `icons/list/list_icons.go` (+ list_icons_test.go)

Updated all consumers to use the new package structure:
- `cmd/main.go`
- `internal/api/v1/favicon.go`
- `internal/api/v1/icons.go`
- `internal/idlewatcher/handle_http.go`
- `internal/route/route.go`

2026-01-09 12:06:54 +08:00

bench_server

refactor(benchmark): replace whoami service with bench server

2026-01-03 12:40:10 +08:00

h2c_test_server

fix(h2c_test_server): correct listening on message

2026-01-03 12:58:14 +08:00

debug_page_prod.go

feat(debug): implement debug server for development environment

2025-12-22 16:57:47 +08:00

debug_page.go

feat(debug): implement debug server for development environment

2025-12-22 16:57:47 +08:00

main.go

refactor(homepage): reorganize icons into dedicated package structure

2026-01-09 12:06:54 +08:00

pprof_production.go

chore: completely drop prometheus support

2025-04-24 20:02:07 +08:00

pprof_prof.go

refactor: move some io, http and string utils to separate repo

2025-09-27 12:46:41 +08:00

README.md

docs: add per package README for implementation details (AI generated with human review)

2026-01-08 23:39:19 +08:00

README.md

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 files
config/ - Configuration directory
certs/ - SSL certificates
proxy/ - Proxy-related files

Environment Variables

API_JWT_SECRET - Secret key for JWT authentication (optional, auto-generated if not set)

Dependencies

internal/api - REST API handlers
internal/auth - Authentication and ACL
internal/config - Configuration management
internal/dnsproviders - DNS provider integration
internal/homepage - WebUI dashboard
internal/logging - Logging infrastructure
internal/metrics - System metrics collection
internal/route - HTTP routing and middleware
github.com/yusing/goutils/task - Task lifecycle management