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

docs(x): update smartproxy readme to yaml format #381

Merged
merged 1 commit into from
Mar 13, 2025
Merged

docs(x): update smartproxy readme to yaml format #381

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
95 changes: 39 additions & 56 deletions x/smart/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,21 @@

The **Smart Dialer** searches for a strategy that unblocks DNS and TLS for a given list of test domains. It takes a config describing multiple strategies to pick from.

## JSON config for the Smart Dialer

The config that the Smart Dialer takes is in a JSON format. Here is an example:

```json
{
"dns": [
{"system": {}},
{"https": {"name": "8.8.8.8"}},
{"https": {"name": "9.9.9.9"}}
],
"tls": [
"",
"split:2",
"tlsfrag:1"
]
}
## YAML config for the Smart Dialer

The config that the Smart Dialer takes is in a YAML format. Here is an example:

```yaml
dns:
- system: {}
- https:
name: 8.8.8.8
- https:
name: 9.9.9.9
tls:
- ""
- split:2
- tlsfrag:1
```

### DNS Configuration
Expand All @@ -33,53 +31,40 @@ The config that the Smart Dialer takes is in a JSON format. Here is an example:

#### DNS-over-HTTPS Resolver (DoH)

```json
{
"https": {
"name": "dns.google",
"address": "8.8.8.8"
}
}

```yaml
https:
name: dns.google
address: 8.8.8.8
```

* `name`: The domain name of the DoH server.
* `address`: The host:port of the DoH server. Defaults to `name`:443.

#### DNS-over-TLS Resolver (DoT)

```json
{
"tls": {
"name": "dns.google",
"address": "8.8.8.8"
}
}
```yaml
tls:
name: dns.google
address: 8.8.8.8
```

* `name`: The domain name of the DoT server.
* `address`: The host:port of the DoT server. Defaults to `name`:853.

#### UDP Resolver

```json
{
"udp": {
"address": "8.8.8.8"
}
}
```yaml
udp:
address: 8.8.8.8
```

* `address`: The host:port of the UDP resolver.

#### TCP Resolver

```json
{
"tcp": {
"address": "8.8.8.8"
}
}
```yaml
tcp:
address: 8.8.8.8
```

* `address`: The host:port of the TCP resolver.
Expand All @@ -103,18 +88,16 @@ finder := &smart.StrategyFinder{
}

configBytes := []byte(`
{
"dns": [
{"system": {}},
{"https": {"name": "8.8.8.8"}},
{"https": {"name": "9.9.9.9"}}
],
"tls": [
"",
"split:2",
"tlsfrag:1"
]
}
dns:
- system: {}
- https:
name: 8.8.8.8
- https:
name: 9.9.9.9
tls:
- ""
- split:2
- tlsfrag:1
`)

dialer, err := finder.NewDialer(context.Background(), []string{"www.google.com"}, configBytes)
Expand Down