diff --git a/README.md b/README.md index 67a04ae2b..635b9efe8 100644 --- a/README.md +++ b/README.md @@ -373,10 +373,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/d3b1597 +[addon-doc-ssh]: https://github.com/hassio-addons/addon-ssh/blob/d3b1597/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-d3b1597-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 bf34e07f1..12eddef34 100644 --- a/ssh/CHANGELOG.md +++ b/ssh/CHANGELOG.md @@ -1,20 +1,44 @@ -[Full Changelog][v2.2.1-v2.3.0] - -### Fixed - -- Adds HASSIO_TOKEN to user environment - -### Added - -- Adds add-on icon -- Adds zip package -- Adds allow_remote_port_forwarding option -- Adds documentation for allow_remote_port_forwarding option - -### Changed - -- Updates base image to v1.3.3 -- Updates hassio-cli to v1.2.1 -- Optimizes images in this repository - -[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 +# Changelog since v2.3.0 + +2018/05/11 09:08 UTC - [d3b1597](https://github.com/hassio-addons/addon-ssh/commit/d3b159781eaee3fc9ee274c012b617b4fafb65de) by [@frenck](https://github.com/frenck) +> :sparkles: Adds Gitlab CI + +2018/05/11 09:08 UTC - [e6ad0c0](https://github.com/hassio-addons/addon-ssh/commit/e6ad0c0d9389109069f539de90de8f746d492f8a) by [@frenck](https://github.com/frenck) +> :sparkles: Adds initial add-on README template + +2018/05/11 09:08 UTC - [e05e0ee](https://github.com/hassio-addons/addon-ssh/commit/e05e0ee7be69802c4b0b39dc9784a3f8027698a6) by [@frenck](https://github.com/frenck) +> :books: Updates README + +2018/05/11 09:08 UTC - [fb80203](https://github.com/hassio-addons/addon-ssh/commit/fb80203dc6387f50e4551dd1c16784057c384961) by [@frenck](https://github.com/frenck) +> :rocket: Updates probot configuration + +2018/05/11 09:08 UTC - [c7d5b07](https://github.com/hassio-addons/addon-ssh/commit/c7d5b076e2363b734440ed7636f952a8bd8276ef) by [@bastula](https://github.com/bastula) +> :arrow_up: Updates hassio-cli to v1.3.0 (#18) + +2018/05/11 09:08 UTC - [256b908](https://github.com/hassio-addons/addon-ssh/commit/256b908fe2100dd4b890a6b40afed0984b4d4e73) by [@frenck](https://github.com/frenck) +> :shirt: Fixes hadolint warnings + +2018/05/11 09:08 UTC - [188b4c1](https://github.com/hassio-addons/addon-ssh/commit/188b4c14ff5660ad463bc9f6513cf758307389b1) by [@frenck](https://github.com/frenck) +> :sparkles: Adds Probot configuration + +2018/05/11 09:08 UTC - [e28314f](https://github.com/hassio-addons/addon-ssh/commit/e28314f28c64672328ef6ec10ad9ccf3056e5a5f) by [@frenck](https://github.com/frenck) +> :shirt: Fixes Markdownlint warning in License + +2018/05/11 09:08 UTC - [efb9d8f](https://github.com/hassio-addons/addon-ssh/commit/efb9d8f9e8b77e0f67e435154a6556e4ebdaf282) by [@frenck](https://github.com/frenck) +> :sparkles: Adds SQLite by default + +2018/05/11 09:08 UTC - [2c4ff1b](https://github.com/hassio-addons/addon-ssh/commit/2c4ff1b7621a838cbfd669a2933ee414471d0623) by [@frenck](https://github.com/frenck) +> :sparkles: Adds .yamllint configuration + +2018/05/11 09:08 UTC - [bf7cfff](https://github.com/hassio-addons/addon-ssh/commit/bf7cfff5ea50822df8cd7f3a9407e4ea6c07dcc3) by [@frenck](https://github.com/frenck) +> :fire: Removes CircleCI + +2018/05/11 09:08 UTC - [3d534a2](https://github.com/hassio-addons/addon-ssh/commit/3d534a2f383410cf345aa3bbba0c69deb9c16887) by [@frenck](https://github.com/frenck) +> :fire: Removes CodeClimate + +2018/05/11 09:08 UTC - [a69b50b](https://github.com/hassio-addons/addon-ssh/commit/a69b50b93b34f2b86feb4d5085118fed6e41d6b7) by [@frenck](https://github.com/frenck) +> :snowflake: Adds all architectures to add-on config + +2018/05/11 09:08 UTC - [ce00b37](https://github.com/hassio-addons/addon-ssh/commit/ce00b37268dcb6152876bb3ce0b51f653a0b1b0a) by [@frenck](https://github.com/frenck) +> :books: Replaces Changelog with GitHub releases + diff --git a/ssh/README.md b/ssh/README.md new file mode 100644 index 000000000..58a5b9a14 --- /dev/null +++ b/ssh/README.md @@ -0,0 +1,85 @@ +# 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] +- 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: + + + +[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/d3b1597/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 +[maintenance-shield]: https://img.shields.io/maintenance/yes/2018.svg +[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg +[release-shield]: https://img.shields.io/badge/version-d3b1597-blue.svg +[release]: https://github.com/hassio-addons/addon-ssh/tree/d3b1597 +[ssh-audit]: https://github.com/hassio-addons/addon-ssh/raw/master/images/ssh-audit.png \ No newline at end of file diff --git a/ssh/config.json b/ssh/config.json index f31a0803b..cf728f5fb 100644 --- a/ssh/config.json +++ b/ssh/config.json @@ -1,10 +1,16 @@ { "name": "SSH - Secure Shell", - "version": "2.3.0", + "version": "d3b1597", "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,