Skip to content

linuxserver/retroarch

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI

RetroArch is a frontend for emulators, game engines and media players. It enables you to run classic games on a wide range of computers and consoles through its slick graphical interface.

retroarch

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lscr.io/linuxserver/retroarch:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture Available Tag
x86-64 amd64-<version tag>
arm64 arm64v8-<version tag>
armhf

Application Setup

The application can be accessed at:

  • https://yourhost:3001/

Note: In pure CPU mode RetroArch will use LLVMPipe for menu rendering, when in game this is less of an issue. You can configure things like the menu refresh rate in your RetroArch settings or mount in an Nvidia GPU. When running with an Nvidia GPU it will be necesarry to right click the desktop and re-launch RetroArch on your first launch only.

Security

[!WARNING] Do not put this on the Internet if you do not know what you are doing.

By default this container has no authentication and the optional environment variables CUSTOM_USER and PASSWORD to enable basic http auth via the embedded NGINX server should only be used to locally secure the container from unwanted access on a local network. If exposing this to the Internet we recommend putting it behind a reverse proxy, such as SWAG, and ensuring a secure authentication solution is in place. From the web interface a terminal can be launched and it is configured for passwordless sudo, so anyone with access to it can install and run whatever they want along with probing your local network.

Strict reverse proxies

This image uses a self-signed certificate by default. This naturally means the scheme is https. If you are using a reverse proxy which validates certificates, you need to disable this check for the container.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

Info

Unless a parameter is flaged as 'optional', it is mandatory and a value must be provided.

---
services:
  retroarch:
    image: lscr.io/linuxserver/retroarch:latest
    container_name: retroarch
    security_opt:
      - seccomp:unconfined #optional
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
    volumes:
      - /path/to/config:/config
    ports:
      - 3000:3000
      - 3001:3001
    shm_size: "1gb"
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=retroarch \
  --security-opt seccomp=unconfined `#optional` \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -p 3000:3000 \
  -p 3001:3001 \
  -v /path/to/config:/config \
  --shm-size="1gb" \
  --restart unless-stopped \
  lscr.io/linuxserver/retroarch:latest

Parameters

Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)

Parameter Function
3000:3000 RetroArch desktop gui HTTP must be proxied.
3001:3001 RetroArch desktop gui HTTPS.

Environment Variables (-e)

Env Function
PUID=1000 for UserID - see below for explanation
PGID=1000 for GroupID - see below for explanation
TZ=Etc/UTC specify a timezone to use, see this list.

Volume Mappings (-v)

Volume Function
/config Users home directory in the container, stores local files and settings

Miscellaneous Options

Parameter Function
--shm-size= This is needed for retroarch to function.
--security-opt seccomp=unconfined For Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker.

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id your_user as below:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

Docker Mods Docker Universal Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info

  • Shell access whilst the container is running:

    docker exec -it retroarch /bin/bash
    
  • To monitor the logs of the container in realtime:

    docker logs -f retroarch
    
  • Container version number:

    docker inspect -f '{{ index .Config.Labels "build_version" }}' retroarch
    
  • Image version number:

    docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/retroarch:latest
    

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.

Below are the instructions for updating containers:

Via Docker Compose

  • Update images:

    • All images:

      docker-compose pull
      
    • Single image:

      docker-compose pull retroarch
      
  • Update containers:

    • All containers:

      docker-compose up -d
      
    • Single container:

      docker-compose up -d retroarch
      
  • You can also remove the old dangling images:

    docker image prune
    

Via Docker Run

  • Update the image:

    docker pull lscr.io/linuxserver/retroarch:latest
    
  • Stop the running container:

    docker stop retroarch
    
  • Delete the container:

    docker rm retroarch
    
  • Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)

  • You can also remove the old dangling images:

    docker image prune
    

Image Update Notifications - Diun (Docker Image Update Notifier)

Tip

We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-retroarch.git
cd docker-retroarch
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/retroarch:latest .

The ARM variants can be built on x86_64 hardware and vice versa using lscr.io/linuxserver/qemu-static

docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

To help with development, we generate this dependency graph.

Init dependency graph
retroarch:latestBase Imagesdocker-modsbaselegacy-servicescustom servicesinit-servicesci-service-checkinit-migrationsinit-adduserinit-os-endinit-configinit-selkies-endinit-config-endinit-crontab-configinit-mods-endinit-custom-filesinit-device-permsinit-envfileinit-modsinit-mods-package-installinit-selkiesinit-nginxinit-selkies-configinit-videosvc-cronsvc-desvc-nginxsvc-selkiessvc-xorgsvc-dockersvc-pulseaudiobaseimage-selkies:ubuntunoblebaseimage-ubuntu:noblefix-attr +legacy cont-init
retroarch:latestBase Imagesdocker-modsbaselegacy-servicescustom servicesinit-servicesci-service-checkinit-migrationsinit-adduserinit-os-endinit-configinit-selkies-endinit-config-endinit-crontab-configinit-mods-endinit-custom-filesinit-device-permsinit-envfileinit-modsinit-mods-package-installinit-selkiesinit-nginxinit-selkies-configinit-videosvc-cronsvc-desvc-nginxsvc-selkiessvc-xorgsvc-dockersvc-pulseaudiobaseimage-selkies:ubuntunoblebaseimage-ubuntu:noblefix-attr +legacy cont-init

Versions

  • 25.05.25: - Initial Version.