Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/giof71/xfce-vnc-audio
Run XFCE on NoVNC (and VNC) with Docker
https://github.com/giof71/xfce-vnc-audio
docker novnc pulseaudio pulseaudio-dlna vnc xfce4
Last synced: about 2 months ago
JSON representation
Run XFCE on NoVNC (and VNC) with Docker
- Host: GitHub
- URL: https://github.com/giof71/xfce-vnc-audio
- Owner: GioF71
- Created: 2023-03-30T16:45:02.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-15T12:23:22.000Z (about 1 year ago)
- Last Synced: 2023-12-16T09:48:54.135Z (about 1 year ago)
- Topics: docker, novnc, pulseaudio, pulseaudio-dlna, vnc, xfce4
- Language: Shell
- Homepage:
- Size: 56.6 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# xfce-vnc-audio
A docker container for xfce4 via vnc for audio playback, possibly through upnp/dlna with pulseaudio-dlna.
The Chromium browser is installed, as well as an Upnp Control Point ([upplay](https://www.lesbonscomptes.com/upplay/index.html)).
PulseAudio-DLNA is also installed, so you will be able to `cast` audio (e.g.) from SoundCloud on the browser to your existing dlna renderers. You can set up your own renderer with docker using a combination of [mpd](https://github.com/GioF71/mpd-alsa-docker) and [upmpdcli](https://github.com/GioF71/upmpdcli-docker).
## Disclaimer
This is a *work in progress*. It is only working correctly on the amd64 platform. On arm, I cannot find a way to make it work correctly due to missing fonts. If anybody knows how to correct this, please create and issue or a discussion.
## Links
Repo|URL
:---|:---
Source code|[GitHub](https://github.com/GioF71/xfce-vnc-audio)
Docker images|[Docker Hub](https://hub.docker.com/r/giof71/xfce-vnc-audio)
## Usage
### Environment Variables
VARIABLE|DESCRIPTION
:---|:---
PUID|User id for the user `vnc-user`, defaults to `1000`
PGID|Group id for the group `vnc-user`, defaults to `1000`
AUDIO_GID|`audio` group id from the host machine.
APT_CACHE_URL|Set to an apt-cacher-ng instance (recommended!)
INSTALL_UPPLAY|Set to `yes` to install upplay
INSTALL_FIREFOX|Set to `yes` to install Firefox. Recommended browser.
INSTALL_CHROMIUM|Set to `yes` to install Chromium. Requires `--privileged`, but does not work very well for me at least.
INSTALL_PULSEAUDIO_DLNA|Set to `yes` to install PulseAudio-DLNA
INSTALL_CANTATA|Set to `yes` to install [Cantata](https://github.com/CDrummond/cantata)
VNC_EXPOSE|Set to `yes` if you want to expose VNC directly (not recommended). If exposed, the port is `5901`.
VNC_GEOMETRY|Geometry of vnc, defaults to `1280x720`
VNC_DEPTH|Color depth of vnc, defaults to `16`, conservatively
VNC_AUTOSTART_PULSEAUDIO|Autostart PulseAudio, defaults to `yes`
VNC_AUTOSTART_PULSEAUDIO_DLNA|Autostart PulseAudio-DLNA, defaults to `yes`
### Volumes
VOLUME|DESCRIPTION
:---|:---
/home/vnc-user|Home directory, use if you want to maintain your configurations.
### Ports
PORT|DESCRIPTION
:---|:---
6080|Port of NOVnc. Connect to `http://:6080/vnc.html`
5901|Port of VNC, available if VNC_EXPOSE is set to `yes`
### Examples
#### Some considerations
Topic|Comment
:---|:---
Networking|If you plan to use upplay, it's likely that you will need to run the container in `host` mode, in order to allow server/renderer discovery
PulseAudio|When using pulseaudio, you might want to mount the `/run/user/1000/pulse` volume to the same path (check if your uid is also `1000`)
Bookworm|Bookworm repositories do not include pulseaudio-dlna, so the main builds are made from bullseye (see [#14](https://github.com/GioF71/xfce-vnc-audio/issues/14))
#### Docker Run
```text
docker run \
--rm \
-it \
--name xfce-vnc-audio \
--network host \
-e AUDIO_GID=995 \
-e INSTALL_FIREFOX=yes \
-e INSTALL_CHROMIUM=yes \
-e INSTALL_PULSEAUDIO=yes \
-e INSTALL_UPPLAY=yes \
-v /run/user/1000/pulse:/run/user/1000/pulse \
giof71/xfce-vnc-audio
```
Check what is the gid of `audio` on your system and use it instead of the `995` shown in the example.
#### Docker Compose
To be added.
## Changelog
DATE|DESCRIPTION
:---|:---
2023-12-15|Back to bullseye because of missing packages (see [#14](https://github.com/GioF71/xfce-vnc-audio/issues/14))
2023-11-24|Support installation of [Cantata](https://github.com/CDrummond/cantata)
2023-08-21|Upgrade to debian bookworm (see [#9](https://github.com/GioF71/xfce-vnc-audio/issues/9))
2023-08-21|Proper restart of the container (see [#7](https://github.com/GioF71/xfce-vnc-audio/issues/7))
2023-06-14|GitHub workflow updated
2023-04-01|Initial release for amd64 only (not an April's fool)