{"id":13494283,"url":"https://github.com/hassio-addons/addon-ssh","last_synced_at":"2025-04-08T01:35:34.905Z","repository":{"id":24201135,"uuid":"100820626","full_name":"hassio-addons/addon-ssh","owner":"hassio-addons","description":"Advanced SSH \u0026 Web Terminal - Home Assistant Community Add-ons","archived":false,"fork":false,"pushed_at":"2024-10-21T19:48:36.000Z","size":1735,"stargazers_count":350,"open_issues_count":9,"forks_count":95,"subscribers_count":13,"default_branch":"main","last_synced_at":"2024-10-29T17:28:39.577Z","etag":null,"topics":["addon","addons","home-assistant","home-automation","homeassistant","ssh","ssh-server"],"latest_commit_sha":null,"homepage":"https://addons.community","language":"Jinja","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hassio-addons.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"frenck","patreon":"frenck","custom":"https://frenck.dev/donate/"}},"created_at":"2017-08-19T20:50:36.000Z","updated_at":"2024-10-26T22:53:03.000Z","dependencies_parsed_at":"2024-03-07T18:30:07.196Z","dependency_job_id":"89194025-1964-4e4b-9e7a-8061a7e2d9a9","html_url":"https://github.com/hassio-addons/addon-ssh","commit_stats":{"total_commits":916,"total_committers":38,"mean_commits":"24.105263157894736","dds":0.685589519650655,"last_synced_commit":"b02e3f6cc90c676946e3fa17172a41782f63cc9f"},"previous_names":[],"tags_count":134,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hassio-addons%2Faddon-ssh","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hassio-addons%2Faddon-ssh/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hassio-addons%2Faddon-ssh/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hassio-addons%2Faddon-ssh/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hassio-addons","download_url":"https://codeload.github.com/hassio-addons/addon-ssh/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247761051,"owners_count":20991531,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["addon","addons","home-assistant","home-automation","homeassistant","ssh","ssh-server"],"created_at":"2024-07-31T19:01:23.475Z","updated_at":"2025-04-08T01:35:34.876Z","avatar_url":"https://github.com/hassio-addons.png","language":"Jinja","funding_links":["https://github.com/sponsors/frenck","https://patreon.com/frenck","https://frenck.dev/donate/","https://www.patreon.com/frenck"],"categories":["Hass.io","Install from Source","Jinja","Add-ons"],"sub_categories":["Third Party Add-ons","Smart Home Automation"],"readme":"# Home Assistant Community Add-on: Advanced SSH \u0026 Web Terminal\n\n[![GitHub Release][releases-shield]][releases]\n![Project Stage][project-stage-shield]\n[![License][license-shield]](LICENSE.md)\n\n![Supports aarch64 Architecture][aarch64-shield]\n![Supports amd64 Architecture][amd64-shield]\n![Supports armhf Architecture][armhf-shield]\n![Supports armv7 Architecture][armv7-shield]\n![Supports i386 Architecture][i386-shield]\n\n[![Github Actions][github-actions-shield]][github-actions]\n![Project Maintenance][maintenance-shield]\n[![GitHub Activity][commits-shield]][commits]\n\n[![Discord][discord-shield]][discord]\n[![Community Forum][forum-shield]][forum]\n\n[![Sponsor Frenck via GitHub Sponsors][github-sponsors-shield]][github-sponsors]\n\n[![Support Frenck on Patreon][patreon-shield]][patreon]\n\nThis add-on allows you to log in to your Home Assistant instance using\nSSH or by using the Web Terminal.\n\n![Web Terminal in the Home Assistant Frontend](images/screenshot.png)\n\n## About\n\nThis add-on allows you to log in to your Home Assistant instance using\nSSH or a Web Terminal, giving you to access your folders and\nalso includes a command-line tool to do things like restart, update,\nand check your instance.\n\nThis is an enhanced version of the provided\n[SSH add-on by Home Assistant][hass-ssh] and focuses on security,\nusability, flexibility and also provides access using a web interface.\n\n[:books: Read the full add-on documentation][docs]\n\n## WARNING\n\nThe advanced SSH \u0026 Web Terminal add-on is very powerful and gives you access\nto almost all tools and hardware of your system.\n\nWhile this add-on is created and maintained with care and with security in mind,\nin the wrong or inexperienced hands, it could damage your system.\n\n## Features\n\nThis add-on, of course, provides an SSH server, based on [OpenSSH][openssh] and\na web-based Terminal (which can be included in your Home Assistant frontend) as\nwell. Additionally, it comes out of the box with the following:\n\n- Access your command line right from the Home Assistant frontend!\n- A secure default configuration of SSH:\n  - Only allows login by the configured user, even if more users are created.\n  - Only uses known secure ciphers and algorithms.\n  - Limits login attempts to hold off brute-force attacks better.\n  - Many more security tweaks, _this addon passes all [ssh-audit] checks\n    without warnings!_\n    ![Result of SSH-Audit][ssh-audit-image]\n- Comes with an SSH compatibility mode option to allow older clients to connect.\n- Support for Mosh allowing roaming and supports intermittent connectivity.\n- SFTP support is disabled by default but is user configurable.\n- Compatible if Home Assistant was installed via the generic Linux installer.\n- Username is configurable, so `root` is no longer mandatory.\n- Persists custom SSH client settings \u0026 keys between add-on restarts\n- Log levels for allowing you to triage issues easier.\n- Hardware access to your audio, uart/serial devices and GPIO pins.\n- Runs with more privileges, allowing you to debug and test more situations.\n- Has access to the dbus of the host system.\n- Has the option to access the Docker instance running on the host system.\n- Runs on host level network, allowing you to open ports or run little daemons.\n- Have custom Alpine packages installed on start. This allows you to install\n  your favorite tools, which will be available every single time you log in.\n- Execute custom commands on add-on start so that you can customize the\n  shell to your likings.\n- [ZSH][zsh] as its default shell. Easier to use for the beginner, more advanced\n  for the more experienced user. It even comes preloaded with\n  [\"Oh My ZSH\"][ohmyzsh], with some plugins enabled as well.\n- Contains a sensible set of tools right out of the box: curl, Wget, RSync, GIT,\n  Nmap, Mosquitto client, MariaDB/MySQL client, Awake (“wake on LAN”), Nano,\n  Vim, tmux, and a bunch commonly used networking tools.\n\n## Support\n\nGot questions?\n\nYou have several options to get them answered:\n\n- The [Home Assistant Community Add-ons Discord chat server][discord] for add-on\n  support and feature requests.\n- The [Home Assistant Discord chat server][discord-ha] for general Home\n  Assistant discussions and questions.\n- The Home Assistant [Community Forum][forum].\n- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit]\n\nYou could also [open an issue here][issue] GitHub.\n\n## Contributing\n\nThis is an active open-source project. We are always open to people who want to\nuse the code or contribute to it.\n\nWe have set up a separate document containing our\n[contribution guidelines](.github/CONTRIBUTING.md).\n\nThank you for being involved! :heart_eyes:\n\n## Authors \u0026 contributors\n\nThe original setup of this repository is by [Franck Nijhof][frenck].\n\nFor a full list of all authors and contributors,\ncheck [the contributors page][contributors].\n\n## We have got some Home Assistant add-ons for you\n\nWant some more functionality to your Home Assistant instance?\n\nWe have created multiple add-ons for Home Assistant. For a full list, check out\nour [GitHub Repository][repository].\n\n## License\n\nMIT License\n\nCopyright (c) 2017-2025 Franck Nijhof\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg\n[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg\n[armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg\n[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg\n[commits-shield]: https://img.shields.io/github/commit-activity/y/hassio-addons/addon-ssh.svg\n[commits]: https://github.com/hassio-addons/addon-ssh/commits/main\n[contributors]: https://github.com/hassio-addons/addon-ssh/graphs/contributors\n[discord-ha]: https://discord.gg/c5DvZ4e\n[discord-shield]: https://img.shields.io/discord/478094546522079232.svg\n[discord]: https://discord.me/hassioaddons\n[docs]: https://github.com/hassio-addons/addon-ssh/blob/main/ssh/DOCS.md\n[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg\n[forum]: https://community.home-assistant.io/t/community-hass-io-add-on-ssh-web-terminal/33820?u=frenck\n[frenck]: https://github.com/frenck\n[github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png\n[github-sponsors]: https://github.com/sponsors/frenck\n[github-actions-shield]: https://github.com/hassio-addons/addon-ssh/workflows/CI/badge.svg\n[github-actions]: https://github.com/hassio-addons/addon-ssh/actions\n[hass-ssh]: https://github.com/home-assistant/addons/tree/master/ssh\n[i386-shield]: https://img.shields.io/badge/i386-no-red.svg\n[issue]: https://github.com/hassio-addons/addon-ssh/issues\n[license-shield]: https://img.shields.io/github/license/hassio-addons/addon-ssh.svg\n[maintenance-shield]: https://img.shields.io/maintenance/yes/2025.svg\n[ohmyzsh]: http://ohmyz.sh/\n[openssh]: https://www.openssh.com/\n[patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png\n[patreon]: https://www.patreon.com/frenck\n[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg\n[reddit]: https://reddit.com/r/homeassistant\n[releases-shield]: https://img.shields.io/github/release/hassio-addons/addon-ssh.svg\n[releases]: https://github.com/hassio-addons/addon-ssh/releases\n[repository]: https://github.com/hassio-addons/repository\n[semver]: http://semver.org/spec/v2.0.0.htm\n[ssh-audit-image]: images/ssh-audit.png\n[ssh-audit]: https://github.com/jtesta/ssh-audit\n[zsh]: https://en.wikipedia.org/wiki/Z_shell\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhassio-addons%2Faddon-ssh","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhassio-addons%2Faddon-ssh","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhassio-addons%2Faddon-ssh/lists"}