Skip to content

Latest commit

 

History

History
42 lines (34 loc) · 1.38 KB

README.md

File metadata and controls

42 lines (34 loc) · 1.38 KB

vlc-telnet

A Docker image of VLC with a Telnet interface for remote control, ideal for use with Home Assistant's VLC Telnet integration.

Overview

This image enables remote management of a VLC media player instance through Telnet. Key features and considerations:

  • Telnet Password: Customizable via the VLC_TELNET_PASSWORD environment variable in your docker-compose file.
  • USB Sound Speakers: Designed specifically for use with USB sound speakers.
  • Device Selection: If multiple USB speakers are present, the behavior is undefined. It's recommended to use only one USB speaker with this image.

How to Use

Docker Run

Run the command below if you don't use docker compose.

docker run -d --privileged -p 4212:4212 -e VLC_TELNET_PASSWORD=your_strong_password \
    ne1ver/vlc-telnet

To deploy it with docker compose use the sample below: docker-compose.yml

services:
  vlc-app:
    image: ne1ver/vlc-telnet
    ports:
      - "4212:4212"
    devices:
      - "/dev/snd:/dev/snd"
    environment:
      - VLC_TELNET_PASSWORD=your_strong_password 
    restart: unless-stopped

Note

This image is built for multiple architectures for broader compatibility. This image is provided as-is, and I offer no guarantee of its suitability for any specific purpose.

Project Links:
https://github.com/en-ver/vlc-telnet
https://hub.docker.com/r/ne1ver/vlc-telnet