Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shadowsocks/luci-app-shadowsocks
OpenWrt/LEDE LuCI for Shadowsocks-libev
https://github.com/shadowsocks/luci-app-shadowsocks
lede luci openwrt shadowsocks-libev
Last synced: about 1 month ago
JSON representation
OpenWrt/LEDE LuCI for Shadowsocks-libev
- Host: GitHub
- URL: https://github.com/shadowsocks/luci-app-shadowsocks
- Owner: shadowsocks
- License: gpl-3.0
- Created: 2016-08-15T01:28:41.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-05-28T16:53:00.000Z (over 1 year ago)
- Last Synced: 2024-09-26T21:04:20.377Z (about 1 month ago)
- Topics: lede, luci, openwrt, shadowsocks-libev
- Language: Lua
- Homepage:
- Size: 319 KB
- Stars: 1,151
- Watchers: 90
- Forks: 422
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-network-stuff - **866**星 - libev (<a id="d03d494700077f6a65092985c06bf8e8"></a>工具 / <a id="cb16466a31a167bb61f39e2a4a85f449"></a>Shadowsocks)
README
OpenWrt LuCI for Shadowsocks-libev
===
[![Latest release][release_badge]][release_url]
简介
---
本软件包是 [shadowsocks-libev][openwrt-shadowsocks] 的 LuCI 控制界面,
方便用户控制和使用「透明代理」「SOCKS5 代理」「端口转发」功能.
软件包文件结构:
```
/
├── etc/
│ ├── config/
│ │ └── shadowsocks // UCI 配置文件
│ │── init.d/
│ │ └── shadowsocks // init 脚本
│ └── uci-defaults/
│ └── luci-shadowsocks // uci-defaults 脚本
└── usr/
├── bin/
│ ├── ss-rules // 生成代理转发规则的脚本
│ └── ss-subscribe // 订阅脚本
│── lib/
│ └── lua/
│ └── luci/ // LuCI 部分
│ ├── controller/
│ │ └── shadowsocks.lua // LuCI 菜单配置
│ ├── i18n/ // LuCI 语言文件目录
│ │ └── shadowsocks.zh-cn.lmo
│ │── model/
│ │ └── cbi/
│ │ └── shadowsocks/
│ │ ├── general.lua // LuCI 基本设置
│ │ ├── subscription.lua // LuCI 订阅管理
│ │ ├── servers.lua // LuCI 服务器列表
│ │ ├── servers-details.lua // LuCI 服务器编辑
│ │ └── access-control.lua // LuCI 访问控制
│ └── view
│ └── shadowsocks/
│ ├── general.htm // LuCI View 基本设置
│ ├── servers-details.htm // LuCI View 服务器编辑
│ └── subscribe.htm // LuCI View 订阅管理
└── share/
└── rpcd/
└── acl.d/
└── luci-app-shadowsocks.json // UCI 访问控制列表
```
依赖
---
软件包的正常使用需要依赖 `wget`、`resolveip`、`iptables` 和 `ipset`.
软件包不显式依赖 `shadowsocks-libev`, 会根据用户添加的可执行文件启用相应的功能.
可执行文件可通过安装 [openwrt-shadowsocks][openwrt-shadowsocks] 中提供的 `shadowsocks-libev` 获得.
只有当文件存在时, 相应的功能才可被使用, 并显示相应的 LuCI 设置界面.
可执行文件 | 可选 | 功能 | TCP协议 | UDP协议
---------------|------|-------------|---------|-----------------------------------
`ss(r)-redir` | 是 | 透明代理 | 支持 | 需安装 `iptables-mod-tproxy`, `ip`
`ss(r)-local` | 是 | SOCKS5 代理 | 支持 | 支持
`ss(r)-tunnel` | 是 | 端口转发 | 支持 | 支持
注: 可执行文件在 `$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/shadowsocks/luci-app-shadowsocks.git package/luci-app-shadowsocks
# 编译 po2lmo (如果有po2lmo可跳过)
pushd package/luci-app-shadowsocks/tools/po2lmo
make && sudo make install
popd
# 选择要编译的包 LuCI -> 3. Applications
make menuconfig
# 开始编译
make package/luci-app-shadowsocks/compile V=99
```
[release_badge]: https://img.shields.io/github/release/shadowsocks/luci-app-shadowsocks.svg
[release_url]: https://github.com/shadowsocks/luci-app-shadowsocks/releases/latest
[openwrt-shadowsocks]: https://github.com/shadowsocks/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