@idkncc/forward-port v1.0.4

Forward Port

Your local port forwarding

Installation

• Install from NPM

  npm i -g @idkncc/forward-port
  forward-port server <preshared-key>

• Build

  #1. Install deps
  yarn
  
  #2. Build
  yarn dev
    
  #3. Run
  yarn start server <preshared-key>
  # or
  # node ./bin server <preshared-key>

Usage

Note: Pre-Shared key needs to be random and identical on server and client

# Generate unique pre-shared key
forward-port gen-key [length]

Create ForwardPort (FP) Server

forward-port server -p

Create ForwardPort Client

forward-port client -p

## Example (Minecraft Server)
- On your server (with white IP, **f.e. VDS**)
  ```bash
  npx @idkncc/forward-port server SUPER_SECRET_KEY
  # f.e. Server runs on IP 5.5.5.5

• On your PC

  #                      minecraft port   vds
  #                                v       v
  npx @idkncc/forward-port client 25565 5.5.5.5 SUPER_SECRET_KEY

• Your friend: Uses 5.5.5.5:1337 to connect