Skip to content

Commit 88531d7

Browse files
sjmiller609sjmiller609
committed
Clean up docs
1 parent f415ff0 commit 88531d7

File tree

5 files changed

+28
-41
lines changed

5 files changed

+28
-41
lines changed

‎proxies/custom.mdx‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,13 @@ title: "Custom Proxies"
44

55
Custom proxies allow you to use your own proxy servers with Kernel browsers. This is useful when you have existing proxy infrastructure or specific proxy requirements not covered by Kernel's managed options.
66

7-
87
## Configuration
98

109
<Note>
1110
Currently, only HTTPS proxies are supported for custom proxy configurations.
1211
</Note>
1312

14-
| Parameter | Required | Description |
15-
|-----------|----------|-------------|
16-
| `host` | Yes | Proxy server hostname or IP address (max 253 characters) |
17-
| `port` | Yes | Proxy server port (1-65535) |
18-
| `username` | No | Username for proxy authentication (max 128 characters, alphanumeric plus `_`, `-`, `@`, `.`) |
19-
| `password` | No | Password for proxy authentication (5-128 characters, no whitespace or escape characters) |
20-
13+
Specify the host, port, and optional authentication credentials for your proxy server:
2114

2215
<CodeGroup>
2316

@@ -63,6 +56,12 @@ browser = client.browsers.create(
6356

6457
</CodeGroup>
6558

59+
## Configuration Parameters
60+
61+
- **`host`** (required) - Proxy server hostname or IP address
62+
- **`port`** (required) - Proxy server port (1-65535)
63+
- **`username`** - Username for proxy authentication
64+
- **`password`** - Password for proxy authentication (minimum 5 characters)
6665

6766
<Note>
6867
When creating a proxy with authentication, provide the password. The API response will only indicate if a password exists (`has_password: true`) but won't return the actual password for security reasons.

‎proxies/datacenter.mdx‎

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Datacenter proxies route traffic through commercial data center servers. While t
66

77
## Configuration
88

9+
Datacenter proxies require a country to route traffic through:
10+
911
<CodeGroup>
1012

1113
```typescript Typescript/Javascript
@@ -46,10 +48,4 @@ browser = client.browsers.create(
4648

4749
## Configuration Parameters
4850

49-
| Parameter | Required | Description |
50-
|-----------|----------|-------------|
51-
| `country` | Yes | ISO 3166 country code |
52-
53-
## Supported Countries
54-
55-
Use ISO 3166 country codes (e.g., `US`, `GB`, `FR`) or `EU` for European Union exit nodes.
51+
- **`country`** (required) - ISO 3166 country code (e.g., `US`, `GB`, `FR`) or `EU` for European Union exit nodes

‎proxies/isp.mdx‎

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ ISP (Internet Service Provider) proxies combine the speed of datacenter proxies
66

77
## Configuration
88

9+
ISP proxies require a country to route traffic through:
10+
911
<CodeGroup>
1012

1113
```typescript Typescript/Javascript
@@ -46,10 +48,4 @@ browser = client.browsers.create(
4648

4749
## Configuration Parameters
4850

49-
| Parameter | Required | Description |
50-
|-----------|----------|-------------|
51-
| `country` | Yes | ISO 3166 country code |
52-
53-
## Supported Countries
54-
55-
Use ISO 3166 country codes (e.g., `US`, `GB`, `FR`) or `EU` for European Union exit nodes.
51+
- **`country`** (required) - ISO 3166 country code (e.g., `US`, `GB`, `DE`) or `EU` for European Union exit nodes

‎proxies/mobile.mdx‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ title: "Mobile Proxies"
44

55
Mobile proxies route traffic through mobile carrier networks, providing the highest level of trust and the best bot detection avoidance. They use IP addresses from real mobile devices on cellular networks.
66

7-
## Configuration Options
7+
## Configuration
88

9-
Mobile proxies support carrier selection and advanced targeting:
9+
Mobile proxies support carrier selection and advanced targeting options:
1010

1111
<CodeGroup>
1212

@@ -54,14 +54,12 @@ browser = client.browsers.create(
5454

5555
## Configuration Parameters
5656

57-
| Parameter | Required | Description |
58-
|-----------|----------|-------------|
59-
| `country` | No | ISO 3166 country code (e.g., `US`, `GB`) |
60-
| `carrier` | No | Mobile carrier name (e.g., `verizon`, `att`) |
61-
| `state` | No | Two-letter state code (e.g., `NY`, `CA`). Only supported for US and Australia. **Cannot be used with `city`**. |
62-
| `city` | No | City name (lowercase letters only, no spaces, e.g., `newyork`, `losangeles`). Required if `zip` is provided. |
63-
| `zip` | No | US ZIP code (5 digits only, e.g., `10001`). **Requires `city` to be provided**. |
64-
| `asn` | No | Autonomous System Number (e.g., `AS15169`, `15169`). **Mutually exclusive with geo-location targeting** (`country`, `city`, `state`, `zip`). |
57+
- **`country`** - ISO 3166 country code
58+
- **`carrier`** - Mobile carrier name (e.g., `verizon`, `att`, `tmobile`)
59+
- **`state`** - Two-letter state code. Only supported for US and Australia. Cannot be used with `city`
60+
- **`city`** - City name (lowercase, no spaces, e.g., `newyork`, `losangeles`). Required if `zip` is provided
61+
- **`zip`** - US ZIP code (5 digits). Requires `city` to be provided
62+
- **`asn`** - Autonomous System Number. Mutually exclusive with geo-location targeting
6563

6664
## Supported Carriers
6765

‎proxies/residential.mdx‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: "Residential Proxies"
44

55
Residential proxies route traffic through real residential IP addresses, making them highly effective at avoiding bot detection. They support advanced targeting options including city, state, and operating system.
66

7-
## Configuration Options
7+
## Configuration
88

99
Residential proxies support multiple targeting parameters:
1010

@@ -54,11 +54,9 @@ browser = client.browsers.create(
5454

5555
## Configuration Parameters
5656

57-
| Parameter | Required | Description |
58-
|-----------|----------|-------------|
59-
| `country` | No | ISO 3166 country code (e.g., `US`, `GB`) |
60-
| `state` | No | Two-letter state code (e.g., `NY`, `CA`). Only supported for US and Australia. **Cannot be used with `city`**. |
61-
| `city` | No | City name (lowercase letters only, no spaces, e.g., `sanfrancisco`, `newyork`). Required if `zip` is provided. |
62-
| `zip` | No | US ZIP code (5 digits only, e.g., `94102`). **Requires `city` to be provided**. |
63-
| `os` | No | Operating system: `windows`, `macos`, or `android` |
64-
| `asn` | No | Autonomous System Number (e.g., `AS7922`, `7922`). **Mutually exclusive with geo-location targeting** (`country`, `city`, `state`, `zip`). |
57+
- **`country`** - ISO 3166 country code
58+
- **`state`** - Two-letter state code. Only supported for US and Australia. Cannot be used with `city`
59+
- **`city`** - City name (lowercase, no spaces, e.g., `sanfrancisco`, `newyork`). Required if `zip` is provided
60+
- **`zip`** - US ZIP code (5 digits). Requires `city` to be provided
61+
- **`os`** - Operating system: `windows`, `macos`, or `android`
62+
- **`asn`** - Autonomous System Number. Mutually exclusive with geo-location targeting

0 commit comments

Comments
 (0)