mirror of
https://github.com/juewuy/ShellCrash.git
synced 2026-03-11 07:51:45 +00:00
docs: beautify the README_CN document layout
This commit is contained in:
231
README_CN.md
231
README_CN.md
@@ -1,7 +1,4 @@
|
|||||||
<h1 align="center">
|
<h1 align="center">ShellCrash</h1>
|
||||||
<br>ShellCrash<br>
|
|
||||||
</h1>
|
|
||||||
|
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a target="_blank" href="https://github.com/MetaCubeX/mihomo/releases">
|
<a target="_blank" href="https://github.com/MetaCubeX/mihomo/releases">
|
||||||
@@ -12,146 +9,176 @@
|
|||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
中文 | [English](README.md)
|
<p align="center">
|
||||||
|
<strong>一款在 Shell 环境下便捷部署与管理 Mihomo/sing-box 内核的脚本工具</strong>
|
||||||
|
</p>
|
||||||
|
|
||||||
功能简介:
|
<p align="center">
|
||||||
--
|
简体中文 | <a href="README.md">English</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
~通过管理脚本在Shell环境下便捷使用Mihomo/Singbox内核<br>
|
---
|
||||||
~支持在Shell环境下管理<br>
|
|
||||||
~支持在线导入订阅及配置链接<br>
|
|
||||||
~支持配置定时任务,支持配置文件定时更新<br>
|
|
||||||
~支持在线安装及使用本地网页面板管理内置规则<br>
|
|
||||||
~支持路由模式、本机模式等多种模式切换<br>
|
|
||||||
~支持在线更新<br>
|
|
||||||
|
|
||||||
设备支持:
|
## :rocket: 核心特性
|
||||||
--
|
|
||||||
|
|
||||||
~支持各种基于OpenWrt或使用OpenWrt二次定制开发的路由器设备<br>
|
- **多内核支持**:在 Shell 环境下便捷管理及切换 **Mihomo** 与 **sing-box** 内核。
|
||||||
~支持各种运行标准Linux系统(如Debian/CenOS/Armbian等)的设备<br>
|
- **灵活配置管理**:支持在线导入订阅连结及配置文件,简化配置流程。
|
||||||
~兼容Padavan固件(保守模式)、潘多拉固件以及华硕/梅林固件<br>
|
- **自动化任务**:支持配置定时任务,实现配置文件与规则的自动定时更新。
|
||||||
~兼容各类使用Linux内核定制开发的各类型设备<br>
|
- **图形化面板**:支持在线安装并使用本地 Web 面板(Dashboard),直观管理内置规则与流量。
|
||||||
|
- **多模式运行**:支持路由模式、本机模式等多种流量转发模式切换。
|
||||||
|
- **一键维护**:内置脚本在线更新功能,保持版本与功能的及时更迭。
|
||||||
|
|
||||||
——————————<br>
|
## :computer: 设备支持
|
||||||
~更多设备支持,请提issue或前往TG群反馈(需提供设备名称及运行uname -a返回的设备核心信息)<br>
|
|
||||||
|
|
||||||
## 常见问题:
|
ShellCrash 旨在兼容绝大多数基于 Linux 内核的网络设备:
|
||||||
|
|
||||||
[ShellCrash常见问题 | Juewuy's Blog](https://juewuy.github.io/chang-jian-wen-ti/)
|
* **路由器设备**:支持各种基于 OpenWrt 或其二次开发的固件。
|
||||||
|
* **Linux 服务器**:支持运行标准 Linux 发行版(如 Debian、CentOS、Armbian、Ubuntu 等)的设备。
|
||||||
|
* **第三方固件**:兼容 Padavan(保守模式)、潘多拉固件以及华硕/梅林固件。
|
||||||
|
* **各类定制设备**:兼容其他使用 Linux 内核开发的专用网络设备。
|
||||||
|
|
||||||
## 使用方式:
|
> 更多设备支持,请提交 [Issue](https://github.com/juewuy/ShellCrash/issues) 或前往 [Telegram 群组](https://t.me/ShellClash) 反馈(请附上设备型号及 `uname -a` 命令的输出信息)。
|
||||||
|
|
||||||
~确认设备已经开启SSH并获取root权限(带GUI桌面的Linux设备可使用自带终端安装)<br>
|
---
|
||||||
~使用SSH连接工具(如putty,JuiceSSH,系统自带终端等)路由器或Linux设备的SSH管理界面或终端界面
|
|
||||||
|
|
||||||
~之后在SSH界面执行目标设备对应的安装命令,并按照后续提示完成安装<br>
|
## :hammer_and_wrench: 安装指南
|
||||||
|
|
||||||
### 在线安装:<br>
|
> **提示**
|
||||||
|
> 若遇到连接失败或与SSL相关问题,请尝试切换至其他安装镜站。
|
||||||
|
|
||||||
(**如无法连接或出现SSL连接错误,请尝试更换各种不同的安装源!**)<br>
|
### 前置条件
|
||||||
|
1. 确保设备已开启 **SSH** 并获得 **Root 权限**(带图形介面的 Linux 系统可直接使用终端)。
|
||||||
|
2. 使用 SSH 工具(如 Putty、JuiceSSH、或系统自带终端)连接至设备。
|
||||||
|
|
||||||
~**标准Linux设备安装:**<br>
|
### :penguin: 标准 Linux 设备安装
|
||||||
|
|
||||||
```shell
|
> 使用 wget 安装(jsDelivr CDN 源)
|
||||||
sudo -i #切换到root用户,如果需要密码,请输入密码
|
```sh
|
||||||
export url='https://testingcf.jsdelivr.net/gh/juewuy/ShellCrash@master' && wget -q --no-check-certificate -O /tmp/install.sh $url/install.sh && bash /tmp/install.sh && . /etc/profile &> /dev/null
|
sudo -i # 切换至root用户,若需密码,请输入
|
||||||
```
|
export url='https://testingcf.jsdelivr.net/gh/juewuy/ShellCrash@master' \
|
||||||
或者
|
&& wget -q --no-check-certificate -O /tmp/install.sh $url/install.sh \
|
||||||
```shell
|
&& bash /tmp/install.sh \
|
||||||
sudo -i #切换到root用户,如果需要密码,请输入密码
|
&& . /etc/profile &> /dev/null
|
||||||
export url='https://gh.jwsc.eu.org/master' && bash -c "$(curl -kfsSl $url/install.sh)" && . /etc/profile &> /dev/null
|
|
||||||
```
|
```
|
||||||
|
|
||||||
~**路由设备使用curl安装**:<br>
|
> 或使用 curl 安装(作者私人源)
|
||||||
|
|
||||||
```shell
|
```sh
|
||||||
#GitHub源(可能需要代理)
|
sudo -i # 切换至root用户,若需密码,请输入
|
||||||
export url='https://raw.githubusercontent.com/juewuy/ShellCrash/master' && sh -c "$(curl -kfsSl $url/install.sh)" && . /etc/profile &> /dev/null
|
export url='https://gh.jwsc.eu.org/master' \
|
||||||
```
|
&& bash -c "$(curl -kfsSl $url/install.sh)" \
|
||||||
或者
|
&& . /etc/profile &> /dev/null
|
||||||
```shell
|
|
||||||
#jsDelivrCDN源
|
|
||||||
export url='https://testingcf.jsdelivr.net/gh/juewuy/ShellCrash@master' && sh -c "$(curl -kfsSl $url/install.sh)" && . /etc/profile &> /dev/null
|
|
||||||
```
|
|
||||||
或者
|
|
||||||
```shell
|
|
||||||
#作者私人源
|
|
||||||
export url='https://gh.jwsc.eu.org/master' && sh -c "$(curl -kfsSl $url/install.sh)" && . /etc/profile &> /dev/null
|
|
||||||
```
|
```
|
||||||
|
|
||||||
~**路由设备使用wget安装**:<br>
|
### :satellite: 路由器设备安装
|
||||||
|
|
||||||
```Shell
|
**使用 `curl` 安装:**
|
||||||
#GitHub源(可能需要代理)
|
> GitHub 源(推荐海外环境或具备代理环境使用)
|
||||||
export url='https://raw.githubusercontent.com/juewuy/ShellCrash/master' && wget -q --no-check-certificate -O /tmp/install.sh $url/install.sh && sh /tmp/install.sh && . /etc/profile &> /dev/null
|
```sh
|
||||||
```
|
export url='https://raw.githubusercontent.com/juewuy/ShellCrash/master' \
|
||||||
或者
|
&& sh -c "$(curl -kfsSl $url/install.sh)" \
|
||||||
```shell
|
&& . /etc/profile &> /dev/null
|
||||||
#jsDelivrCDN源
|
|
||||||
export url='https://testingcf.jsdelivr.net/gh/juewuy/ShellCrash@master' && wget -q --no-check-certificate -O /tmp/install.sh $url/install.sh && sh /tmp/install.sh && . /etc/profile &> /dev/null
|
|
||||||
```
|
```
|
||||||
|
|
||||||
~**老旧设备使用低版本wge安装**:<br>
|
> 或 jsDelivr CDN 源
|
||||||
|
|
||||||
```Shell
|
```sh
|
||||||
#作者私人http内测源
|
export url='https://testingcf.jsdelivr.net/gh/juewuy/ShellCrash@master' \
|
||||||
export url='http://t.jwsc.eu.org' && wget -q -O /tmp/install.sh $url/install.sh && sh /tmp/install.sh && . /etc/profile &> /dev/null
|
&& sh -c "$(curl -kfsSl $url/install.sh)" \
|
||||||
|
&& . /etc/profile &> /dev/null
|
||||||
```
|
```
|
||||||
|
|
||||||
##### ~**虚拟机安装:**<br>
|
> 或作者私人源
|
||||||
|
```sh
|
||||||
|
export url='https://gh.jwsc.eu.org/master' \
|
||||||
|
&& sh -c "$(curl -kfsSl $url/install.sh)" \
|
||||||
|
&& . /etc/profile &> /dev/null
|
||||||
|
```
|
||||||
|
|
||||||
虚拟机环境强烈建议使用Alpine镜像安装<br>
|
**使用 `wget` 安装:**
|
||||||
|
> GitHub 源(推荐海外环境或具备代理环境使用)
|
||||||
|
```sh
|
||||||
|
export url='https://raw.githubusercontent.com/juewuy/ShellCrash/master' \
|
||||||
|
&& wget -q --no-check-certificate -O /tmp/install.sh $url/install.sh \
|
||||||
|
&& sh /tmp/install.sh \
|
||||||
|
&& . /etc/profile &> /dev/null
|
||||||
|
```
|
||||||
|
|
||||||
```shell
|
> 或 jsDelivr CDN 源
|
||||||
|
```sh
|
||||||
|
export url='https://testingcf.jsdelivr.net/gh/juewuy/ShellCrash@master' \
|
||||||
|
&& wget -q --no-check-certificate -O /tmp/install.sh $url/install.sh \
|
||||||
|
&& sh /tmp/install.sh \
|
||||||
|
&& . /etc/profile &> /dev/null
|
||||||
|
```
|
||||||
|
|
||||||
|
### :pager: 老旧设备使用低版本 `wget` 安装
|
||||||
|
|
||||||
|
> 作者私人 http 内测源
|
||||||
|
```sh
|
||||||
|
export url='http://t.jwsc.eu.org' \
|
||||||
|
&& wget -q -O /tmp/install.sh $url/install.sh \
|
||||||
|
&& sh /tmp/install.sh \
|
||||||
|
&& . /etc/profile &> /dev/null
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### :cloud: 虚拟机
|
||||||
|
- **Alpine Linux 虚拟机**:强烈建议使用 Alpine 镜像以获得最佳兼容性
|
||||||
|
```sh
|
||||||
# 安装必要依赖
|
# 安装必要依赖
|
||||||
apk add --no-cache wget openrc ca-certificates tzdata nftables iproute2 dcron
|
apk add --no-cache wget openrc ca-certificates tzdata nftables iproute2 dcron
|
||||||
|
|
||||||
# 执行安装命令
|
# 执行安装命令
|
||||||
export url='https://testingcf.jsdelivr.net/gh/juewuy/ShellCrash@master' && wget -q --no-check-certificate -O /tmp/install.sh $url/install.sh && sh /tmp/install.sh && . /etc/profile &> /dev/null
|
export url='https://testingcf.jsdelivr.net/gh/juewuy/ShellCrash@master' \
|
||||||
|
&& wget -q --no-check-certificate -O /tmp/install.sh $url/install.sh \
|
||||||
|
&& sh /tmp/install.sh \
|
||||||
|
&& . /etc/profile &> /dev/null
|
||||||
```
|
```
|
||||||
|
|
||||||
##### ~Docker安装:<br>
|
### :whale: Docker
|
||||||
|
|
||||||
请前往[ShellCrash官方Docker镜像](https://hub.docker.com/r/juewuy/shellcrash)
|
请访问官方 Docker 镜像:
|
||||||
|
|
||||||
### **本地安装:**<br>
|
- [ShellCrash on Docker Hub](https://hub.docker.com/r/juewuy/shellcrash)
|
||||||
|
|
||||||
如使用在线安装出现问题,请参考:[本地安装ShellCrash的教程 | Juewuy's Blog](https://juewuy.github.io/bdaz) 使用本地安装!<br>
|
|
||||||
|
|
||||||
### 使用脚本:<br>
|
### :package: 本地安装
|
||||||
|
|
||||||
安装完成管理脚本后,执行如下命令使用~
|
若无法进行在线安装,请参照以下指南执行本地安装:
|
||||||
|
|
||||||
```Shell
|
- [本地安装ShellCrash教程 | Juewuy's Blog](https://juewuy.github.io/bdaz)
|
||||||
crash #进入对话
|
|
||||||
crash -h #帮助列表
|
---
|
||||||
|
|
||||||
|
## 📖 使用说明
|
||||||
|
|
||||||
|
安装完成后,在终端输入以下指令即可启动管理界面:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
crash # 启动脚本交互选单
|
||||||
|
crash -h # 查看命令帮助列表
|
||||||
```
|
```
|
||||||
|
|
||||||
#### **运行时的额外依赖**:<br>
|
### 运行依赖说明
|
||||||
|
| 依赖组件 | 必要性 | 说明 |
|
||||||
|
| :--- | :--- | :--- |
|
||||||
|
| curl / wget | 必须 | 缺少时将无法进行节点保存、在线安装及更新操作 |
|
||||||
|
| iptables / nftables | 重要 | 缺少时仅能运行于纯淨模式 |
|
||||||
|
| crontab | 较低 | 缺少时定时任务功能将失效 |
|
||||||
|
| net-tools | 极低 | 缺少时无法自动检测端口占用 |
|
||||||
|
| ubus / iproute-doc | 极低 | 缺少时无法自动获取本机 Host 地址 |
|
||||||
|
|
||||||
> 大部分的设备/系统都已经预装了以下的大部分依赖,使用时如无影响可以无视之
|
---
|
||||||
|
|
||||||
| 依赖 | 重要性 | 备注 |
|
## 🔗 相关链接
|
||||||
|---|---|---|
|
- 常见问题:[Juewuy's Blog](https://juewuy.github.io/chang-jian-wen-ti/)
|
||||||
| curl / wget | 必须 | 全部缺少时无法在线安装及更新,无法使用节点保存功能 |
|
- 更新日志:[Release History](https://github.com/juewuy/ShellCrash/releases)
|
||||||
| iptables / nftables | 重要 | 缺少时只能使用纯净模式 |
|
- 交流反馈:[Telegram 讨论组](https://t.me/ShellClash)
|
||||||
| crontab | 较低 | 缺少时无法启用定时任务功能 |
|
|
||||||
| net-tools | 极低 | 缺少时无法正常检测端口占用 |
|
|
||||||
| ubus / iproute-doc | 极低 | 缺少时无法正常获取本机host地址 |
|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
更新日志:
|
## :airplane: 机场推荐
|
||||||
--
|
|
||||||
|
|
||||||
### [点击查看](https://github.com/juewuy/ShellCrash/releases)
|
- [**Dler-墙洞**](https://dler.pro/auth/register?affid=89698),多年稳定运行,功能齐全。
|
||||||
|
- [**大米**](https://1s.bigmeok.me/user#/register?code=2PuWY9I7),群友力荐,流媒体解锁,月付推荐。
|
||||||
交流反馈:
|
|
||||||
--
|
|
||||||
### [TG讨论组](https://t.me/ShellClash)
|
|
||||||
|
|
||||||
机场推荐:
|
|
||||||
--
|
|
||||||
|
|
||||||
#### [Dler-墙洞,多年稳定运行,功能齐全](https://dler.pro/auth/register?affid=89698)<br>
|
|
||||||
|
|
||||||
#### [大米-群友力荐,流媒体解锁,月付推荐](https://1s.bigmeok.me/user#/register?code=2PuWY9I7)<br>
|
|
||||||
|
|||||||
Reference in New Issue
Block a user