Emulatorjs - In browser web based emulation portable to nearly any device for many retro consoles. A mix of emulators is used between Libretro and EmulatorJS.
lscr.io/linuxserver/emulatorjs: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:
The Backend can be accessed at:
The first thing you will need to do is click to download the default art/configs from this interface, this will setup a skeleton directory in your
/data mount. From there add roms to the respective
roms directories and follow the on screen instructions to add them to your web frontend running on port 80.
The frontend application has been initially optimized around being used with a standard gamepad (more specifically for modern Xbox consoles that have chromium based Edge browsers). The navigation revolves around the up/down/left/right keys to browse the menus and launch games. Mobile browsers will function, just keep in mind compatibility will be reduced especially for CD based games.
Currently only n64 is using an EmulatorJS core. I understand there may be some confusion as to project naming, but when this project (linuxserver/emulatorjs) started it was meant to be a simple frontend for self hosting folks to use the at the time deobfuscated code of https://www.emulatorjs.com/ that ethanaobrien was working on. Since then EmulatorJS has evolved into it's own amazing project based on Libretro cores that have been highly optimized to function for web. Also since then I tried to roll my own cores, which while fuinctional have fallen out of maintenance as they are all pinned back to the Retroarch 1.11.0 days and comprise the majority of the systems. So in general despite the naming of this project and the logo this is just a docker container with a web based backend for generating a useable self hosted emulation website and is in no way affiliated with EmulatorJS outside of using their n64 core.
For Xbox users please click the select button a couple times after launching a game to ensure the B button does not trigger a "back" action in the browser. (official name "view button" it is the two small squares) Exiting the controller mode and back to browser controls can be triggered by holding the start button for 3 seconds. (official name "menu button" the three lines) You will be unable to use features like save states and modify controller layouts on the emulatorjs based emulators currently as I have not determined a methodology of re-entering controller mode once you exit it. All normal game saves will function given you exit the game play screen cleanly using the B button for back this includes multi disc games for psx. Your game saves are stored in browser storage by hostname so if you make any changes to your local hosted setup (port or IP) the saves will not follow with it. For libretro based emulators you can use the button combination start+select+L+R to access the libretro menu and change settings/save or load/etc.
This container (outside of the profile functionality) only generates a static set of files that can be hosted on any web provider even object storage. Eveyrthing runs in the clients browser and there are no dependencies on this container. To extract/copy this website it is at the path
/emulatorjs/frontend inside the container. If you are happy with the catalouge you have created and no longer want to run stuff like the IPFS backend or want to upload these files to some other hosting provider you can simply copy the contents of that directory and kill off this container.
Mounting in existing rom directories can be achieved by pointing to the default folder structure, IE lets say you would like to mount your NES library:
The folder names are: * 3do * arcade * atari2600 * atari7800 * colecovision * doom * gb * gba * gbc * jaguar * lynx * msx * n64 * nds * nes * ngp * odyssey2 * pce * psx * sega32x * segaCD * segaGG * segaMD * segaMS * segaSaturn * segaSG * snes * vb * vectrex * ws
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
docker-compose (recommended, click here for more info)¶
--- version: "2.1" services: emulatorjs: image: lscr.io/linuxserver/emulatorjs:latest container_name: emulatorjs environment: - PUID=1000 - PGID=1000 - TZ=Etc/UTC - SUBFOLDER=/ #optional volumes: - /path/to/config:/config - /path/to/data:/data ports: - 3000:3000 - 80:80 - 4001:4001 #optional restart: unless-stopped
docker cli (click here for more info)¶
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.
| ||Rom/artwork management interface, used to generate/manage config files and download artwork|
| ||Emulation frontend containing static web files used to browse and launch games|
| ||IPFS peering port, if you want to participate in the P2P network to distribute frontend artwork please forward this to the Internet|
Environment Variables (
| ||for UserID - see below for explanation|
| ||for GroupID - see below for explanation|
| ||specify a timezone to use, see this list.|
| ||Specify a subfolder for reverse proxies IE '/FOLDER/'|
Volume Mappings (
| ||Path to store user profiles|
| ||Path to store roms/artwork|
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend
As an example:
Will set the environment variable
MYVAR based on the contents of the
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
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
PGID=1000, to find yours use
id your_user as below:
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.
Shell access whilst the container is running:
To monitor the logs of the container in realtime:
Container version number:
Image version number:
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), 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¶
You can also remove the old dangling images:
Via Docker Run¶
Update the image:
Stop the running container:
Delete the container:
Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your
/configfolder and settings will be preserved)
You can also remove the old dangling images:
Via Watchtower auto-updater (only use if you don't remember the original parameters)¶
Pull the latest image at its tag and replace it with the same env variables in one run:
You can also remove the old dangling images:
docker image prune
We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using Docker Compose.
Image Update Notifications - Diun (Docker Image Update Notifier)¶
We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
If you want to make local modifications to these images for development purposes or just to customize the logic:
The ARM variants can be built on x86_64 hardware using
Once registered you can define the dockerfile to use with
- 09.08.23: - Rebase to Alpine 3.18, migrate to s6v3.
- 06.07.23: - Deprecate armhf. As announced here
- 24.11.22: - Update IPFS links for chdman.
- 04.04.22: - Ingest pre-built chdman bins during build time.
- 23.02.22: - Update ingestion point for emulatorjs bins.
- 25.01.22: - Allow users to mount in existing rom directories.
- 14.01.22: - Add profile paths and rebase to Alpine 3.15.
- 04.01.22: - Add headers needed for Threaded emulators.
- 29.11.21: - Add wasm mime type to NGINX.
- 26.11.21: - Configure IPFS in a lower power mode, use homebuilt blobs for emu cores.
- 19.11.21: - Pin retroarch version.
- 14.11.21: - Update default cores to ingest.
- 23.10.21: - Initial release.
Created: January 9, 2020