Skip to content
Login

Unraid

Unraid is a Docker-based NAS OS. HLE runs as a Docker container alongside your other apps — use it to expose any service on your Unraid box to the internet with SSO.

Run one container and manage every tunnel from the hle.world dashboard — add or remove services without touching Unraid again. See the agent guide.

Get a token from Connections → New → Agent (shown only once), then:

Terminal window
docker run -d \
--name hle-agent \
--restart unless-stopped \
-e HLE_AGENT_TOKEN=hlea_your_token_here \
--add-host=host.docker.internal:host-gateway \
-v /mnt/user/appdata/hle-agent:/data \
ghcr.io/hle-world/hle-docker:headless

Now add endpoints in the dashboard:

ServiceLocal URL
Unraid web UIhttp://host.docker.internal:80
Jellyfin (host port)http://host.docker.internal:8096
A container on the same networkhttp://jellyfin:8096

Option B: Docker Run (quick)

Terminal window
# Run HLE as a background container on your Unraid server
docker run -d \
--name hle \
--restart unless-stopped \
-e HLE_API_KEY=hle_your_key_here \
-v /mnt/user/appdata/hle:/data \
ghcr.io/hle-world/hle-docker:latest
# Expose your Unraid web UI (default port 80/443)
docker exec hle hle expose \
--service http://host.docker.internal:80 \
--label unraid \
--allow google:alex@gmail.com
# Expose any Docker app running on the same server
docker exec hle hle expose \
--service http://host.docker.internal:8096 \
--label jellyfin \
--allow google:alex@gmail.com

Option C: Docker Compose

If you use Docker Compose or Unraid’s Compose Manager plugin, add HLE to your stack:

services:
hle:
image: ghcr.io/hle-world/hle-docker:latest
container_name: hle
restart: unless-stopped
environment:
- HLE_API_KEY=hle_your_key_here
volumes:
- /mnt/user/appdata/hle:/data
extra_hosts:
- "host.docker.internal:host-gateway"

Option D: Community Apps template

You can also add the container manually via the Unraid Docker tab:

  1. Go to Docker > Add Container
  2. Repository: ghcr.io/hle-world/hle-docker:latest
  3. Add a variable: HLE_API_KEY = your key
  4. Add a path: /data > /mnt/user/appdata/hle
  5. Set Extra Parameters: --add-host=host.docker.internal:host-gateway
  6. Click Apply

For agent mode, use repository ghcr.io/hle-world/hle-docker:headless, set HLE_AGENT_TOKEN instead of HLE_API_KEY, and skip the WebUI port — the agent dials out and needs no inbound port.