op-packages/luci-app-shadowsocks-rust/README.md
github-actions[bot] 32600acc60 🌴 Sync 2026-03-05 23:51:42
2026-03-05 23:51:42 +08:00

92 lines
4.0 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

OpenWrt LuCI for Shadowsocks-Rust
===
[![Latest release][release_badge]][release_url]
简介
---
本软件包是 [shadowsocks-rust][openwrt-shadowsocks] 的 LuCI 控制界面,
方便用户控制和使用「透明代理」「SOCKS5 代理」「端口转发」功能.
软件包文件结构:
```
/
├── etc/
│   ├── config/
│   │   └── shadowsocks // UCI 配置文件
│   │── init.d/
│   │   └── shadowsocks // init 脚本
│   └── uci-defaults/
│      └── luci-shadowsocks // uci-defaults 脚本
└── usr/
├── bin/
│   └── ss-rules // 生成代理转发规则的脚本
└── lib/
└── lua/
└── luci/ // LuCI 部分
├── controller/
│   └── shadowsocks.lua // LuCI 菜单配置
├── i18n/ // LuCI 语言文件目录
│   └── shadowsocks.zh-cn.lmo
└── model/
└── cbi/
└── shadowsocks/
├── general.lua // LuCI 基本设置
├── servers.lua // LuCI 服务器列表
├── servers-details.lua // LuCI 服务器编辑
└── access-control.lua // LuCI 访问控制
```
依赖
---
软件包的正常使用需要依赖 `iptables``ipset`.
软件包不显式依赖 `shadowsocks-rust`, 会根据用户添加的可执行文件启用相应的功能.
- `TCP Fast-Open` 依赖版本 v1.11.0 或更高
- GFW-List模式 正常使用需要依赖 [dnsmasq-extra][openwrt-dnsmasq-extra], 其中包括`DNS防污染`和`GFW-List`
可执行文件可通过安装 [openwrt-shadowsocks][openwrt-shadowsocks] 中提供的 `shadowsocks-rust` 获得.
只有当文件存在时, 相应的功能才可被使用, 并显示相应的 LuCI 设置界面.
可执行文件 | 可选 | 功能 | TCP协议 | UDP协议
------------|------|-------------|---------|-----------------------------------
`sslocal` | 是 | 透明代理 | 支持 | 需安装 `iptables-mod-tproxy`, `ip`
注: 可执行文件在 `$PATH` 环境变量所表示的搜索路径中, 都可被正确调用.
配置
---
软件包的配置文件路径: `/etc/config/shadowsocks`
此文件为 UCI 配置文件, 配置方式可参考 [Wiki -> Use-UCI-system][Use-UCI-system] 和 [OpenWrt Wiki][uci]
透明代理的访问控制功能设置可参考 [Wiki -> LuCI-Access-Control][LuCI-Access-Control]
编译
---
从 OpenWrt 的 [SDK][openwrt-sdk] 编译
```bash
# 解压下载好的 SDK
tar xjf OpenWrt-SDK-ar71xx-for-linux-x86_64-gcc-4.8-linaro_uClibc-0.9.33.2.tar.bz2
cd OpenWrt-SDK-ar71xx-*
# Clone 项目
git clone https://github.com/honwen/luci-app-shadowsocks-rust.git package/luci-app-shadowsocks-rust
# Clone Luci 项目
git clone https://github.com/openwrt/luci.git feeds/luci
# 选择要编译的包 LuCI -> 3. Applications
make menuconfig
# 开始编译
make package/luci-app-shadowsocks-rust/compile V=99
```
[release_badge]: https://img.shields.io/github/release/honwen/luci-app-shadowsocks-rust.svg
[release_url]: https://github.com/honwen/luci-app-shadowsocks-rust/releases
[openwrt-shadowsocks]: https://github.com/honwen/openwrt-shadowsocks
[openwrt-sdk]: https://wiki.openwrt.org/doc/howto/obtain.firmware.sdk
[ss-rules]: https://github.com/shadowsocks/luci-app-shadowsocks/wiki/Instruction-of-ss-rules
[Use-UCI-system]: https://github.com/shadowsocks/luci-app-shadowsocks/wiki/Use-UCI-system
[uci]: https://wiki.openwrt.org/doc/uci
[LuCI-Access-Control]: https://github.com/shadowsocks/luci-app-shadowsocks/wiki/LuCI-Access-Control
[openwrt-dnsmasq-extra]: https://github.com/honwen/openwrt-dnsmasq-extra