diff --git a/apps/lucky/README.md b/apps/lucky/README.md new file mode 100644 index 0000000..1441fe6 --- /dev/null +++ b/apps/lucky/README.md @@ -0,0 +1,85 @@ +# Lucky + +Lucky 是一款集端口转发、流量转发、WAF、防火墙、备份等多功能于一体的网络加速与安全工具,支持 OpenWrt、Docker、Linux 等多平台部署,适用于家庭、企业、开发者等多种场景。 + +## 主要功能 + +- **端口转发/流量转发**:支持多种协议的端口转发,轻松实现内外网互通。 +- **WAF 防火墙**:内置 Web 应用防火墙,有效防护常见攻击。 +- **多平台支持**:兼容 OpenWrt、Docker、Linux、Windows 等主流平台。 +- **IPv4/IPv6 支持**:支持双栈网络,适应多种网络环境。 +- **配置备份与还原**:一键备份/恢复配置,升级无忧。 +- **Web 管理界面**:直观易用的 Web UI,支持多用户管理。 +- **自动升级**:支持后台上传升级包或手动替换升级。 + +## 部署模式说明 + +Lucky 提供两种 Docker 部署模式: + +- **host 模式(推荐)**: + - 使用主机网络,支持 IPv4/IPv6,端口固定 16601。 + - 适合需要完整网络能力、IPv6、端口穿透等高级场景。 +- **bridge 模式**: + - 支持自定义端口映射(默认 16601:16601),仅支持 IPv4。 + - 适合需要端口隔离、面板统一管理的场景。 + +> 配置目录(容器内):`/goodluck`,主机目录可自定义,建议持久化保存。 + +## 典型使用场景 + +- 家庭/企业内网穿透与端口映射 +- 多端口/多协议转发与流量管理 +- Web 服务安全防护(WAF) +- OpenWrt 路由器高级网络管理 +- Docker 环境下的统一端口转发与备份 + +## 平台与架构支持 + +- OpenWrt、Docker、Linux、Windows +- 支持 amd64、arm64、arm/v7 等主流架构 + +## 快速部署(Docker 示例) + +**host 网络模式(推荐,支持 IPv4/IPv6)** +```yaml +services: + lucky: + image: gdy666/lucky + container_name: lucky + network_mode: host + volumes: + - ./luckyconf:/goodluck + restart: always +``` + +**bridge 网络模式(仅支持 IPv4,部分功能受限)** +```yaml +services: + lucky: + image: gdy666/lucky + container_name: lucky + ports: + - 16601:16601 + volumes: + - ./luckyconf:/goodluck + restart: always +``` + +## 常见问题 FAQ + +- **Q: 默认管理端口和账号密码?** + A: 默认端口 16601,账号/密码均为 666。 +- **Q: 如何备份和升级?** + A: 可在 Web 后台一键备份/还原配置,或上传升级包升级。 +- **Q: bridge 模式下端口无法访问?** + A: 建议优先使用 host 模式,bridge 模式部分环境下端口访问有限制。 +- **Q: 支持哪些平台?** + A: OpenWrt、Docker、Linux、Windows 等。 +- **Q: 配置目录如何持久化?** + A: 挂载主机目录到 `/goodluck`,如 `./luckyconf:/goodluck`,升级/重装不丢失配置。 + +## 官方文档与支持 + +- 官网:[https://lucky666.cn/](https://lucky666.cn/) +- 安装文档:[https://lucky666.cn/docs/install](https://lucky666.cn/docs/install) +- GitHub:[https://github.com/gdy666/lucky](https://github.com/gdy666/lucky) \ No newline at end of file diff --git a/apps/lucky/README_en.md b/apps/lucky/README_en.md new file mode 100644 index 0000000..17698d6 --- /dev/null +++ b/apps/lucky/README_en.md @@ -0,0 +1,72 @@ +# Lucky + +Lucky is an all-in-one network acceleration and security tool integrating port forwarding, traffic proxy, WAF, firewall, and backup. It supports OpenWrt, Docker, Linux, and more, suitable for home, enterprise, and developer scenarios. + +## Main Features + +- **Port/Traffic Forwarding**: Supports multiple protocols, easily connect internal and external networks. +- **WAF Firewall**: Built-in web application firewall for effective protection. +- **Multi-Platform Support**: Compatible with OpenWrt, Docker, Linux, Windows, etc. +- **IPv4/IPv6 Support**: Dual-stack network support for various environments. +- **Config Backup & Restore**: One-click backup/restore, worry-free upgrades. +- **Web UI**: Intuitive web management, multi-user support. +- **Auto Upgrade**: Upgrade via web or manual replacement. + +## Typical Use Cases + +- Home/enterprise NAT traversal and port mapping +- Multi-port/protocol forwarding and traffic management +- Web service security (WAF) +- Advanced network management for OpenWrt routers +- Unified port forwarding and backup in Docker + +## Platform & Architecture Support + +- OpenWrt, Docker, Linux, Windows +- Supports amd64, arm64, arm/v7, etc. + +## Quick Deployment (Docker Example) + +**Host network mode (recommended, IPv4/IPv6 supported)** +```yaml +services: + lucky: + image: gdy666/lucky + container_name: lucky + network_mode: host + volumes: + - ./luckyconf:/goodluck + restart: always +``` + +**Bridge network mode (IPv4 only, some features limited)** +```yaml +services: + lucky: + image: gdy666/lucky + container_name: lucky + ports: + - 16601:16601 + volumes: + - ./luckyconf:/goodluck + restart: always +``` + +> Config directory (in container): `/goodluck`, host path customizable. + +## FAQ + +- **Q: Default admin port and credentials?** + A: Default port 16601, username/password: 666/666. +- **Q: How to backup and upgrade?** + A: Use web UI for one-click backup/restore or upload upgrade package. +- **Q: Bridge mode port not accessible?** + A: Host mode is recommended; bridge mode may have port access issues in some environments. +- **Q: Which platforms are supported?** + A: OpenWrt, Docker, Linux, Windows, etc. + +## Official Docs & Support + +- Website: [https://lucky666.cn/](https://lucky666.cn/) +- Install Guide: [https://lucky666.cn/docs/install](https://lucky666.cn/docs/install) +- GitHub: [https://github.com/gdy666/lucky](https://github.com/gdy666/lucky) \ No newline at end of file diff --git a/apps/lucky/bridge/data.yml b/apps/lucky/bridge/data.yml new file mode 100644 index 0000000..3b68a99 --- /dev/null +++ b/apps/lucky/bridge/data.yml @@ -0,0 +1,17 @@ +additionalProperties: + formFields: + - default: 16601 + edit: true + envKey: PANEL_APP_PORT_HTTP + labelEn: Port + labelZh: 管理端口 + required: true + rule: paramPort + type: number + - default: ./luckyconf + edit: true + envKey: LUCKY_CONF_PATH + labelEn: Config Path + labelZh: 配置目录 + required: true + type: string \ No newline at end of file diff --git a/apps/lucky/bridge/docker-compose.yml b/apps/lucky/bridge/docker-compose.yml new file mode 100644 index 0000000..22defa2 --- /dev/null +++ b/apps/lucky/bridge/docker-compose.yml @@ -0,0 +1,9 @@ +services: + lucky: + image: gdy666/lucky + container_name: lucky + ports: + - "${PANEL_APP_PORT_HTTP:-16601}:16601" + volumes: + - "${LUCKY_CONF_PATH:-./luckyconf}:/goodluck" + restart: always \ No newline at end of file diff --git a/apps/lucky/data.yml b/apps/lucky/data.yml new file mode 100644 index 0000000..7806d67 --- /dev/null +++ b/apps/lucky/data.yml @@ -0,0 +1,48 @@ +name: Lucky + +tags: + - 实用工具 + - 网络工具 + - 代理 + - 防火墙 + - 端口转发 + - OpenWrt + - Docker + - 备份 + - 跨平台 +title: 一站式网络加速与端口转发工具 +description: Lucky 是一款集端口转发、流量转发、WAF、备份等多功能于一体的网络加速与安全工具,支持多平台部署。 +additionalProperties: + key: lucky + name: Lucky + tags: + - Tool + - Network + - Proxy + - Firewall + - OpenWrt + - Docker + - Backup + - CrossPlatform + shortDescZh: 一站式网络加速与端口转发工具,支持多平台和多架构。 + shortDescEn: All-in-one network acceleration and port forwarding tool, cross-platform and multi-architecture supported. + description: + en: All-in-one network acceleration, port forwarding, WAF, and backup tool. Supports OpenWrt, Docker, and more. Easy to deploy, powerful and secure. + ja: 多機能ネットワーク加速・ポート転送・WAF・バックアップツール。OpenWrtやDocker等に対応。 + ms: Alat pecutan rangkaian, pemajuan port, WAF dan sandaran serba lengkap, menyokong pelbagai platform. + pt-br: Ferramenta completa de aceleração de rede, encaminhamento de portas, WAF e backup, com suporte multiplataforma. + ru: Многофункциональный инструмент для ускорения сети, проброса портов, WAF и резервного копирования, поддержка разных платформ. + ko: 네트워크 가속, 포트 포워딩, WAF, 백업을 지원하는 올인원 도구, 다양한 플랫폼 지원. + zh-hant: 一站式網絡加速與端口轉發工具,支援多平台和多架構。 + zh: Lucky 是一款集端口转发、流量转发、WAF、备份等多功能于一体的网络加速与安全工具,支持多平台部署。 + type: website + crossVersionUpdate: true + limit: 0 + recommend: 0 + website: https://lucky666.cn/ + github: https://github.com/gdy666/lucky + document: https://lucky666.cn/docs/install + architectures: + - amd64 + - arm64 + - arm/v7 \ No newline at end of file diff --git a/apps/lucky/host/data.yml b/apps/lucky/host/data.yml new file mode 100644 index 0000000..3b68a99 --- /dev/null +++ b/apps/lucky/host/data.yml @@ -0,0 +1,17 @@ +additionalProperties: + formFields: + - default: 16601 + edit: true + envKey: PANEL_APP_PORT_HTTP + labelEn: Port + labelZh: 管理端口 + required: true + rule: paramPort + type: number + - default: ./luckyconf + edit: true + envKey: LUCKY_CONF_PATH + labelEn: Config Path + labelZh: 配置目录 + required: true + type: string \ No newline at end of file diff --git a/apps/lucky/host/docker-compose.yml b/apps/lucky/host/docker-compose.yml new file mode 100644 index 0000000..5ed30e1 --- /dev/null +++ b/apps/lucky/host/docker-compose.yml @@ -0,0 +1,8 @@ +services: + lucky: + image: gdy666/lucky + container_name: lucky + network_mode: host + volumes: + - "${LUCKY_CONF_PATH:-./luckyconf}:/goodluck" + restart: always \ No newline at end of file diff --git a/apps/lucky/logo.png b/apps/lucky/logo.png new file mode 100644 index 0000000..aebfc74 Binary files /dev/null and b/apps/lucky/logo.png differ