Docker

We offer a few different example configurations in the pod-arcade/example-apps.

For ease of use, many of these examples embed both the desktop program (yuzu, retroarch, etc.), and desktop image into one. These images have the -aio suffix on them.

This is a perfectly valid way of running pod-arcade desktops, though the images can become quite large. This is in contrast to how we recommend running them with helm, where we have a separate image for both the application and the desktop images (which allows you to update the two images separately).

It's also worth noting that we do not maintain or support these images in the same way that we do the desktop and server images. They're provided as a convenience and example of how you can build your own all-in-one desktop, but are not guaranteed to be up to date or function.

Docker Compose

Server

Below is an example of running the server and a desktop using docker-compose. You should be able to connect to it using https://<SERVER_IP>:8443. You may need to accept the self-signed certificate.

note

If you are using https://play.pod-arcade.com you can skip this step completely and go straight to the desktop configuration.

docker-compose.yaml

version: "3"

services:
  server:
    image: ghcr.io/pod-arcade/server:v1
    restart: on-failure
    networks: [pod-arcade]
    ports:
      - "8443:8443" # HTTPS Web Port (the one you should connect to)
    environment:
      - CLIENT_PSK=passwordForClients
      - DESKTOP_PSK=magicPa$$wordForDesktops
      - ICE_SERVERS='[{"urls":["stun:stun.l.google.com:19302"]}]'
networks:
  pod-arcade:

Desktop

Below is an example pulled from the pod-arcade/example-apps repo for running an all-in-one desktop for the Yuzu emulator.

docker-compose.yaml

# ...
  yuzu:
    image: ghcr.io/pod-arcade/example-yuzu-aio:main
    restart: on-failure
    privileged: true
    networks: [pod-arcade]
    environment:
      - RESOLUTION=1920x1080

      # If you are using play.pod-arcade.com you can skip these three variables
      - DESKTOP_ID=yuzu-all-in-one
      - DESKTOP_PSK=magicPa$$wordForDesktops
      - MQTT_HOST=ws://server:8080/mqtt

      # If you are using play.pod-arcade.com, you need to add your CLOUD_AUTH_KEY as shared in the installation instructions
      # - CLOUD_AUTH_KEY=PAD-NOT-REAL
    volumes:
      - /dev/dri:/host/dev/dri
      - /dev/uinput:/host/dev/uinput
      - yuzu-home-dir:/home/ubuntu
volumes:
  yuzu-home-dir:
# ...

Pure Docker

The following docker command should be enough to get the server up and running. You should then be able to connect using https://localhost:8443.

docker run -it --rm --name pa-server \
  -p 8443:8443 \
  -e DESKTOP_PSK="theMagicStringUsedToAuthenticateDesktops" \
  -e CLIENT_PSK="thePasswordUsersPutInToConnect" \
  -e ICE_SERVERS='[{"urls":["stun:stun.l.google.com:19302"]}]' \
  -e AUTH_REQUIRED="true" \
  -e SERVE_TLS="true" \
  ghcr.io/pod-arcade/server:v1

and run an example yuzu all-in-one client with:

docker volume create yuzu-home-dir

docker run -it --privileged --name pa-yuzu \
  --link pa-server:pa-server \
  -e RESOLUTION='1920x1080' \
  # If you are using play.pod-arcade.com you can skip these three variables
  -e DESKTOP_ID=yuzu-all-in-one \
  -e DESKTOP_PSK='theMagicStringUsedToAuthenticateDesktops' \
  -e MQTT_HOST=ws://pa-server:8080/mqtt \
  # If you are using play.pod-arcade.com, you need to add your CLOUD_AUTH_KEY as shared in the installation instructions \
  # -e CLOUD_AUTH_KEY=PAD-NOT-REAL \
  -v yuzu-home-dir:/home/ubuntu \
  -v /dev/dri:/host/dev/dri \
  -v /dev/uinput:/host/dev/uinput \
  ghcr.io/pod-arcade/example-yuzu-aio:main

Troubleshooting

I can't connect to the server

Be sure you're connecting to the HTTPS port. You may need to accept the self-signed certificate. If that doesn't work, you may need to generate your own certificate and key. Check out the server configuration for more details.

The Desktop won't connect to the server

Ensure that the DESKTOP_PSK matches between the server and the desktop.