Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md with docs on how to properly use the cloudflare tunnel. #55

Closed
wants to merge 3 commits into from
Closed

Update README.md with docs on how to properly use the cloudflare tunnel. #55

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4ac8b0b
Update README.md
devantler Sep 13, 2023
3a3ea30
Update README.md
devantler Sep 13, 2023
d1223e7
Update README.md
devantler Sep 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,48 @@ helm repo update
helm search repo cloudflare
```

### Usage

#### Cloudflare Tunnel

> [!NOTE]
> To get the cloudflare tunnel secret you need to decrypt your cloudflare tunnel token.
>
> ```bash
> echo "ey..." | base64 -d
> ```
>
> The decoded token should be a JSON object like
>
> ```json
> {"a": "<account-id>", "t": "<tunnel-id>", "s": "<tunnel-secret>"}
> ```
>
> Remember the value of the tunnel-secret!


If you are using the Cloudflare Tunnel without an existing secret you have to set the following values:

```yaml
cloudflare:
account: <your-cloudflare-account-id>
tunnelName: <your-cloudflare-tunnel-name>
tunnelId: <your-cloudflare-tunnel-id>
secret: <your-cloudflare-tunnel-secret>
```

If you are using the Cloudflare Tunnel with an existing secret you have to set the following values:

```yaml
cloudflare:
tunnelName: <your-cloudflare-tunnel-name>
secretName: <your-existing-cloudflare-tunnel-secret> # It must be created in the namespace that your are deploying your cloudflare-tunnel in.
```

#### Cloudflare Tunnel Remote

Docs are coming soon...

### Contents

- `charts/cloudflare-tunnel`: Helm 3 chart using cloudflared best practices