From 0f1064067063fdaada986cbe9c612e61013c5f4d Mon Sep 17 00:00:00 2001 From: "Community Hass.io Add-ons Bot" Date: Sun, 13 May 2018 21:00:43 +0000 Subject: [PATCH] :tada: Release of add-on SSH - Secure Shell 2.4.0 --- README.md | 6 ++-- ssh/CHANGELOG.md | 37 ++++++++++++-------- ssh/README.md | 87 ++++++++++++++++++++++++++++++++++++++++++++++++ ssh/config.json | 11 ++++-- 4 files changed, 122 insertions(+), 19 deletions(-) create mode 100644 ssh/README.md diff --git a/README.md b/README.md index 71052075..57ff974e 100644 --- a/README.md +++ b/README.md @@ -378,10 +378,10 @@ SOFTWARE. [pi-hole-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg [pi-hole-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [pi-hole-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg -[addon-ssh]: https://github.com/hassio-addons/addon-ssh/tree/v2.3.0 -[addon-doc-ssh]: https://github.com/hassio-addons/addon-ssh/blob/v2.3.0/README.md +[addon-ssh]: https://github.com/hassio-addons/addon-ssh/tree/v2.4.0 +[addon-doc-ssh]: https://github.com/hassio-addons/addon-ssh/blob/v2.4.0/README.md [ssh-issue]: https://github.com/hassio-addons/addon-ssh/issues -[ssh-version-shield]: https://img.shields.io/badge/version-v2.3.0-blue.svg +[ssh-version-shield]: https://img.shields.io/badge/version-v2.4.0-blue.svg [ssh-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/ssh-armhf.svg [ssh-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [ssh-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg diff --git a/ssh/CHANGELOG.md b/ssh/CHANGELOG.md index bf34e07f..52330b7e 100644 --- a/ssh/CHANGELOG.md +++ b/ssh/CHANGELOG.md @@ -1,20 +1,31 @@ -[Full Changelog][v2.2.1-v2.3.0] - -### Fixed - -- Adds HASSIO_TOKEN to user environment +[Full Changelog][changelog] ### Added -- Adds add-on icon -- Adds zip package -- Adds allow_remote_port_forwarding option -- Adds documentation for allow_remote_port_forwarding option +- Adds all architectures to add-on config +- Adds .yamllint configuration +- Adds SQLite by default +- Adds Probot configuration +- Adds add-on README template +- Adds Gitlab CI + +### Fixed + +- Fixes Markdownlint warning in License +- Fixes hadolint warnings +- Fixes sudoers file permissions ### Changed -- Updates base image to v1.3.3 -- Updates hassio-cli to v1.2.1 -- Optimizes images in this repository +- Replaces Changelog with GitHub releases +- Updates hassio-cli to v1.3.0 (#18) (@bastula) +- Updates README +- Upgrades add-on base image to v1.4.1 -[v2.2.1-v2.3.0]: https://github.com/hassio-addons/addon-ssh/compare/v2.2.1...v2.3.0 \ No newline at end of file +### Removed + +- Removes CodeClimate +- Removes CircleCI +- Removes supervisor version constraint from add-on config + +[changelog]: https://github.com/hassio-addons/addon-ssh/compare/v2.3.0...v2.4.0 \ No newline at end of file diff --git a/ssh/README.md b/ssh/README.md new file mode 100644 index 00000000..a32e83e5 --- /dev/null +++ b/ssh/README.md @@ -0,0 +1,87 @@ +# 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 A BETA VERSION! + +This Hass.io Add-ons repository contains beta releases of add-ons. + +- 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. + +If you are more interested in stable releases of our add-ons: + + + +[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/v2.4.0/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-v2.4.0-blue.svg +[release]: https://github.com/hassio-addons/addon-ssh/tree/v2.4.0 +[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 \ No newline at end of file diff --git a/ssh/config.json b/ssh/config.json index f31a0803..c2c67b19 100644 --- a/ssh/config.json +++ b/ssh/config.json @@ -1,10 +1,16 @@ { "name": "SSH - Secure Shell", - "version": "2.3.0", + "version": "2.4.0", "slug": "ssh", "description": "Allows SSH connections to your Home Assistant instance", "url": "https://community.home-assistant.io/t/community-hass-io-add-on-ssh/33820?u=frenck", "startup": "services", + "arch": [ + "aarch64", + "amd64", + "armhf", + "i386" + ], "boot": "auto", "hassio_api": true, "homeassistant_api": true, @@ -51,8 +57,7 @@ ] }, "environment": { - "LOG_FORMAT": "{LEVEL}: {MESSAGE}", - "SUPERVISOR_VERSION": ">=0.94.0" + "LOG_FORMAT": "{LEVEL}: {MESSAGE}" }, "image": "hassioaddons/ssh-{arch}" } \ No newline at end of file