sanmark/janus

Sanmark Janus

镜像概述和主要用途

Sanmark Janus 是一个用户认证管理系统，主要用于处理用户认证相关的核心功能，包括用户账户管理、元数据存储、认证会话创建及密码重置请求等。通过该系统，可实现用户身份验证流程的标准化管理，并支持第三方登录集成，适用于各类需要用户认证机制的应用场景。

核心功能和特性

核心功能

• 存储用户账户信息
• 存储用户元数据
• 创建用户认证会话
• 生成用户密码重置请求

支持功能

• 用户（User）的CRUD操作
• 元数据键（Metakey）的CRUD操作（如"name"、"email"、"birth-place"等）
• 元数据值（Meta）的CRUD操作（如"Jon Snow"、"***"、"Tower of Joy"等，用于存储用户对应元数据键的值）
• 认证会话（AuthSession）的CRUD操作：用户登录时创建带有唯一token的AuthSession，客户端可通过该token识别已登录用户
• 支持Google和***第三方登录（需提供对应API访问凭证）

使用场景和适用范围

Sanmark Janus 适用于需要实现用户认证管理的各类应用，包括但不限于：

• Web应用的用户登录与会话管理
• 移动应用的用户身份验证
• 需要集成第三方登录（Google、***）的系统
• 需要管理用户元数据的应用场景

使用方法和配置说明

安装方式

推荐通过官方Docker镜像安装Sanmark Janus，镜像地址：https://hub.docker.com/r/sanmark/janus/

前置要求

• 独立的MySQL服务器及访问凭证
• 使用 https://github.com/sanmark/janus-db 进行数据库迁移

环境变量配置

创建Docker容器时需传入以下环境变量：

Docker部署示例

Docker Run命令

bash
docker run -d \
  --name sanmark-janus \
  -p 80:80 \
  -e APP_NAME="Janus Auth System" \
  -e APP_ENV="production" \
  -e APP_KEY="base64:your-laravel-app-key" \
  -e APP_DEBUG="false" \
  -e DB_CONNECTION="mysql" \
  -e DB_HOST="mysql-host" \
  -e DB_PORT="3306" \
  -e DB_DATABASE="janus_db" \
  -e DB_USERNAME="janus_user" \
  -e DB_PASSWORD="secure-password" \
  -e SYSTEM_AUTH_SESSION_ACTIVE_MINUTES="120" \
  -e THIRD_PARTY_GUZZLEHTTP_VERIFY="true" \
  sanmark/janus

API文档

Sanmark Janus 安装并运行后，访问服务器的 /api/doc 路径即可获取交互式API文档，包含所有可用接口的详细说明和测试功能。