使用Docker Compose部署ROMM游戏库管理系统的完整指南

使用Docker Compose部署ROMM游戏库管理系统的完整指南

romm A beautiful, powerful, self-hosted rom manager 项目地址: https://gitcode.com/gh_mirrors/rom/romm

前言

ROMM是一款功能强大的游戏库管理系统，它能够帮助游戏爱好者高效地组织和管理自己的游戏收藏。本文将详细介绍如何使用Docker Compose部署ROMM系统，包括环境配置、服务设置以及关键参数的说明。

系统架构概述

ROMM系统采用典型的微服务架构，主要由以下两个核心组件构成：

1. ROMM应用服务：基于rommapp/romm镜像，提供主要的Web界面和API功能
2. 数据库服务：使用MariaDB作为后端数据存储

这种分离式架构设计确保了系统的可扩展性和稳定性。

准备工作

在开始部署前，请确保已满足以下条件：

• 已安装Docker和Docker Compose
• 准备必要的API密钥（IGDB、MobyGames、SteamGridDB）
• 规划好本地目录结构用于存储游戏库和配置文件

配置文件详解

基础配置

version: "3"

这指定了我们使用Docker Compose的版本3格式，这是目前最稳定且功能完善的版本。

数据卷配置

volumes:
  mysql_data:
  romm_resources:
  romm_redis_data:

这里定义了三个持久化数据卷：

1. mysql_data：存储MariaDB数据库文件
2. romm_resources：保存从IGDB获取的游戏资源（封面、截图等）
3. romm_redis_data：用于缓存后台任务数据

使用数据卷可以确保容器重启后数据不会丢失。

ROMM应用服务配置

services:
  romm:
    image: rommapp/romm:latest
    container_name: romm
    restart: unless-stopped

这部分定义了ROMM主应用服务：

• 使用最新版的rommapp/romm镜像
• 指定容器名称为romm
• 设置自动重启策略（除非手动停止）

环境变量配置

environment:
  - DB_HOST=romm-db
  - DB_NAME=romm
  - DB_USER=romm-user
  - DB_PASSWD=
  - ROMM_AUTH_SECRET_KEY=
  - IGDB_CLIENT_ID=
  - IGDB_CLIENT_SECRET=
  - MOBYGAMES_API_KEY=
  - STEAMGRIDDB_API_KEY=

关键环境变量说明：

1. 数据库连接：需要与数据库服务中的配置匹配
2. ROMM_AUTH_SECRET_KEY：用于加密的安全密钥，可通过openssl rand -hex 32生成
3. API密钥：需要从各平台申请（IGDB、MobyGames、SteamGridDB）

卷挂载配置

volumes:
  - romm_resources:/romm/resources
  - romm_redis_data:/redis-data
  - /path/to/library:/romm/library
  - /path/to/assets:/romm/assets
  - /path/to/config:/romm/config

重要挂载点说明：

1. /romm/library：游戏库目录，替换为实际的游戏文件路径
2. /romm/assets：保存上传的游戏存档和状态
3. /romm/config：配置文件目录，包含config.yml

网络和端口

ports:
  - 80:8080
depends_on:
  - romm-db

• 将容器内部的8080端口映射到主机的80端口
• 设置依赖关系，确保数据库服务先启动

数据库服务配置

romm-db:
  image: mariadb:latest
  container_name: romm-db
  restart: unless-stopped

使用官方MariaDB镜像作为数据库服务。

数据库环境变量

environment:
  - MYSQL_ROOT_PASSWORD=
  - MYSQL_DATABASE=romm
  - MYSQL_USER=romm-user
  - MYSQL_PASSWORD=

注意：

1. MYSQL_ROOT_PASSWORD：必须设置强密码
2. 数据库名、用户名和密码需要与ROMM应用中的配置一致

数据持久化

volumes:
  - mysql_data:/var/lib/mysql

将数据库文件存储在持久化卷中，防止数据丢失。

部署步骤

1. 创建docker-compose.yml文件，复制上述配置并修改必要参数
2. 替换所有路径占位符（如/path/to/library）为实际路径
3. 生成并设置所有必需的API密钥和安全密钥
4. 在配置文件目录中准备config.yml
5. 运行docker-compose up -d启动服务

常见问题解决

1. 数据库连接问题：确保数据库服务的环境变量与ROMM应用中的配置完全匹配
2. 权限问题：确保Docker对挂载的本地目录有读写权限
3. API服务不可用：检查各API密钥是否正确且未过期

最佳实践建议

1. 定期备份数据卷中的重要数据
2. 使用版本控制管理docker-compose.yml文件
3. 考虑使用.env文件管理敏感信息
4. 生产环境建议使用特定版本标签而非latest

结语

通过Docker Compose部署ROMM系统，您可以轻松搭建一个功能完善的游戏库管理平台。这种容器化部署方式不仅简化了安装过程，还提高了系统的可维护性和可移植性。按照本文指南配置后，您就可以开始整理和享受您的游戏收藏了。

romm A beautiful, powerful, self-hosted rom manager 项目地址: https://gitcode.com/gh_mirrors/rom/romm