Skip to content

Commit d8cd818

Browse files
authored
[ZT] Move locally-managed tunnel docs (#20015)
* move local tunnels and clean up config folder * clean up IA * link to local tunnel config * add redirects * show remotely-managed tunnel info * move deployment guides out of config * fix broken links * fix more broken links * remove broken link * fix redirects
1 parent 5f3ed73 commit d8cd818

File tree

75 files changed

+511
-494
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+511
-494
lines changed

public/_redirects

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1700,7 +1700,7 @@
17001700
/cloudflare-one/applications/non-http/arbitrary-tcp/ /cloudflare-one/applications/non-http/cloudflared-authentication/arbitrary-tcp/ 301
17011701
/cloudflare-one/connections/connect-apps/configuration/ /cloudflare-one/connections/connect-networks/configure-tunnels/ 301
17021702
/cloudflare-one/connections/connect-apps/install-and-setup/setup/ /cloudflare-one/connections/connect-networks/get-started/ 301
1703-
/cloudflare-one/connections/connect-apps/run-tunnel/deploy-cloudflared-replicas/ /cloudflare-one/connections/connect-networks/deploy-tunnels/deploy-cloudflared-replicas/ 301
1703+
/cloudflare-one/connections/connect-apps/run-tunnel/deploy-cloudflared-replicas/ /cloudflare-one/connections/connect-networks/configure-tunnels/tunnel-availability/ 301
17041704
/cloudflare-one/connections/connect-apps/create-tunnel/ /cloudflare-one/connections/connect-networks/get-started/ 301
17051705
/cloudflare-one/connections/connect-apps/configuration/remote-management/ /cloudflare-one/connections/connect-networks/configure-tunnels/remote-management/ 301
17061706
/cloudflare-one/connections/connect-apps/run-tunnel/ /cloudflare-one/connections/connect-networks/get-started/create-local-tunnel/ 301
@@ -1719,8 +1719,8 @@
17191719
/cloudflare-one/connections/connect-apps/install-and-setup/tunnel-useful-commands/ /cloudflare-one/connections/connect-networks/configure-tunnels/local-management/tunnel-useful-commands/ 301
17201720
/cloudflare-one/connections/connect-apps/configuration/private-networks/ /cloudflare-one/connections/connect-networks/private-net/ 301
17211721
/cloudflare-one/connections/connect-apps/routing-to-tunnel/kubernetes/ /cloudflare-one/connections/connect-networks/deploy-tunnels/deployment-guides/kubernetes/ 301
1722-
/cloudflare-one/connections/connect-apps/configuration/ports-and-ips/ /cloudflare-one/connections/connect-networks/deploy-tunnels/tunnel-with-firewall/ 301
1723-
/cloudflare-one/connections/connect-apps/do-more-with-tunnels/ports-and-ips/ /cloudflare-one/connections/connect-networks/deploy-tunnels/tunnel-with-firewall/ 301
1722+
/cloudflare-one/connections/connect-apps/configuration/ports-and-ips/ /cloudflare-one/connections/connect-networks/configure-tunnels/tunnel-with-firewall/ 301
1723+
/cloudflare-one/connections/connect-apps/do-more-with-tunnels/ports-and-ips/ /cloudflare-one/connections/connect-networks/configure-tunnels/tunnel-with-firewall/ 301
17241724
/cloudflare-one/connections/connect-apps/run-tunnel/trycloudflare/ /cloudflare-one/connections/connect-networks/do-more-with-tunnels/trycloudflare/ 301
17251725
/cloudflare-one/connections/connect-apps/trycloudflare/ /cloudflare-one/connections/connect-networks/do-more-with-tunnels/trycloudflare/ 301
17261726
/cloudflare-one/connections/connect-apps/tunnel-monitoring/ /cloudflare-one/connections/connect-networks/monitor-tunnels/ 301
@@ -1736,13 +1736,13 @@
17361736
/cloudflare-one/connections/connect-networks/install-and-setup/tunnel-guide/local/local-management/arguments/ /cloudflare-one/connections/connect-networks/configure-tunnels/tunnel-run-parameters/ 301
17371737
/cloudflare-one/connections/connect-networks/install-and-setup/tunnel-guide/local/run-tunnel/ /cloudflare-one/connections/connect-networks/get-started/create-local-tunnel/ 301
17381738
/cloudflare-one/connections/connect-networks/install-and-setup/tunnel-guide/local/tunnel-useful-commands/ /cloudflare-one/connections/connect-networks/configure-tunnels/local-management/tunnel-useful-commands/ 301
1739-
/cloudflare-one/connections/connect-networks/install-and-setup/deploy-cloudflared-replicas/ /cloudflare-one/connections/connect-networks/deploy-tunnels/deploy-cloudflared-replicas/ 301
1739+
/cloudflare-one/connections/connect-networks/install-and-setup/deploy-cloudflared-replicas/ /cloudflare-one/connections/connect-networks/configure-tunnels/tunnel-availability/ 301
17401740
/cloudflare-one/connections/connect-networks/install-and-setup/tunnel-permissions/ /cloudflare-one/connections/connect-networks/configure-tunnels/local-management/tunnel-permissions/ 301
17411741
/cloudflare-one/connections/connect-networks/install-and-setup/installation /cloudflare-one/connections/connect-networks/downloads/update-cloudflared/ 307
17421742
/cloudflare-one/connections/connect-networks/deploy-tunnels/tunnel-permissions/ /cloudflare-one/connections/connect-networks/configure-tunnels/ 301
1743-
/cloudflare-one/connections/connect-networks/install-and-setup/ports-and-ips/ /cloudflare-one/connections/connect-networks/deploy-tunnels/tunnel-with-firewall/ 301
1743+
/cloudflare-one/connections/connect-networks/install-and-setup/ports-and-ips/ /cloudflare-one/connections/connect-networks/configure-tunnels/tunnel-with-firewall/ 301
17441744
/cloudflare-one/connections/connect-networks/install-and-setup/tunnel-useful-terms/ /cloudflare-one/connections/connect-networks/get-started/tunnel-useful-terms/ 301
1745-
/cloudflare-one/connections/connect-networks/do-more-with-tunnels/secure-server/ /cloudflare-one/connections/connect-networks/deploy-tunnels/tunnel-with-firewall/ 301
1745+
/cloudflare-one/connections/connect-networks/do-more-with-tunnels/secure-server/ /cloudflare-one/connections/connect-networks/configure-tunnels/tunnel-with-firewall/ 301
17461746
/cloudflare-one/connections/connect-networks/do-more-with-tunnels/grafana/ /cloudflare-one/connections/connect-networks/monitor-tunnels/grafana/ 301
17471747
/cloudflare-one/connections/connect-networks/downloads/system-requirements/ /cloudflare-one/connections/connect-networks/deploy-tunnels/system-requirements/ 301
17481748
/cloudflare-one/connections/connect-networks/private-net/connect-private-networks/ /cloudflare-one/connections/connect-networks/private-net/cloudflared/ 301
@@ -1761,6 +1761,14 @@
17611761
/cloudflare-one/connections/connect-devices/warp/user-side-certificates/install-cloudflare-cert/ /cloudflare-one/connections/connect-devices/warp/user-side-certificates/manual-deployment/ 301
17621762
/cloudflare-one/connections/connect-devices/warp/user-side-certificates/install-cert-with-warp/ /cloudflare-one/connections/connect-devices/warp/user-side-certificates/automated-deployment/ 301
17631763
/cloudflare-one/connections/connect-networks/locations/ /cloudflare-one/connections/connect-devices/agentless/dns/locations/ 301
1764+
/cloudflare-one/connections/connect-networks/get-started/create-local-tunnel/ /cloudflare-one/connections/connect-networks/do-more-with-tunnels/local-management/create-local-tunnel/ 301
1765+
/cloudflare-one/connections/connect-networks/configure-tunnels/remote-management/ /cloudflare-one/connections/connect-networks/configure-tunnels/cloudflared-parameters/ 301
1766+
/cloudflare-one/connections/connect-networks/configure-tunnels/origin-configuration/ /cloudflare-one/connections/connect-networks/configure-tunnels/cloudflared-parameters/origin-parameters/ 301
1767+
/cloudflare-one/connections/connect-networks/configure-tunnels/tunnel-run-parameters/ /cloudflare-one/connections/connect-networks/configure-tunnels/cloudflared-parameters/run-parameters/ 301
1768+
/cloudflare-one/connections/connect-networks/deploy-tunnels/system-requirements/ /cloudflare-one/connections/connect-networks/configure-tunnels/tunnel-availability/system-requirements/ 301
1769+
/cloudflare-one/connections/connect-networks/deploy-tunnels/deploy-cloudflared-replicas/ /cloudflare-one/connections/connect-networks/configure-tunnels/tunnel-availability/ 301
1770+
/cloudflare-one/connections/connect-networks/deploy-tunnels/tunnel-with-firewall/ /cloudflare-one/connections/connect-networks/configure-tunnels/tunnel-with-firewall/ 301
1771+
/cloudflare-one/connections/connect-networks/deploy-tunnels/ /cloudflare-one/connections/connect-networks/get-started/ 301
17641772
/cloudflare-one/connections/connect-networks/monitor-tunnels/grafana/ /cloudflare-one/tutorials/grafana/ 301
17651773
/cloudflare-one/connections/connect-networks/use-cases/kubectl/ /cloudflare-one/tutorials/many-cfd-one-tunnel/ 301
17661774
/cloudflare-one/connections/connect-networks/use_cases/ssh/ /cloudflare-one/connections/connect-networks/use-cases/ssh/ 301
@@ -1885,8 +1893,9 @@
18851893

18861894
# Cloudflare One / Zero Trust
18871895
/cloudflare-one/connections/connect-networks/install-and-setup/tunnel-guide/local/as-a-service/* /cloudflare-one/connections/connect-networks/configure-tunnels/local-management/as-a-service/:splat 301
1888-
/cloudflare-one/connections/connect-apps/install-and-setup/deployment-guides/* /cloudflare-one/connections/connect-networks/deploy-tunnels/deployment-guides/:splat 301
1889-
/cloudflare-one/connections/connect-networks/deployment-guides/* /cloudflare-one/connections/connect-networks/deploy-tunnels/deployment-guides/:splat 301
1896+
/cloudflare-one/connections/connect-apps/install-and-setup/deployment-guides/* /cloudflare-one/connections/connect-networks/deployment-guides/:splat 301
1897+
/cloudflare-one/connections/connect-networks/deploy-tunnels/deployment-guides/* /cloudflare-one/connections/connect-networks/deployment-guides/:splat 301
1898+
/cloudflare-one/connections/connect-networks/configure-tunnels/local-management/* /cloudflare-one/connections/connect-networks/do-more-with-tunnels/local-management/:splat 301
18901899
/cloudflare-one/analytics/logs/* /cloudflare-one/insights/logs/:splat 301
18911900
/cloudflare-one/applications/scan-apps/* /cloudflare-one/applications/casb/:splat 301
18921901
/cloudflare-one/connections/connect-apps/use_cases/* /cloudflare-one/connections/connect-networks/use-cases/:splat 301
Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
---
2+
pcx_content_type: how-to
3+
title: Configure cloudflared parameters
4+
sidebar:
5+
order: 1
6+
---
7+
8+
import { TabItem, Tabs, Render } from "~/components";
9+
10+
Remotely-managed tunnels run as a service on your OS. You can modify the Cloudflare Tunnel service with one or more [general-purpose tunnel parameters](/cloudflare-one/connections/connect-networks/configure-tunnels/cloudflared-parameters/run-parameters/).
11+
12+
:::note
13+
For instructions on configuring a locally-managed tunnel, refer to the [configuration file documentation](/cloudflare-one/connections/connect-networks/do-more-with-tunnels/local-management/configuration-file/).
14+
:::
15+
16+
## Update tunnel run parameters
17+
18+
<Tabs> <TabItem label="Linux">
19+
20+
On Linux, Cloudflare Tunnel installs itself as a system service using `systemctl`. By default, the service will be named `cloudflared.service`. To configure your tunnel on Linux:
21+
22+
1. Open `cloudflared.service`.
23+
24+
```sh
25+
sudo systemctl edit --full cloudflared.service
26+
```
27+
28+
2. Modify the `cloudflared tunnel run` command with the desired configuration flag. For example,
29+
30+
```txt null {8}
31+
[Unit]
32+
Description=Cloudflare Tunnel
33+
After=network.target
34+
35+
[Service]
36+
TimeoutStartSec=0
37+
Type=notify
38+
ExecStart=/usr/local/bin/cloudflared tunnel --loglevel debug --logfile /var/log/cloudflared/cloudflared.log run --token <TOKEN VALUE>
39+
Restart=on-failure
40+
RestartSec=5s
41+
42+
[Install]
43+
WantedBy=multi-user.target
44+
```
45+
46+
3. Restart `cloudflared.service`:
47+
48+
```sh
49+
sudo systemctl restart cloudflared
50+
```
51+
52+
4. To verify the new configuration, check the service status:
53+
54+
```sh
55+
sudo systemctl status cloudflared
56+
```
57+
```sh output
58+
● cloudflared.service - cloudflared
59+
Loaded: loaded (/etc/systemd/system/cloudflared.service; enabled; preset: enabled)
60+
Active: active (running) since Wed 2024-10-09 20:02:59 UTC; 2s ago
61+
Main PID: 2157 (cloudflared)
62+
Tasks: 8 (limit: 1136)
63+
Memory: 16.3M
64+
CPU: 136ms
65+
CGroup: /system.slice/cloudflared.service
66+
└─2157 /usr/bin/cloudflared tunnel --loglevel debug --logfile /var/log/cloudflared/cloudflared.log run --token eyJhIjoi...
67+
```
68+
69+
</TabItem> <TabItem label="macOS">
70+
71+
On macOS, Cloudflare Tunnel installs itself as a launch agent using `launchctl`. By default, the agent will be called `com.cloudflare.cloudflared`. To configure your tunnel on macOS:
72+
73+
1. Stop the `cloudflared` service.
74+
75+
```sh
76+
sudo launchctl stop com.cloudflare.cloudflared
77+
```
78+
79+
2. Unload the configuration file.
80+
81+
```sh
82+
sudo launchctl unload /Library/LaunchDaemons/com.cloudflare.cloudflared.plist
83+
```
84+
85+
3. Open `/Library/LaunchDaemons/com.cloudflare.cloudflared.plist` in a text editor.
86+
87+
4. Modify the `ProgramArguments` key with the desired configuration flag. For example,
88+
89+
```txt
90+
<plist version="1.0">
91+
<dict>
92+
<key>Label</key>
93+
<string>com.cloudflare.cloudflared</string>
94+
<key>ProgramArguments</key>
95+
<array>
96+
<string>/opt/homebrew/bin/cloudflared</string>
97+
<string>tunnel</string>
98+
<string>--logfile</string>
99+
<string><PATH></string>
100+
<string>--loglevel</string>
101+
<string>debug</string>
102+
<string>run</string>
103+
<string>--token</string>
104+
<string><TOKEN VALUE> </string>
105+
</array>
106+
```
107+
108+
5. Load the updated configuration file.
109+
110+
```sh
111+
sudo launchctl load /Library/LaunchDaemons/com.cloudflare.cloudflared.plist
112+
```
113+
114+
6. Start the `cloudflared` service.
115+
116+
```sh
117+
sudo launchctl start com.cloudflare.cloudflared
118+
```
119+
120+
</TabItem> <TabItem label="Windows">
121+
122+
On Windows, Cloudflare Tunnel installs itself as a system service using the Registry Editor. By default, the service will be named `cloudflared`. To configure your tunnel on Windows:
123+
124+
1. Open the Registry Editor.
125+
126+
2. Go to **HKEY_LOCAL_MACHINE** > **SYSTEM** > **CurrentControlSet** > **Services** > **cloudflared**.
127+
128+
3. Double-click **ImagePath**.
129+
130+
4. Modify **Value data** with the desired configuration flag. For example,
131+
132+
```txt
133+
C:\Program Files (x86)\cloudflared\.\cloudflared.exe tunnel --loglevel debug --logfile <PATH> run --token <TOKEN VALUE>
134+
```
135+
136+
![Modify cloudflared service in the Registry Editor](~/assets/images/cloudflare-one/connections/connect-apps/remote-management-windows.png)
137+
138+
</TabItem> </Tabs>
139+
140+
141+
## Update origin configuration
142+
143+
To configure how `cloudflared` sends requests to your [public hostname](/cloudflare-one/connections/connect-networks/routing-to-tunnel/) services:
144+
145+
1. In [Zero Trust](https://one.dash.cloudflare.com/), go to **Networks** > **Tunnels**.
146+
2. Choose a tunnel and select **Configure**.
147+
3. Select the **Public Hostname** tab.
148+
4. Choose a route and select **Edit**.
149+
5. Under **Additional application settings**, modify one or more [origin configuration parameters](/cloudflare-one/connections/connect-networks/configure-tunnels/cloudflared-parameters/origin-parameters/).
150+
6. Select **Save hostname**.

src/content/docs/cloudflare-one/connections/connect-networks/configure-tunnels/origin-configuration.mdx renamed to src/content/docs/cloudflare-one/connections/connect-networks/configure-tunnels/cloudflared-parameters/origin-parameters.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
pcx_content_type: reference
3-
title: Origin configuration
3+
title: Origin configuration parameters
44
sidebar:
5-
order: 3
5+
order: 9
66

77
---
88

9-
Origin configuration parameters determine how `cloudflared` proxies traffic to your origin server. You can configure these settings [in the dashboard](/cloudflare-one/connections/connect-networks/configure-tunnels/remote-management/#update-origin-configuration) for remotely-managed tunnels, or add them to your [configuration file](/cloudflare-one/connections/connect-networks/configure-tunnels/local-management/configuration-file/#origin-configuration) for locally-managed tunnels.
9+
Origin configuration parameters determine how `cloudflared` proxies traffic to your origin server. If you are using remotely-managed tunnels (default), configure these settings [using the dashboard or API](/cloudflare-one/connections/connect-networks/configure-tunnels/cloudflared-parameters/#update-origin-configuration). If you are using [locally-managed tunnels](/cloudflare-one/connections/connect-networks/do-more-with-tunnels/local-management/), add these parameters to your [configuration file](/cloudflare-one/connections/connect-networks/do-more-with-tunnels/local-management/configuration-file/).
1010

1111
## TLS settings
1212

@@ -111,7 +111,7 @@ This configures what type of proxy will be started. Valid options are:
111111

112112
:::note
113113

114-
For locally-managed tunnels only.
114+
For locally-managed tunnels only.
115115
:::
116116

117117
| Default | UI name |
@@ -125,7 +125,7 @@ This configures the listen address for that proxy.
125125

126126
:::note
127127

128-
For locally-managed tunnels only.
128+
For locally-managed tunnels only.
129129
:::
130130

131131
| Default | UI name |
@@ -173,7 +173,7 @@ The timeout after which a TCP keepalive packet is sent on a connection between C
173173

174174
Requires `cloudflared` to validate the [Cloudflare Access JWT](/cloudflare-one/identity/authorization-cookie/validating-json/) prior to proxying traffic to your origin. You can enforce this check on public hostname routes that are protected by an Access application. For all L7 requests to these hostnames, Access will send the JWT to `cloudflared` as a `Cf-Access-Jwt-Assertion` request header.
175175

176-
To enable this security control in a [configuration file](/cloudflare-one/connections/connect-networks/configure-tunnels/local-management/configuration-file/#origin-configuration), [get the AUD tag](/cloudflare-one/identity/authorization-cookie/validating-json/#get-your-aud-tag) for your Access application and add the following rule to `originRequest`:
176+
To enable this security control in a [configuration file](/cloudflare-one/connections/connect-networks/do-more-with-tunnels/local-management/configuration-file/#origin-configuration), [get the AUD tag](/cloudflare-one/identity/authorization-cookie/validating-json/#get-your-aud-tag) for your Access application and add the following rule to `originRequest`:
177177

178178
```yml
179179
access:
Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ sidebar:
66

77
---
88

9-
This page lists general-purpose configuration options for a Cloudflare Tunnel. You can add these flags to the `cloudflared tunnel run` command for [remotely-managed](/cloudflare-one/connections/connect-networks/configure-tunnels/remote-management/) and [locally-managed](/cloudflare-one/connections/connect-networks/configure-tunnels/local-management/) tunnels. These flags can also be added as key/value pairs to your [configuration file](/cloudflare-one/connections/connect-networks/configure-tunnels/local-management/).
9+
This page lists general-purpose configuration options that you can [add](/cloudflare-one/connections/connect-networks/configure-tunnels/cloudflared-parameters/#update-tunnel-run-parameters) to the `cloudflared tunnel run` command.
10+
11+
Alternatively, if you are running a [locally-managed tunnel](/cloudflare-one/connections/connect-networks/do-more-with-tunnels/local-management/) you can add these flags to your [configuration file](/cloudflare-one/connections/connect-networks/do-more-with-tunnels/local-management/configuration-file/) as key/value pairs.
1012

1113
## `autoupdate-freq`
1214

@@ -29,7 +31,7 @@ For locally-managed tunnels only.
2931
| ------------------------------------------------------- | --------------------------- |
3032
| `cloudflared tunnel --config <PATH> run <UUID or NAME>` | `~/.cloudflared/config.yml` |
3133

32-
Specifies the path to a [configuration file](/cloudflare-one/connections/connect-networks/configure-tunnels/local-management/configuration-file/) in YAML format.
34+
Specifies the path to a [configuration file](/cloudflare-one/connections/connect-networks/do-more-with-tunnels/local-management/configuration-file/) in YAML format.
3335

3436
## `edge-bind-address`
3537

@@ -104,7 +106,7 @@ For locally-managed tunnels only.
104106
| ----------------------------------------------------------- | ------------------------- | -------------------- |
105107
| `cloudflared tunnel --origincert <PATH> run <UUID or NAME>` | `~/.cloudflared/cert.pem` | `TUNNEL_ORIGIN_CERT` |
106108

107-
Specifies the [account certificate](/cloudflare-one/connections/connect-networks/configure-tunnels/local-management/tunnel-permissions/) for one of your zones, authorizing the client to serve as an origin for that zone. You can obtain a certificate by using the `cloudflared tunnel login` command or by visiting `https://dash.cloudflare.com/argotunnel`.
109+
Specifies the [account certificate](/cloudflare-one/connections/connect-networks/do-more-with-tunnels/local-management/tunnel-permissions/) for one of your zones, authorizing the client to serve as an origin for that zone. You can obtain a certificate by using the `cloudflared tunnel login` command or by visiting `https://dash.cloudflare.com/argotunnel`.
108110

109111
## `pidfile`
110112

src/content/docs/cloudflare-one/connections/connect-networks/configure-tunnels/index.mdx

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,6 @@ title: Configure a tunnel
33
pcx_content_type: navigation
44
sidebar:
55
order: 3
6-
6+
group:
7+
hideIndex: true
78
---
8-
9-
import { DirectoryListing } from "~/components"
10-
11-
<DirectoryListing />

0 commit comments

Comments
 (0)