🔒 WG-Easy Installer

WG-Easy Installer is a comprehensive automation script that simplifies the deployment of wg-easy, a beautiful web interface for WireGuard VPN. This installer handles everything from dependency installation to SSL configuration, making it perfect for both beginners and advanced users.

• 🚀 One-Command Installation - Deploy WireGuard VPN in seconds
• 🔐 SSL/TLS Support - Automatic SSL certificates with Let's Encrypt
• 🌐 Custom Domain Support - Professional setup with your own domain
• 👥 Advanced User Management - Built-in client expiry system
• 🏷️ Custom Image Tags - Choose your preferred wg-easy version (default v15)
• 🔧 Easy Configuration - Modify settings without reinstalling
• 🛡️ Security First - No port conflicts, proper firewall handling
• 📱 Responsive Web UI - Modern interface for all devices
• 🔄 Auto-Updates - Daily client expiry enforcement via cron
• 📦 Zero Dependencies - Installs everything automatically

bash <(curl -fsSL https://raw.githubusercontent.com/deathline94/wg-easy-installer/master/wg-easy-install.sh)

That's it! The script will guide you through the setup process.

1. Dependency Check - Installs required packages (Docker, Nginx, Certbot, etc.)
2. Configuration - Prompts for wg-easy image tag, domain, and ports
3. SSL Setup - Automatically configures SSL certificates if domain provided
4. WireGuard Deployment - Sets up containerized WireGuard with Docker Compose
5. User Management - Configures client expiry system with cron jobs

This installer has been heavily tested and is fully compatible with wg-easy v15+. The script defaults to the 15 major tag to automatically receive minor updates and security patches while avoiding breaking changes.

• Domain: Leave blank for IP-based access
• Web UI Port: Default 51821 (customizable)
• WireGuard Port: Default 51820 (customizable)
• Access: http://YOUR_IP:UI_PORT

• Domain: Your domain (e.g., vpn.example.com)
• SSL: Automatic Let's Encrypt certificates
• Proxy Setup: Configures Nginx as a reverse proxy, and sets INSECURE=true in wg-easy so it can securely run behind the local Nginx proxy.
• Access: https://vpn.example.com:UI_PORT

Once installed, run the script again to access the management menu:

• Daily Checks: Automated cron job removes expired clients
• Flexible Management: Set, remove, or extend expiry dates
• Zero Downtime: Automatic service restart after changes

• Let's Encrypt Integration: Free SSL certificates
• Auto-Renewal: Certificates renew automatically
• Custom Ports: No conflicts with existing services
• Nginx Reverse Proxy: Professional-grade setup

• Containerized: Isolated and secure deployment
• IPv6 Support: Full dual-stack networking
• Resource Management: Optimized container configuration
• Easy Updates: Simple container version management

• Experimental Obfuscation: Bypass Deep Packet Inspection (DPI) in heavily restricted networks.
• Interactive Setup: The script will ask if you want to enable AmneziaWG during installation.
• Note: When enabled, standard WireGuard clients will not be able to connect. All users must use the official AmneziaWG app.

After installation, access your VPN management interface:

• With Domain: https://yourdomain.com:UI_PORT
• Without Domain: http://YOUR_IP:UI_PORT

1. Open the web interface
2. Click "Add Client"
3. Download the configuration file
4. Import into your WireGuard client

• Mobile: iOS, Android
• Desktop: Windows, macOS, Linux
• Router: pfSense, OPNsense, OpenWrt

Ensure these ports are open:

# WireGuard traffic
sudo ufw allow [WG_PORT]/udp

# Web interface
sudo ufw allow [UI_PORT]/tcp

• Use strong, unique passwords for the admin interface
• Regularly review and remove unused clients
• Enable client expiry for temporary access
• Monitor logs for suspicious activity
• Keep the system updated

• OS: Ubuntu 18.04+ / Debian 9+ / CentOS 7+
• RAM: 512MB
• Storage: 1GB free space
• Network: Public IP address

• OS: Ubuntu 22.04 LTS
• RAM: 1GB+
• CPU: 1 vCPU
• Storage: 5GB+ SSD

# Check what's using the port
sudo netstat -tlnp | grep :51821

# Kill the process if needed
sudo kill -9 [PID]

# Check certificate status
sudo certbot certificates

# Renew certificates manually
sudo certbot renew

# Restart Docker service
sudo systemctl restart docker

# Check container logs
docker logs wg-easy

• WG-Easy Logs: docker logs wg-easy
• Nginx Logs: /var/log/nginx/error.log
• Certbot Logs: /var/log/letsencrypt/letsencrypt.log

We welcome contributions! Here's how you can help:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

git clone https://github.com/deathline94/wg-easy-installer.git
cd wg-easy-installer
# Make your changes and test

This project is licensed under the MIT License - see the LICENSE file for details.

• WG-Easy Project - The amazing WireGuard web interface this installer is built around
• WireGuard - The revolutionary VPN technology
• Community Contributors - Thank you for your feedback and contributions!

If you find this project useful, please consider:

• ⭐ Starring the repository
• 🐛 Reporting bugs and issues
• 💡 Suggesting new features
• 🤝 Contributing code improvements