MikroWizard/MikroWizard_wireguard
1
0
Fork 0
mirror of https://github.com/MikroWizard/MikroWizard_wireguard.git synced 2026-06-20 02:07:38 +00:00
Code Issues Projects Releases Packages Wiki Activity
MikroWizard WireGuard server docker with api and tools
3 commits 1 branch 0 tags 59 KiB
  • Python 89.3%
  • Shell 9.4%
  • Dockerfile 1.3%
Find a file
Exact
sepehr 434f1a6bb8 improve installer,README
2026-04-10 12:11:34 +03:00
.gitignore Initialize public repository with AGPL-3.0 and install.sh 2026-03-29 17:32:40 +03:00
app.py Initialize public repository with AGPL-3.0 and install.sh 2026-03-29 17:32:40 +03:00
Dockerfile Initialize public repository with AGPL-3.0 and install.sh 2026-03-29 17:32:40 +03:00
install.sh improve installer,README 2026-04-10 12:11:34 +03:00
LICENSE Initialize public repository with AGPL-3.0 and install.sh 2026-03-29 17:32:40 +03:00
README.md improve installer,README 2026-04-10 12:11:34 +03:00

README.md

MikroWG - WireGuard API Agent

License: AGPL-v3.0 Docker Hub

MikroWizard WireGuard Addon is a lightweight, secure, and fast WireGuard management agent designed for the MikroWizard ecosystem. It provides a RESTful API to manage VPN interfaces, peer connectivity, and real-time bandwidth monitoring.

🚀 Quick Install

To install MikroWizard WireGuard Addon on a server already running MikroWizard:

sudo bash -c "$(curl -sSL https://raw.githubusercontent.com/MikroWizard/MikroWizard_wireguard/refs/heads/master/install.sh)"

This script will:

  1. Pull the official mikrowizard/wireguard-addon:latest image.
  2. Prompt for basic VPN configuration (Port, Subnet, MTU, etc.).
  3. Configure the local WireGuard kernel module.
  4. Auto-integrate with your existing MikroWizard /opt/mikrowizard/server-conf.json.

🛠️ Key Features

  • Real-time Monitoring: Instant RX/TX speed tracking for the server and individual peers.
  • Security First: Hardened iptables defaults, including MSS Clamping for MTU stability.
  • Zero-Config Peers: Automatic generation of client configs and QR Codes for mobile devices.
  • NAT Management: Intelligent SNAT/MASQUERADE handling for split and full tunnel modes.
  • Dockerized: Isolated environment with minimal host dependencies.

📖 API Usage

The agent listens on 127.0.0.1:8000 (host-only for security). All requests require a Bearer token.

Authentication

Include the following header: Authorization: Bearer <YOUR_ADDON_TOKEN>

Common Endpoints

Method Endpoint Description
GET /health Verify agent and interface status
GET /status Get detailed peer transfer stats
GET /status/live Real-time bandwidth speeds (JSON)
POST /peer/add Create/Update a new WireGuard peer
GET /peer/{pubkey}/qrcode Generate a mobile-ready QR code

🔒 Security

For optimal security, this agent binds to the host's loopback interface (127.0.0.1). It is intended to be accessed by a local process or a reverse proxy.

📜 License

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). See the LICENSE file for details.

Developed by Sepehr Hashtroudilar MikroWizard