From 7ca38e2a70368659b5310603158516db2efa1a1c Mon Sep 17 00:00:00 2001 From: "Community Hass.io Add-ons Bot" Date: Fri, 10 Jun 2022 20:42:27 +0000 Subject: [PATCH] :tada: Release of add-on Tor 4.0.0 --- README.md | 6 ++-- tor/CHANGELOG.md | 63 +++++++++++++++++++++++++++++++++------- tor/DOCS.md | 11 +++++-- tor/README.md | 6 ++-- tor/config.json | 47 ------------------------------ tor/config.yaml | 38 ++++++++++++++++++++++++ tor/translations/en.yaml | 34 ++++++++++++++++++++++ 7 files changed, 140 insertions(+), 65 deletions(-) delete mode 100644 tor/config.json create mode 100644 tor/config.yaml create mode 100644 tor/translations/en.yaml diff --git a/README.md b/README.md index d932db76..5462be2c 100644 --- a/README.md +++ b/README.md @@ -920,10 +920,10 @@ SOFTWARE. [thelounge-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [thelounge-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg [thelounge-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg -[addon-tor]: https://github.com/hassio-addons/addon-tor/tree/v3.0.5 -[addon-doc-tor]: https://github.com/hassio-addons/addon-tor/blob/v3.0.5/README.md +[addon-tor]: https://github.com/hassio-addons/addon-tor/tree/v4.0.0 +[addon-doc-tor]: https://github.com/hassio-addons/addon-tor/blob/v4.0.0/README.md [tor-issue]: https://github.com/hassio-addons/addon-tor/issues -[tor-version-shield]: https://img.shields.io/badge/version-v3.0.5-blue.svg +[tor-version-shield]: https://img.shields.io/badge/version-v4.0.0-blue.svg [tor-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [tor-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg [tor-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg diff --git a/tor/CHANGELOG.md b/tor/CHANGELOG.md index 7e68f5cc..e0250a84 100644 --- a/tor/CHANGELOG.md +++ b/tor/CHANGELOG.md @@ -1,14 +1,57 @@ ## What’s changed +Large overhaul of the add-on, including Hidden Service v3 support (thanks, @foo-calls-bar & @Psykopear!) + +## ✨ New features + +- Upgrade to Hidden Service v3 @foo-calls-bar (#89) + +## 🐛 Bug fixes + +- 🚑 Fix Hidden Service V3 Client Authorization @Psykopear (#105) + +## 🚀 Enhancements + +- Migrate JSON config to YAML @frenck (#116) +- :shirt: Change ports default to use port 80 @frenck (#141) +- 🌎 Add translations files @frenck (#142) +- 🔨 Refactor container init @frenck (#143) + +## 🧰 Maintenance + +- 🚀 Add-on CI improvements @frenck (#90) +- ⬆️ Upgrade lock-threads workflow to 3.0.0 @frenck (#103) +- Switch to centralized GitHub Action Workflows @frenck (#115) +- 🚀 Update CI to latest version @frenck (#121) +- 🚑 Fix deployment of add-on @frenck (#137) +- 🎆 Updates maintenance/license year to 2022 @frenck (#138) +- 🔥 Clean up obsolete fixattrs.d @frenck (#139) + +## 📚 Documentation + +- 🚑 Fix contributing link in readme @frenck (#91) +- 📚 Add My button to documentation @frenck (#140) + ## ⬆️ Dependency updates -- ⬆️ Bump brpaz/hadolint-action from v1.4.0 to v1.5.0 @dependabot (#67) -- ⬆️ Bump frenck/action-addon-linter from 2 to 2.1 @dependabot (#68) -- ⬆️ Bump actions/stale from 3.0.18 to 3.0.19 @dependabot (#69) -- ⬆️ Bump frenck/action-addon-information from 1.0.0 to 1.1 @dependabot (#70) -- ⬆️ Bump micnncim/action-label-syncer from 1.2.0 to 1.3.0 @dependabot (#71) -- ⬆️ Bump docker/build-push-action from 2.4.0 to 2.5.0 @dependabot (#72) -- ⬆️ Bump docker/setup-qemu-action from 1.1.0 to 1.2.0 @dependabot (#73) -- ⬆️ Bump actions/cache from 2.1.5 to 2.1.6 @dependabot (#74) -- ⬆️ Bump frenck/action-addon-information from 1.1 to 1.2.2 @dependabot (#76) -- ⬆️ Upgrades add-on base image to v9.2.2 @frenck (#77) +- ⬆️ Bump docker/setup-buildx-action from 1.3.0 to 1.5.0 @dependabot (#81) +- ⬆️ Bump docker/build-push-action from 2.5.0 to 2.6.1 @dependabot (#80) +- ⬆️ Bump docker/login-action from 1.9.0 to 1.10.0 @dependabot (#78) +- ⬆️ Upgrades add-on base image to v10.0.0 @frenck (#82) +- ⬆️ Bump dessant/lock-threads from 2.0.3 to 2.1.1 @dependabot (#85) +- ⬆️ Bump docker/setup-buildx-action from 1.5.0 to 1.5.1 @dependabot (#86) +- ⬆️ Bump actions/stale from 3.0.19 to 4 @dependabot (#87) +- ⬆️ Bump frenck/action-addon-linter from 2.1 to 2.2 @dependabot (#88) +- ⬆️ Bump dessant/lock-threads from 2.1.1 to 2.1.2 @dependabot (#92) +- ⬆️ Bump docker/build-push-action from 2.6.1 to 2.7.0 @dependabot (#93) +- ⬆️ Bump frenck/action-addon-linter from 2.2 to 2.3 @dependabot (#94) +- ⬆️ Bump creyD/prettier_action from 3.3 to 4.0 @dependabot (#96) +- ⬆️ Bump docker/setup-buildx-action from 1.5.1 to 1.6.0 @dependabot (#95) +- ⬆️ Upgrades tor to 0.4.5.10-r0 @frenck (#98) +- ⬆️ Upgrades add-on base image to 10.1.0 @frenck (#99) +- ⬆️ Bump frenck/action-addon-linter from 2.3 to 2.4.1 @dependabot (#102) +- ⬆️ Bump actions/checkout from 2.3.4 to 2.3.5 @dependabot (#106) +- ⬆️ Upgrades add-on base image to 10.2.1 @frenck (#117) +- ⬆️ Upgrades add-on base image to 10.2.2 @frenck (#118) +- ⬆️ Upgrades add-on base image to 11.0.0 @frenck (#122) +- ⬆️ Upgrades add-on base image to 12.0.0 @frenck (#136) diff --git a/tor/DOCS.md b/tor/DOCS.md index f4124fdb..1b32317e 100644 --- a/tor/DOCS.md +++ b/tor/DOCS.md @@ -25,7 +25,12 @@ applications through your Home Assistant installation. The installation of this add-on is pretty straightforward and not different in comparison to installing any other Home Assistant add-on. -1. Search for the "Tor" add-on in the Supervisor add-on store and install it. +1. Click the Home Assistant My button below to open the add-on on your Home + Assistant instance. + + [![Open this add-on in your Home Assistant instance.][addon-badge]][addon] + +1. Click the "Install" button to install the add-on. 1. Start the "Tor" add-on 1. Check the logs of the "Tor" add-on to see if everything went well. The log will also display your Tor .onion address. @@ -222,7 +227,7 @@ check [the contributor's page][contributors]. MIT License -Copyright (c) 2017-2021 Franck Nijhof +Copyright (c) 2017-2022 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 @@ -242,6 +247,8 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +[addon-badge]: https://my.home-assistant.io/badges/supervisor_addon.svg +[addon]: https://my.home-assistant.io/redirect/supervisor_addon/?addon=a0d7b954_tor&repository_url=https%3A%2F%2Fgithub.com%2Fhassio-addons%2Frepository [contributors]: https://github.com/hassio-addons/addon-tor/graphs/contributors [discord-ha]: https://discord.gg/c5DvZ4e [discord]: https://discord.me/hassioaddons diff --git a/tor/README.md b/tor/README.md index 8ebf603d..d0259c61 100644 --- a/tor/README.md +++ b/tor/README.md @@ -54,10 +54,10 @@ If you are more interested in stable releases of our add-ons: [forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-tor/33822?u=frenck [github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png [github-sponsors]: https://github.com/sponsors/frenck -[maintenance-shield]: https://img.shields.io/maintenance/yes/2021.svg +[maintenance-shield]: https://img.shields.io/maintenance/yes/2022.svg [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-v3.0.5-blue.svg -[release]: https://github.com/hassio-addons/addon-tor/tree/v3.0.5 +[release-shield]: https://img.shields.io/badge/version-v4.0.0-blue.svg +[release]: https://github.com/hassio-addons/addon-tor/tree/v4.0.0 [tor-hidden-service]: https://www.torproject.org/docs/hidden-services.html.en \ No newline at end of file diff --git a/tor/config.json b/tor/config.json deleted file mode 100644 index b1780821..00000000 --- a/tor/config.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "name": "Tor", - "version": "3.0.5", - "slug": "tor", - "description": "Protect your privacy and access Home Assistant via Tor.", - "url": "https://github.com/hassio-addons/addon-tor", - "startup": "services", - "arch": [ - "aarch64", - "amd64", - "armhf", - "armv7", - "i386" - ], - "init": false, - "ports": { - "9050/tcp": 9050 - }, - "ports_description": { - "9050/tcp": "Tor SOCKS proxy port" - }, - "map": [ - "ssl:rw" - ], - "options": { - "socks": false, - "hidden_services": true, - "stealth": false, - "client_names": [], - "ports": [ - "8123" - ] - }, - "schema": { - "log_level": "list(trace|debug|info|notice|warning|error|fatal)?", - "socks": "bool", - "hidden_services": "bool", - "stealth": "bool", - "client_names": [ - "match(^[A-Za-z0-9+-_]{1,16}$)" - ], - "ports": [ - "match(^(.*:)?(?:[0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])?$)" - ] - }, - "image": "ghcr.io/hassio-addons/tor/{arch}" -} \ No newline at end of file diff --git a/tor/config.yaml b/tor/config.yaml new file mode 100644 index 00000000..62cc8a7b --- /dev/null +++ b/tor/config.yaml @@ -0,0 +1,38 @@ +arch: +- aarch64 +- amd64 +- armhf +- armv7 +- i386 +codenotary: codenotary@frenck.dev +description: Protect your privacy and access Home Assistant via Tor +image: ghcr.io/hassio-addons/tor/{arch} +init: false +map: +- ssl:rw +name: Tor +options: + client_names: [] + hidden_services: true + ports: + - '8123' + - 8123:80 + socks: false + stealth: false +ports: + 9050/tcp: 9050 +ports_description: + 9050/tcp: Tor SOCKS proxy port +schema: + client_names: + - match(^[A-Za-z0-9+-_]{1,16}$) + hidden_services: bool + log_level: list(trace|debug|info|notice|warning|error|fatal)? + ports: + - match(^(.*:)?(?:[0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])?$) + socks: bool + stealth: bool +slug: tor +startup: services +url: https://github.com/hassio-addons/addon-tor +version: 4.0.0 diff --git a/tor/translations/en.yaml b/tor/translations/en.yaml new file mode 100644 index 00000000..61fc685c --- /dev/null +++ b/tor/translations/en.yaml @@ -0,0 +1,34 @@ +--- +configuration: + log_level: + name: Log level + description: >- + Controls the level of log details the add-on provides. + socks: + name: SOCKS proxy + description: >- + Enabling this feature allows you to use other applications on your + network to use the Tor network using this add-on as the SOCKS Proxy. + hidden_services: + name: Tor's hidden service + description: >- + Enable Tor's Hidden Service to expose services on the Tor network. + (E.g., accessing your Home Assistant instance over Tor.) + stealth: + name: Stealth mode + description: >- + Requires clients to use an additional encryption key to be able to connect + to the hidden service this add-on exposes to the Tor network. + client_names: + name: Clients + description: >- + Names of client when using stealth mode. The add-on will generate keys + for each of these clients. Valid client names are 1 to 16 characters long + and only use characters in `A-Za-z0-9+-_` (no spaces). + ports: + name: Ports + description: >- + Configures hosts and ports to publish via a Tor Hidden Service. Check + the add-on documentation for the exact format to enter here. +network: + 9050/tcp: Tor SOCKS proxy port