An open API service indexing awesome lists of open source software.

https://github.com/daemonless/retroassembly

Personal retro game collection cabinet in your browser. Play NES, SNES, Genesis, GBA, and more.
https://github.com/daemonless/retroassembly

container emulator freebsd podman retro-gaming

Last synced: 12 days ago
JSON representation

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

Awesome Lists containing this project

README

          

# RetroAssembly

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

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

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

## Version Tags

| Tag | Description | Best For |
| :--- | :--- | :--- |
| `latest` | **Upstream Binary**. Built from official release. | Most users. Matches Linux Docker behavior. |

## Prerequisites

Before deploying, ensure your host environment is ready. See the [Quick Start Guide](https://daemonless.io/guides/quick-start) for host setup instructions.

## Deployment

### Podman Compose

```yaml
services:
retroassembly:
image: ghcr.io/daemonless/retroassembly:latest
container_name: retroassembly
environment:
- RETROASSEMBLY_RUN_TIME_DATA_DIRECTORY=/data
- RETROASSEMBLY_RUN_TIME_STORAGE_DIRECTORY=/data/storage
volumes:
- "/path/to/containers/retroassembly/data:/data"
ports:
- 8000:8000
restart: unless-stopped
```

### AppJail Director

**.env**:

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

**appjail-director.yml**:

```yaml
options:
- virtualnet: ': default'
- nat:
services:
retroassembly:
name: retroassembly
options:
- container: 'boot args:--pull'
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: /data
volumes:
retroassembly_data:
device: '/path/to/containers/retroassembly/data'
```

**Makejail**:

```
ARG tag=latest

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

### Podman CLI

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

### Ansible

```yaml
- 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"
ports:
- "8000:8000"
volumes:
- "/path/to/containers/retroassembly/data:/data"
```

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

### Volumes

| Path | Description |
|------|-------------|
| `/data` | Database and uploaded ROM storage |

### Ports

| Port | Protocol | Description |
|------|----------|-------------|
| `8000` | TCP | Web UI |

**Architectures:** amd64
**User:** `bsd` (UID/GID via PUID/PGID, defaults to 1000:1000)
**Base:** FreeBSD 15.0

---

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