Traefik Forward Auth 项目教程

1. 项目的目录结构及介绍

Traefik Forward Auth 项目的目录结构如下：

traefik-forward-auth/
├── Dockerfile
├── LICENSE
├── README.md
├── cmd/
│   └── main.go
├── examples/
│   ├── docker-compose-auth-host.yml
│   ├── docker-compose.yml
│   ├── kubernetes/
│   │   ├── advanced-separate-pod.yml
│   │   └── simple-separate-pod.yml
├── go.mod
├── go.sum
├── internal/
│   ├── config/
│   │   └── config.go
│   ├── providers/
│   │   ├── google.go
│   │   └── provider.go
│   └── server/
│       └── server.go
└── traefik-forward-auth.go

目录结构介绍

• Dockerfile: 用于构建 Docker 镜像的文件。
• LICENSE: 项目的开源许可证。
• README.md: 项目的说明文档。
• cmd/: 包含项目的主程序文件 main.go。
• examples/: 包含项目的示例配置文件，如 docker-compose 和 Kubernetes 配置。
• go.mod 和 go.sum: Go 模块依赖管理文件。
• internal/: 包含项目的内部逻辑代码，如配置、提供者和服务器等。
• traefik-forward-auth.go: 项目的主文件。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/main.go。这个文件是项目的入口点，负责初始化配置和启动服务器。

package main

import (
    "log"
    "os"

    "github.com/thomseddon/traefik-forward-auth/internal/config"
    "github.com/thomseddon/traefik-forward-auth/internal/server"
)

func main() {
    cfg, err := config.LoadConfig()
    if err != nil {
        log.Fatalf("Failed to load config: %v", err)
    }

    srv := server.NewServer(cfg)
    if err := srv.Run(); err != nil {
        log.Fatalf("Server failed to start: %v", err)
    }
}

启动文件介绍

• main.go 文件首先导入必要的包。
• config.LoadConfig() 函数用于加载配置。
• server.NewServer(cfg) 函数用于创建服务器实例。
• srv.Run() 函数用于启动服务器。

3. 项目的配置文件介绍

项目的配置文件主要通过环境变量进行设置。以下是一些关键的环境变量及其说明：

environment:
  - PROVIDERS_GOOGLE_CLIENT_ID=your-client-id
  - PROVIDERS_GOOGLE_CLIENT_SECRET=your-client-secret
  - SECRET=something-random
  - INSECURE_COOKIE=true # 示例假设没有 HTTPS，不要在生产环境中使用

配置文件介绍

• PROVIDERS_GOOGLE_CLIENT_ID: Google OAuth 客户端 ID。
• PROVIDERS_GOOGLE_CLIENT_SECRET: Google OAuth 客户端密钥。
• SECRET: 用于加密 Cookie 的随机密钥。
• INSECURE_COOKIE: 是否使用不安全的 Cookie（仅用于开发环境）。

以上是 Traefik Forward Auth 项目的基本教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用该项目。