Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mon4ik/forward-port
https://github.com/mon4ik/forward-port
Last synced: 7 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/mon4ik/forward-port
- Owner: Mon4ik
- Created: 2023-07-10T13:21:55.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-11T13:20:25.000Z (over 1 year ago)
- Last Synced: 2024-10-30T01:36:05.249Z (8 days ago)
- Language: TypeScript
- Size: 54.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Forward Port
Your local port forwarding
## Installation
- Install from NPM
```shell
npm i -g @idkncc/forward-port
forward-port server
```
- Build
```shell
#1. Install deps
yarn
#2. Build
yarn dev
#3. Run
yarn start server
# or
# node ./bin server
```
## Usage
> **Note:** Pre-Shared key needs to be random and identical on server and client
```shell
# 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 ] [--debug]
```
## Example (Minecraft Server)
- On your server (with white IP, **f.e. VDS**)
```shell
npx @idkncc/forward-port server SUPER_SECRET_KEY
# f.e. Server runs on IP 5.5.5.5
```
- On your PC
```shell
# 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