https://github.com/devcore321/wg-easy
wg-easy simplifies the installation and management of WireGuard on Linux hosts. With user-friendly features and seamless integration, it makes setting up secure connections a breeze. 🐙✨
https://github.com/devcore321/wg-easy
ad-block ad-blocking configuration dns dns-server docker docker-image encryption firefly go ipv6 nat security vpn vpn-server wg-api wg-easy wg-easy-wrapper
Last synced: 12 months ago
JSON representation
wg-easy simplifies the installation and management of WireGuard on Linux hosts. With user-friendly features and seamless integration, it makes setting up secure connections a breeze. 🐙✨
- Host: GitHub
- URL: https://github.com/devcore321/wg-easy
- Owner: Devcore321
- License: agpl-3.0
- Created: 2025-05-30T17:12:35.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-06-21T14:00:16.000Z (12 months ago)
- Last Synced: 2025-06-21T15:18:44.976Z (12 months ago)
- Topics: ad-block, ad-blocking, configuration, dns, dns-server, docker, docker-image, encryption, firefly, go, ipv6, nat, security, vpn, vpn-server, wg-api, wg-easy, wg-easy-wrapper
- Language: TypeScript
- Size: 3.22 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# wg-easy: The Easiest Way to Run WireGuard VPN 🌐
Welcome to the **wg-easy** repository! This project offers a straightforward way to set up and manage a WireGuard VPN, complete with a web-based admin interface. If you want to enhance your online privacy and security, you’ve come to the right place.
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Configuration](#configuration)
- [Admin UI](#admin-ui)
- [Contributing](#contributing)
- [License](#license)
- [Releases](#releases)
## Introduction
WireGuard is a modern VPN protocol known for its simplicity and high performance. With **wg-easy**, you can easily deploy WireGuard without diving into complex configurations. Our goal is to make VPN setup accessible to everyone.
## Features
- **Easy Installation**: Get up and running in minutes.
- **Web-Based Admin UI**: Manage your VPN connections with a user-friendly interface.
- **Secure Connections**: Benefit from WireGuard's robust security features.
- **Lightweight**: Minimal resource usage ensures efficient performance.
- **Cross-Platform**: Compatible with various operating systems.
## Installation
To install **wg-easy**, follow these steps:
1. **Download the latest release** from the [Releases section](https://github.com/Devcore321/wg-easy/releases). Make sure to choose the correct file for your system.
2. **Execute the downloaded file** to start the installation process.
### Example Command
```bash
chmod +x wg-easy-linux-amd64
./wg-easy-linux-amd64
```
Make sure to replace `wg-easy-linux-amd64` with the actual file name you downloaded.
## Usage
Once installed, you can start using **wg-easy** right away. Here’s how:
1. **Start the application** by running the executable.
2. **Access the Admin UI** through your web browser at `http://localhost:51820`.
3. **Configure your VPN settings** through the interface.
## Configuration
Configuring your WireGuard VPN is simple. You can add users, set up peers, and manage connections directly from the Admin UI.
### Basic Configuration Steps
1. **Add a new user**: Click on "Add User" and fill in the required details.
2. **Set up peers**: Configure peer settings to connect with other devices.
3. **Adjust server settings**: Modify the server configuration as needed.
## Admin UI
The web-based Admin UI is designed for ease of use. You can perform various tasks, such as:
- Viewing active connections
- Monitoring data usage
- Generating configuration files for clients
### Screenshot of the Admin UI
## Contributing
We welcome contributions from the community! If you want to help improve **wg-easy**, please follow these steps:
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them.
4. Push your branch and submit a pull request.
Your contributions help us make this project better for everyone.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Releases
For the latest updates and downloads, please visit the [Releases section](https://github.com/Devcore321/wg-easy/releases). Make sure to download the appropriate file for your system and execute it to get started.
## Conclusion
Thank you for checking out **wg-easy**! We hope this tool makes your VPN experience seamless and secure. If you have any questions or feedback, feel free to reach out through the issues section.
Let's secure your online presence together!