From 0e4fffccc1ea507a1361a5496adee5384759060e Mon Sep 17 00:00:00 2001 From: "Community Hass.io Add-ons Bot" Date: Sat, 30 May 2020 17:26:52 +0000 Subject: [PATCH] :tada: Release of add-on AdGuard Home 2.4.0 --- README.md | 6 +- adguard/CHANGELOG.md | 13 ++-- adguard/DOCS.md | 165 +++++++++++++++++++++++++++++++++++++++++++ adguard/README.md | 9 +-- adguard/config.json | 2 +- 5 files changed, 179 insertions(+), 16 deletions(-) create mode 100644 adguard/DOCS.md diff --git a/README.md b/README.md index fc9bb1fc..3cc7cf79 100644 --- a/README.md +++ b/README.md @@ -786,10 +786,10 @@ SOFTWARE. [adb-armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg [adb-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg [adb-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg -[addon-adguard]: https://github.com/hassio-addons/addon-adguard-home/tree/v2.3.3 -[addon-doc-adguard]: https://github.com/hassio-addons/addon-adguard-home/blob/v2.3.3/README.md +[addon-adguard]: https://github.com/hassio-addons/addon-adguard-home/tree/v2.4.0 +[addon-doc-adguard]: https://github.com/hassio-addons/addon-adguard-home/blob/v2.4.0/README.md [adguard-issue]: https://github.com/hassio-addons/addon-adguard-home/issues -[adguard-version-shield]: https://img.shields.io/badge/version-v2.3.3-blue.svg +[adguard-version-shield]: https://img.shields.io/badge/version-v2.4.0-blue.svg [adguard-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/adguard-armhf.svg [adguard-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [adguard-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg diff --git a/adguard/CHANGELOG.md b/adguard/CHANGELOG.md index 2c930fed..aab0cea3 100644 --- a/adguard/CHANGELOG.md +++ b/adguard/CHANGELOG.md @@ -1,14 +1,15 @@ [Full Changelog][changelog] -This is a general maintenance release. - ### 🔨 Changes -- :arrow_up: Upgrade AdGuard Home to v0.101.0 (#46) -- :arrow_up: Upgrades add-on base image to v7.0.5 -- :hammer: Disable Docker init +- ⬆ Upgrade Adguard to 0.102.0 (#58) +- ⬆ Upgrades add-on base image to v7.2.0 +- 🔨 Implement OCI image specification on labels +- ✏ Split add-on documentation +- ✏ Documentation tweak +- 🔨 Configure Adguard port/protocol dynamically on startup (#67) -[changelog]: https://github.com/hassio-addons/addon-adguard-home/compare/v2.3.2...v2.3.3 +[changelog]: https://github.com/hassio-addons/addon-adguard-home/compare/v2.3.3...v2.4.0 Questions? Join our Discord server! https://discord.me/hassioaddons Enjoying my add-ons? Consider supporting my work: diff --git a/adguard/DOCS.md b/adguard/DOCS.md new file mode 100644 index 00000000..5a54cdf8 --- /dev/null +++ b/adguard/DOCS.md @@ -0,0 +1,165 @@ +# Home Assistant Community Add-on: AdGuard Home + +AdGuard Home is a network-wide ad-and-tracker blocking DNS server with +parental control (adult content blocking) capabilities. Its purpose is to let +you control your entire network and all your devices, and it does not require +using a client-side program. + +AdGuard Home provides a beautiful, easy and feature-rich web interface to +easily manage the filtering process and its settings. + +## Installation + +The installation of this add-on is pretty straightforward and not different in +comparison to installing any other Home Assistant add-on. + +1. **Ensure your Home Assistant device has a + [static IP and static external DNS servers!](https://github.com/home-assistant/hassos/blob/dev/Documentation/network.md#static-ip)** + This is important! You **WILL** end up having issues if you skip this step. + Also, please note, setting a fixed IP in your router is **NOT** static. +1. Search for the "AdGuard Home" add-on in the Supervisor add-on store and + install it. +1. Start the "AdGuard Home" add-on. +1. Check the logs of the "AdGuard Home" to see if everything went well. +1. Click the "OPEN WEB UI" button and log in with your Home Assistant account. +1. Ready to go! + +## Configuration + +**Note**: _Remember to restart the add-on when the configuration is changed._ + +Example add-on configuration: + +```yaml +log_level: info +ssl: true +certfile: fullchain.pem +keyfile: privkey.pem +``` + +**Note**: _This is just an example, don't copy and paste it! Create your own!_ + +### Option: `log_level` + +The `log_level` option controls the level of log output by the addon and can +be changed to be more or less verbose, which might be useful when you are +dealing with an unknown issue. Possible values are: + +- `trace`: Show every detail, like all called internal functions. +- `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. +- `fatal`: Something went terribly wrong. Add-on becomes unusable. + +Please note that each level automatically includes log messages from a +more severe level, e.g., `debug` also shows `info` messages. By default, +the `log_level` is set to `info`, which is the recommended setting unless +you are troubleshooting. + +### Option: `ssl` + +Enables/Disables SSL (HTTPS) on the add-on. Set it `true` to enable it, +`false` otherwise. + +**Note**: _The SSL settings only apply to direct access and has no effect +on the Ingress service._ + +### Option: `certfile` + +The certificate file to use for SSL. + +**Note**: _The file MUST be stored in `/ssl/`, which is the default_ + +### Option: `keyfile` + +The private key file to use for SSL. + +**Note**: _The file MUST be stored in `/ssl/`, which is the default_ + +### Option: `leave_front_door_open` + +Adding this option to the add-on configuration allows you to disable +authentication on the AdGuard Home by setting it to `true`. + +**Note**: _We STRONGLY suggest, not to use this, even if this add-on is +only exposed to your internal network. USE AT YOUR OWN RISK!_ + +## Encryption Settings (Advanced Usage) + +Adguard allows the configuration of running DNS-over-HTTPS and DNS-over- +TLS locally. If you configure these options please ensure to restart the +addon afterwards. Also to use DNS-over-HTTPS correctly please ensure to +configure SSL on the addon as well as in Adguard itself. Also consider +that the addon and Adguard cannot use the same port for SSL. + +## 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]. + +Releases are based on [Semantic Versioning][semver], and use the format +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. + +## Support + +Got questions? + +You have several options to get them answered: + +- The [Home Assistant Community Add-ons Discord chat server][discord] for add-on + support and feature requests. +- The [Home Assistant Discord chat server][discord-ha] for general Home + Assistant discussions and questions. +- The Home Assistant [Community Forum][forum]. +- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit] + +You could also [open an issue here][issue] GitHub. + +## Authors & contributors + +The original setup of this repository is by [Franck Nijhof][frenck]. + +For a full list of all authors and contributors, +check [the contributor's page][contributors]. + +## License + +MIT License + +Copyright (c) 2019-2020 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 +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +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. + +[contributors]: https://github.com/hassio-addons/addon-adguard-home/graphs/contributors +[discord-ha]: https://discord.gg/c5DvZ4e +[discord]: https://discord.me/hassioaddons +[forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-adguard-home/90684?u=frenck +[frenck]: https://github.com/frenck +[issue]: https://github.com/hassio-addons/addon-adguard-home/issues +[keepchangelog]: http://keepachangelog.com/en/1.0.0/ +[reddit]: https://reddit.com/r/homeassistant +[releases]: https://github.com/hassio-addons/addon-adguard-home/releases +[semver]: http://semver.org/spec/v2.0.0.htm diff --git a/adguard/README.md b/adguard/README.md index c29481e9..acb1490b 100644 --- a/adguard/README.md +++ b/adguard/README.md @@ -20,8 +20,6 @@ using a client-side program. AdGuard Home provides a beautiful, easy and feature-rich web interface to easily manage the filtering process and its settings. -[Click here for the full documentation][docs] - ![AdGuard Home in the Home Assistant frontend][screenshot] ## WARNING! THIS IS A BETA VERSION! @@ -42,7 +40,6 @@ If you are more interested in stable releases of our add-ons: [discord-shield]: https://img.shields.io/discord/478094546522079232.svg [discord]: https://discord.me/hassioaddons -[docs]: https://github.com/hassio-addons/addon-adguard-home/blob/v2.3.3/README.md [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg [forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-adguard-home/90684?u=frenck [github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png @@ -51,6 +48,6 @@ If you are more interested in stable releases of our add-ons: [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-v2.3.3-blue.svg -[release]: https://github.com/hassio-addons/addon-adguard-home/tree/v2.3.3 -[screenshot]: https://github.com/hassio-addons/addon-adguard-home/raw/v2.3.3/images/screenshot.png \ No newline at end of file +[release-shield]: https://img.shields.io/badge/version-v2.4.0-blue.svg +[release]: https://github.com/hassio-addons/addon-adguard-home/tree/v2.4.0 +[screenshot]: https://github.com/hassio-addons/addon-adguard-home/raw/v2.4.0/images/screenshot.png \ No newline at end of file diff --git a/adguard/config.json b/adguard/config.json index 15842acd..6efadbaf 100644 --- a/adguard/config.json +++ b/adguard/config.json @@ -1,6 +1,6 @@ { "name": "AdGuard Home", - "version": "2.3.3", + "version": "2.4.0", "slug": "adguard", "description": "Network-wide ads & trackers blocking DNS server", "url": "https://github.com/hassio-addons/addon-adguard-home",