https://github.com/davdiv/wgnet

https://github.com/davdiv/wgnet

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/davdiv/wgnet
• Owner: davdiv
• Created: 2023-04-29T09:01:40.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-04-29T09:01:40.000Z (about 2 years ago)
• Last Synced: 2024-04-09T21:35:15.666Z (about 1 year ago)
• Size: 0 Bytes
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# wgnet

[![npm](https://img.shields.io/badge/npm-wgnet-blue)](https://www.npmjs.com/package/wgnet)

[![license](https://img.shields.io/badge/license-MIT-brightgreen)](./LICENSE.md)

**Note that this is a work in progress. Some features may not work yet as expected.**

Command-line tool and web server to simplify the management of a [WireGuard](https://www.wireguard.com/) network.

## Install

First make sure you have [node.js](https://nodejs.org/en/download/package-manager) installed.

Then install the `wgnet` package globally with:

```

npm install -g wgnet

```

Then the `wgnet` command will be available in your terminal:

```

wgnet --help

```

Alternatively, you can also skip the `npm install` command and use the package directly with `npx`:

```

npx wgnet@latest --help

```

## Getting started

Start a web server to manage your WireGuard network:

```

wgnet server

```

This will create a `wgnet.db` sqlite database in the current directory, start the server on port 3000 and open your web browser so that you can start configuring your Wireguard network.

Note that you can list the available command line options with:

```

wgnet server --help

```