A tool to manage WireGuard VPN connections.

INSTALLATION

To install WG-Bridge, use:

./wg-bridge-installation install

UNINSTALLATION

To remove WG-Bridge, use:

./wg-bridge-installation uninstall

UPDATE

To remove WG-Bridge, use:

./wg-bridge-installation install --update

or

./wg-bridge-installation install -u

SYNOPSIS

wgb [OPTIONS] [COMMANDS] [ARGUMENT]

DESCRIPTION

wgb is a command-line tool designed to handle WireGuard VPN connections. It allows users to connect, disconnect, list available configurations, and check the status of connections.

OPTIONS

-v | --verbose

Enable a verbose logging

-h | --help

Print in standard output an help message

COMMANDS

connect [<config_path>]

Establish a VPN connection using the specified WireGuard configuration file.

• config_path: (optional) full path to the WireGuard configuration file.

Example:

wgb connect

wgb connect /path/to/config.conf

disconnect [<config_path>]

Terminate the VPN connection associated with the specified WireGuard configuration file.

• config_path: (optional) full path to the WireGuard configuration file.

Example:

wgb disconnect /path/to/config.conf

wgb disconnect

list

List all available WireGuard configurations.

Example:

wgb list

status

Display the current status of active WireGuard connections.

Example:

wgb status

path

add

Add paths where Wireguard configurations are saved

Example

wgb path add

delete

Remove a path where Wireguard configurations are saved

Example

wgb path delete

list

List all paths where Wireguard configurations are saved

Example

wgb path list

CONFIGURATION FILE

The software uses a configuration file located in the user's home directory:

~/.wgbconf.json

Configuration Properties

• conf_path (array): List of full paths to directories containing WireGuard configuration files.

• error_codes (object): Mapping of error codes to error messages.

  • Example:

    "error_codes": {
        "000": "Missing wgb configuration"
    }

• confs (array): Contains the properties of each configuration

Example Configuration File:

{
    "conf_path": ["/etc/wireguard/", "/home/user/"],
    "error_codes": {
        "000": "Missing wgb configuration"
    },
    "token": false,
    "token_uri": ""
}