-
Notifications
You must be signed in to change notification settings - Fork 428
/
README.md
275 lines (163 loc) · 10.3 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# Lucky(万吉)
## 注意：源码公布到1.4.10版本，后续暂无继续开源计划。
## 麻烦各位大佬发表lucky相关教程的时候不要加上“开源”神器，开源二字我不配，lucky后续也没开源打算。
1.开源并不等于安全，闭源并不等于不安全。闭源软件开发也会受到安全人员的审查。无论是开源还是闭源软件，都有可能会受到各种安全人员的审查和研究。安全人员可以使用各种技术手段来检测软件的安全性和漏洞。
2. 个人观点lucky这种应用类软件更多只是体力活，毫无技术含量，开源的优势在于透明度和社区参与，更多劳动力参与，但也可能导致功能过多、复杂度增加的问题。闭源软件的优势在于我想怎么写就怎么写,即使还未能从lucky中获利，lucky对我也有更深的特殊含义。
3. 我对lucky的规划还有一大部分未实现，不想被人当免费劳动力使唤，不解释太多，就这样。
## 如果您是第一次使用Lucky，请务必先访问 https://lucky666.cn ，并仔细阅读相关的文档，以获得必要的信息和答案。在这些文档中，您可以了解到Lucky的基本功能和特性，掌握Lucky的使用方法，以及解决常见的问题和疑惑。
<!-- TOC -->
- [Lucky(万吉)](#)
- [特性](#特性)
- [一键安装](#一键安装)
- [OpenwrtIPK包安装](#OpenwrtIPK包安装)
- [使用](#使用)
- [Docker中使用](#docker中使用)
- [后台界面](#后台界面)
- [开发编译](#开发编译)
- [更新日志](#更新日志)
- [使用注意与常见问题](#使用注意与常见问题)
<!-- /TOC -->
## 特性
Lucky最初是作为一个小工具，由开发者为自己的个人使用而开发，用于替代socat，在小米路由AX6000官方系统上实现公网IPv6转内网IPv4的功能。Lucky的设计始终致力于让更多的Linux嵌入式设备运行，以实现或集成个人用户常用功能，降低用户的硬件和软件操作学习成本，同时引导使用者注意网络安全。随着版本更新和网友反馈，Lucky不断迭代改进，拥有更多功能和更好的性能，成为用户值得信赖的工具。
Lucky 的核心程序完全采用 Golang 实现，具有高效、稳定、跨平台等优点。其后台前端则采用 Vue3.2 技术进行开发，具有良好的用户体验和响应速度。此外，Lucky 的管理后台采用前后端分离的架构，第三方开发者也可以自由使用OpenToken轻松调用Lucky的各种功能接口。
## 功能模块
目前已经实现/集成的主要功能模块有
- 端口转发
- 动态域名(DDNS)
- Web服务
- Stun内网穿透
- 网络唤醒
- 计划任务
- ACME自动证书
- 网络存储
### 端口转发
1. 主要用于实现公网 IPv6 转内网 IPv4 的 TCP/UDP 端口转发。
2. 支持界面化的管理转发规则，用户可以通过 web 后台轻松地进行规则的添加、删除、修改等操作。
3. 单条转发规则支持设置多个转发端口，这样可以实现多个内网服务端口的转发。
4. 提供了一键开关和定时开关功能，用户可以根据自己的需求设置转发规则的开启和关闭时间，还可以使用计划任务模块进行定时开关。
5. 单条规则支持黑白名单安全模式切换，用户可以根据需要选择使用白名单模式或黑名单模式。
6. 白名单模式可以让没有安全验证的内网服务端口稍微安全一点暴露到公网，提高服务可用性。
7. 实时记录最新的访问日志，方便用户了解转发情况。
8. 规则列表日志一目了然，用户可以方便地追踪转发异常，及时进行排查和处理。
### 动态域名(DDNS)
1. 支持接入多个不同的 DNS 服务商。
2. 支持全功能自定义回调（Callback），包括设置 BasicAuth，方便接入任意 DNS 服务商。
3. Webhook 支持自定义 headers。
4. 内置常用免费 DNS 服务商设置模板（每步、No-IP、Dynv6、Dynu），通过自定义回调进行快速接入，仅需修改相应用户密码或 token 即可一键填充。
5. 支持 阿里云，百度云，华为云，京东云，腾讯云，火山引擎，帝恩爱斯-DNS.LA,Cloudflare，deSEC,DNSPod.CN，DNSPod.COM，Dynadot，Dynv6，Freemyip ,GoDaddy，Name.com，NameSilo,Porkbun，Vercel等服务商。
### Web服务
1. 支持反向代理、重定向和 URL 跳转。
2. 支持 HTTP 基本认证。
3. 支持 IP 黑白名单模式。
4. 支持 UserAgent 黑白名单。
5. 规则日志清晰易懂，便于追踪异常。
6. 支持一键开关规则和定时开关规则。
### Stun内网穿透
1. 实现内网穿透，无需公网IPv4地址。
2. 适合于国内运营商级NAT1宽带网络.
### 网络唤醒
1. 支持远程控制唤醒和关机操作
2. 支持接入第三方物联网平台(点灯科技 巴法云),可通过各大平台的语音助手控制设备唤醒和关机.
### 计划任务
1. 不依赖 Linux 系统的 Cron，支持 Windows 系统。
2. 操作简便，可视化编辑。
3. 可操作控制 Lucky 框架内的其他模块开关。
### ACME自动证书
1. 支持 ACME 自动证书的申请和续签。
2. 支持 阿里云，百度云，华为云，京东云，腾讯云，火山引擎，帝恩爱斯-DNS.LA,Cloudflare，deSEC,DNSPod.CN，DNSPod.COM，Dynadot，Dynv6，Freemyip ,GoDaddy，Name.com，NameSilo,Porkbun，Vercel等服务商.
### 网络存储
1. 网络存储模块是一个应用范围广泛的模块，它提供了将本地存储、WebDAV和阿里云盘挂载到Lucky内部的各个文件类服务功能。
2. 通过网络存储模块，你可以将添加的存储挂载到Web服务的文件服务、WebDAV、FTP和FileBrowser模块，实现更加便捷的文件管理和访问。
## 一键安装
- [一键安装详看这里](https://github.com/gdy666/lucky-files)
## OpenwrtIPK包安装
- [Openwrt IPK包](https://github.com/gdy666/luci-app-lucky)
## 使用
- 默认后台管理地址 http://<运行设备IP>:16601
默认登录账号: 666
默认登录密码: 666
- 常规使用请用 -cd <配置文件夹路径> 指定配置文件夹的方式运行
```bash
#仅指定配置文件夹路径(如果配置文件夹不存在会自动创建),建议使用绝对路径
lucky -cd luckyconf
```
## Docker中使用
- 不挂载主机目录, 删除容器同时会删除配置
```bash
# host模式, 同时支持IPv4/IPv6, Liunx系统推荐
docker run -d --name lucky --restart=always --net=host gdy666/lucky
# 桥接模式, 只支持IPv4, Mac/Windows推荐,windows 不推荐使用docker版本
docker run -d --name lucky --restart=always -p 16601:16601 gdy666/lucky
```
- 在浏览器中打开`http://主机IP:16601`，修改你的配置，成功
- [可选] 挂载主机目录, 删除容器后配置不会丢失。可替换 `/root/luckyconf` 为主机目录, 配置文件夹为lucky
```bash
docker run -d --name lucky --restart=always --net=host -v /root/luckyconf:/goodluck gdy666/lucky
```
## 宝塔Docker安装
1. 安装宝塔面板 (9.2.0版本及以上)，前往 [宝塔面板](https://www.bt.cn/new/download.html) 官网，选择正式版的脚本下载安装
2. 安装后登录宝塔面板，在菜单栏中点击 Docker ，首次进入会提示安装 Docker 服务，点击立即安装，按提示完成安装
3. 安装完成后在应用商店中找到 lucky ，点击安装，配置基本选项 即可完成安装
## 后台界面
#### 动态域名服务
#### Http反向代理
#### 网络唤醒
#开发编译
```bash
go build -v -tags "adminweb nomsgpack" -ldflags="-s -w"
```
# 更新日志
2024-10-24 v2.13.4
1. 更新 quic-go，修复上个版本中 HTTP/3 导致的崩溃问题。
2. 修复 filebrowser 模块部分设置在重启后会重置的 bug。
3. 其他优化。
2024-10-19 v2.13.3
1. 修复已知bug
2. Web服务基本认证相关日志记录增加IP地址信息
3. Web服务 新增连接管理，支持手动断开连接，一键拉黑（未开放
2024-10-14 v2.13.2 Beta1
1. 增加一组备用 DNS 设置。
2. 默认设置 DNS 全部使用公共 DoH 服务。
3. 优化 DNS 切换策略。
4. 记录当前正常使用的 DNS 服务器，下一次启动时将优先使用。
2024-10-13 v2.13.1 Beta1
1. Lucky底层DNS解析新增对DoH3、DoQ、DoH和DoT的支持。 格式参考：
doh@https://doh.opendns.com/dns-query
2. IP地址库新增对lkdb格式的支持。
3. Web服务连续404错误次数统计中忽略对favicon.ico的记录。
4. 修复已知Bug。
5. 进行细节优化。
2024-10-04 v2.13.0 Beta1
1. 新增模块 — IP地址库
1.1 自动对相关日志信息中的IP地址数据进行富化（显示IP地址信息）
1.2 Web服务文本输出类型支持查询IP信息
1.3 针对IP地址信息的关键词进行IP过滤（未开放）
详细介绍和使用方法：请参考官网文档
2. 修复Web服务中 proxy_set_header host 无效的问题
3. 修复移动端浏览器复制域名失败的问题
4. 优化UDP转发性能
5. FileBrowser同步至最新源码
6. Web服务文本输出新增变量 ClientIPInfo 和 RemoteIPInfo，支持查询IP地址信息
7. IP过滤增加子规则类型 — IP地址信息关键字匹配，黑名单（未开放）
8. Web服务底层连接增加全局黑名单过滤处理
9. IP过滤全局黑名单影响范围覆盖FTP、WebDAV及FileBrowser模块
10. 优化连接数限制策略
11. 修复网络存储中添加WebDAV存储时导致的阻塞Bug
12. 修复已知Bug
[更多日志请查看](https://lucky666.cn/docs/category/%E6%9B%B4%E6%96%B0%E6%97%A5%E5%BF%97)
。