Skip to content

Conversation

@deadlypants1973
Copy link
Contributor

Summary

PCX-14143

Documentation checklist

  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@deadlypants1973 deadlypants1973 requested review from a team and ranbel as code owners March 26, 2025 15:59
@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Mar 26, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.


PR Change Summary

Updated documentation to include instructions for locally-managed tunnels alongside remotely-managed tunnels.

  • Expanded the section on updating cloudflared to include locally-managed tunnels.
  • Clarified the instructions for using Docker with cloudflared.
  • Updated links to reflect the changes in tunnel management.

Modified Files

  • src/content/docs/cloudflare-one/connections/connect-networks/downloads/update-cloudflared.mdx

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

What is Hyperlint?

Hyperlint is an AI agent that helps you write, edit, and maintain your documentation.

Learn more about the Hyperlint AI reviewer and the checks that we can run on your documentation.

## Remotely and locally-managed tunnels

To update `cloudflared` for a tunnel [created through the dashboard](/cloudflare-one/connections/connect-networks/get-started/create-remote-tunnel/):
To update `cloudflared` for a [remotely-managed tunnel](/cloudflare-one/connections/connect-networks/get-started/create-remote-tunnel/) created through the dashboard or a [locally-managed tunnel](/cloudflare-one/connections/connect-networks/do-more-with-tunnels/local-management/):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For locally-managed tunnels, the instructions below only apply if the tunnel runs as a service. https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/do-more-with-tunnels/local-management/as-a-service/

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we need to mention locally or remotely managed tunnels here. This is simply an instruction on how to update cloudflared, which is analogous for both.

Run the following command:

```sh
docker run cloudflare/cloudflared:latest tunnel --no-autoupdate run --token eyJhIjoiYTY3ZTE0ZGFhNWY4ZGNlZWI5MWZlNTQ0OWJhNDk2ZWIiLCJ0IjoiOGU2MTY3MWEtYjQ4ZS00OWI2LWI4OGUtZDNhOWU1NzQzYWIwIiwicyI6Ik5qUTFOR013TnpZdE5qVmxNUzAwWXprNExUZzJaVGd0TXpGalpERTBOelUxWkRBMSJ9
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add a step explaining how to find your tunnel token. For remotely-managed tunnels: https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/configure-tunnels/remote-tunnel-permissions/

Updates will cause `cloudflared` to restart which will impact traffic currently being served. You can perform zero-downtime upgrades by using Cloudflare's [Load Balancer product](/cloudflare-one/connections/connect-networks/downloads/update-cloudflared/#update-with-cloudflare-load-balancer) or by using [multiple `cloudflared` instances](/cloudflare-one/connections/connect-networks/downloads/update-cloudflared/#update-with-multiple-cloudflared-instances).

## Remotely-managed tunnels
## Remotely and locally-managed tunnels
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Remotely and locally-managed tunnels
## Update the cloudflared service

@cloudflare cloudflare deleted a comment from ranbel Mar 26, 2025
@cloudflare cloudflare deleted a comment from ranbel Mar 26, 2025
Run the following command:

```sh
docker run cloudflare/cloudflared:latest tunnel --no-autoupdate run --token <token>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To ensure the command runs with the latest cloudflared it needs to use the flag --pull always, so:
docker run --pull always cloudflare/cloudflared:latest tunnel --no-autoupdate run --token <token>
Otherwise, it might use an old image that is already available locally that is not the latest.

@deadlypants1973
Copy link
Contributor Author

#21410

@deadlypants1973 deadlypants1973 deleted the kate/fixes-localinstalltunnel branch May 15, 2025 11:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants