leonjza/trauth

trauth

!Docker Cloud Build Status

镜像概述

trauth是一个适用于Traefik的简单ForwardAuth服务。与其他支持OpenID/OAuth流程的ForwardAuth项目不同，trauth使用简单的htpasswd文件作为凭证数据库，通过HTTP基本认证方式提示用户登录。这对于使用Traefik提供服务的私有、隔离环境，需要简单单点登录（SSO）解决方案的场景非常理想。

核心功能与特性

• 轻量级认证：基于HTTP基本认证机制，无需复杂的OAuth/OpenID流程
• htpasswd集成：使用Apache htpasswd文件管理用户凭证，配置简单
• SSO支持：通过域名范围的Cookie实现单点登录，一次认证即可访问多个关联服务
• 灵活配置：支持端口、Cookie名称、路径等多项参数自定义

使用场景

• 私有内部服务的访问控制
• 隔离环境中的服务保护
• 需要简单SSO但不需要复杂身份提供商的场景
• Traefik作为反向代理时的集中式认证管理

使用方法

Docker Compose部署示例

项目包含示例docker-compose.yml文件，假设htpass文件通过外部挂载。以下是基本配置示例：

yaml
version: '3'

services:
  trauth:
    image: leonjza/trauth
    environment:
      - TRAUTH_DOMAIN=yourdomain.local
      - TRAUTH_PASSWORD_FILE_LOCATION=/config/htpass
    volumes:
      - ./htpass:/config/htpass
    networks:
      - traefik-network

networks:
  traefik-network:
    external: true

当然，也可以从源码编译或从https://github.com/leonjza/trauth/releases%E4%B8%8B%E8%BD%BD%E4%BA%8C%E8%BF%9B%E5%88%B6%E6%96%87%E4%BB%B6%EF%BC%8C%E5%9C%A8Docker%E5%A4%96%E9%83%A8%E8%BF%90%E8%A1%8C%E3%80%82

环境变量配置

根据部署环境，需配置以下环境变量。对于Docker Compose部署，至少需要设置TRAUTH_DOMAIN和TRAUTH_PASSWORD_FILE_LOCATION：

yaml
environment:
  - TRAUTH_DOMAIN=yourdomain.local          # SSO Cookie的作用域域名
  - TRAUTH_PASSWORD_FILE_LOCATION=/config/htpass  # htpasswd文件路径

其他可用环境变量：

• TRAUTH_SERVER_PORT - 服务监听端口（默认：8080）
• TRAUTH_COOKIE_PATH - SSO Cookie的路径（默认：/）
• TRAUTH_COOKIE_NAME - SSO Cookie的名称（默认：trauth）
• TRAUTH_PASSWORD_FILE_LOCATION - htpasswd文件位置（默认：./htpass）

Traefik集成配置

要在Traefik中使用trauth，需定义一个新的中间件，指定认证服务器地址：

text
- "traefik.http.middlewares.trauth.forwardauth.address=http://trauth.web:8080/"

然后，为需要启用认证的Web服务添加中间件标签：

text
- "traefik.http.routers.netdata.middlewares=trauth"

添加用户

trauth使用标准的Apache htpasswd文件存储用户凭证。有关htpasswd的详细用法，请参阅官方文档。

创建新的htpasswd文件并添加用户（使用Bcrypt算法）：

bash
htpasswd -Bc htpass username1

向现有htpasswd文件添加用户：

bash
htpasswd -B htpass username2