72 lines
1.7 KiB
Markdown
72 lines
1.7 KiB
Markdown
<h1 align="center">
|
|
<img src="https://github.com/Dreamacro/clash/raw/master/docs/logo.png" alt="Clash" width="200">
|
|
<br>
|
|
ClashX
|
|
<br>
|
|
</h1>
|
|
|
|
|
|
A rule based proxy For Mac base on [Clash](https://github.com/Dreamacro/clash).
|
|
|
|
|
|
|
|
## Features
|
|
|
|
- HTTP/HTTPS and SOCKS protocol
|
|
- Surge like configuration
|
|
- GeoIP rule support
|
|
- Support Vmess/Shadowsocks/Socks5
|
|
- Support for Netfilter TCP redirect
|
|
|
|
## Install
|
|
|
|
You can download from [release](https://github.com/yichengchen/clashX/releases) page
|
|
|
|
## Build
|
|
- Download deps
|
|
```
|
|
bash install_dependency.sh
|
|
```
|
|
- Build clash core.
|
|
```
|
|
cd ClashX
|
|
python3 build_clash.py
|
|
```
|
|
- Build and run.
|
|
|
|
## Config
|
|
|
|
|
|
The default configuration directory is `$HOME/.config/clash`
|
|
|
|
The default name of the configuration file is `config.yaml`. You can use your custom config name and switch config in menu `Config` section.
|
|
|
|
To Change the ports of ClashX, you need to modify the `config.yaml` file. The `General` section settings in your custom config file would be ignored.
|
|
|
|
Checkout [Clash](https://github.com/Dreamacro/clash) or [SS-Rule-Snippet for Clash](https://github.com/Hackl0us/SS-Rule-Snippet/blob/master/LAZY_RULES/clash.yaml) for more detail.
|
|
|
|
## Advance Config
|
|
### Change your status menu icon
|
|
|
|
Place your icon file in the `~/.config/clash/menuImage.png` then restart ClashX
|
|
|
|
### Change default system ignore list.
|
|
|
|
- Download sample plist in the [Here](proxyIgnoreList.plist) and place in the
|
|
|
|
```
|
|
~/.config/clash/proxyIgnoreList.plist
|
|
```
|
|
|
|
- Edit the `proxyIgnoreList.plist` to set up your own proxy ignore list
|
|
|
|
### Use url scheme to import remote config.
|
|
|
|
- Using url scheme describe below
|
|
|
|
```
|
|
clash://install-config?url=http%3A%2F%2Fexample.com&name=example
|
|
```
|
|
|
|
|