hassio-addons / addon-terminal

Terminal - Community Hass.io Add-on for Home Assistant

Community Hass.io Add-ons: Terminal

This add-on allows you to log in to your Hass.io Home Assistant instance using a web terminal.

Deprecation warning

This add-on is in a deprecated state!

This add-on is now deprecated and has been replaced by a different addon: "SSH & Web Terminal"

This new add-on combines the SSH and Terminal add-ons into one single powerful solution, contains the latest upgrades and updates, and provide much more tools.

Please upgrade asap since this add-on won't receive any updates or upgrades anymore.

About

This add-on allows you to log in to your Hass.io Home Assistant instance using a web terminal. Giving you to access your Home Assistant configuration file and folder, and also includes a command-line tool to do things like restart, update, and check your instance.

Features

• Access your terminal right from the web!
• Add-able to your Home Assistant interface.
• Compatible if Hass.io was installed via the generic Linux installer.
• Persists custom SSH client settings & keys between add-on restarts
• Have Alpine packages installed on start. This will allow you to install your favorite tools, which will be available every single time you log in.
• Execute custom commands on start automatically 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.
• 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.

Installation

The installation of this add-on is pretty straightforward and not different in comparison to installing any other Hass.io add-on.

1. Add our Hass.io add-ons repository to your Hass.io instance.
2. Install the "Terminal" add-on.
3. Start the "Terminal" add-on
4. Check the logs of the "Terminal" add-on to see if everything went well.
5. Surf to your Hass.io instance and use port 7681 (e.g. http://hassio.local:7681).

NOTE: Do not add this repository to Hass.io, please use: https://github.com/hassio-addons/repository.

Docker status

Configuration

Note: Remember to restart the add-on when the configuration is changed.

Example add-on configuration:

{
  "log_level": "info",
  "username": "hassio",
  "password": "changeme",
  "ssl": true,
  "certfile": "fullchain.pem",
  "keyfile": "privkey.pem",
  "packages": [
    "python",
    "python-dev",
    "py-pip",
    "build-base"
  ],
  "init_commands": [
    "pip install virtualenv",
    "pip install yamllint"
  ]
}

Note: This is just an example, don't copy and past it! Create your own!

Option: log_level

The log_level option controls the level of log output by the addon and can be changed to be more or less verbose, which might be useful when you are dealing with an unknown issue. Possible values are:

• trace: Show every detail, like all called internal functions.
• debug: Shows detailed debug information.
• info: Normal (usually) interesting events.
• warning: Exceptional occurrences that are not errors.
• error: Runtime errors that do not require immediate action.
• fatal: Something went terribly wrong. Add-on becomes unusable.

Please note that each level automatically includes log messages from a more severe level, e.g., debug also shows info messages. By default, the log_level is set to info, which is the recommended setting unless you are troubleshooting.

Using trace or debug log levels puts the terminal daemon into debug mode.

Option: username

This option allows you to enable authentication on accessing the terminal. It is only used for the authentication; you will be the root user after you have authenticated. Using root as the username is possible, but not recommended. Leaving it empty would disable the possibility of authentication completely.

Note: If you set an username, password becomes mandatory as well.

Option: password

Sets the password to authenticate with. Leaving it empty would disable the possibility to authenticate completely.

Note: If you set a password, username becomes mandatory as well.

Option: ssl

Enables/Disables SSL (HTTPS) on the web terminal. Set it true to enable it, false otherwise.

Option: certfile

The certificate file to use for SSL.

Note: The file MUST be stored in /ssl/, which is default for Hass.io

Option: keyfile

The private key file to use for SSL.

Note: The file MUST be stored in /ssl/, which is default for Hass.io

Option: packages

Allows you to specify additional Alpine packages to be installed in your shell environment (e.g., Python, Joe, Irssi).

Note: Adding many packages will result in a longer start-up time for the add-on.

Option: init_commands

Customize your terminal environment even more with the init_commands option. Add one or more shell commands to the list, and they will be executed every single time this add-on starts.

Embedding into Home Assistant

It is possible to embed the terminal directly into Home Assistant, allowing you to access your terminal through the Home Assistant frontend.

Home Assistant provides the panel_iframe component, for these purposes.

Example configuration:

panel_iframe:
  terminal:
    title: Terminal
    icon: mdi:console
    url: https://addres.to.your.hass.io:7681

Known issues and limitations

The following error may occur in your add-on log:

ERR: lws_context_init_server_ssl: SSL_CTX_load_verify_locations unhappy

This error can be safely ignored; the add-on will function properly.

Changelog & Releases

This repository keeps a change log using GitHub's releases functionality. The format of the log is based on Keep a Changelog.

Releases are based on Semantic Versioning, and use the format of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented based on the following:

• MAJOR: Incompatible or major changes.
• MINOR: Backwards-compatible new features and enhancements.
• PATCH: Backwards-compatible bugfixes and package updates.

Support

Got questions?

You have several options to get them answered:

• The Home Assistant Community Forum, we have a dedicated topic on that forum regarding this add-on.
• The Home Assistant Discord Chat Server for general Home Assistant discussions and questions.
• 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 Hass.io add-ons for you

Want some more functionality to your Hass.io Home Assistant instance?

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

License

MIT License

Copyright (c) 2017 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.