https://github.com/felinae98/clashup

Subscribe updator for clash on Archlinux
https://github.com/felinae98/clashup

clash

Last synced: 3 months ago
JSON representation

Subscribe updator for clash on Archlinux

• Host: GitHub
• URL: https://github.com/felinae98/clashup
• Owner: felinae98
• License: gpl-3.0
• Archived: true
• Created: 2020-04-11T06:54:48.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-11-21T11:39:47.000Z (almost 2 years ago)
• Last Synced: 2024-07-11T12:58:08.507Z (4 months ago)
• Topics: clash
• Language: Python
• Homepage:
• Size: 44.9 KB
• Stars: 41
• Watchers: 4
• Forks: 10
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# clashup

An updator for clash on Archlinux

## Install 

`$ git clone https://github.com/felinae98/clashup.git && cd clashup && makepkg -si`

or use aur

`yay -Sy clashup`

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": [],

    "mmdb_file_url": "http://www.ideame.top/mmdb/Country.mmdb",

    "mmdb_version_url": "http://www.ideame.top/mmdb/version"

}

```

* Set `is_subscribe_banned` true if your subscribe address was banned.

* `http_port` is required if `is_subscribe_banned` is true

* If you both set `mmdb_file_url` and `mmdb_version_url` it will update `Country.mmdb` file every start up time.

## 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.

## FAQ

* How to see log

  

    `journalctl --user -u clash -e`

* How to add custom rules

    edit `~/.config/clash/clashup.json` and `systemctl --user restart clash`