Unraid Deployment

Recommended path: one-click install (Community Applications)

Unraid's Community Applications (CA for short, the Apps tab) is a community-maintained app store. SkyView is listed in the official CA store, so Unraid users can simply search 'yunkan' in Apps and install with one click — no template repository to add, an experience on par with the Home Assistant add-on. No hand-written compose, no SSH.

1. 1

   Confirm the Community Applications plugin is installed

   Unraid 6.10+ usually ships with it. If the Apps tab is visible, you're set. If it's missing, go to Plugins → Install Plugin and paste https://raw.githubusercontent.com/Squidly271/community.applications/master/plugins/community.applications.plg to install.

2. 2

   Search and install (pick one; port conflicts mean you can't install more than one)

   Apps tab → type yunkan in the search box → 3 variants appear: YunKan (CPU only, no hardware dependency) / YunKan-OpenVINO (Intel iGPU, install the Intel GPU TOP plugin first) / YunKan-CUDA (NVIDIA GPU, install the NVIDIA Driver plugin first). Click Install on the matching variant; the defaults are fine, with the data directory defaulting to /mnt/user/appdata/yunkan/data.

3. 3

   First launch → Setup wizard

   Once the container starts, find the yunkan container on the Docker tab → click WebUI (or open http://<Unraid IP>:23406/ directly) → enter the Setup wizard → choose SQLite → create an admin → add a camera.

Or: the docker compose path (custom / older Unraid)

Below is the traditional hand-written compose deployment path, for users who need custom ports or are on Unraid < 6.12 without the CA plugin. If you used the CA one-click install above, you can skip this section and jump to the GPU plugin install in 2. Prerequisites, or skip ahead to 5. Ports and firewall / 6. FAQ.

1. Supported hardware & recommended variant

2. Prerequisites

1. 1

   Confirm the Unraid version

   Tools → Update OS, check version ≥ 6.12.13 (older versions need the Docker Compose Manager plugin)

2. 2

   Install the GPU plugin

   On the Apps tab, search for the matching plugin: install Intel GPU TOP for Intel iGPU, NVIDIA Driver for NVIDIA; you'll be prompted to reboot after install, and /dev/dri or /dev/nvidia* appears afterward

3. 3

   Create the AppData directory

   Unraid conventionally uses /mnt/user/appdata/yunkan/; create it and cd into it to place the compose file

3. Get the compose file

Pick any one of three ways — download in the browser, wget over SSH, or paste the minimal version in Unraid's Compose Manager:

Or SSH into Unraid (or use the Terminal plugin):

ssh root@<Unraid IP>
mkdir -p /mnt/user/appdata/yunkan
cd /mnt/user/appdata/yunkan
wget https://yun-kan.com/compose/unraid.yml -O compose.yml

name: yunkan

services:
  yunkan:
    image: registry.cn-hangzhou.aliyuncs.com/yunkan/yunkan-openvino:latest
    container_name: yunkan
    restart: always
    network_mode: host
    devices:
      - /dev/dri:/dev/dri
    volumes:
      - /mnt/user/appdata/yunkan/data:/app/data
      - /mnt/user/appdata/yunkan/recordings:/app/data/recordings
      - /etc/machine-id:/etc/machine-id:ro
      - /sys/class/dmi/id/product_uuid:/sys/class/dmi/id/product_uuid:ro
      - /var/run/docker.sock:/var/run/docker.sock
    environment:
      - TZ=Asia/Shanghai
      - SKYVIEW_SELF_CONTAINER_NAME=yunkan

4. Start SkyView

Option A · CLI (recommended, full functionality):

cd /mnt/user/appdata/yunkan
docker compose up -d
docker logs -f yunkan

Option B · GUI: Unraid Web UI → Docker tab → "Compose Manager" block → "Add New Stack" → name it yunkan → paste the compose.yml contents → "Compose Up".

After it starts, open http://<Unraid IP>:23406/ in the browser to enter the Setup wizard.

5. Ports and firewall

Unraid has no firewall by default, so all ports are exposed directly on the host NIC; SkyView uses 23406/23880/24214/24215/tcp + 23515/udp.

6. FAQ

Upgrading: docker socket permissions are normal on Unraid, so the web console's one-click online upgrade works out of the box; you can also upgrade manually with cd /mnt/user/appdata/yunkan && docker compose pull && docker compose up -d.