From 988f47fb4098a0f4e621c4b3a347aaafc7d9fd36 Mon Sep 17 00:00:00 2001 From: Kroese Date: Tue, 14 Jul 2026 02:06:45 +0200 Subject: [PATCH] docs: Document audio support (#1844) --- docs/environment.md | 5 ++++- readme.md | 13 ++++++++++++- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/docs/environment.md b/docs/environment.md index dd38a0f..4213018 100644 --- a/docs/environment.md +++ b/docs/environment.md @@ -118,8 +118,11 @@ This page lists all the environment variables that can be used to configure the | `WEB` | `Y` | Enables or disables the web interface. | | `WEB_PORT` | `8006` | Port for the web interface. | | `VNC_PORT` | `5900` | Port for the VNC server. | -| `WSS_PORT` | `5700` | WebSocket port used by QEMU/noVNC. | +| `WSS_PORT` | `5700` | WebSocket port used by noVNC. | | `WSD_PORT` | `8004` | Internal websocketd port. | +| `AUDIO` | `N` | Streams guest audio to the web viewer. | +| `SOUND` | `intel-hda` | QEMU audio device used for browser audio. | +| `AUX_PORT` | `8003` | Internal WebSocket port used for browser audio. | | `PROTECT` | `N` | Enables password protection for the web interface. | ## 🎈 Memory Ballooning diff --git a/readme.md b/readme.md index c3959a9..f101f86 100644 --- a/readme.md +++ b/readme.md @@ -264,12 +264,23 @@ kubectl apply -f https://raw.githubusercontent.com/dockur/windows/refs/heads/mas ### How do I connect using RDP? - The web viewer is mainly meant to be used during installation, as its picture quality is low, and it has no audio or clipboard for example. + The web viewer is mainly intended for use during installation, since it is less responsive than RDP and does not support features such as clipboard sharing. So for a better experience you can connect using any Microsoft Remote Desktop client to the IP of the container, using the username `Docker` and password `admin`. There is an RDP client for [Android](https://play.google.com/store/apps/details?id=com.microsoft.rdc.androidx) available from the Play Store and one for [iOS](https://apps.apple.com/nl/app/microsoft-remote-desktop/id714464092?l=en-GB) in the Apple Store. For Linux you can use [FreeRDP](https://www.freerdp.com/) and on Windows just type `mstsc` in the search box. +### How do I enable audio? + + Audio is disabled by default unless you are using RDP. To stream it to the browser, add the following environment variable: + + ```yaml + environment: + AUDIO: "Y" + ``` + + Then enable **Audio** under **Settings → Advanced** in the web viewer. The stream is only active while this option is enabled, so it uses no extra bandwidth otherwise. + ### How do I assign an individual IP address to the container? By default, the container uses bridge networking, which shares the IP address with the host.