@infraspecdev/mikrotik-wireguard-client-manager

A Node.js package for managing WireGuard VPN clients on MikroTik routers via SSH.

This project has a Code of Conduct.

Table of contents

• Installation
• Features
• Running Tests
• Contributing
• License

const { MikroTikWireGuardClientManager, MikroTikSSHClient }  = require('@infraspecdev/mikrotik-wireguard-client-manager')

const sshClient = new MikroTikSSHClient("192.168.1.1", 22, "admin", "password");

const vpnManager = new MikroTikWireGuardClientManager(sshClient);
const clients = await vpnManager.listClients();

Installation

This is a Node.js module available through the npm registry.

Before installing, download and install Node.js. Node.js 22 or higher is required.

If this is a brand new project, make sure to create a package.json first with the npm init command.

Installation is done using the npm install command:

npm install @infraspecdev/mikrotik-wireguard-client-manager

Features

• Add WireGuard Client
• Remove WireGuard Client
• List WireGuard Clients

Running Tests

To run the test suite, first install the dependencies:

npm install

Then run npm test:

npm test

Contributing

The project welcomes all constructive contributions. Contributions take many forms, from code for bug fixes and enhancements, to additions and fixes to documentation, additional tests, triaging incoming pull requests and issues, and more!

See the Contributing Guide for more technical details on contributing.

License

MIT