# ![RetroAssembly](<https://daemonless.io/images/logos/retroassembly.svg>) RetroAssembly

[![Build Status](<https://img.shields.io/github/actions/workflow/status/daemonless/retroassembly/build.yaml?style=flat-square&amp;label=Build&amp;color=green>)](<https://github.com/daemonless/retroassembly/actions>) [![Last Commit](<https://img.shields.io/github/last-commit/daemonless/retroassembly?style=flat-square&amp;label=Last+Commit&amp;color=blue>)](<https://github.com/daemonless/retroassembly/commits>) [![OCI Pulls](<https://img.shields.io/docker/pulls/daemonless/retroassembly?style=flat-square&amp;label=OCI+Pulls&amp;color=blue>)](<https://hub.docker.com/r/daemonless/retroassembly>)

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

[[![RetroAssembly screenshot 1](<https://daemonless.io/images/screenshots/retroassembly/games.jpg>)](</images/screenshots/retroassembly/games.jpg>)](</images/screenshots/retroassembly/games.jpg>) [[![RetroAssembly screenshot 2](<https://daemonless.io/images/screenshots/retroassembly/library.jpg>)](</images/screenshots/retroassembly/library.jpg>)](</images/screenshots/retroassembly/library.jpg>) [[![RetroAssembly screenshot 3](<https://daemonless.io/images/screenshots/retroassembly/menu.jpg>)](</images/screenshots/retroassembly/menu.jpg>)](</images/screenshots/retroassembly/menu.jpg>) [[![RetroAssembly screenshot 4](<https://daemonless.io/images/screenshots/retroassembly/platform.jpg>)](</images/screenshots/retroassembly/platform.jpg>)](</images/screenshots/retroassembly/platform.jpg>)

|  |  |
| --- | --- |
| **Port** | `8000` |
| **Registry** | [`ghcr.io/daemonless/retroassembly`](<https://github.com/daemonless/retroassembly/pkgs/container/retroassembly>) |
| **Daemonless** | [daemonless/retroassembly](<https://github.com/daemonless/retroassembly>) |
| **Source** | [arianrhodsandlot/retroassembly](<https://github.com/arianrhodsandlot/retroassembly>) |
| **Website** | [retroassembly.com](<https://retroassembly.com/>) |

## Prerequisites

Before deploying, ensure your host environment is ready. See the [Quick Start Guide](<https://daemonless.io/guides/quick-start/index.md>) for host setup instructions, including the security model for host vs. container privileges.

## Deployment

**Customize Paths, UID &amp; Ports**

Install and manage **RetroAssembly** on FreeBSD with [fjord](<https://fjord.daemonless.io>):

```
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](<https://fjord.daemonless.io/install/>).

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

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

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

> [!WARNING]
>
> **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. |

> [!NOTE]
>
> **Implementation Details**
>
> - **Architectures:** amd64
> - **User:** `bsd` (UID/GID set via [PUID/PGID](<https://daemonless.io/guides/permissions/index.md>)). Defaults to `1000:1000`.
> - **Base:** Built on `ghcr.io/daemonless/base` (FreeBSD 15).

---

Need help? Join our [Discord](<https://discord.gg/Kb9tkhecZT>) community.
