c8h4/wgdash
Archived
1
0
Fork 0
Code Activity
A simple dashboard for your WireGuard server.
This repository has been archived on 2024-06-24. You can view files and clone it, but cannot push or open issues or pull requests.
11 commits 1 branch 0 tags 204 KiB
TypeScript 85.3%
JavaScript 9%
Dockerfile 4.6%
SCSS 1.1%
Find a file
Christoph Heiss 54ffc131e8
Some checks failed
Lint and build / lint (push) Has been cancelled
Lint and build / build (push) Has been cancelled
Lint and build / docker-image (push) Has been cancelled
refactor: Rework API request handling with an Either<> type 
Signed-off-by: Christoph Heiss <contact@christoph-heiss.at>
2022-09-07 23:34:04 +02:00
.github/workflows feat: Add GitHub Actions CI pipeline 2022-07-15 00:11:49 +02:00
public feat: Add GitHub Actions CI pipeline 2022-07-15 00:11:49 +02:00
src refactor: Rework API request handling with an Either<> type 2022-09-07 23:34:04 +02:00
.dockerignore Initial commit 2022-07-15 00:11:42 +02:00
.editorconfig Initial commit 2022-07-15 00:11:42 +02:00
.eslintrc.json Initial commit 2022-07-15 00:11:42 +02:00
.gitignore chore: Do not commit data/ directory 2022-07-15 00:11:48 +02:00
.stylelintrc.json Initial commit 2022-07-15 00:11:42 +02:00
create-user.js chore: Add license 2022-09-07 22:15:24 +02:00
docker-compose.yml chore: Add an actual README 2022-07-15 11:47:32 +02:00
Dockerfile fix: Use custom node_netlink fork (for now) to fix linkstats 2022-09-07 22:34:45 +02:00
LICENSE chore: Add license 2022-09-07 22:15:24 +02:00
next-env.d.ts Initial commit 2022-07-15 00:11:42 +02:00
next.config.js refactor: Make cookie 'secure' setting more configurable 2022-07-15 00:11:49 +02:00
package-lock.json fix: Use custom node_netlink fork (for now) to fix linkstats 2022-09-07 22:34:45 +02:00
package.json fix: Use custom node_netlink fork (for now) to fix linkstats 2022-09-07 22:34:45 +02:00
postcss.config.js Initial commit 2022-07-15 00:11:42 +02:00
README.md chore: Add an actual README 2022-07-15 11:47:32 +02:00
tailwind.config.js Initial commit 2022-07-15 00:11:42 +02:00
tsconfig.json Initial commit 2022-07-15 00:11:42 +02:00

README.md

wgdash

Lint and build

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.