Skip to content

Latest commit

 

History

History
158 lines (98 loc) · 5.9 KB

README.md

File metadata and controls

158 lines (98 loc) · 5.9 KB
Raw


firefly

Firefly WireGuard Server

Features • Usage • Credits • Contact • License

English 中文

Firefly is a simple and easy to install WireGuard server software, which can be widely used in scenarios such as remote networking, remote work, and expose a local server behind a NAT or firewall to the internet.

firefly

🎯 Features

🟢 Provide a beautiful, simple, and easy-to-use web management UI

🟣 Support all native WireGuard client access

🟡 Compact and lightweight, less than 10M in size, does not rely on WireGuard

🟠 Developed in Go language, single file, high-performance, supports multi CPU architecture

🔴 Support automatic application and renewal of free SSL certificates

🔵 Support TCP protocol relay and prevent UDP QoS flow limitation (advanced version)

🚀 Usage

Firefly supports CPU architecture environments such as Linux x86 and ARM. The download address for the Firefly server and WireGuard clients is: https://github.com/Safe3/firefly/releases .

  • Server Installation

Select the corresponding public server, such as x86 environment, please download firefly-linux-amd64

Add executable permissions：

chmod +x ./firefly

Run it：

./firefly

Run in background：

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

Run in container：download docker-compose.yml and execute

docker compose up -d

Visit http://ip:50121 ,login to the management backend with the default password firefly

☣️ If the server is using cloud services, remember to open the UDP port 50120 and TCP port 50121-50122 required for Firefly

  • Server Configuration

The first time running firefly will generate a conf/config.json configuration file in the software root directory, as follows:

{
 "version": 4.3,              // Firefly current version
 "host": "7.7.7.7",           // Firefly web management IP or domain name
 "port": 50121,               // Firefly web management port
 "auto_ssl": false,           // Is the firefly web enabled to automatically obtain Let's Encrypt certificate issuance? If enabled, please change the port to 443
 "password": "firefly",       // Firefly web management login authentication password
 "lang": "en",                // Firefly web management UI language
 "ui_traffic_stats": true,    // Firefly web management traffic chart switch
 "ui_chart_type": 2,          // Firefly web management traffic chart type
 "log_level": "error",        // Firefly server logging level
 "wg_private_key": "YBw5KAo1vM2mz35GLhZB01ZNYWJYWdGZNQT1MebuCHk=",  // WireGuard server private key
 "wg_device": "eth0",                   // WireGuard server in/out traffic network card name
 "wg_port": 50120,                      // WireGuard server UDP port
 "wg_mtu": 1280,                        // WireGuard server MTU value
 "wg_persistent_keepalive": 25,         // WireGuard client keepalive packet sending interval time
 "wg_address": "198.18.0.1/15",         // WireGuard client virtual IP network range
 "wg_dns": "1.1.1.1",                   // WireGuard client DNS configuration
 "wg_allowed_ips": "0.0.0.0/0, ::/0",   // WireGuard client allowed ips
 "wg_proxy_address": ":50122"           // TCP relay listening address,which can prevent UDP QoS flow limitation
}

  • Client configuration

After creating multiple clients in the web management UI on the server side, import the WireGuard client configuration in the following way.

1.WireGuard mobile client can directly scan the firefly web QR code to import configuration

2.WireGuard PC client can download the firefly web configuration file to the local device and import the configuration

💝 Credits

Thanks to all the amazing community contributors for sending PRs and keeping this project updated. ❤️

If you have an idea or some kind of improvement, you are welcome to contribute and participate in the Project, feel free to send your PR.

😘 Contact

If you want to support more features such as access controling, advanced routing, bastion machines, peer-to-peer transmission, etc, please contact us.

🔑 License

Firefly is only for personal free use. The front-end of this project is sourced from wg easy , follow the original project CC 4.0 license, thanks for the original auther Emile Nijssen！