diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 000000000000..9957b8a37b77 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# clashup + +An updator for clash on Archlinux + +## Install +`$ git clone https://github.com/felinae98/clashup.git && cd clashup && makepkg -si` + +or use aur + +`tbd` + +and just + +`$ systemctl --user start clash` + +## Config +The config file is `~/.config/clash/clashup.json` +```json +{ + "http_port": 7890, + "socks5_port": 7891, + "redir_port": 7892, + "allow_lan": true, + "external_controller": "127.0.0.1:9090", + "subscribe_url": "", + "is_subscribe_banned": false, + "custom_rules": [] +} +``` +* Set `is_subscribe_banned` true if your subscribe address was banned. +* `http_port` is required if `is_subscribe_banned` is true +## How it works +It just simply download the subscribe config file and override `http-port`, `socks-port`, `redir-port`, `allow-lan`, `external-controller` in the config file, and append `custom_rules` to `Rules`. + +If your can access your subscribe url directly, it just download and update config file before clash start. + +Otherwise your subscribe url is banned, it download and update the config file after clash start and then restart clash.
\ No newline at end of file |