diff --git a/README.md b/README.md index f614e470..7484af1e 100644 --- a/README.md +++ b/README.md @@ -952,10 +952,10 @@ SOFTWARE. [sqlite-web-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [sqlite-web-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg [sqlite-web-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg -[addon-ssh]: https://github.com/hassio-addons/addon-ssh/tree/v7.8.0 -[addon-doc-ssh]: https://github.com/hassio-addons/addon-ssh/blob/v7.8.0/README.md +[addon-ssh]: https://github.com/hassio-addons/addon-ssh/tree/v8.0.0 +[addon-doc-ssh]: https://github.com/hassio-addons/addon-ssh/blob/v8.0.0/README.md [ssh-issue]: https://github.com/hassio-addons/addon-ssh/issues -[ssh-version-shield]: https://img.shields.io/badge/version-v7.8.0-blue.svg +[ssh-version-shield]: https://img.shields.io/badge/version-v8.0.0-blue.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 [ssh-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg diff --git a/ssh/CHANGELOG.md b/ssh/CHANGELOG.md index 1d393984..d7da2d47 100644 --- a/ssh/CHANGELOG.md +++ b/ssh/CHANGELOG.md @@ -1,12 +1,37 @@ -[Full Changelog][changelog] +## What’s changed -### 🔨 Changes +This is a major release. This add-on now runs on the latest Alpine Linux, meaning almost all dependencies have been updated. +Furthermore, this add-on is now built on GitHub Actions and distributed via the GitHub Container Registry (you should not notice, but still a big change). -- ⬆ Upgrades add-on base image to v8.0.6 -- ⬆ Upgrades tmux to 3.1c-r0 -- ⬆ Upgrades Home Assistant CLI to v4.9.0 +Everything is shiny new and fresh! -[changelog]: https://github.com/hassio-addons/addon-ssh/compare/v7.7.0...v7.8.0 +../Frenck -Questions? Join our Discord server! https://discord.me/hassioaddons -Enjoying my add-ons? Consider supporting my work: https://patreon.com/frenck \ No newline at end of file +## 🚀 Enhancements + +- Disable SSH DNS lookup @duhow (#171) +- ⬆ Upgrades Home Assistant CLI to v4.10.0 @frenck (#194) + +## 🧰 Maintenance + +- Cleanup repository @frenck (#180) +- Happy New Year @frenck (#181) +- Upgrade Code of Conduct @frenck (#182) +- Add new repository workflow @frenck (#183) +- Allow dependabot to upgrade Python dependencies @frenck (#191) + +## 📚 Documentation + +- Update link and copy in README @AlecRust (#176) +- Update link and copy in DOCS @AlecRust (#177) + +## ⬆️ Dependency updates + +- ⬆️ Bump frenck/action-addon-linter from v1.3.1 to v1.4 @dependabot (#185) +- ⬆️ Bump actions/stale from v3.0.14 to v3.0.15 @dependabot (#184) +- Upgrade add-on base image to 9.1.1 @frenck (#189) +- Upgrade ttyd 1.6.3 & libwebsockets 4.1.4 @frenck (#190) +- ⬆️ Bump yamllint from 1.25.0 to 1.26.0 in /ssh @dependabot (#193) +- ⬆️ Bump frenck/action-yamllint from v1.0.2 to v1.1 @dependabot (#192) +- ⬆ Upgrades Home Assistant CLI to v4.10.0 @frenck (#194) +- Upgrade add-on base image to 9.1.2 @frenck (#195) diff --git a/ssh/DOCS.md b/ssh/DOCS.md index 224a160d..ae96e517 100644 --- a/ssh/DOCS.md +++ b/ssh/DOCS.md @@ -11,8 +11,8 @@ usability, flexibility and also provides access using a web interface. ## WARNING -The SSH & Web Terminal add-on is a really powerful and gives you virtually -access to all tools and almost all hardware of your system. +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. @@ -28,8 +28,8 @@ well. Additionally, it comes out of the box with the following: - 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!* + - 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. @@ -69,7 +69,7 @@ comparison to installing any other Home Assistant add-on. 1. Configure the `username` and `password`/`authorized_keys` options. 1. Start the "SSH & Web Terminal" add-on. 1. Check the logs of the "SSH & Web Terminal" add-on to see if everything - went well. + went well. ## Configuration @@ -81,7 +81,7 @@ SSH add-on configuration: log_level: info ssh: username: homeassistant - password: '' + password: "" authorized_keys: - ssh-rsa AASDJKJKJFWJFAFLCNALCMLAK234234..... sftp: false @@ -109,7 +109,7 @@ dealing with an unknown issue. Possible values are: - `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. +- `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 @@ -252,16 +252,16 @@ Example automation running `my_command`: ```yaml automation: -- alias: 'Example my script' - trigger: - platform: state - entity_id: binary_sensor.motion_sensor - to: 'ON' - action: - service: hassio.addon_stdin - data: - addon: a0d7b954_ssh - input: "/config/scripts/my_command" + - alias: "Example my script" + trigger: + platform: state + entity_id: binary_sensor.motion_sensor + to: "ON" + action: + service: hassio.addon_stdin + data: + addon: a0d7b954_ssh + input: "/config/scripts/my_command" ``` ## Known issues and limitations @@ -275,16 +275,15 @@ automation: ## Changelog & Releases This repository keeps a change log using [GitHub's releases][releases] -functionality. The format of the log is based on -[Keep a Changelog][keepchangelog]. +functionality. Releases are based on [Semantic Versioning][semver], and use the format -of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented +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. +- `MAJOR`: Incompatible or major changes. +- `MINOR`: Backwards-compatible new features and enhancements. +- `PATCH`: Backwards-compatible bugfixes and package updates. ## Support @@ -312,7 +311,7 @@ check [the contributor's page][contributors]. MIT License -Copyright (c) 2017-2020 Franck Nijhof +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 @@ -339,9 +338,8 @@ SOFTWARE. [forum]: https://community.home-assistant.io/t/community-hass-io-add-on-ssh-web-terminal/33820?u=frenck [frenck]: https://github.com/frenck [github-ssh]: https://help.github.com/articles/connecting-to-github-with-ssh/ -[hass-ssh]: https://github.com/home-assistant/hassio-addons/tree/master/ssh +[hass-ssh]: https://github.com/home-assistant/addons/tree/master/ssh [issue]: https://github.com/hassio-addons/addon-ssh/issues -[keepchangelog]: http://keepachangelog.com/en/1.0.0/ [ohmyzsh]: http://ohmyz.sh/ [openssh]: https://www.openssh.com/ [reddit]: https://reddit.com/r/homeassistant diff --git a/ssh/README.md b/ssh/README.md index e221224d..19d1c3a2 100644 --- a/ssh/README.md +++ b/ssh/README.md @@ -79,15 +79,15 @@ well. Additionally, it comes out of the box with the following: [github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png [github-sponsors]: https://github.com/sponsors/frenck [hass-ssh]: https://home-assistant.io/addons/ssh/ -[maintenance-shield]: https://img.shields.io/maintenance/yes/2020.svg +[maintenance-shield]: https://img.shields.io/maintenance/yes/2021.svg [ohmyzsh]: http://ohmyz.sh/ [openssh]: https://www.openssh.com/ [patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png [patreon]: https://www.patreon.com/frenck [project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg -[release-shield]: https://img.shields.io/badge/version-v7.8.0-blue.svg -[release]: https://github.com/hassio-addons/addon-ssh/tree/v7.8.0 -[screenshot]: https://github.com/hassio-addons/addon-ssh/raw/master/images/screenshot.png -[ssh-audit-image]: https://github.com/hassio-addons/addon-ssh/raw/master/images/ssh-audit.png +[release-shield]: https://img.shields.io/badge/version-v8.0.0-blue.svg +[release]: https://github.com/hassio-addons/addon-ssh/tree/v8.0.0 +[screenshot]: https://github.com/hassio-addons/addon-ssh/raw/main/images/screenshot.png +[ssh-audit-image]: https://github.com/hassio-addons/addon-ssh/raw/main/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 bb01bb30..6ece8e5f 100755 --- a/ssh/config.json +++ b/ssh/config.json @@ -1,6 +1,6 @@ { "name": "SSH & Web Terminal", - "version": "7.8.0", + "version": "8.0.0", "slug": "ssh", "description": "SSH & Web Terminal access to your Home Assistant instance", "url": "https://github.com/hassio-addons/addon-ssh", @@ -24,7 +24,6 @@ "ports_description": { "22/tcp": "SSH server port (make empty to disable)" }, - "boot": "auto", "hassio_api": true, "hassio_role": "manager", "services": [ @@ -99,5 +98,5 @@ ], "i_like_to_be_pwned": "bool?" }, - "image": "hassioaddons/ssh-{arch}" + "image": "ghcr.io/hassio-addons/ssh/{arch}" } \ No newline at end of file