README
¶
AnixOps Control Docs
This is the main documentation landing page for AnixOps/anix-control.
Use this tree like NodeX:
intro/README.md- start here if you need repository role, v4 architecture, boundary, and mode semantics
reference/README.md- use this for exact startup steps, config ownership, runtime mode references, and repository layout
guide/README.md- use this for deep implementation details, runtime operations, and runbooks
Status And Planning
- Feature status register:
features.md - Current 4.0.x RC execution roadmap:
ROADMAP-4.0.x-RC.md - Current RC verification snapshot:
RC-EVIDENCE-4.0.x.md - Product version history and staged-plan status:
architecture/release-line-status.md - Plugin kernel contract:
architecture/plugin-kernel-contract.md - Package extraction design and current development direction:
architecture/package-extraction.md - Order completion contract for the payment callbacks:
architecture/order-service.md - Node operations contract, node credential split and Agent A2 (design, draft):
architecture/node-ops-service.md - Forward SDK: routes, hops, engines and drivers for v4.2 (design, draft for review):
architecture/forward-sdk.md - AnixOps relay protocol: secure transport between forward nodes (design approved, H22):
architecture/anixops-protocol.md - Package reports on the Agent Control stream, and the privacy of the systemd services report:
architecture/package-reports.md - Network module runtime (mTLS, module PKI, remote runtime):
architecture/module-runtime.md - Identity service design (login and credentials as a module):
architecture/identity-service.md - Kernel contracts for modules: subscriber state
architecture/subscriber-service.md, system settingsarchitecture/settings-service.md, the kernel's cached answersarchitecture/kernel-caches.md - Control Center merge record (
control-center/):CONTROL-CENTER-MERGE-PLAN.md - Open backlog:
../TODO.md - Change history:
../CHANGELOG.md
Install, Upgrade, And Operate
- Deployment guide (Docker Compose, Kubernetes):
DEPLOYMENT.md - Container design and multi-replica status:
architecture/container-deployment.md - Native systemd install (frozen):
guide/release-installation.md - Upgrade runbook:
UPGRADE.md - V4 plugin-only upgrade:
guide/v4-plugin-only-upgrade.md - V4 plugin-only rollback:
guide/v4-plugin-only-rollback.md - Official package signing root rotation:
guide/release-root-rotation.md - In-place Control migration:
guide/control-migration.md - Legacy panel migration:
guide/legacy-migration.md - Route cutover staging rehearsal (legacy → shadow → native, batch sign-off):
guide/staging-rehearsal.md - SQLite to PostgreSQL migration:
reference/sqlite-to-postgres-migration.md - Manual intervention requirements:
manual-intervention.md - Brand and compatibility migration:
BRAND_MIGRATION.md
Startup And Configuration
- Docker quickstart:
reference/quickstart.md - Environment variables (
ANIX_CONTROL_*):reference/environment-variables.md - Exact startup flow:
reference/startup-config.md - Config source-of-truth:
reference/configuration.md - Repository layout:
reference/repository-layout.md - Frontend design system (AnixOps Design tokens, brand assets, sync and lint):
reference/frontend-design.md - Control boundary and entry points:
control-boundary.md
Forwarding Runtime
- Runtime mode entrypoint:
reference/runtime.md - Runtime config migration:
reference/forward-runtime-migration.md - The v4.2 forwarding pages (operator guide):
guide/forwarding.md - Relay onboarding:
guide/forward-relay-onboarding.md - Forward entry HA through DNS (DDNS providers, least-privilege credentials):
guide/forward-entry-ha.md - Forwarding: the v4.2 model
architecture/forward-sdk.md, the APIforwarding/v4-api.md,forwarding/security.md, and the legacy runtime designforwarding/design.md. The flux v2 API and compatibility docs were removed with the flux routes in v4.2 (F5d) and are inarchive/. - Clean-room forward agent:
forward-clean-room/spec.md,forward-clean-room/provenance.md
WireGuard
- P0 WireGuard relay plan:
guide/wireguard-relay.md - Peer schema:
reference/wireguard-peer-schema.md - Entry network policy:
guide/wireguard-network-policy.md - Peer key rotation:
guide/wireguard-key-rotation.md
Audit Registers
audit/repository-audit.mdaudit/security-risk.mdaudit/concurrency-risk.mdaudit/performance-risk.mdaudit/test-gap.md
Rule Of Thumb
- if you are asking "what does this repo own": read
intro - if you are asking "what do I edit to boot this": read
reference - if you are asking "how was this feature cloned or implemented": read
guide - if you are asking "what is implemented or still planned": read
features.md
Documentation
¶
Overview ¶
Package docs Code generated by swaggo/swag. DO NOT EDIT
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var SwaggerInfo = &swag.Spec{ Version: "4.2.0-rc.4", Host: "localhost:8080", BasePath: "/api/v2", Schemes: []string{"http", "https"}, Title: "AnixOps Control API", Description: "AnixOps Control 统一控制面 API 文档\n支持用户管理、节点管理、订阅系统、支付网关、流量转发等功能", InfoInstanceName: "swagger", SwaggerTemplate: docTemplate, LeftDelim: "{{", RightDelim: "}}", }
SwaggerInfo holds exported Swagger Info so clients can modify it
Functions ¶
This section is empty.
Types ¶
This section is empty.
Source Files
Click to show internal directories.
Click to hide internal directories.