docs: 同步 README 至当前 homelab 状态
- 添加 Authentik SSO 统一认证架构说明 - MinIO → SeaweedFS v4.28,域名 s3 → file.xiteng.site - 补充 Authentik ForwardAuth + 独立 Outpost 的认证架构图 - 更新目录结构(authentik/、outpost/、outpost-seaweedfs/、seaweedfs/) - 更新服务一览表(增加认证方式列) - 更新快速启动命令(包含新增服务)
This commit is contained in:
@@ -7,43 +7,73 @@
|
|||||||
```
|
```
|
||||||
公网用户
|
公网用户
|
||||||
│
|
│
|
||||||
├─ Web (443) ──→ Cloudflare Tunnel ──→ cloudflared (Docker) ──→ Traefik (反向代理)
|
├─ Web (443) ──→ Cloudflare Tunnel ──→ cloudflared (Docker, HTTP/2)
|
||||||
│ │
|
│ │
|
||||||
└─ SSH (22) ──→ 阿里云 VPS (frps) ──→ frpc (Docker) ──→ Gitea │
|
└─ SSH (22) ──→ 阿里云 VPS (frps) ──→ frpc (Docker) ──→ Gitea
|
||||||
│
|
│
|
||||||
┌───────────────┤
|
Traefik v3.7.1 (反向代理)
|
||||||
▼ ▼
|
│
|
||||||
各 Web 服务 Gitea SSH
|
┌───────────────┼───────────────────┐
|
||||||
|
▼ ▼ ▼
|
||||||
|
(有 Authentik SSO) (ForwardAuth) (免认证)
|
||||||
|
Gitea / HedgeDoc SeaweedFS / Gitea SSH
|
||||||
|
Homepage Uptime Kuma
|
||||||
```
|
```
|
||||||
|
|
||||||
| 入口 | 域名 | 传输 | 延迟 |
|
| 入口 | 域名 | 传输 | 延迟 |
|
||||||
|------|------|------|:--:|
|
|------|------|------|:--:|
|
||||||
| Web | `*.xiteng.site` | Cloudflare Tunnel → Traefik | ~50ms |
|
| Web | `*.xiteng.site` | Cloudflare Tunnel (HTTP/2) → Traefik | ~50ms |
|
||||||
| Git SSH | `git.xiteng.site` | 阿里云 VPS → frp → Gitea | ~5ms |
|
| Git SSH | `git.xiteng.site` | 阿里云 VPS → frp → Gitea | ~5ms |
|
||||||
|
|
||||||
## 服务一览
|
## 服务一览
|
||||||
|
|
||||||
| 服务 | 地址 | 说明 |
|
| 服务 | 地址 | 认证 | 说明 |
|
||||||
|------|------|------|
|
|------|------|------|------|
|
||||||
| Homepage | [xiteng.site](https://xiteng.site) | 导航面板 |
|
| Homepage | [home.xiteng.site](https://home.xiteng.site) | Authentik OIDC | 导航面板 |
|
||||||
| Gitea | [gitea.xiteng.site](https://gitea.xiteng.site) | 代码托管, `git clone git@git.xiteng.site:…` |
|
| Authentik | [auth.xiteng.site](https://auth.xiteng.site) | 自身 | 统一 SSO (v2026.5.0) |
|
||||||
| HedgeDoc | [notes.xiteng.site](https://notes.xiteng.site) | Markdown 协作 |
|
| Gitea | [gitea.xiteng.site](https://gitea.xiteng.site) | Authentik OAuth2 | 代码托管 |
|
||||||
| Uptime Kuma | [uptime.xiteng.site](https://uptime.xiteng.site) | 服务监控 |
|
| HedgeDoc | [notes.xiteng.site](https://notes.xiteng.site) | Authentik OIDC | Markdown 协作 |
|
||||||
| MinIO | 内网 | 对象存储(不暴露公网) |
|
| SeaweedFS | [file.xiteng.site](https://file.xiteng.site) | Authentik ForwardAuth | 对象存储 (v4.28) |
|
||||||
| Traefik | 内网 | 反向代理 |
|
| SeaweedFS S3 | [minio-api.xiteng.site](https://minio-api.xiteng.site) | Access Key | S3 API |
|
||||||
|
| Uptime Kuma | [uptime.xiteng.site](https://uptime.xiteng.site) | Authentik ForwardAuth | 服务监控 |
|
||||||
|
| Traefik | 内网 | — | 反向代理 |
|
||||||
|
|
||||||
|
> **注意**: SeaweedFS 已替代原 MinIO。域名于 2026-05-27 从 `s3.xiteng.site` 迁移至 `file.xiteng.site`。
|
||||||
|
|
||||||
|
## 认证架构
|
||||||
|
|
||||||
|
```
|
||||||
|
用户请求 → Cloudflare → cloudflared → Traefik
|
||||||
|
│
|
||||||
|
┌─────────────┤
|
||||||
|
▼ ▼
|
||||||
|
ForwardAuth OAuth2/OIDC
|
||||||
|
(中间件子请求) (应用层重定向)
|
||||||
|
│ │
|
||||||
|
▼ ▼
|
||||||
|
Authentik Outpost Authentik Server
|
||||||
|
(proxy container) (Django)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **OAuth2/OIDC**: Gitea、HedgeDoc、Homepage 各自持有 client_id/secret,用户从应用发起登录
|
||||||
|
- **ForwardAuth**: SeaweedFS、Uptime Kuma 由 Traefik 中间件在请求到达前拦截验证
|
||||||
|
- **独立 Outpost**: SeaweedFS 和 Uptime Kuma 各用独立 proxy outpost 容器(避免 cookie domain 冲突)
|
||||||
|
|
||||||
## 目录结构
|
## 目录结构
|
||||||
|
|
||||||
```
|
```
|
||||||
homelab/
|
homelab/
|
||||||
├── compose.yml # 共享网络定义 (homelab_net)
|
├── compose.yml # 共享网络定义 (homelab_net)
|
||||||
├── .env # 统一环境变量(敏感,gitignore)
|
├── .env # 统一环境变量(敏感,gitignore)
|
||||||
|
├── authentik/
|
||||||
|
│ ├── compose.yml
|
||||||
|
│ └── data/
|
||||||
├── cloudflared/
|
├── cloudflared/
|
||||||
│ ├── compose.yml
|
│ ├── compose.yml
|
||||||
│ └── config.yml
|
│ └── config.yml
|
||||||
├── frpc/
|
├── frpc/
|
||||||
│ ├── compose.yml
|
│ ├── compose.yml
|
||||||
│ └── frpc.toml # 敏感,gitignore
|
│ └── frpc.toml # 敏感,gitignore
|
||||||
├── gitea/
|
├── gitea/
|
||||||
│ ├── compose.yml
|
│ ├── compose.yml
|
||||||
│ └── data/
|
│ └── data/
|
||||||
@@ -53,12 +83,18 @@ homelab/
|
|||||||
├── homepage/
|
├── homepage/
|
||||||
│ ├── compose.yml
|
│ ├── compose.yml
|
||||||
│ └── config/
|
│ └── config/
|
||||||
├── minio/
|
├── outpost/
|
||||||
|
│ ├── compose.yml # Uptime Kuma outpost
|
||||||
|
│ └── ...
|
||||||
|
├── outpost-seaweedfs/
|
||||||
|
│ └── compose.yml # SeaweedFS 独立 outpost
|
||||||
|
├── seaweedfs/
|
||||||
│ ├── compose.yml
|
│ ├── compose.yml
|
||||||
|
│ ├── security.toml # JWT 已全部注释(社区版 UI 不支持 OIDC)
|
||||||
│ └── data/
|
│ └── data/
|
||||||
├── traefik/
|
├── traefik/
|
||||||
│ ├── compose.yml
|
│ ├── compose.yml
|
||||||
│ └── letsencrypt/ # gitignore
|
│ └── letsencrypt/ # gitignore
|
||||||
└── uptime-kuma/
|
└── uptime-kuma/
|
||||||
├── compose.yml
|
├── compose.yml
|
||||||
└── data/
|
└── data/
|
||||||
@@ -74,10 +110,14 @@ homelab/
|
|||||||
# 按依赖顺序启动
|
# 按依赖顺序启动
|
||||||
docker compose -f compose.yml up -d # 创建网络
|
docker compose -f compose.yml up -d # 创建网络
|
||||||
docker compose -f traefik/compose.yml up -d
|
docker compose -f traefik/compose.yml up -d
|
||||||
|
docker compose -f authentik/compose.yml up -d
|
||||||
docker compose -f gitea/compose.yml up -d
|
docker compose -f gitea/compose.yml up -d
|
||||||
docker compose -f hedgedoc/compose.yml up -d
|
docker compose -f hedgedoc/compose.yml up -d
|
||||||
|
docker compose -f seaweedfs/compose.yml up -d
|
||||||
docker compose -f uptime-kuma/compose.yml up -d
|
docker compose -f uptime-kuma/compose.yml up -d
|
||||||
docker compose -f homepage/compose.yml up -d
|
docker compose -f homepage/compose.yml up -d
|
||||||
|
docker compose -f outpost/compose.yml up -d
|
||||||
|
docker compose -f outpost-seaweedfs/compose.yml up -d
|
||||||
docker compose -f cloudflared/compose.yml up -d
|
docker compose -f cloudflared/compose.yml up -d
|
||||||
docker compose -f frpc/compose.yml up -d
|
docker compose -f frpc/compose.yml up -d
|
||||||
```
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user