update
This commit is contained in:
@@ -1,12 +1,8 @@
|
|||||||
## What’s changed
|
## What’s changed
|
||||||
|
|
||||||
## 🚨 Announcement
|
|
||||||
**This will be the last version to support armhf & i386 architecture.**
|
|
||||||
All Home Assistant Community Add-ons are dropping or have already dropped support for armhf & i386, additionally it is expected that Home Assistant will drop support as well in the upcoming months.
|
|
||||||
Taking into account the very low number of downloads for those architectures, we will follow the general direction that HA and the Community Add-ons are going and drop support as well.
|
|
||||||
|
|
||||||
## ⬆️ Dependency updates
|
## ⬆️ Dependency updates
|
||||||
|
|
||||||
- ⬆️ Update Add-on base image to v14.3.3 @renovate (#531)
|
- ⬆️ Update docker/build-push-action action to v6.8.0 @renovate (#707)
|
||||||
- ⬆️ Update Add-on base image to v15 (major) @renovate (#535)
|
- ⬆️ Update frenck/action-addon-linter action to v2.17 @renovate (#708)
|
||||||
- ⬆️ Update Add-on base image to v15.0.1 @renovate (#537)
|
- ⬆️ Update docker/build-push-action action to v6.9.0 @renovate (#709)
|
||||||
|
- ⬆️ Update Add-on base image to v16.3.2 @renovate (#710)
|
||||||
|
- ⬆️ Update docker/setup-buildx-action action to v3.7.0 @renovate (#711)
|
||||||
|
|||||||
+63
-16
@@ -18,6 +18,8 @@ add-on.
|
|||||||
|
|
||||||
1. A domain name (e.g. example.com) using Cloudflare for DNS. If you don't have
|
1. A domain name (e.g. example.com) using Cloudflare for DNS. If you don't have
|
||||||
one see [Domain name and Cloudflare set up][how-tos].
|
one see [Domain name and Cloudflare set up][how-tos].
|
||||||
|
Please be aware that domains from **Freenom** do not work anymore, so you
|
||||||
|
have to chose / migrate to another registrar.
|
||||||
1. Decide between a local tunnel (managed by the add-on) or a remote tunnel
|
1. Decide between a local tunnel (managed by the add-on) or a remote tunnel
|
||||||
(managed in Cloudflare's interface). [Learn more][addon-remote-or-local].
|
(managed in Cloudflare's interface). [Learn more][addon-remote-or-local].
|
||||||
1. This add-on should be [installed][addon-installation] but not started yet.
|
1. This add-on should be [installed][addon-installation] but not started yet.
|
||||||
@@ -75,6 +77,8 @@ advanced config can be achieved using the remote tunnel setup.
|
|||||||
- [`tunnel_name`](#option-tunnel_name)
|
- [`tunnel_name`](#option-tunnel_name)
|
||||||
- [`catch_all_service`](#option-catch_all_service)
|
- [`catch_all_service`](#option-catch_all_service)
|
||||||
- [`nginx_proxy_manager`](#option-nginx_proxy_manager)
|
- [`nginx_proxy_manager`](#option-nginx_proxy_manager)
|
||||||
|
- [`post_quantum`](#option-post_quantum)
|
||||||
|
- [`run_parameters`](#option-run_parameters)
|
||||||
- [`log_level`](#option-log_level)
|
- [`log_level`](#option-log_level)
|
||||||
|
|
||||||
### Overview: Add-on configuration
|
### Overview: Add-on configuration
|
||||||
@@ -150,20 +154,6 @@ than the default of `homeassistant`.
|
|||||||
tunnel_name: myHomeAssistant
|
tunnel_name: myHomeAssistant
|
||||||
```
|
```
|
||||||
|
|
||||||
### Option: `post_quantum`
|
|
||||||
|
|
||||||
If you want Cloudflared to use post-quantum cryptography for the tunnel,
|
|
||||||
set this flag.
|
|
||||||
|
|
||||||
**Note**: _When `post_quantum` is set, cloudflared restricts itself to QUIC
|
|
||||||
transport for the tunnel connection. This might lead to problems for some users.
|
|
||||||
Also, it will only allow post-quantum hybrid key exchanges and not fall back to
|
|
||||||
a non post-quantum connection._
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
post_quantum: true
|
|
||||||
```
|
|
||||||
|
|
||||||
### Option: `catch_all_service`
|
### Option: `catch_all_service`
|
||||||
|
|
||||||
If you want to forward all requests from any hostnames not defined in the
|
If you want to forward all requests from any hostnames not defined in the
|
||||||
@@ -218,12 +208,66 @@ in Cloudflare by adding a CNAME record with `*` as name.
|
|||||||
Finally, you have to set-up your proxy hosts in Nginx Proxy Manager and forward
|
Finally, you have to set-up your proxy hosts in Nginx Proxy Manager and forward
|
||||||
them to wherever you like.
|
them to wherever you like.
|
||||||
|
|
||||||
|
### Option: `post_quantum`
|
||||||
|
|
||||||
|
If you want Cloudflared to use post-quantum cryptography for the tunnel,
|
||||||
|
set this flag.
|
||||||
|
|
||||||
|
**Note**: _When `post_quantum` is set, cloudflared restricts itself to QUIC
|
||||||
|
transport for the tunnel connection. This might lead to problems for some users.
|
||||||
|
Also, it will only allow post-quantum hybrid key exchanges and not fall back to
|
||||||
|
a non post-quantum connection._
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
post_quantum: true
|
||||||
|
```
|
||||||
|
|
||||||
|
### Option: `run_parameters`
|
||||||
|
|
||||||
|
You can add additional run parameters to the cloudflared demon using this
|
||||||
|
parameter. Check the [Cloudflare documentation][cloudflare-run_parameter]
|
||||||
|
for all available parameters and their explanation.
|
||||||
|
|
||||||
|
Valid parameters to add are:
|
||||||
|
|
||||||
|
- --edge-bind-address
|
||||||
|
- --edge-ip-version
|
||||||
|
- --grace-period
|
||||||
|
- --logfile
|
||||||
|
- --loglevel
|
||||||
|
- --pidfile
|
||||||
|
- --protocol
|
||||||
|
- --region
|
||||||
|
- --retries
|
||||||
|
- --tag
|
||||||
|
- --ha-connections
|
||||||
|
|
||||||
|
**Note**: _These parameters are added to the by default present parameters
|
||||||
|
"no-autoupdate", "metrics" and "loglevel". Additionally, for a locally managed
|
||||||
|
tunnel "origincert" and "config" are added while "token" is added
|
||||||
|
for remote managed tunnels. You cannot override these parameters with this
|
||||||
|
option._
|
||||||
|
|
||||||
|
**Note**: _If you are using an option that requires a path, you can use /config
|
||||||
|
as root. This path can be accessed, for example, via the VS-code add-on via
|
||||||
|
/addon_configs._
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
run_parameters:
|
||||||
|
- "--region=us"
|
||||||
|
- "--protocol=http2"
|
||||||
|
- "--loglevel=debug"
|
||||||
|
```
|
||||||
|
|
||||||
### Option: `log_level`
|
### Option: `log_level`
|
||||||
|
|
||||||
The `log_level` option controls the level of log output by the addon and can
|
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
|
be changed to be more or less verbose, which might be useful when you are
|
||||||
dealing with an unknown issue.
|
dealing with an unknown issue.
|
||||||
|
|
||||||
|
**Note**: _If you want to change the log level of the tunnel itself you can
|
||||||
|
use the `run_parameters` `--loglevel` option._
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
log_level: debug
|
log_level: debug
|
||||||
```
|
```
|
||||||
@@ -268,18 +312,21 @@ If you need assistance changing the config, please follow the
|
|||||||
|
|
||||||
## Add-On Wiki
|
## Add-On Wiki
|
||||||
|
|
||||||
For more advance [How-Tos][how-tos] and a [Troubleshooting Section](troubleshooting),
|
For more advance [How-Tos][how-tos] and a [Troubleshooting Section][troubleshooting],
|
||||||
please visit the [Add-On Wiki on GitHub][addon-wiki].
|
please visit the [Add-On Wiki on GitHub][addon-wiki].
|
||||||
|
|
||||||
## Authors & contributors
|
## Authors & contributors
|
||||||
|
|
||||||
The original setup of this repository is by [Tobias Brenner][tobias].
|
The original setup of this repository is by [Tobias Brenner][tobias].
|
||||||
|
|
||||||
|
For a full list of all authors and contributors,
|
||||||
|
check [the contributor's page][contributors].
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
MIT License
|
MIT License
|
||||||
|
|
||||||
Copyright (c) 2023 Tobias Brenner
|
Copyright (c) 2024 Tobias Brenner
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
|||||||
@@ -3,6 +3,7 @@
|
|||||||
[![GitHub Release][releases-shield]][releases]
|
[![GitHub Release][releases-shield]][releases]
|
||||||
![Project Stage][project-stage-shield]
|
![Project Stage][project-stage-shield]
|
||||||
![Project Maintenance][maintenance-shield]
|
![Project Maintenance][maintenance-shield]
|
||||||
|
![Reported Installations][installations-shield-stable]
|
||||||
|
|
||||||
Connect remotely to your Home Assistant instance without opening any ports using
|
Connect remotely to your Home Assistant instance without opening any ports using
|
||||||
Cloudflared.
|
Cloudflared.
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
name: Cloudflared
|
name: Cloudflared
|
||||||
version: 4.2.12
|
version: 5.1.21
|
||||||
slug: cloudflared
|
slug: cloudflared
|
||||||
description: Use a Cloudflare Tunnel to remotely connect to Home Assistant without
|
description: Use a Cloudflare Tunnel to remotely connect to Home Assistant without
|
||||||
opening any ports
|
opening any ports
|
||||||
@@ -11,9 +11,9 @@ hassio_role: homeassistant
|
|||||||
arch:
|
arch:
|
||||||
- aarch64
|
- aarch64
|
||||||
- amd64
|
- amd64
|
||||||
- armhf
|
|
||||||
- armv7
|
- armv7
|
||||||
- i386
|
map:
|
||||||
|
- addon_config:rw
|
||||||
options:
|
options:
|
||||||
external_hostname: ''
|
external_hostname: ''
|
||||||
additional_hosts: []
|
additional_hosts: []
|
||||||
@@ -24,9 +24,11 @@ schema:
|
|||||||
service: str
|
service: str
|
||||||
disableChunkedEncoding: bool?
|
disableChunkedEncoding: bool?
|
||||||
tunnel_name: str?
|
tunnel_name: str?
|
||||||
tunnel_token: str?
|
|
||||||
post_quantum: bool?
|
|
||||||
catch_all_service: str?
|
catch_all_service: str?
|
||||||
nginx_proxy_manager: bool?
|
nginx_proxy_manager: bool?
|
||||||
|
tunnel_token: str?
|
||||||
|
post_quantum: bool?
|
||||||
|
run_parameters:
|
||||||
|
- match(^(--edge-bind-address|--edge-ip-version|--grace-period|--ha-connections|--logfile|--loglevel|--pidfile|--protocol|--region|--retries|--tag)=.*$)?
|
||||||
log_level: list(trace|debug|info|notice|warning|error|fatal)?
|
log_level: list(trace|debug|info|notice|warning|error|fatal)?
|
||||||
image: ghcr.io/brenner-tobias/cloudflared/{arch}
|
image: ghcr.io/brenner-tobias/cloudflared/{arch}
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ configuration:
|
|||||||
log_level:
|
log_level:
|
||||||
name: Log Level
|
name: Log Level
|
||||||
description: >-
|
description: >-
|
||||||
Defines the log level for add-on and the Cloudflare service.
|
Defines the log level for the add-on.
|
||||||
external_hostname:
|
external_hostname:
|
||||||
name: External Home Assistant Hostname
|
name: External Home Assistant Hostname
|
||||||
description: >-
|
description: >-
|
||||||
@@ -23,8 +23,12 @@ configuration:
|
|||||||
name: Use Post-Quantum Cryptography
|
name: Use Post-Quantum Cryptography
|
||||||
description: >-
|
description: >-
|
||||||
Check to make the tunnel use Post-Quantum Cryptography. Warning: This
|
Check to make the tunnel use Post-Quantum Cryptography. Warning: This
|
||||||
will also restricts the tunnel to QUIC, which might lead to problems
|
also restricts the tunnel to QUIC, which might lead to problems
|
||||||
for some users.
|
for some users.
|
||||||
|
run_parameters:
|
||||||
|
name: Add run parameters
|
||||||
|
description: >-
|
||||||
|
Possibility to add run parameters to Cloudflared
|
||||||
catch_all_service:
|
catch_all_service:
|
||||||
name: Catch-All Service
|
name: Catch-All Service
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
Reference in New Issue
Block a user