folioci/mod-login-saml

FOLIO - mod-login-saml

镜像概述和主要用途

FOLIO - mod-login-saml是FOLIO平台的核心模块之一，专注于提供基于SAML（Security Assertion Markup Language）协议的用户登录认证功能。该模块通过SAML 2.0标准与身份提供商（IdP）进行通信，实现单点登录（SSO），是FOLIO平台身份认证体系的重要组成部分。

代码仓库：https://github.com/folio-org/mod-login-saml

核心功能和特性

• SAML协议支持：完整实现SAML 2.0协议规范，支持与主流身份提供商（如Okta、Azure AD、ADFS等）集成
• 认证流程集成：与FOLIO平台的用户管理系统无缝对接，完成身份验证后的用户信息同步
• 配置灵活性：支持通过环境变量和配置文件自定义SAML相关参数（具体配置项需参考代码仓库文档）

使用场景和适用范围

适用于需要通过SAML协议实现统一身份认证的FOLIO平台部署场景，典型包括：

• 企业级FOLIO部署，需与企业现有身份管理系统集成
• 多系统环境下，要求用户通过单点登录访问FOLIO的场景
• 对身份认证安全性有较高要求，需符合SAML标准的合规场景

使用方法和配置说明

基础信息

Docker部署示例

docker run 命令

bash
docker run -d \
  --name mod-login-saml \
  -p 8081:8081 \
  -e DB_HOST=folio-db \
  -e DB_PORT=5432 \
  -e DB_NAME=okapi_modules \
  -e DB_USER=folio_user \
  -e DB_PASSWORD=folio_password \
  -e JAVA_OPTIONS="-XX:MaxRAMPercentage=66.0" \
  folioorg/mod-login-saml:latest

docker-compose 配置片段

yaml
services:
  mod-login-saml:
    image: folioorg/mod-login-saml:latest
    ports:
      - "8081:8081"
    environment:
      - DB_HOST=folio-db
      - DB_PORT=5432
      - DB_NAME=okapi_modules
      - DB_USER=folio_user
      - DB_PASSWORD=folio_password
      - JAVA_OPTIONS=-XX:MaxRAMPercentage=66.0
    depends_on:
      - folio-db

关键配置说明

1. 数据库配置
   必须提供有效的数据库连接信息，包括数据库主机（DB_HOST）、端口（DB_PORT）、数据库名（DB_NAME）、用户名（DB_USER）和密码（DB_PASSWORD），具体参数需与实际数据库环境匹配。

2. Java内存配置
   通过JAVA_OPTIONS环境变量调整JVM内存参数，默认值-XX:MaxRAMPercentage=66.0表示JVM可使用容器内存的66%，可根据宿主机资源情况调整。

3. SAML专项配置
   SAML协议相关配置（如IdP元数据URL、SP实体ID、断言消费服务URL等）需参考代码仓库文档，通过配置文件或额外环境变量传入，配置需与身份提供商的设置保持一致。

注意事项

• 部署前需确保数据库已完成初始化，且模块所需表结构已创建
• SAML配置需包含正确的证书信息和元数据，建议通过HTTPS协议传输SAML消息以保障安全性
• 容器内存配置应根据实际负载调整，生产环境建议进行压力测试后确定最优配置