fiware/idm

IdM Keyrock Docker镜像使用指南

镜像概述和主要用途

IdM Keyrock是Fiware生态系统中的身份管理组件，提供用户认证、授权和身份管理功能。使用此镜像需在机器上安装docker和docker-compose，并依赖两个镜像：fiware/idm和mysql/mysql-server:5.7.21。通过Docker可实现以下操作：

• 使用Docker Hub提供的镜像通过docker-compose运行服务
• 基于提供的Dockerfile构建自定义镜像后通过docker-compose运行
• 支持自定义配置等其他功能

核心功能和特性

• 便捷部署：通过docker-compose实现一键部署，自动拉取依赖镜像
• 数据持久化：使用Docker卷存储MySQL数据，避免容器重启导致数据丢失
• 敏感数据安全：支持Docker Secrets，通过文件加载敏感配置而非环境变量明文传递
• 邮件发送集成：可配置SMTP中继服务实现邮件发送功能
• 自定义配置：支持挂载自定义配置文件，灵活调整服务参数

使用场景和适用范围

• 企业级身份认证与授权系统搭建
• Fiware生态系统应用的用户管理
• 需要快速部署身份管理服务的开发与测试环境
• 对敏感数据安全有要求的生产环境

使用方法和配置说明

用docker-compose运行服务

步骤：

1. 创建目录
2. 在目录中创建docker-compose.yml文件，内容如下：

yml
version: '3.5'
services:
    keyrock:
        image: fiware/idm:7.6.0
        container_name: fiware-keyrock
        hostname: keyrock
        networks:
            default:
                ipv4_address: 172.18.1.5
        depends_on:
            - mysql-db
        ports:
            - '3000:3000'
            - '443:443'
        environment:
            - DEBUG=idm:*
            - IDM_DB_HOST=mysql-db
            - IDM_HOST=http://localhost:3000
            - IDM_PORT=3000
            # 仅开发环境使用
            # 敏感数据建议使用Docker Secrets
            - IDM_DB_PASS=secret
            - IDM_DB_USER=root
            - IDM_ADMIN_USER=admin
            - IDM_ADMIN_EMAIL=admin@test.com
            - IDM_ADMIN_PASS=1234
            # 如需发送邮件，配置SMTP服务器
            - IDM_EMAIL_HOST=mailer
            - IDM_EMAIL_PORT=25

    mysql-db:
        restart: always
        image: mysql:5.7
        hostname: mysql-db
        container_name: db-mysql
        expose:
            - '3306'
        ports:
            - '3306:3306'
        networks:
            default:
                ipv4_address: 172.18.1.6
        environment:
            # 仅开发环境使用
            # 敏感数据建议使用Docker Secrets
            - 'MYSQL_ROOT_PASSWORD=secret'
            - 'MYSQL_ROOT_HOST=172.18.1.5'
        volumes:
            - mysql-db:/var/lib/mysql

    mailer:
        restart: always
        image: mazdermind/docker-mail-relay
        hostname: mailer
        container_name: mailer
        ports:
            - '25:25'
        environment:
            - SMTP_LOGIN=<login> # 外部中继登录名
            - SMTP_PASSWORD=<password> # 外部中继密码
            - EXT_RELAY_HOST=<hostname> # 外部中继DNS名称
            - EXT_RELAY_PORT=25
            - ACCEPTED_NETWORKS=172.18.1.0/24
            - USE_TLS=no
networks:
    default:
        ipam:
            config:
                - subnet: 172.18.1.0/24
volumes:
    mysql-db: ~

参数说明：

• networks：定义容器运行的网络，此处使用子网172.18.1.0/24
• volumes：创建mysql-db卷以持久化存储MySQL数据，避免容器重启数据丢失
• services：定义三个服务：
  • keyrock：IdM服务容器，依赖mysql-db，暴露3000（HTTP）和443（HTTPS）端口
  • mysql-db：MySQL数据库容器，暴露3306端口，通过环境变量配置root密码和允许访问的Keyrock容器IP
  • mailer：邮件中继容器，用于Keyrock发送邮件，需配置外部SMTP服务器信息

3. 运行命令启动服务：

console
sudo docker-compose up

该命令会自动下载所需镜像并启动IdM Keyrock服务

Docker Secrets

对于敏感信息，可在环境变量后添加_FILE后缀，使初始化脚本从容器内文件加载值（适用于Docker Secrets，文件通常位于/run/secrets/<secret_name>）。示例：

console
docker run --name keyrock -e IDM_DB_USER_FILE=/run/secrets/password -d fiware/idm

支持_FILE后缀的环境变量包括：

• IDM_SESSION_SECRET
• IDM_ENCRYPTION_KEY
• IDM_DB_PASS
• IDM_DB_USER
• IDM_ADMIN_ID
• IDM_ADMIN_USER
• IDM_ADMIN_EMAIL
• IDM_ADMIN_PASS
• IDM_EX_AUTH_DB_USER
• IDM_EX_AUTH_DB_PASS
• IDM_DB_HOST

发送邮件

在私有网络中运行Docker化Keyrock实例并需发送邮件时，需配置独立的邮件中继容器。通过以下步骤实现：

1. 配置Keyrock环境变量指向SMTP中继服务器：

   • IDM_EMAIL_HOST：邮件中继容器主机名
   • IDM_EMAIL_PORT：邮件中继容器端口

2. 配置SMTP中继容器以匹配外部SMTP服务器。以Gmail SMTP为例：

   • 服务器地址：smtp.gmail.com
   • 用户名：Gmail地址（如example@gmail.com）
   • 密码：Gmail密码
   • 端口（TLS）：587
   • 端口（SSL）：465
   • 要求TLS/SSL：Yes

构建自己的镜像

1. 从GitHub下载IdM代码：

console
git clone https://github.com/ging/fiware-idm.git

2. 进入extras/docker目录：

console
cd fiware-idm/extras/docker

3. 构建自定义镜像：

console
sudo docker build -t idm-fiware-image .

注意：如需避免使用sudo，请参考Docker安装指南配置Docker用户组

4. 验证镜像是否构建成功：

console
sudo docker images

5. 编辑docker-compose.yml，将fiware/idm镜像替换为自定义镜像名（如idm-fiware-image），然后启动服务：

console
sudo docker-compose up

其他功能

可通过挂载自定义配置文件自定义Keyrock服务。配置文件模板可参考https://github.com/ging/fiware-idm/blob/master/config.js.template%E3%80%82%E4%BF%AE%E6%94%B9%60docker-compose.yml%60%E6%B7%BB%E5%8A%A0%E5%8D%B7%E6%8C%82%E8%BD%BD%EF%BC%9A

yml
fiware-idm:
    image: fiware/idm
    ports:
        - '3000:3000'
        - '443:443'
    networks:
        idm_network:
            ipv4_address: 172.18.1.6
    environment:
        - IDM_DB_HOST=mysql
    volumes:
        - /本地路径/config.js:/opt/fiware-idm/config.js

将/本地路径/config.js替换为实际配置文件路径