Skip to content

SPIFFE 中文站(spiffe-cn)

基于 VitePress 的 SPIFFE/SPIRE 中文文档门户,含:协议中文版、SPIRE 源码解读、高可用与大集群部署、云上落地、安全加固与行业应用、资源下载、联系我们。

本地开发(推荐用 Makefile)

bash
make install     # 安装依赖(默认公共 npm 源;在 homelab 网内可 make install REGISTRY=<私有源>)
make dev         # 本地开发,热更新
make build       # 构建静态站到 .vitepress/dist
make preview     # 构建并预览
make doctor      # 体检:node/pnpm/wrangler 版本与登录状态
make help        # 查看全部目标

等价的 pnpm 命令:pnpm install / pnpm dev / pnpm build / pnpm preview

⚠️ 本机 pnpm 默认指向 homelab 私有源;离网时用 make install(已默认公共源)或 pnpm install --registry https://registry.npmjs.org/

目录结构

website/
├── .vitepress/
│   ├── config.mts           # 站点配置(导航、侧边栏、搜索、mermaid)
│   └── theme/               # 品牌主题(custom.css)
├── index.md                 # 首页(hero + 特性)
├── spec/                    # 协议中文版(8 份规范译文 + img/)
├── source/                  # SPIRE 源码解读(架构、SVID 颁发)
├── practice/                # 实战:三节点部署、SVID 形式vs实际、配置实验
├── ha/                      # 高可用与大集群部署
├── cloud/                   # 云上落地
├── security/                # 安全加固与行业应用
├── resources/               # 资源下载与术语表
├── contact/                 # 联系我们
├── release-notes.md         # 发布说明 / 更新日志
├── public/                  # 静态资源(logo.svg / favicon.svg)
├── Makefile                 # 构建/发布快捷目标(make help)
├── scripts/release.sh       # 发布脚本(校验→构建→部署→打标签)
└── wrangler.jsonc           # Cloudflare Pages 部署配置

部署到 Cloudflare Pages

bash
# 首次:登录 Cloudflare(浏览器 OAuth,只需一次)
pnpm exec wrangler login
# 首次:创建 Pages 项目(仅一次)
pnpm exec wrangler pages project create spiffe-cn --production-branch main

# 日常部署(构建 + 部署)
make deploy

正式发布(带版本与发布说明)

scripts/release.sh 会:预检登录 → (可选)升版本 + 在 release-notes.md 插入模板条目 + 打 git 标签 → 构建 → 部署。

bash
make release                 # 用当前内容构建并发布(不改版本)
make release VERSION=0.2.0   # 顺带升到 0.2.0、写发布说明模板、打 v0.2.0 标签

发布后得到 https://spiffe-cn.pages.dev。绑定自定义域名(如 spiffe.cn):Cloudflare Dashboard → Pages → spiffe-cn → Custom domains 添加并配 DNS;同时把 .vitepress/config.mts 顶部的 SITE_URL 改为正式域名(用于 sitemap)。

发布说明维护:编辑 release-notes.md,在 <!-- RELEASE-NOTES:START --> 标记后新增 ## vX.Y.Z — 日期 条目;make release VERSION=... 会自动插入模板骨架供你补全。

待站主完善的占位

  • contact/index.md:把联系方式占位符替换为真实邮箱/社群/公众号。
  • public/:如需放二维码等图片,放此目录并用 /xxx.png 引用。