folioorg/mod-authtoken

mod-authtoken Docker镜像文档

镜像概述

mod-authtoken是FOLIO项目的核心模块之一，提供基于JWT（JSON Web Token）令牌的请求过滤功能，用于实现系统的认证与授权机制，确保服务访问的合法性与安全性。该模块通常部署于FOLIO生态系统中，作为请求入口的认证过滤层，支持与FOLIO其他服务协同工作。

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

核心功能与特性

• JWT令牌验证：对传入请求的JWT令牌进行解析与验证，确保请求来源的合法性；
• 请求过滤控制：基于令牌中的用户角色、权限等声明信息，过滤非法请求，实现精细化授权；
• 权限缓存机制：通过-Dcache.permissions=true启用权限缓存，提升高频请求的权限验证性能；
• FOLIO生态集成：无缝对接FOLIO系统的服务架构，支持标准的FOLIO认证流程与权限模型。

使用场景

• FOLIO服务集群中，服务间通信的身份认证与权限校验；
• 用户通过API网关访问FOLIO服务时的请求合法性过滤；
• 需要基于JWT令牌实现细粒度访问控制的FOLIO功能模块（如用户管理、资源访问等）。

使用方法与配置说明

部署要求

• 数据库依赖：模块需连接数据库以存储和获取权限配置数据，需提前部署并配置FOLIO兼容的数据库（如PostgreSQL）；
• 资源配置：建议容器内存分配不低于357913941字节（约341MB），以满足基本运行需求。

核心配置参数

Docker部署示例

基本运行命令

bash
docker run -d \
  --name mod-authtoken \
  -p 8081:8081 \
  -e DB_HOST=folio-postgres \
  -e DB_PORT=5432 \
  -e DB_NAME=folio_mod_authtoken \
  -e DB_USER=authtoken_user \
  -e DB_PASSWORD=secure_password \
  -e JAVA_OPTIONS="-XX:MaxRAMPercentage=66.0 -Dcache.permissions=true" \
  folioorg/mod-authtoken:latest

参数说明

• -p 8081:8081：将容器内8081端口映射至宿主机，允许外部服务通过宿主机端口访问该模块；
• 数据库相关环境变量（DB_HOST至DB_PASSWORD）：配置数据库连接信息，需与实际部署的数据库环境匹配；
• JAVA_OPTIONS：可根据容器内存资源调整MaxRAMPercentage值（如容器分配2GB内存，66%约为1.32GB），-Dcache.permissions=true启用权限缓存以优化性能。

适用范围

该镜像专为FOLIO图书馆服务平台设计，适用于需要基于JWT令牌实现请求认证与授权的FOLIO生态部署环境，是保障系统资源安全访问的核心组件之一。