diff --git a/README.md b/README.md index 4d854a5..a438d04 100644 --- a/README.md +++ b/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.1 -[addon-doc-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/blob/v4.0.1/README.md +[addon-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/tree/v4.0.2 +[addon-doc-cloudflared]: https://github.com/brenner-tobias/addon-cloudflared/blob/v4.0.2/README.md [cloudflared-issue]: https://github.com/brenner-tobias/addon-cloudflared/issues -[cloudflared-version-shield]: https://img.shields.io/badge/version-v4.0.1-blue.svg +[cloudflared-version-shield]: https://img.shields.io/badge/version-v4.0.2-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 diff --git a/cloudflared/CHANGELOG.md b/cloudflared/CHANGELOG.md index c027194..f4fcfdc 100644 --- a/cloudflared/CHANGELOG.md +++ b/cloudflared/CHANGELOG.md @@ -7,3 +7,7 @@ - Bump docker/setup-buildx-action from 2.2.0 to 2.2.1 @dependabot (#226) - â„šī¸ Update Cloudflared to version 2022.10.2 @github-actions (#227) + +## 📚 Documentation + +- Fix list of options in docs @AlecRust (#229) diff --git a/cloudflared/DOCS.md b/cloudflared/DOCS.md index fac6b8a..cc2f0ce 100644 --- a/cloudflared/DOCS.md +++ b/cloudflared/DOCS.md @@ -45,8 +45,8 @@ empty and set `additional_hosts` as [shown below](#configuration). authenticate with Cloudflare**. You need to copy a URL from the logs and visit it to authenticate. -A tunnel will now have been created and show up in your Cloudflare Teams -dashboard. Please review the additional configuration options listed below. +A tunnel should now be listed in your Cloudflare Teams dashboard. +Please review the additional configuration options below. ### Remote tunnel add-on setup (advanced setups only) @@ -62,16 +62,17 @@ Trust Dashboard and provide the token to the add-on. 1. Start the "Cloudflared" add-on, check the logs to see whether everything went as expected. -The tunnel you created should now be associated with the Cloudflared add-on. -The configuration options listed below are ignored when using a remote tunnel. +Your tunnel should now be associated with the Cloudflared add-on. Any +configuration changes should be made in the Cloudflare Teams dashboard. ## Configuration **These configuration options only apply to the local tunnel setup**. More -advanced configurations can be achieved using the remote tunnel setup. +advanced config can be achieved using the remote tunnel setup. -- [`tunnel_name`](#option-tunnel_name) +- [`external_hostname`](#option-external_hostname) - [`additional_hosts`](#option-additional_hosts) +- [`tunnel_name`](#option-tunnel_name) - [`catch_all_service`](#option-catch_all_service) - [`nginx_proxy_manager`](#option-nginx_proxy_manager) - [`log_level`](#option-log_level) diff --git a/cloudflared/config.yaml b/cloudflared/config.yaml index 9b2ba03..ebccc2c 100644 --- a/cloudflared/config.yaml +++ b/cloudflared/config.yaml @@ -32,4 +32,4 @@ schema: tunnel_token: str? slug: cloudflared url: https://github.com/brenner-tobias/addon-cloudflared/ -version: 4.0.1 +version: 4.0.2