mirror of
https://github.com/hassio-addons/repository-edge.git
synced 2025-05-05 11:41:31 +00:00
90 lines
No EOL
4 KiB
Markdown
90 lines
No EOL
4 KiB
Markdown
# Community Hass.io Add-ons: SSH - Secure Shell
|
|
|
|
[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield]
|
|
|
|
[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum]
|
|
|
|
[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]
|
|
|
|
This add-on allows you to log in to your Hass.io Home Assistant instance using
|
|
SSH.
|
|
|
|
## About
|
|
|
|
This add-on allows you to log in to your Hass.io Home Assistant instance using
|
|
SSH, giving you to access your Hass.io 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][hass-ssh] and focusses on security,
|
|
usability and flexibility.
|
|
|
|
[Click here for the full documentation][docs]
|
|
|
|
## Features
|
|
|
|
This add-on, of course, provides an SSH server, based on [OpenSSH][openssh].
|
|
Additionally, it comes out of the box with the following:
|
|
|
|
- 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 of brute-force attacks better.
|
|
- Many more security tweaks, *this addon passes all [ssh-audit] checks
|
|
without warnings!*
|
|
![Result of SSH-Audit][ssh-audit-image]
|
|
- Comes with compatibility mode option to allow older clients to connect.
|
|
- SFTP support is disabled by default but is user configurable.
|
|
- Compatible if Hass.io 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
|
|
- Log levels for allowing you to triage issues easier.
|
|
- 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][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"][ohmyzsh], 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.
|
|
|
|
[Click here for the full documentation][docs]
|
|
|
|
## WARNING! THIS IS AN EDGE VERSION!
|
|
|
|
This Hass.io Add-ons repository contains edge builds of add-ons. Edge builds
|
|
add-ons are based upon the latest development version.
|
|
|
|
- They may not work at all.
|
|
- They might stop working at any time.
|
|
- They could have a negative impact on your system.
|
|
|
|
This repository was created for:
|
|
|
|
- Anybody willing to test.
|
|
- Anybody interested in trying out upcoming add-ons or add-on features.
|
|
- Developers.
|
|
|
|
If you are more interested in stable releases of our add-ons:
|
|
|
|
<https://github.com/hassio-addons/repository>
|
|
|
|
[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg
|
|
[buymeacoffee]: https://www.buymeacoffee.com/frenck
|
|
[discord-shield]: https://img.shields.io/discord/330944238910963714.svg
|
|
[discord]: https://discord.gg/c5DvZ4e
|
|
[docs]: https://github.com/hassio-addons/addon-ssh/blob/ff23320/README.md
|
|
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
|
|
[forum]: https://community.home-assistant.io/t/community-hass-io-add-on-ssh/33820?u=frenck
|
|
[hass-ssh]: https://home-assistant.io/addons/ssh/
|
|
[maintenance-shield]: https://img.shields.io/maintenance/yes/2018.svg
|
|
[ohmyzsh]: http://ohmyz.sh/
|
|
[openssh]: https://www.openssh.com/
|
|
[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg
|
|
[release-shield]: https://img.shields.io/badge/version-ff23320-blue.svg
|
|
[release]: https://github.com/hassio-addons/addon-ssh/tree/ff23320
|
|
[ssh-audit-image]: https://github.com/hassio-addons/addon-ssh/raw/master/images/ssh-audit.png
|
|
[ssh-audit]: https://github.com/arthepsy/ssh-audit
|
|
[zsh]: https://en.wikipedia.org/wiki/Z_shell |