Skip to content

cdzombak/ha-hawser

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 

Repository files navigation

Hawser for Home Assistant

Home Assistant Add-on

This Home Assistant add-on runs Hawser, a lightweight agent that allows Dockhand to manage the Docker instance on your Home Assistant host.

Warning

This add-on grants Dockhand full control over Docker on your Home Assistant host. This includes the ability to start, stop, and remove any container — including Home Assistant itself. Only install this if you understand the implications and trust your Dockhand installation.

Installation

  1. Add this repository to your Home Assistant add-on store:

    Repository URL: https://github.com/cdzombak/ha-hawser

  2. Install the Hawser add-on.

  3. Configure the add-on (see below).

  4. Start the add-on.

Modes

Standard mode

Hawser listens for incoming connections from Dockhand. Use this when your HA instance is directly reachable from your Dockhand server (e.g. on the same LAN).

Set mode to standard. Hawser listens on port 2376 inside the container; use the add-on's network configuration to map it to a different host port if needed.

Edge mode

Hawser initiates an outbound WebSocket connection to your Dockhand server. Use this when your HA instance is behind NAT, a firewall, or has a dynamic IP.

Set mode to edge, provide the dockhand_server_url (e.g. wss://dockhand.example.com/api/hawser/connect), and set the token from Dockhand.

Configuration

Option Description
mode standard or edge
token Authentication token (required for edge mode, optional for standard)
dockhand_server_url Dockhand WebSocket URL (required for edge mode)
agent_name Human-readable name for this agent (default: hostname)
log_level debug, info, warn, or error
tls_cert TLS certificate filename in /ssl (standard mode)
tls_key TLS key filename in /ssl (standard mode)
skip_df_collection Disable disk usage collection
heartbeat_interval Keepalive interval in seconds (default: 30)
request_timeout Request timeout in seconds (default: 30)

Supported Architectures

  • amd64
  • aarch64
  • armv7

License

ha-hawser is licensed under the MIT License.

About

Allows Dockhand to manage the Docker instance running on your Home Assistant host

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Contributors