Ways to install

The packaged container is the simplest option. Docker Run and Docker Compose are alternatives—choose one, not both.

Before you start

Choose a dedicated directory containing only media you intend to expose.
FolderFrame has no built-in authentication or TLS.
The container reads media from /media and listens on container port 8080.
The media mount is read-only, but reachable visitors can still browse and download those files.

OPTION 1

Docker Run

Use this when you prefer one command. Replace the source path with an absolute path on your Docker host. Host port 8088 maps to container port 8080.

SHELL

docker run -d \
  --name folderframe \
  --restart unless-stopped \
  -p 8088:8080 \
  --mount type=bind,source=/absolute/path/to/media,target=/media,readonly \
  ghcr.io/the-grog/folderframe-deployment:stable

Open http://SERVER-IP:8088/.

OPTION 2

Docker Compose

Use this instead of Docker Run when you want the configuration saved in a file. Replace the source path with an absolute existing directory.

COMPOSE.YAML

services:
  folderframe:
    image: ghcr.io/the-grog/folderframe-deployment:stable
    container_name: folderframe
    restart: unless-stopped
    ports:
      - "8088:8080"
    volumes:
      - type: bind
        source: /absolute/path/to/media
        target: /media
        read_only: true

Save as compose.yaml, run docker compose up -d, then open http://SERVER-IP:8088/.

Unraid

Find FolderFrame in Unraid Community Apps, install it, then choose a dedicated Media Folder and an unused WebUI port. The Community Apps template supplies the container paths and image settings.

Repository: ghcr.io/the-grog/folderframe-deployment:stable
Container port: 8080
Media container path: /media, read-only
No appdata, database, privileged mode, host network, PUID or PGID required

Unraid instructions ↗

Home Assistant

The dedicated Home Assistant app and card are still planned. FolderFrame is not currently a Home Assistant add-on.

Run the Docker image on a separate Docker host—or alongside Home Assistant Container when you manage that Docker host—then open or embed its HTTP address from your Home Assistant dashboard. Home Assistant OS does not provide a supported way to run arbitrary Docker containers directly.

Keep FolderFrame reachable only on a trusted network unless a separate access layer supplies authentication and HTTPS.

Full deployment documentation ↗How it works