文档 — OpenVLAN

快速入门：三条命令搭起 tailnet

安装 CLI、登录，您的设备就带着一个稳定地址和一个名字加入网络。无需编写配置文件，无需照看证书，无需开放端口 — 安装脚本会自动识别平台，剩下的只是在浏览器里登录一次。

✓macOS、Linux 与 Windows 上同样的三条命令
✓仅出站连接 — 无任何暴露，无需加固
✓上线即可按名称 ping 任意设备

# install the CLI (macOS / Linux)

$ curl -fsSL https://www.openvlan.com/install.sh | sh

# sign in and join the network

$ openvlan up

# check your connection

$ openvlan status

# you're on the tailnet. ping any device by name:

$ ping my-other-device

与您所装版本同步的文档

每篇指南都与客户端同步版本化，并在每个发布周期评审。如果您的管理控制台里出现这些页面从未提及的开关，那是文档的 bug — 提个 issue，PR 通常几天内就会合并。

文档覆盖情况，当前版本

快速入门从安装到首次 ping 通12最新

专题指南网络 · 安全 · 自动化38最新

API 端点参考 + 实战示例13已版本化

CLI 命令附带 man 手册41已版本化

知识库文章以排障为先120+持续增加

核心概念

Tailnet

您的专属私有网络：所有设备共享一个地址空间（默认 100.64.0.0/10）与一个 DNS 命名空间。

节点

一切接入 tailnet 的对象 — 笔记本、服务器、容器、手机。每个节点都有稳定身份。

ACL

规定谁可以访问什么的规则手册。默认拒绝，面向用户、组与标签表达。

MagicDNS

每个节点都可用短名称访问 — ssh build-01 直接可用，无需记 IP。

子网路由器

将整个 CIDR 发布进 tailnet，现有网络无需逐台改动即可接入。

按主题浏览指南

入门

✓在 Windows、macOS、Linux、iOS、Android 上安装
✓用 CLI 添加您的第一台服务器
✓邀请用户并组织分组
✓启用 MagicDNS

下载页面 →

网络

✓从 AWS / GCP / Azure 发布子网
✓用出口节点处理出境流量
✓通过 pfSense / OPNsense 接入本地网段
✓为内部域名配置 Split DNS

基础设施访问 →

安全

✓编写您的第一份 ACL 文件
✓设备状态检查
✓使用按用户证书的 SSH 会话
✓将审计日志流式发送至 SIEM

零信任 →

自动化

✓Terraform provider 快速入门
✓GitHub Actions 临时 runner
✓Kubernetes operator
✓授权密钥：预授权、限范围、可过期

API 参考 →

功能深度解析

OpenVLAN SSH

服务器上的 SSO 认证会话、录制与检入模式。

功能页 →

出口节点

发布、审批出口节点，并让设备流量经可信出口路由。

功能页 →

Kubernetes operator

入口、出口与 CRD — 集群成为 tailnet 的一等公民。

用例 →

Funnel

将指定服务发布到公网，TLS 一并就绪。

用例 →

CLI 速查表

命令	用途说明
openvlan up	连接 / 重新认证此设备
openvlan down	断开连接
openvlan status	显示对等节点、路由与连接状态
openvlan ip	打印本节点的 tailnet 地址
openvlan up --advertise-routes=10.0.0.0/16	成为子网路由器
openvlan up --advertise-exit-node	将本节点用作互联网出口
openvlan logout	移除密钥并退出 tailnet

文档常见问题

我是新手，先读什么？

先看上面的快速入门，再看"核心概念"— tailnet、节点、ACL、MagicDNS，总共十分钟。之后按任务跳转：按主题指南的网格会把每张卡片对应到您真正需要的深入内容。

文档覆盖自托管协调器吗？

覆盖 — 企业版自托管指南涵盖安装、容量规划、升级与数据驻留，位于专题指南的"安全与架构"之下。

我能为文档贡献修正吗？

可以。文档源码在公开仓库里；一段话的 PR 会受到欢迎，通常几天内合并。错别字、失效链接、"这步在 FreeBSD 上跑不通"的报告，都欢迎提交。

旧版客户端的文档在哪里？

每个页面都有版本选择器 — 1.8 发布后 /v1.7 文档依然可读。API 参考页显式锁定在 /v1，针对去年端点编写的集成可以继续工作。

文档、知识库和博客有什么区别？

文档讲"怎么用"，知识库答"哪里出了问题"，博客说"我们为什么这样设计"。当博客的"怎么用"部分过时时，它会链接到常新的文档。

文档