From d26fbe5046d22355019c59ae39a5feeadb39d110 Mon Sep 17 00:00:00 2001 From: juewuy Date: Mon, 21 Dec 2020 13:06:04 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0Readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 + README_EN.md | 107 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 109 insertions(+) create mode 100644 README_EN.md diff --git a/README.md b/README.md index c9a1bb5..fb7af89 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,11 @@

+ [中文](README.md) | [English](README_EN.md) 功能简介： -- + ~通过管理脚本在Shell环境下便捷使用[Clash](https://github.com/Dreamacro/clash)
~支持在Shell环境下管理[Clash各种功能](https://lancellc.gitbook.io/clash)
~支持在线导入[Clash](https://github.com/Dreamacro/clash)支持的分享、订阅及配置链接
~支持配置定时任务，支持配置文件定时更新
~支持在线安装及使用本地网页面板管理内置规则
diff --git a/README_EN.md b/README_EN.md new file mode 100644 index 0000000..ea9f99c --- /dev/null +++ b/README_EN.md @@ -0,0 +1,107 @@ +

+ Clash +
ShellClash
+ + +

+ + + + + + +

+ + [中文](README.md) | [English](README_EN.md) + +## Function introduction: + +~Convenient use in Shell environment through management script [Clash](https://github.com/Dreamacro/clash)
~Support management of [Clash functions](https://lancellc.gitbook.io/clash)
~Support online import [Clash](https://github.com/Dreamacro/clash) supports sharing, subscription and configuration links
~Support configuration timing tasks, support configuration file timing updates
~Support online installation and Use local web panel to manage built-in rules
~Support routing mode, native mode and other mode switching
~Support GNOME, KDE desktop automatic configuration native mode
~Support online update
+ +## Equipment support: + +~Support various router devices based on OpenWrt or secondary custom development using OpenWrt
~Support various devices running standard Linux systems (such as Debian/CenOS/Armbian, etc.)
~Compatible with Padavan firmware (conservative mode), Pandora firmware
~Compatible with various types of devices customized and developed using the Linux kernel
——————————
~For more device support, please submit an issue or go to the TG group for feedback (the device name and the device core information returned by running uname -a must be provided)
+ +How to use: +-- + +~Confirm that the router device has enabled SSH and obtained root privileges (Linux devices with GUI desktops can be installed using their own terminal)
~Use SSH connection tools (such as putty, JuiceSSH, system built-in terminal, etc.) router or Linux device SSH management interface or terminal interface, and switch to the root user
~Confirm that the curl or wget download tool has been installed on the device. If not installed, please [refer to here](https://www.howtoforge.com/install-curl-in-linux) for LInux devices to install curl. For devices based on OpenWrt (Xiaomi official system, Pandora, Gaoke, etc.), please Use the following command to install curl:
+ +```sh +opkg update && opkg install curl +``` + +~ Then execute the following installation commands on the SSH interface, and follow the subsequent prompts to complete the installation
+ +##### ~Use curl:
+ +```Shell +#Release version - by github +sh -c "$(curl -kfsSl --resolve raw.githubusercontent.com:443:199.232.68.133 https://raw.githubusercontent.com/juewuy/ShellClash/master/install.sh)" && source /etc/profile &> /dev/null +#Release version - by jsdelivrCDN +sh -c "$(curl -kfsSl https://cdn.jsdelivr.net/gh/juewuy/ShellClash@master/install.sh)" && source /etc/profile &> /dev/null +#Test version - by github +sh -c "$(curl -kfsSl --resolve raw.githubusercontent.com:443:199.232.68.133 https://raw.githubusercontent.com/juewuy/ShellClash/master/install.sh)" -s 1 && source /etc/profile &> /dev/null +``` + +##### ~Use wget：
+ +```sh +#Release version - by jsdelivrCDN +wget -q --no-check-certificate -O /tmp/install.sh https://cdn.jsdelivr.net/gh/juewuy/ShellClash@master/install.sh && sh /tmp/install.sh && source /etc/profile &> /dev/null +``` + +~**After installation by non-root users**, please execute the following additional commands to read environment variables:
+ +```shell +source ~/.bashrc &> /dev/null +``` + +~After installing the management script, execute the following command to **run the management script**
+ +```Shell +clash #normal mode +clash -h #help +clash -t #test mode +``` + +~**Additional dependencies at runtime**：
+ +``` +Most of the equipment/systems are pre-installed with most of the following dependencies, you can ignore them if there is no impact when you use them. +``` + +```sh +bash/ash necessary Cannot install and run scripts when all are missing +curl/wget necessary When all are missing, it cannot be installed and updated online +iptables important Only use pure mode when missing +systemd/rc.common general Only use conservative mode when all are missing +iptables-mod-nat general Cannot use redir mode, mixed mode when missing +ip6tables-mod-nat lower Affects redir mode when missing, mixed mode support for ipv6 +crontab lower Cannot enable timing task function when missing +net-tools minimal Cannot detect port occupancy normally when missing +ubus/iproute-doc minimal The host address of the machine cannot be obtained normally when missing +``` + + + +## Update log: + +### [Click to view](https://github.com/juewuy/ShellClash/releases) + +## Exchange feedback: + +### [TG Discussion Group](https://t.me/clashfm) + +## Related Q&A: + +### [See blog for details](https://juewuy.github.io) + +## Donate this project + +### [Go to page](https://juewuy.github.io/yOF4Yf06Q/) + +## Friendly promotion: + +### [Top 8K Airport-Dler](https://dler.best/auth/register?affid=89698) +