https://github.com/secshellnet/wpm-django
Django App for Wireguard Peer Manager
https://github.com/secshellnet/wpm-django
django-package python-package
Last synced: 3 months ago
JSON representation
Django App for Wireguard Peer Manager
- Host: GitHub
- URL: https://github.com/secshellnet/wpm-django
- Owner: secshellnet
- Created: 2023-10-12T06:56:56.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-15T09:32:22.000Z (over 1 year ago)
- Last Synced: 2024-01-28T13:39:42.800Z (over 1 year ago)
- Topics: django-package, python-package
- Language: Python
- Homepage:
- Size: 19.5 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Wireguard Peer Manager: django-wpm
Wireguard Peer Manager is used for managing Road Warrior VPN endpoints and consists of two components. Users and
administrators utilize the [Django app](https://github.com/secshellnet/wpm-django) for graphical management of
Wireguard peers. It communicates with the router's REST API (for VyOS
[this project](https://github.com/secshellnet/wpm-api-vyos)) to apply the Wireguard configuration.
After the user logs in, they can easily create new Wireguard peers (each device should have its own peer to enable
simultaneous connections) and view or delete the Wireguard configuration. Due to this abstraction layer, end-users don't
need access to the router to manage their peers but also don't have to open a ticket every time they want to make a new
device VPN-enabled.
When creating new peers, the browser generates an asymmetric key pair upon the user's request and also a pre-shared key
(PSK), which needs to be set up on both sides for the tunnel to function. The private key is not sent to the server and
not stored in the browser, so the user must save it directly.
Afterward, the user sees the newly created peer in the list of registered peers with a red status indicator. Once it
changes to green (usually taking no longer than 30 seconds), the peer is usable.
All clients connecting to the same router use the same Wireguard endpoint (in our case, the interface `wg100`),
differing only in the IPv4 and IPv6 addresses used within the tunnel.
## Quick start
1. Add `wpm.apps.WpmConfig` to your `INSTALLED_APPS` setting like this:
```py
INSTALLED_APPS = [
# ...,
"wpm.apps.WpmConfig",
]
```
2. Run `python manage.py migrate` to create the wpm models.
3. Start the development server and visit http://127.0.0.1:8000/admin/wpm to use the app.