Skip to content

hotchkj/hass-ws-discovery

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WS-Discovery Home Assistant Add-on Repository

Supports amd64 Architecture Supports aarch64 Architecture Supports armhf Architecture Supports armv7 Architecture Supports i386 Architecture

About

This repository contains a Home Assistant add-on that provides WS-Discovery (Web Services Dynamic Discovery) support. It makes Linux/Samba servers visible in the Windows Network Browser, allowing Windows computers to discover your Home Assistant server and any Samba shares on your network.

This add-on uses wsdd by Steffen Christgau - a Python implementation of a WS-Discovery server that implements the LLMNR and WS-Discovery protocols. The wsdd implementation is sourced directly from the official repository at https://github.com/christgau/wsdd.

Installation

Add the Repository

  1. Navigate to the Supervisor Add-on Store in Home Assistant
  2. Click on the three dots in the top right corner and select "Repositories"
  3. Add this repository URL: https://github.com/hotchkj/hass-ws-discovery
  4. Find "WS-Discovery" in the add-on store and click it
  5. Click "Install"
  6. Configure the add-on (see Configuration section below)
  7. Start the add-on
  8. Check the logs to see if everything is working correctly

Alternatively, click the button below to add this repository automatically:

Open your Home Assistant instance and show the add add-on repository dialog with this repository URL pre-filled.

Security

This add-on requires access to the host network to receive and send multicast packets used by WS-Discovery. Running with host_network: true allows the add-on to see and use network interfaces directly which is necessary for discovery protocols but increases the add-on's exposure to your local network.

Recommendations:

  • Only install add-ons you trust and review their source code when possible.
  • Be aware that host_network lets the add-on listen on all interfaces; do not run this add-on on untrusted networks.

Configuration

Add-on configuration example:

workgroup: WORKGROUP
hostname: ""
domain: ""
interface: ""
verbose: false

For detailed configuration options, see the add-on DOCS. The add-on supports all wsdd command line options including:

  • Basic options: workgroup, hostname, domain, interface, verbose
  • Advanced options: hoplimit, uuid, ipv4only, ipv6only, preserve_case, and more

Common Options

workgroup

The Windows workgroup name. Default is WORKGROUP.

hostname

The hostname to advertise. If left empty, the system hostname will be used.

domain

Report being a member of an Active Directory domain. If set, this disables the workgroup option. Leave empty if not using AD.

interface

Specify the network interface or IP address to use for WS-Discovery traffic. For example: eth0 or 192.168.1.10. Leave empty to use all available interfaces.

verbose

Enable verbose logging for debugging. Default is false.

Support

Got questions?

You could open an issue on GitHub:

License

MIT License - see LICENSE file for details.

The underlying wsdd implementation is licensed under the MIT License.

About

Home Assistant unofficial addon for WS Discovery

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors