Overview

GoRetro - REST API server for managing retro gaming ROM collections. Generate gamelist XML files, scrape metadata from ScreenScraper, download media, and manage favorites via HTTP API endpoints.

Runtime arguments

Web UI: http://[IP]:[PORT:8080]
Network: bridge
Privileged: false

Template configuration

API Server PortPorttcp

Port for the GoRetro HTTP API server. Access API at http://[IP]:[PORT]

Target: 8080
Default: 8080
Value: 8080

ROM DirectoryPathrw

Base ROM directory containing system subdirectories (snes/, nes/, etc.). GoRetro reads ROMs from /roms/{system}/ and writes gamelist.xml and media to the same location.

Target: /roms
Default: /mnt/user/data/media/roms
Value: /mnt/user/data/media/roms

Config DirectoryPathrw

Configuration directory. Contains config.yaml (edit this!), favorites.yaml, and .cache/ subdirectory. Copy config.yaml.example to config.yaml on first run.

Target: /config
Default: /mnt/user/appdata/goretro
Value: /mnt/user/appdata/goretro

API KeyVariable

Optional API key for authentication. When set, all API requests must include this key via X-API-Key header or Authorization: Bearer header. Generate with: openssl rand -hex 32. Leave empty to disable authentication.

Target: GORETRO_API_KEY

Links

Template Support Docker Hub Project

Details

Repository

lowess/goretro

Registry

https://hub.docker.com/r/lowess/goretro/

Last Updated2026-02-07

First Seen2026-01-03

Run GoRetro on Unraid.

GoRetro is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.

Explore Unraid OS

GoRetro