Home Assistant Community Add-on: SSH & Web Terminal

This add-on allows you to log in to your Home Assistant instance using SSH or by using the Web Terminal.

About

This add-on allows you to log in to your Home Assistant instance using SSH or a Web Terminal, giving you to access your folders and also includes a command-line tool to do things like restart, update, and check your instance.

This is an enhanced version of the provided SSH add-on by Home Assistant and focusses on security, usability, flexibility and also provides access using a web interface.

📚 Read the full add-on documentation

WARNING

The SSH & Web Terminal add-on is very powerful and gives you access to almost all tools and hardware of your system.

While this add-on is created and maintained with care and with security in mind, in the wrong or inexperienced hands, it could damage your system.

Features

This add-on, of course, provides an SSH server, based on OpenSSH and a web-based Terminal (which can be included in your Home Assistant frontend) as well. Additionally, it comes out of the box with the following:

• Access your command line right from the Home Assistant frontend!
• A secure default configuration of SSH:
  • Only allows login by the configured user, even if more users are created.
  • Only uses known secure ciphers and algorithms.
  • Limits login attempts to hold off brute-force attacks better.
  • Many more security tweaks, this addon passes all ssh-audit checks without warnings!
• Passwords are checked with HaveIBeenPwned using K-anonymity.
• Comes with an SSH compatibility mode option to allow older clients to connect.
• Support for Mosh allowing roaming and supports intermittent connectivity.
• SFTP support is disabled by default but is user configurable.
• Compatible if Home Assistant was installed via the generic Linux installer.
• Username is configurable, so root is no longer mandatory.
• Persists custom SSH client settings & keys between add-on restarts
• Hardware access to your audio, uart/serial devices and GPIO pins.
• Runs with more privileges, allowing you to debug and test more situations.
• Has access to the dbus of the host system.
• Has the option to access the Docker instance running on the host system.
• Runs on host level network, allowing you to open ports or run little daemons.
• Have custom Alpine packages installed on start. This allows you to install your favorite tools, which will be available every single time you log in.
• Execute custom commands on add-on start so that you can customize the shell to your likings.
• ZSH as its default shell. Easier to use for the beginner, more advanced for the more experienced user. It even comes preloaded with "Oh My ZSH", with some plugins enabled as well.
• Bash: If ZSH is not your cup of tea, Bash can be enabled again, which includes Bash completion for both the Core CLI and the Home Assistant CLI.
• Contains a sensible set of tools right out of the box: curl, Wget, RSync, GIT, Nmap, Mosquitto client, MariaDB/MySQL client, Awake (“wake on LAN”), Nano, Vim, tmux, and a bunch commonly used networking tools.
• Has the Home Assistant CLI (hass-cli) command line tool pre-installed and pre-configured.
• Support executing commands inside using a Home Assistant service call, e.g., for use with automations.

Support

Got questions?

You have several options to get them answered:

• The Home Assistant Community Add-ons Discord chat server for add-on support and feature requests.
• The Home Assistant Discord chat server for general Home Assistant discussions and questions.
• The Home Assistant Community Forum.
• Join the Reddit subreddit in /r/homeassistant

You could also open an issue here GitHub.

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We have set up a separate document containing our contribution guidelines.

Thank you for being involved! 😍

Authors & contributors

The original setup of this repository is by Franck Nijhof.

For a full list of all authors and contributors, check the contributor's page.

We have got some Home Assistant add-ons for you

Want some more functionality to your Home Assistant instance?

We have created multiple add-ons for Home Assistant. For a full list, check out our GitHub Repository.

License

MIT License

Copyright (c) 2017-2021 Franck Nijhof

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.