Skip to content

Latest commit

 

History

History
179 lines (109 loc) · 6.3 KB

README_CN.md

File metadata and controls

179 lines (109 loc) · 6.3 KB
Raw


firefly

萤火虫 WireGuard Server

特色 • 使用 • 感谢 • 联系 • 授权

中文 English

最简单易用的轻量级、高性能 WireGuard 服务端软件，可广泛用于异地组网、远程办公、内网穿透等场景。

🏠 全功能在线SAAS版请访问官网：https://qq.uusec.com/

firefly

🎯 特色

🟢 提供美观且简单、易用的web管理后台

🟣 支持所有原生 WireGuard 客户端接入

🟡 小巧轻量级，不到10M大小，不依赖WireGuard

🟠 go语言开发，单文件、高性能、支持多CPU架构

🔴 支持自动申请免费SSL证书并续期

🔵 支持TCP协议中转，防UDP QoS限流（高级版）

🚀 使用

萤火虫支持Linux x86、ARM CPU架构，服务端和客户端下载地址: https://github.com/Safe3/firefly/releases 。

  • 服务端安装

准备一台公网IP服务器，选择对应的CPU架构，如x86 64环境请下载firefly-linux-amd64

添加可执行权限：

chmod +x ./firefly

前台运行：

./firefly

后台运行：

nohup ./firefly >/dev/null 2>&1 &

容器中运行：下载docker-compose.yml文件然后执行

docker compose up -d

访问 http://ip:50121 登录管理后台，默认密码firefly

☣️ 如果服务器使用的是各种云服务，记得在云服务管理后台上开放萤火虫所需的udp端口50120、tcp端口50121和50122

  • 服务端配置

首次运行firefly会在软件目录生成conf/config.json配置文件，配置说明如下：

{
 "version": 4.3,              // 萤火虫当前版本
 "host": "7.7.7.7",           // 萤火虫web管理后台ip或域名，默认为自动获取的公网ip
 "port": 50121,               // 萤火虫web管理后台端口
 "auto_ssl": false,           // 萤火虫web是否启用自动申请免费SSL证书并续期，启用前将web端口改为443并配置host为域名
 "password": "firefly",       // 萤火虫web管理后台登录认证密码
 "lang": "en",                // 萤火虫web管理后台多语言支持，中文请将en改为cn
 "ui_traffic_stats": true,    // 萤火虫web管理后台是否开启流量图特效
 "ui_chart_type": 2,          // 萤火虫web管理后台流量特效图类型
 "log_level": "error",        // 萤火虫服务端日志记录等级
 "wg_private_key": "YBw5KAo1vM2mz35GLhZB01ZNYWJYWdGZNQT1MebuCHk=",  // 萤火虫服务端 WireGuard 私钥
 "wg_device": "eth0",                   // 萤火虫服务端 WireGuard 出入流量网卡名称
 "wg_port": 50120,                      // 萤火虫服务端 WireGuard UDP端口
 "wg_mtu": 1280,                        // 萤火虫服务端 WireGuard MTU值
 "wg_persistent_keepalive": 25,         // 萤火虫客户端存活包发送间隔时间
 "wg_address": "198.18.0.1/15",         // 萤火虫客户端虚拟ip网段范围
 "wg_dns": "1.1.1.1",                   // 萤火虫客户端dns配置
 "wg_allowed_ips": "0.0.0.0/0, ::/0",   // 萤火虫客户端要转发流量到服务端的ip地址范围，默认所有流量
 "wg_proxy_address": ":50122"           // 萤火虫TCP协议中转监听地址，可防止UDP QoS限流
}

  • 客户端安装

萤火虫支持所有原生WireGuard官方和第三方客户端，包括Windows、Linux、Mac、iOS、Android，下载地址：https://github.com/Safe3/firefly/releases ，根据提示一步步安装。

  • 客户端配置

登录萤火虫服务端web管理后台，新建2个客户端，通过以下方式导入WireGuard客户端配置。

1.移动客户端可直接扫描萤火虫后台二维码导入配置

2.Windows、Mac客户端可下载萤火虫后台配置文件到本地后从WireGuard界面导入配置

3.Linux客户端将配置文件保存到/etc/wireguard/firefly.conf，执行wg-quick up firefly启动wireguard，开机自启动systemctl enable wg-quick@firefly

两个客户端启动之后，可以通过萤火虫服务端分配的ip 198.18.0.x 直接相互访问

💝 感谢

由于开源后社区贡献代码为零，本项目不再开源。此repo仅供反馈bug和提建议，请支持萤火虫的朋友点个 ❤️ 赞！

捐赠请扫描如下二维码：

捐赠

😘 联系

若想支持更多功能，如权限分组、高级路由、堡垒机、点对点传输等，请访问鹊桥: https://qq.uusec.com

🔑 授权

萤火虫仅限于个人免费使用！