supertokens/supertokens-mongodb

概述

SuperTokens Community与MongoDB的Docker镜像用于部署SuperTokens认证服务，该服务提供用户认证、会话管理等核心功能，并集成MongoDB作为数据存储。本镜像支持灵活配置，适用于需要可靠认证系统的各类应用场景。

快速启动

bash
# 这将使用内存数据库启动
$ docker run -p 3567:3567 -d registry.supertokens.io/supertokens/supertokens-mongodb

配置

您可以使用自定义的config.yaml文件作为共享卷，或通过环境变量传递键值对。若两者同时使用，将仅考虑共享的config.yaml文件。

使用环境变量

可用环境变量

• 核心配置

  • API_KEYS：API密钥
  • SUPERTOKENS_HOST：服务主机地址
  • SUPERTOKENS_PORT：服务端口
  • ACCESS_TOKEN_VALIDITY：访问令牌有效期
  • ACCESS_TOKEN_BLACKLISTING：访问令牌黑名单功能开关
  • ACCESS_TOKEN_SIGNING_KEY_DYNAMIC：动态签名密钥开关
  • ACCESS_TOKEN_DYNAMIC_SIGNING_KEY_UPDATE_INTERVAL：动态签名密钥更新间隔
  • REFRESH_TOKEN_VALIDITY：刷新令牌有效期
  • INFO_LOG_PATH：信息日志路径
  • ERROR_LOG_PATH：错误日志路径
  • MAX_SERVER_POOL_SIZE：服务器池最大大小
  • DISABLE_TELEMETRY：禁用遥测功能开关
  • BASE_PATH：基础路径
  • LOG_LEVEL：日志级别
  • IP_ALLOW_REGEX：IP允许规则正则表达式
  • IP_DENY_REGEX：IP拒绝规则正则表达式

• MongoDB配置

  • MONGODB_CONNECTION_URI：MongoDB连接URI
  • MONGODB_DATABASE_NAME：MongoDB数据库名称
  • MONGODB_COLLECTION_NAMES_PREFIX：MongoDB集合名称前缀

示例命令

bash
docker run \
	-p 3567:3567 \
	-e MONGODB_CONNECTION_URI="mongodb://root:root@192.168.1.2:27017" \
	-d docker.xuanyuan.run/registry.supertokens.io/supertokens/supertokens-mongodb

使用自定义配置文件

配置文件要求

在自定义config.yaml文件中，需包含以下键值对：

• core_config_version: 0
• host: "0.0.0.0"
• mongodb_config_version: 0
• info_log_path: null（日志输出到docker logs）
• error_log_path: null（日志输出到docker logs）

容器内配置文件路径：/usr/lib/supertokens/config.yaml

示例命令

bash
docker run \
	-p 3567:3567 \
	-v /path/to/config.yaml:/usr/lib/supertokens/config.yaml \
	-d docker.xuanyuan.run/registry.supertokens.io/supertokens/supertokens-mongodb

日志配置

• 默认情况下，所有日志可通过docker logs <容器名称>命令查看。
• 如需自定义日志路径，需：
  • 通过config.yaml或环境变量设置info_log_path和error_log_path
  • 挂载日志目录到容器

示例命令

bash
docker run \
	-p 3567:3567 \
	-v /path/to/logsFolder:/home/logsFolder \
	-e INFO_LOG_PATH=/home/logsFolder/info.log \
	-e ERROR_LOG_PATH=/home/logsFolder/error.log \
	-e MONGODB_CONNECTION_URI="mongodb://root:root@localhost:27017" \
	-d docker.xuanyuan.run/registry.supertokens.io/supertokens/supertokens-mongodb

数据库设置

• 无需确保MongoDB在容器启动前已就绪。SuperTokens启动时会等待约1小时，直至MongoDB实例可用。
• 若未提供MONGODB_CONNECTION_URI，服务将自动使用内存数据库。

只读根文件系统配置

• 支持以只读根文件系统运行容器，但需为临时目录创建挂载点，容器需在此目录写入和执行文件。
• 需挂载/lib/supertokens/temp/目录。

示例命令（绑定挂载）

bash
docker run \
	-p 3567:3567 \
	--mount source=/path/on/host/machine,destination=/lib/supertokens/temp/,type=bind \
	--read-only \
	-d docker.xuanyuan.run/registry.supertokens.io/supertokens/supertokens-mongodb

示例命令（tmpfs挂载）

bash
docker run \
	-p 3567:3567 \
	--tmpfs=/lib/supertokens/temp/:exec \
	--read-only \
	-d registry.supertokens.io/supertokens/supertokens-mongodb