Skip to content

RetroAssembly RetroAssembly

Build Status Last Commit OCI Pulls

Personal retro game collection cabinet in your browser. Play NES, SNES, Genesis, GBA, and more.

Port 8000
Registry ghcr.io/daemonless/retroassembly
Daemonless daemonless/retroassembly
Source arianrhodsandlot/retroassembly
Website retroassembly.com

Prerequisites

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions, including the security model for host vs. container privileges.

Deployment

Customize Paths, UID & Ports

Install and manage RetroAssembly on FreeBSD with fjord:

fjord install retroassembly

Or open the App Store in the fjord web UI and install RetroAssembly from the wizard. New to fjord? See the Install Guide.

services:
  retroassembly:
    image: "ghcr.io/daemonless/retroassembly:latest"
    container_name: retroassembly
    environment:
      - RETROASSEMBLY_RUN_TIME_DATA_DIRECTORY=/data  # Data directory for SQLite database (default: /data)
      - RETROASSEMBLY_RUN_TIME_STORAGE_DIRECTORY=/data/storage  # Directory for uploaded ROM files (default: /data/storage)
      # - RETROASSEMBLY_RUN_TIME_PORT=  # HTTP port (default: 8000)
    volumes:
      - "/containers/retroassembly:/data"
    ports:
      - "8000:8000"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always

Save as compose.yaml, then run podman-compose up -d.

Warning

Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

1
2
3
4
5
# .env

DIRECTOR_PROJECT=retroassembly
RETROASSEMBLY_RUN_TIME_DATA_DIRECTORY=/data
RETROASSEMBLY_RUN_TIME_STORAGE_DIRECTORY=/data/storage
# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  retroassembly:
    name: retroassembly
    options:
      - container: 'args:--pull'
      - expose: '8000:8000 proto:tcp'
    oci:
      user: root
      environment:
        - RETROASSEMBLY_RUN_TIME_DATA_DIRECTORY: !ENV '${RETROASSEMBLY_RUN_TIME_DATA_DIRECTORY}'
        - RETROASSEMBLY_RUN_TIME_STORAGE_DIRECTORY: !ENV '${RETROASSEMBLY_RUN_TIME_STORAGE_DIRECTORY}'
    volumes:
      - retroassembly: /data
volumes:
  retroassembly:
    device: '/containers/retroassembly'
1
2
3
4
5
6
7
# Makejail

ARG tag=latest

OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/retroassembly:${tag}

Save the files above, then run appjail-director up.

Experimental

Bastille's OCI support is experimental. It requires buildah and shares the host network stack (inherit). Mount volumes with --volume HOST JAIL; without it, image-declared volumes are stored under ${bastille_volumesdir}/${jail}.

services:
  retroassembly:
    name: retroassembly
    image: "ghcr.io/daemonless/retroassembly:latest"
    network:
      - mode: host
    environment:
      - RETROASSEMBLY_RUN_TIME_DATA_DIRECTORY=/data
      - RETROASSEMBLY_RUN_TIME_STORAGE_DIRECTORY=/data/storage
    volumes:
      - "/containers/retroassembly:/data"

Save as bastille-compose.yml, then run bastille up.

Open http://<server>:8000 from another machine (the server's own browser can't use a published port).

Parameters

Environment Variables

Variable Default Description
RETROASSEMBLY_RUN_TIME_DATA_DIRECTORY /data Data directory for SQLite database (default: /data)
RETROASSEMBLY_RUN_TIME_STORAGE_DIRECTORY /data/storage Directory for uploaded ROM files (default: /data/storage)
RETROASSEMBLY_RUN_TIME_PORT `` HTTP port (default: 8000)

Volumes

Path Description
/data Database and uploaded ROM storage

Ports

Port Protocol Description
8000 TCP Web UI

Version Tags

Tag Description Best For
latest Upstream Binary. Built from official release. Most users — recommended.

Implementation Details

  • Architectures: amd64
  • User: bsd (UID/GID set via PUID/PGID). Defaults to 1000:1000.
  • Base: Built on ghcr.io/daemonless/base (FreeBSD 15).

Need help? Join our Discord community.