🎉 Release of add-on Cloudflared 4.0.1

README.md

@@ -86,10 +86,10 @@ 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-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/tree/v4.0.0
-[addon-doc-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/blob/v4.0.0/README.md
+[addon-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/tree/v4.0.1
+[addon-doc-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/blob/v4.0.1/README.md
 [cloudflared-issue]: https://github.com/brenner-tobias/addon-cloudflared/issues
-[cloudflared-version-shield]: https://img.shields.io/badge/version-v4.0.0-blue.svg
+[cloudflared-version-shield]: https://img.shields.io/badge/version-v4.0.1-blue.svg
 [cloudflared-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
 [cloudflared-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
 [cloudflared-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg

cloudflared/DOCS.md

@@ -80,40 +80,31 @@ advanced configurations can be achieved using the remote tunnel setup.
 
 **Note**: _Remember to restart the add-on when the configuration is changed._
 
-Example basic add-on configuration:
-
-```yaml
-external_hostname: "ha.example.com"
-additional_hosts: []
-```
-
-Example extended add-on configuration:
+Example add-on configuration:
 
 ```yaml
 external_hostname: "ha.example.com"
 additional_hosts:
   - hostname: "router.example.com"
     service: "http://192.168.1.1"
-  - hostname: "diskstation.example.com"
-    service: "https://192.168.1.2:5001"
   - hostname: "website.example.com"
     service: "http://192.168.1.3:8080"
-    disableChunkedEncoding: true
-nginx_proxy_manager: true
-log_level: "debug"
 ```
 
 **Note**: _This is just an example, don't copy and paste it! Create your own!_
 
-### Option: `tunnel_name`
+### Option: `external_hostname`
 
-If you want to change the default tunnel name to something different than
-"homeassistant", you can do so by using this option.
+Set the `external_hostname` option to the domain name or subdomain that you want
+to use to access Home Assistant on.
+
+This is optional, `additional_hosts` can be used instead to only expose other
+services.
 
 **Note**: _The tunnel name needs to be unique in your Cloudflare account._
 
 ```yaml
-tunnel_name: "myHomeAssistant"
+external_hostname: "ha.example.com"
 ```
 
 ### Option: `additional_hosts`
@@ -122,8 +113,8 @@ You can use the internal reverse proxy of Cloudflare Tunnel to define additional
 hosts next to Home Assistant. That way, you can use the tunnel to also access
 other systems like a diskstation, router or anything else.
 
-Like with the `external_hostname` of Home Assistant, DNS entries will be
-automatically created at Cloudflare.
+Like the `external_hostname` option used for Home Assistant, DNS entries will
+be automatically created at Cloudflare.
 
 Add the (optional) `disableChunkedEncoding` option to a hostname, to disable
 chunked transfer encoding. This is useful if you are running a WSGI server,
@@ -147,6 +138,17 @@ additional_hosts:
 anymore. Nevertheless, you should also manually delete the DNS entry from
 Cloudflare since it can not be deleted by the add-on._
 
+### Option: `tunnel_name`
+
+The `tunnel_name` option allows changing the tunnel name to something other
+than the default of `homeassistant`.
+
+**Note**: _The tunnel name needs to be unique in your Cloudflare account._
+
+```yaml
+tunnel_name: "myHomeAssistant"
+```
+
 ### Option: `catch_all_service`
 
 If you want to forward all requests from any hostnames not defined in the
@@ -284,7 +286,7 @@ are able to access Home Assistant, see the
 
 ## Domain name and Cloudflare set up
 
-To use this plugin, you need a domain name that is using Cloudflare for its
+To use this add-on, you need a domain name that is using Cloudflare for its
 DNS entries.
 
 ### Domain name

cloudflared/config.yaml

@@ -32,4 +32,4 @@ schema:
   tunnel_token: str?
 slug: cloudflared
 url: https://github.com/brenner-tobias/addon-cloudflared/
-version: 4.0.0
+version: 4.0.1