Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
xishang0128 committed Mar 12, 2024
1 parent bf5ab71 commit 6ee6279
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 63 deletions.
57 changes: 30 additions & 27 deletions docs/config/general.en.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
## **Allow LAN**
# General configuration

## Allow LAN

Allows other devices to access the internet through Clash [proxy port](./inbound/port.md).

Expand Down Expand Up @@ -34,7 +36,7 @@ lan-disallowed-ips:
- 192.168.0.3/32
```

### **User Authentication**
### User Authentication

User authentication for http(s), socks, and mixed proxies.

Expand All @@ -52,7 +54,7 @@ skip-auth-prefixes:
- ::1/128
```

## **Operation Mode**
## Operation Mode

- `rule` Rule-based matching
- `global` Global proxy (requires selecting proxy/strategy in GLOBAL proxy group)
Expand All @@ -64,7 +66,7 @@ defaulting to `rule` mode.
mode: rule
```

## **Log Level**
## Log Level

Controls the logging level of Clash core, only output to console and control page.

Expand All @@ -78,7 +80,7 @@ log-level: info
- `info` Outputs general operational logs, as well as logs of error and warning levels.
- `debug` Outputs as much information as possible during runtime.

## **IPv6**
## IPv6

Whether to allow the kernel to accept IPv6 traffic.

Expand All @@ -88,7 +90,7 @@ default is `true`.
ipv6: true
```

## **TCP Keep Alive Interval**
## TCP Keep Alive Interval

Controls the interval at which Clash sends out TCP Keep Alive packets to reduce temporary measures for mobile device power consumption.

Expand All @@ -98,9 +100,9 @@ keep-alive-interval: 30

The time Clash discovers and closes an invalid TCP connection:

1 * keep-alive-interval + 9 * keep-alive-interval
1 × keep-alive-interval + 9 × keep-alive-interval

## **Process Matching Mode**
## Process Matching Mode

Controls whether Clash matches processes.

Expand All @@ -112,7 +114,7 @@ Controls whether Clash matches processes.
find-process-mode: strict
```

## **External Control (API)**
## External Control (API)

External controller, allows controlling your Clash kernel using RESTful API.

Expand All @@ -134,7 +136,7 @@ Access key for the API.
secret: ""
```

## **External User Interface**
## External User Interface

Allows running static webpage resources (such as Clash-dashboard) on Clash API, path is API address/ui.

Expand All @@ -144,21 +146,21 @@ external-ui: /path/to/ui/folder

Can be an absolute path or a relative path to the Clash working directory.

## **Custom External User Interface Name**
## Custom External User Interface Name

```{.yaml linenums="1"}
external-ui-name: xd # Merged into external-ui/xd
```

Not mandatory, will be updated to the specified folder during updates, if not configured, it will be updated directly to the `external-ui` directory.

## **Custom External User Interface Download URL**
## Custom External User Interface Download URL

```{.yaml linenums="1"}
external-ui-url: "<https://github.com/MetaCubeX/metacubexd/archive/refs/heads/gh-pages.zip>" # Get from GitHub Pages branch
```

## **Cache**
## Cache

In Clash official, profile should be an extension configuration, but in Clash.meta, it is only used as a cache item.

Expand All @@ -173,37 +175,37 @@ profile:
# Stores the fakeip mapping table, using the original mapping address when the domain connects again
```

## **Unified Delay**
## Unified Delay

Change delay calculation method, remove additional delays such as handshakes.

```{.yaml linenums="1"}
unified-delay: true
```

## **TCP Concurrency**
## TCP Concurrency

```{.yaml linenums="1"}
tcp-concurrent: true
```

## **Outbound Interface**
## Outbound Interface

Clash's traffic outbound interface.

```{.yaml linenums="1"}
interface-name: en0
```

## **Routing Mark**
## Routing Mark

Provides a default traffic mark for outbound connections on Linux.

```{.yaml linenums="1"}
routing-mark: 6666
```

## **TLS**
## TLS

Currently only used for https in API.

Expand All @@ -213,7 +215,7 @@ tls:
private-key: string # Private key PEM format corresponding to the certificate, or private key path
```

## **Global Client Fingerprint**
## Global Client Fingerprint

Global TLS fingerprint, lower priority than client-fingerprint inside proxy.

Expand All @@ -227,15 +229,15 @@ global-client-fingerprint: chrome
Options: `chrome`, `firefox`, `safari`, `iOS`, `android`, `edge`, `360`, `qq`, `random`
If `random` is selected, a modern browser fingerprint will be generated based on Cloudflare Radar data.

## **GEO Data Mode**
## GEO Data Mode

Change the geoip usage file, `mmdb` or `dat`,`true` is `dat`, with a default value of `false`.

```{.yaml linenums="1"}
geodata-mode: true
```

## **GEO File Loading Mode**
## GEO File Loading Mode

Optional loading modes are as follows:

Expand All @@ -246,7 +248,7 @@ Optional loading modes are as follows:
geodata-loader: memconservative
```

## **Auto Update GEO**
## Auto Update GEO

```{.yaml linenums="1"}
geo-auto-update: false
Expand All @@ -258,16 +260,17 @@ Update interval, in hours.
geo-update-interval: 24
```

## **Custom GEO Download Address**
## Custom GEO Download Address

```{.yaml linenums="1"}
geox-url:
geoip: "<https://testingcf.jsdelivr.net/gh/MetaCubeX/meta-rules-dat@release/geoip.dat>"
geosite: "<https://testingcf.jsdelivr.net/gh/MetaCubeX/meta-rules-dat@release/geosite.dat>"
mmdb: "<https://testingcf.jsdelivr.net/gh/MetaCubeX/meta-rules-dat@release/country.mmdb>"
geoip: "https://testingcf.jsdelivr.net/gh/MetaCubeX/meta-rules-dat@release/geoip.dat"
geosite: "https://testingcf.jsdelivr.net/gh/MetaCubeX/meta-rules-dat@release/geosite.dat"
mmdb: "https://testingcf.jsdelivr.net/gh/MetaCubeX/meta-rules-dat@release/country.mmdb"
asn: "https://github.com/xishang0128/geoip/releases/download/latest/GeoLite2-ASN.mmdb"
```

## **Custom Global UA**
## Custom Global UA

Custom UA used when downloading external resources, default is clash.meta.

Expand Down
Loading

0 comments on commit 6ee6279

Please sign in to comment.