https://github.com/brsyuksel/wghttp

a web server manages wireguard devices and peers
https://github.com/brsyuksel/wghttp

wireguard

Last synced: about 2 months ago
JSON representation

a web server manages wireguard devices and peers

• Host: GitHub
• URL: https://github.com/brsyuksel/wghttp
• Owner: brsyuksel
• License: gpl-2.0
• Created: 2022-11-24T14:12:54.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-06T08:32:18.000Z (about 1 year ago)
• Last Synced: 2024-11-19T03:03:22.485Z (2 months ago)
• Topics: wireguard
• Language: Rust
• Homepage:
• Size: 96.7 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-wireguard - brsyuksel/wghttp - A http server helps managing wireguard devices and peers on kernel level. (Projects / User Interface)

README

        
# wghttp

a web server helps you managing your wireguard devices and peers.

## how to use

run `wghttp` command to listen unix socket `/var/run/wghttp.socket`, you can also specify path by using `--unix PATH` option.

if you want to make it listening tcp use `--tcp SOCK_ADDR` option, e.g, `--tcp 0.0.0.0:9204`

see `wghttp --help` for details.

> NOTE THAT `wghttp` needs root permissions since it manages devices, so I strongly suggest you to run it listening unix socket. using unix socket can leverage user permissions to your operating system.

### api

visit `/api-doc.json`, you will have openapi 3 specs, use a client supports openapi import like Postman.

## tests

tests depends `wg` and `ip` commands, so make sure you install relevant packages in your env before running tests.

## copyright

"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld.