ClashX/README.md

73 lines
1.9 KiB
Markdown
Raw Normal View History

2018-08-08 22:00:04 +08:00
<h1 align="center">
<img src="https://github.com/Dreamacro/clash/raw/master/docs/logo.png" alt="Clash" width="200">
<br>
ClashX
<br>
</h1>
2018-06-14 17:38:27 +08:00
2018-08-08 22:00:04 +08:00
A rule based proxy For Mac base on [Clash](https://github.com/Dreamacro/clash).
2018-08-14 17:22:58 +08:00
2018-06-14 17:38:27 +08:00
2018-11-09 10:12:26 +08:00
## Features
2018-06-14 17:38:27 +08:00
2018-11-09 10:12:26 +08:00
- HTTP/HTTPS and SOCKS protocol
- Surge like configuration
- GeoIP rule support
- Support Vmess/Shadowsocks/Socks5
2019-05-31 13:00:43 +08:00
- Support for Netfilter TCP redirect
2018-08-08 22:00:04 +08:00
2018-11-09 10:12:26 +08:00
## Install
2018-06-14 17:38:27 +08:00
2018-06-23 15:50:37 +08:00
You can download from [release](https://github.com/yichengchen/clashX/releases) page
2018-06-14 17:38:27 +08:00
2019-02-11 16:37:30 +08:00
## Build
- Download mmdb from http://geolite.maxmind.com/download/geoip/database/GeoLite2-Country.tar.gz unzip and put it in the "ClashX/Support Files/Country.mmdb".
- Open the "ClashX/Resources" folder and clone the dashboard project.
```
git clone -b gh-pages git@github.com:Dreamacro/clash-dashboard.git dashboard
```
2019-03-18 20:32:59 +08:00
- Build clash core.
```
go build -buildmode=c-archive
```
2019-02-11 16:37:30 +08:00
- Build and run.
2018-11-09 10:12:26 +08:00
## Config
The default configuration directory is `$HOME/.config/clash`
2019-02-11 16:37:30 +08:00
The default name of the configuration file is `config.yml`. You can use your custom config name and switch config in menu "Config" section.
2019-05-31 12:59:40 +08:00
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.yml) for more detail.
2019-02-11 16:37:30 +08:00
2019-03-31 16:38:00 +08:00
## Advance Config
### Change your status menu icon
Place your icon file in the ~/.config/clash/menuImage.png then restart ClashX
### Disable auto restore proxy setting.
```
defaults write com.west2online.ClashX kDisableRestoreProxy -bool true
```
2019-03-31 16:38:00 +08:00
### Change default system ignore list.
- Download sample plist in the [Here](https://baidu.com) and place in the ~/.config/clash/proxyIgnoreList.plist
- edit the proxyIgnoreList.plist to set up your own proxy ignore list
2019-07-30 21:03:24 +08:00
### Use url scheme to import remote config.
- Using url scheme describe below
```
clash://install-config?url=http%3A%2F%2Fexample.com
```
2019-03-31 16:38:00 +08:00
2018-06-14 17:38:27 +08:00