Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/honwen/luci-app-shadowsocksr

OpenWrt/LEDE LuCI for ShadowsocksR-libev
https://github.com/honwen/luci-app-shadowsocksr

luci shadowsocksr

Last synced: 3 months ago
JSON representation

OpenWrt/LEDE LuCI for ShadowsocksR-libev

Host: GitHub
URL: https://github.com/honwen/luci-app-shadowsocksr
Owner: honwen
License: gpl-3.0
Created: 2017-06-16T04:24:16.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2021-04-01T18:03:00.000Z (over 3 years ago)
Last Synced: 2024-04-24T12:18:52.628Z (7 months ago)
Topics: luci, shadowsocksr
Language: Shell
Homepage:
Size: 381 KB
Stars: 116
Watchers: 11
Forks: 40
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-network-stuff - **90**星 - libev (<a id="d03d494700077f6a65092985c06bf8e8"></a>工具 / <a id="cb16466a31a167bb61f39e2a4a85f449"></a>Shadowsocks)

README

OpenWrt LuCI for ShadowSocksR-libev
===

简介 ([预览][preview])
---

本软件包是 [shadowsocksr-libev][openwrt-shadowsocksr] 的 LuCI 控制界面,
方便用户控制和使用「透明代理」「SOCKS5 代理」「端口转发」功能.

软件包文件结构:
```
├── etc/
│   ├── config/
│   │   └── shadowsocksr // UCI 配置文件
│   │── init.d/
│   │   └── shadowsocksr // init 脚本
│   └── uci-defaults/
│      └── luci-shadowsocksr // uci-defaults 脚本
└── usr/
├── bin/
│   └── ssr-rules // 生成代理转发规则的脚本
└── lib/
└── lua/
└── luci/ // LuCI 部分
├── controller/
│   └── shadowsocksr.lua // LuCI 菜单配置
├── i18n/ // LuCI 语言文件目录
│   └── shadowsocksr.zh-cn.lmo
└── model/
├── cbi/
| └── shadowsocksr/
| ├── general.lua // LuCI 基本设置
| ├── servers.lua // LuCI 服务器列表
| ├── servers-details.lua // LuCI 服务器管理
| ├── gfwlist-custom.lua // LuCI 自定义GFW
| └── access-control.lua // LuCI 访问控制
└── view/
└── shadowsocksr/
└── gfwlist.htm // LuCI GFW列表
```

依赖
---

软件包的正常使用需要依赖 `iptables` 和 `ipset`.
软件包不显式依赖 `shadowsocksr-libev`, 会根据用户添加的可执行文件启用相应的功能.
**GFW-List模式正常使用需要依赖 [dnsmasq-extra][openwrt-dnsmasq-extra], 其中包括`DNS防污染`和`GFW-List`**
可执行文件可通过安装 [openwrt-shadowsocksr][openwrt-shadowsocksr] 中提供的 `shadowsocksr-libev` 获得.
只有当文件存在时, 相应的功能才可被使用, 并显示相应的 LuCI 设置界面.

可执行文件 | 可选 | 功能 | TCP协议 | UDP协议
------------|------|-------------|---------|-----------------------------------
`ssr-redir` | 是 | 透明代理 | 支持 | 需安装 `iptables-mod-tproxy`, `ip`
`ssr-local` | 是 | SOCKS5 代理 | 支持 | 支持
`ssr-tunnel` | 是 | 端口转发 | 支持 | 支持

注: 可执行文件在 `$PATH` 环境变量所表示的搜索路径中, 都可被正确调用.

配置
---

软件包的配置文件路径: `/etc/config/shadowsocksr`
此文件为 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/chenhw2/luci-app-shadowsocksr.git package/feeds/luci-app-shadowsocksr
# 编译 po2lmo (如果有po2lmo可跳过)
pushd package/feeds/luci-app-shadowsocksr/tools/po2lmo
make && sudo make install
popd
# 选择要编译的包 LuCI -> 3. Applications
make menuconfig
# 开始编译
make package/feeds/luci-app-shadowsocksr/compile V=99
```

[openwrt-shadowsocksr]: https://github.com/chenhw2/openwrt-shadowsocksr
[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/chenhw2/openwrt-dnsmasq-extra
[preview]: https://github.com/chenhw2/luci-app-shadowsocksr/tree/master/preview