ianlintner068/oauth2-server

Rust OAuth2 Server (Docker镜像)

一个基于Rust + Actix-web构建的生产就绪型OAuth2授权服务器。

本文档面向希望无需编译直接运行服务器的Docker Hub用户。

完整文档：https://ianlintner.github.io/rust-oauth2-server/

示例中使用的镜像名称：ianlintner068/oauth2-server

若使用不同命名空间/名称发布，请替换下方所有相关引用。

快速启动（SQLite，无需额外容器）

此方式使用嵌入式SQLite数据库（存储在Docker卷中）运行服务器。

• UI登录页面：http://localhost:8080/auth/login
• Swagger UI：http://localhost:8080/swagger-ui
• 健康检查：http://localhost:8080/health

1) 生成密钥

生产环境中必须设置JWT密钥，且（强烈建议）设置持久化会话密钥。

• OAUTH2_JWT_SECRET：至少32字符（推荐64+字符）
• OAUTH2_SESSION_KEY：推荐128个十六进制字符（64字节）

生成示例：

• JWT密钥（十六进制，32字节）：openssl rand -hex 32
• 会话密钥（十六进制，64字节）：openssl rand -hex 64

2) 运行容器

bash
docker run --rm -p 8080:8080 \
  -e OAUTH2_SERVER_HOST=0.0.0.0 \
  -e OAUTH2_SERVER_PORT=8080 \
  -e OAUTH2_DATABASE_URL=sqlite:/app/data/oauth2.db \
  -e OAUTH2_JWT_SECRET="$(openssl rand -hex 32)" \
  -e OAUTH2_SESSION_KEY="$(openssl rand -hex 64)" \
  -e RUST_LOG=info \
  -v oauth2_data:/app/data \
  --name rust-oauth2-server \
  ianlintner068/oauth2-server:latest

首次启动时会自动创建/app/data/oauth2.db数据库文件。

Docker Compose配置（SQLite）

yaml
services:
  oauth2:
    image: ianlintner068/oauth2-server:latest
    ports:
      - "8080:8080"
    environment:
      OAUTH2_SERVER_HOST: 0.0.0.0
      OAUTH2_SERVER_PORT: 8080
      OAUTH2_DATABASE_URL: sqlite:/app/data/oauth2.db
      OAUTH2_JWT_SECRET: ${OAUTH2_JWT_SECRET}
      OAUTH2_SESSION_KEY: ${OAUTH2_SESSION_KEY}
      RUST_LOG: info
    volumes:
      - oauth2_data:/app/data

volumes:
  oauth2_data:

常用环境变量

常用端点

• 登录UI：GET /auth/login
• OAuth端点：
  • GET /oauth/authorize（授权请求）
  • POST /oauth/token（令牌获取）
  • POST /oauth/introspect（令牌验证）
  • POST /oauth/revoke（令牌撤销）
• OpenID发现：GET /.well-known/openid-configuration
• Swagger UI：GET /swagger-ui（API文档界面）
• OpenAPI JSON：GET /api-docs/openapi.json（API规范）
• 健康检查：GET /health
• 就绪检查：GET /ready
• Prometheus指标：GET /metrics（监控指标）

通过application.conf配置（可选）

默认情况下，容器通过环境变量读取配置。

若需使用配置文件，可将文件挂载到/app/application.conf：

bash
docker run --rm -p 8080:8080 \
  -v "$PWD/application.conf:/app/application.conf:ro" \
  -e OAUTH2_JWT_SECRET="$(openssl rand -hex 32)" \
  ianlintner068/oauth2-server:latest

application.conf采用HOCON格式，支持环境变量替换。

PostgreSQL（生产环境配置）

支持PostgreSQL后端，但数据库 schema 需通过Flyway迁移创建。

推荐方式（无需编译，但需克隆仓库获取迁移脚本）

使用仓库中的docker-compose.yml（包含PostgreSQL和Flyway迁移）。

若要运行预构建镜像，将oauth2_server服务的build: .替换为：

• image: ianlintner/rust-oauth2-server:latest

仓库地址：https://github.com/ianlintner/rust-oauth2-server

注意事项与故障排除

• JWT密钥警告：若未设置OAUTH2_JWT_SECRET，服务器将使用仅用于测试的不安全默认值启动。
• 会话密钥格式：OAUTH2_SESSION_KEY必须为十六进制。使用openssl rand -hex 64生成。
• SQLite持久化：挂载/app/data（或其他目录）并将OAUTH2_DATABASE_URL指向该路径。
• MongoDB支持：MongoDB支持在Rust构建时通过特性标志启用。默认预构建镜像通常不包含MongoDB支持，建议使用SQLite或PostgreSQL。

源代码

• GitHub：https://github.com/ianlintner/rust-oauth2-server

许可证

双许可证：Apache-2.0和MIT。