快速入门
- 打开
http://<SERVER-IP>在您的浏览器中。 - 首次启动可能需要一些时间。
- 首次访问时,RomM 会将你重定向到安装向导。
- 完成安装向导。
- 创建管理员用户名和密码。
- 首个创建的账户将成为管理员。
ROM 库
- 将你的 ROM 文件放入:
/root/romm/library/roms - 将 BIOS 文件放入:
/root/romm/library/bios - 添加游戏后,在 RomM 网页界面中执行一次媒体库扫描。
元数据
- Hasheous metadata support lets RomM retrieve game metadata without requiring an API key.
- 可在以下位置配置更多元数据来源:
/root/romm/.env
重要文件与目录
- 安装路径:
/root/romm - Compose 文件:
/root/romm/docker-compose.yml - 环境变量文件:
/root/romm/.env - ROM 库:
/root/romm/library - ROM:
/root/romm/library/roms - BIOS:
/root/romm/library/bios - 资源文件:
/root/romm/assets - 配置:
/root/romm/config - Caddy 配置:
/etc/caddy/Caddyfile - MariaDB 数据:
/var/lib/docker/volumes/romm_mysql_data
Docker 管理
查看状态:
docker ps
查看日志:
cd /root/romm
docker compose logs -f
重启服务:
cd /root/romm
docker compose restart
停止服务:
cd /root/romm
docker compose down
启动服务:
cd /root/romm
docker compose up -d
域名与 HTTPS(Caddy)
注意:Let's Encrypt 的 TLS 证书无法签发给 IP 地址,需要使用域名。
1. 将域名(例如 example.com)解析到你服务器的 IP 地址。
2. 编辑 /root/romm/.env 并更新 ROMM_BASE_URL:
BASE_URL=https://example.com
3. 重新创建服务:
docker compose -f /root/romm/docker-compose.yml up -d
4. Update the site address in /etc/caddy/Caddyfile 从 http://<SERVER_IP> 替换为你的域名。保持现有的压缩、请求头和反向代理配置不变。
vim /etc/caddy/Caddyfile
将:
http://<SERVER_IP> {
以:
example.com {
5. 重新加载 Caddy:
systemctl reload caddy
6. Caddy 会自动申请并续期 Let's Encrypt 证书。
7. 通过以下地址访问 RomM: https://example.com