|
|
||
|---|---|---|
| .github/workflows | ||
| public | ||
| src | ||
| .dockerignore | ||
| .editorconfig | ||
| .eslintrc.json | ||
| .gitignore | ||
| .stylelintrc.json | ||
| create-user.js | ||
| docker-compose.yml | ||
| Dockerfile | ||
| next-env.d.ts | ||
| next.config.js | ||
| package-lock.json | ||
| package.json | ||
| postcss.config.js | ||
| README.md | ||
| tailwind.config.js | ||
| tsconfig.json | ||
wgdash
is a simple yet effective tool for monitoring your WireGuard connections (on Linux).
Getting started
To best way to quickly get wgdash up and running is by using docker compose.
mkdir wgdash && cd wgdash
cat <<EOF >docker-compose.yml
version: '3'
services:
wgdash:
image: ghcr.io/christoph-heiss/wgdash:latest
restart: unless-stopped
cap_add:
- NET_ADMIN
network_mode: host
EOF
docker compose up -d
This will use the latest CD-built image.
Development
To run it directly on your machine, without a Docker container:
npm install
npm run dev
To allow wgdash to actually use the Linux' kernel
netlink interface, it
generally needs the have CAP_NET_ADMIN set on the node binary.
This can be done using
sudo setcap cap_net_admin+eip $(which node)
License
Licensed under MIT license (LICENSE or https://opensource.org/licenses/MIT).
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you shall be licensed by MIT license as above, without any additional terms or conditions.