Skip to content

Commit b205d47

Browse files
authored
Merge pull request #5 from sbldevnet/fix_binary_name
docs: correct binary name
2 parents 171ab72 + 5697964 commit b205d47

2 files changed

Lines changed: 13 additions & 13 deletions

File tree

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@ The binary can be downloaded from the [GitHub Releases](https://github.com/sblde
2020
Alternatively, you can build from source:
2121

2222
```bash
23-
go build -o cfproxy .
23+
go build -o cloudflared-proxy .
2424
```
2525

2626
## Usage
2727

2828
The primary command is `run`, which starts the reverse proxies.
2929

3030
```bash
31-
./cfproxy run [flags]
31+
./cloudflared-proxy run [flags]
3232
```
3333

3434
### Command-Line Flags
@@ -45,29 +45,29 @@ You can specify endpoints directly on the command line.
4545

4646
```bash
4747
# Proxy example.com to localhost:8888
48-
./cfproxy run -e example.com
48+
./cloudflared-proxy run -e example.com
4949

5050
# Proxy example.com to localhost:9000
51-
./cfproxy run -e 9000:example.com
51+
./cloudflared-proxy run -e 9000:example.com
5252

5353
# Proxy example.com:8443 to localhost:8888
54-
./cfproxy run -e example.com:8443
54+
./cloudflared-proxy run -e example.com:8443
5555

5656
# Proxy example.com:8443 to localhost:9000
57-
./cfproxy run -e 9000:example.com:8443
57+
./cloudflared-proxy run -e 9000:example.com:8443
5858

5959
# Proxy multiple endpoints
60-
./cfproxy run -e example1.com,9001:example2.com
60+
./cloudflared-proxy run -e example1.com,9001:example2.com
6161
# or
62-
./cfproxy run -e example1.com -e 9001:example2.com
62+
./cloudflared-proxy run -e example1.com -e 9001:example2.com
6363

6464
# Skip TLS verification
65-
./cfproxy run -e example.com --skip-tls
65+
./cloudflared-proxy run -e example.com --skip-tls
6666
```
6767

6868
### Configuration File
6969

70-
For a more persistent setup, you can use a configuration file. By default, `cfproxy` looks for a `config` file in `$HOME/.config/cloudflared-proxy/`. You can specify a different file with the `--config` or `-c` flag.
70+
For a more persistent setup, you can use a configuration file. By default, `cloudflared-proxy` looks for a `config` file in `$HOME/.config/cloudflared-proxy/`. You can specify a different file with the `--config` or `-c` flag.
7171

7272
**Example `config.yaml`:**
7373

@@ -85,12 +85,12 @@ proxies:
8585
With a configuration file, you can start the proxies with a simple command:
8686
8787
```bash
88-
./cfproxy run
88+
./cloudflared-proxy run
8989
```
9090

9191
Or with a custom config file path:
9292
```bash
93-
./cfproxy run -c /path/to/your/config.yaml
93+
./cloudflared-proxy run -c /path/to/your/config.yaml
9494
```
9595

9696
### Configuration Precedence

cmd/cmd.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import (
1616
func Execute() *cobra.Command {
1717

1818
cmd := &cobra.Command{
19-
Use: "cfproxy",
19+
Use: "cloudflared-proxy",
2020
Short: "A reverse proxy tool for Cloudflare Access applications.",
2121
}
2222

0 commit comments

Comments
 (0)