irods/metalnx

iRODS Web GUI (metalnx-web) Docker镜像文档

1. 镜像概述和主要用途

1.1 概述

iRODS Web GUI (metalnx-web) Docker镜像是基于https://github.com/irods-contrib/metalnx-web%E9%A1%B9%E7%9B%AE%E6%9E%84%E5%BB%BA%E7%9A%84%E5%AE%B9%E5%99%A8%E5%8C%96%E9%83%A8%E7%BD%B2%E6%96%B9%E6%A1%88%EF%BC%8C%E4%B8%BAiRODS%E6%95%B0%E6%8D%AE%E7%AE%A1%E7%90%86%E7%B3%BB%E7%BB%9F%E6%8F%90%E4%BE%9BWeb%E5%9B%BE%E5%BD%A2%E7%94%A8%E6%88%B7%E7%95%8C%E9%9D%A2%EF%BC%88GUI%EF%BC%89%E3%80%82iRODS%E6%98%AF%E5%BC%80%E6%BA%90%E4%BC%81%E4%B8%9A%E7%BA%A7%E6%95%B0%E6%8D%AE%E7%AE%A1%E7%90%86%E8%BD%AF%E4%BB%B6%EF%BC%8C%E6%94%AF%E6%8C%81%E6%95%B0%E6%8D%AE%E9%9B%86%E6%88%90%E3%80%81%E8%AE%BF%E9%97%AE%E6%8E%A7%E5%88%B6%E3%80%81%E5%85%83%E6%95%B0%E6%8D%AE%E7%AE%A1%E7%90%86%E7%AD%89%E8%83%BD%E5%8A%9B%EF%BC%9Bmetalnx-web%E4%BD%9C%E4%B8%BA%E5%85%B6Web%E5%89%8D%E7%AB%AF%EF%BC%8C%E9%80%9A%E8%BF%87%E6%B5%8F%E8%A7%88%E5%99%A8%E7%95%8C%E9%9D%A2%E7%AE%80%E5%8C%96iRODS%E6%95%B0%E6%8D%AE%E7%AE%A1%E7%90%86%E6%93%8D%E4%BD%9C%EF%BC%8C%E9%99%8D%E4%BD%8E%E7%94%A8%E6%88%B7%E4%BD%BF%E7%94%A8%E9%97%A8%E6%A7%9B%E3%80%82

1.2 主要用途

• 提供无需安装客户端的iRODS Web访问方式，用户通过浏览器即可管理iRODS数据
• 支持数据管理员通过可视化界面执行日常管理任务（数据组织、权限配置等）
• 降低非专业用户（如科研人员、学生）使用iRODS的技术门槛

2. 核心功能和特性

2.1 核心功能

• 数据浏览：以树形结构展示iRODS集合（collections）和数据对象（data objects），支持层级导航
• 文件操作：提供文件/文件夹的上传、下载、删除、重命名、移动、复制等操作
• 权限管理：可视化配置数据对象/集合的访问权限（读、写、管理等），支持用户/用户组权限设置
• 元数据管理：添加、编辑、删除数据对象/集合的元数据（key-value对）
• 用户与组管理：管理员可管理iRODS用户、用户组及角色（需rodsadmin权限）
• 操作日志：记录用户操作及系统运行日志，辅助问题排查

2.2 特性

• 直观易用：基于Web的图形界面，符合日常文件管理操作习惯
• 跨平台兼容：支持主流浏览器（Chrome、Firefox、Edge等），无需依赖特定操作系统
• 容器化部署：简化部署流程，减少环境依赖，支持快速启停和版本管理
• 灵活配置：通过环境变量自定义iRODS连接参数、日志级别等配置项

3. 使用场景和适用范围

3.1 典型使用场景

• 科研机构数据管理：研究团队通过Web界面协作管理实验数据，实现跨实验室数据共享
• 高校教学实践：学生无需配置客户端，通过浏览器学习iRODS数据操作
• 企业数据管理：IT管理员通过可视化界面监控iRODS存储系统，执行权限审计、数据备份等任务
• 多用户协作：团队成员通过Web界面共同管理项目数据，实时同步操作状态

3.2 适用范围

• 已部署iRODS数据管理系统的组织或个人
• 需要为iRODS用户提供图形化操作界面的场景
• 希望降低iRODS使用门槛的科研、教育、企业等领域用户
• 支持Docker/Kubernetes容器化部署的环境

4. 使用方法和配置说明

4.1 前提条件

• 已部署iRODS服务器（推荐iRODS 4.2.x及以上版本）
• 安装Docker环境（参考Docker官方文档）
• 确保宿主机与iRODS服务器网络连通（默认开放iRODS端口1247）

4.2 基础部署（docker run）

使用以下命令启动容器（替换<>占位符为实际配置）：

bash
docker run -d \
  --name metalnx-web \
  -p 8080:8080 \  # 宿主机端口:容器内端口（默认容器内端口8080）
  -e IRODS_HOST=<irods-server-ip> \  # iRODS服务器IP/主机名（必填）
  -e IRODS_PORT=1247 \  # iRODS服务器端口（默认1247，可选）
  -e IRODS_USERNAME=<irods-username> \  # iRODS用户名（建议rodsadmin权限，必填）
  -e IRODS_PASSWORD=<irods-password> \  # 对应用户名密码（必填）
  -e IRODS_ZONE=tempZone \  # iRODS区域名称（默认tempZone，可选）
  -e IRODS_RESOURCE=demoResc \  # 默认资源名称（可选）
  irods-contrib/metalnx-web:latest

4.3 Docker Compose部署

创建docker-compose.yml文件：

yaml
version: '3'
services:
  metalnx-web:
    image: irods-contrib/metalnx-web:latest
    container_name: metalnx-web
    ports:
      - "8080:8080"
    environment:
      - IRODS_HOST=<irods-server-ip>
      - IRODS_PORT=1247
      - IRODS_USERNAME=<irods-username>
      - IRODS_PASSWORD=<irods-password>
      - IRODS_ZONE=tempZone
      - IRODS_RESOURCE=demoResc
      - LOG_LEVEL=INFO  # 日志级别：DEBUG/INFO/WARN/ERROR（可选）
    restart: unless-stopped  # 容器退出时自动重启（可选）

启动服务：

bash
docker-compose up -d

4.4 访问Web界面

容器启动后，通过浏览器访问：
http://<宿主机IP>:<映射端口>（例：http://localhost:8080）
使用配置的IRODS_USERNAME和IRODS_PASSWORD登录系统。

5. 配置参数说明

5.1 核心环境变量

5.2 高级配置

• 自定义配置文件：通过-v /local/path/metalnx.properties:/opt/metalnx-web/conf/metalnx.properties挂载本地配置文件覆盖默认配置
• HTTPS启用：配置SERVER_PORT=443，挂载SSL证书并设置SSL_CERT_PATH（具体参考https://github.com/irods-contrib/metalnx-web%EF%BC%89

6. 注意事项

• 网络连通性：确保宿主机与iRODS服务器端口（默认1247）连通，可通过telnet <irods-host> <port>测试
• 用户权限：IRODS_USERNAME权限决定可执行操作范围（rodsadmin用户拥有管理员功能，普通用户仅能操作其权限内数据）
• 版本兼容性：建议使用与iRODS服务器版本匹配的metalnx-web版本（参考https://github.com/irods-contrib/metalnx-web/releases%EF%BC%89
• 数据安全：生产环境建议启用SSL加密iRODS连接（IRODS_SSL_ENABLED=true）并配置证书