Mirrors/wireguard_webadmin
1
0
Fork 0
mirror of https://github.com/eduardogsilva/wireguard_webadmin.git synced 2025-08-26 13:21:14 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improved docker-compose to handle server_address. Also added an option to run without nginx.

Browse Source
This commit is contained in:
Eduardo Silva
2024-02-16 11:59:03 -03:00
parent 5e598deba3
commit 6a2648ddf7
7 changed files with 118 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@@ -1,4 +1,3 @@
# wireguard_webadmin
wireguard_webadmin is a full-featured yet easy-to-configure web interface for managing WireGuard VPN instances. Designed to simplify the administration of WireGuard networks, it provides a user-friendly interface that supports multiple users with varying access levels, multiple WireGuard instances with individual peer management, and support for crypto key routing for site-to-site interconnections.
@@ -19,31 +18,36 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
Follow these steps to deploy wireguard_webadmin:
1. Clone the repository:
1. **Clone the repository:**
```
git clone https://github.com/eduardogsilva/wireguard_webadmin
```
2. Create the `wireguard_webadmin/production_settings.py` file and configure the minimum required variables:
```python
DEBUG = False
ALLOWED_HOSTS = ['your_domain']
CSRF_TRUSTED_ORIGINS = ['https://your_domain']
SECRET_KEY = 'your_secret_key'
```
2. **Place your SSL certificates for nginx in the `certificates` volume.**
The files should be named `nginx.pem` and `nginx.key`. You can use self-signed certificates and accept the certificate exception in your browser.
3. Place your SSL certificates for nginx in the `certificates` volume.
3. **Run Docker Compose (choose one):**
4. Run Docker Compose:
```
docker-compose up
```
### With NGINX (Recommended)
This mode is recommended for running the webadmin. Set up your certificates for nginx; you can use a self-signed certificate. If you don't have a DNS name pointing to your server, use `SERVER_ADDRESS=ip_address`.
After completing these steps, your wireguard_webadmin should be up and running. Access your server using `http://your_domain` and start configuring it.
```
SERVER_ADDRESS=yourserver.example.com docker-compose up --build -d
```
Access the web interface using `https://yourserver.example.com`.
### Without NGINX (Debug mode and testing only)
This mode does not require SSL certificates and runs Django with `DEBUG=True`. Not recommended for production use without HTTPS.
```
docker-compose -f docker-compose-no-nginx.yml up --build -d
```
Access the web interface using `http://127.0.0.1:8000`.
After completing these steps, your wireguard_webadmin should be up and running. Begin configuration by accessing your server.
## Contributing
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
Contributions make the open-source community an amazing place to learn, inspire, and create. Your contributions are **greatly appreciated**.
## Support