RetroAssembly

Description / name	Input element
Container Registry
Container Configuration Root Path
RetroAssembly Host Port
RetroAssembly /data Path

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

Version Tags

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

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

Podman AppJail Bastille

Compose CLI Ansible

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:
      - "/path/to/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.

podman run -d --name retroassembly \
  -p 8000:8000 \
  -e RETROASSEMBLY_RUN_TIME_DATA_DIRECTORY=/data \
  -e RETROASSEMBLY_RUN_TIME_STORAGE_DIRECTORY=/data/storage \
  -e RETROASSEMBLY_RUN_TIME_PORT= \
  -v /path/to/containers/retroassembly:/data \
  ghcr.io/daemonless/retroassembly:latest

Save as run.sh, then run sh run.sh.

- name: Deploy retroassembly
  containers.podman.podman_container:
    name: retroassembly
    image: "ghcr.io/daemonless/retroassembly:latest"
    state: started
    restart_policy: always
    env:
      RETROASSEMBLY_RUN_TIME_DATA_DIRECTORY: "/data"
      RETROASSEMBLY_RUN_TIME_STORAGE_DIRECTORY: "/data/storage"
      RETROASSEMBLY_RUN_TIME_PORT: ""
    ports:
      - "8000:8000"
    volumes:
      - "/path/to/containers/retroassembly:/data"

Save as retroassembly-deploy.yaml, then run ansible-playbook retroassembly-deploy.yaml.

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.

Director CLI

# .env

DIRECTOR_PROJECT=retroassembly
RETROASSEMBLY_RUN_TIME_DATA_DIRECTORY=/data
RETROASSEMBLY_RUN_TIME_STORAGE_DIRECTORY=/data/storage
RETROASSEMBLY_RUN_TIME_PORT=

# 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}'
        - RETROASSEMBLY_RUN_TIME_PORT: !ENV '${RETROASSEMBLY_RUN_TIME_PORT}'
    volumes:
      - RETROASSEMBLY_DATA_PATH: /data
volumes:
  RETROASSEMBLY_DATA_PATH:
    device: '/path/to/containers/retroassembly'

# 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.

appjail oci run -Pd \
  -o overwrite=force \
  -o container="args:--pull" \
  -o virtualnet=":<random> default" \
  -o nat \
  -o expose="8000:8000 proto:tcp" \
  -e RETROASSEMBLY_RUN_TIME_DATA_DIRECTORY=/data \
  -e RETROASSEMBLY_RUN_TIME_STORAGE_DIRECTORY=/data/storage \
  -e RETROASSEMBLY_RUN_TIME_PORT= \
  -o fstab="/path/to/containers/retroassembly /data <pseudofs>" \
  ghcr.io/daemonless/retroassembly:latest retroassembly

Save the files above, then run sh run.sh.

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}.

Compose CLI

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
      - RETROASSEMBLY_RUN_TIME_PORT=
    volumes:
      - "/path/to/containers/retroassembly:/data"

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

bastille create -O \
  --env RETROASSEMBLY_RUN_TIME_DATA_DIRECTORY=/data \
  --env RETROASSEMBLY_RUN_TIME_STORAGE_DIRECTORY=/data/storage \
  --env RETROASSEMBLY_RUN_TIME_PORT= \
  --volume /path/to/containers/retroassembly /data \
  retroassembly ghcr.io/daemonless/retroassembly:latest inherit

Access at: http://localhost:8000

Interactive Configuration

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

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.1).

Need help? Join our Discord community.