Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kerwin612/portforwarder
A lightweight, portable port forwarding tool.
https://github.com/kerwin612/portforwarder
cli go golang gui http https port-forwarding ssh tcp tunnel udp
Last synced: 5 days ago
JSON representation
A lightweight, portable port forwarding tool.
- Host: GitHub
- URL: https://github.com/kerwin612/portforwarder
- Owner: kerwin612
- License: apache-2.0
- Created: 2024-05-13T03:39:08.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-06-17T02:47:35.000Z (5 months ago)
- Last Synced: 2024-11-01T08:42:15.373Z (12 days ago)
- Topics: cli, go, golang, gui, http, https, port-forwarding, ssh, tcp, tunnel, udp
- Language: Go
- Homepage:
- Size: 515 KB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PortForwarder
**PortForwarder is a lightweight, single-purpose utility for forwarding local ports to destination ports without installation.**
## Download
> [Releases](https://github.com/kerwin612/PortForwarder/releases)
## Developer Guide (GUI)
> For Windows users, it will only support **Win10+** operating systems.
### Prerequisites
* GO: 1.22+ (For building the Go-based backend)
* NODEJS: 20+ (For managing the Node.js-based scripts and dependencies)
### Installing Dependencies
Navigate to the **[gui](./gui)** directory and run the following command to install all dependencies:
```
npm install
```
### Scripts
```
# Start the backend application
npm run start:app
# Start the frontend application
npm run start:gui
# Build the releasable application
npm run build
```
## Developer Guide (CLI)
> Navigate to the **[cli](./cli)** directory
### Prerequisites
* GO: 1.22+
### Scripts
```
# Run from source code
go run main.go -h
# Install and run a binary program
go install github.com/kerwin612/port-forwarder/cli && $GOPATH/bin/cli -h
# Build and run a binary program
go build -o port_forwarder github.com/kerwin612/port-forwarder/cli && ./port_forwarder -h
```
## License
PortForwarder is licensed under the Apache License, Version 2.0. See the [LICENSE](./LICENSE) file for more details.
## Contributions
Contributions to PortForwarder are welcome! Please feel free to submit pull requests, report issues, or provide feedback. We appreciate any help you can offer to improve this tool.
Thank you for considering PortForwarder!