goport

package module
v0.1.9 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 17, 2026 License: MIT Imports: 12 Imported by: 0

README

GoPort

Put your localhost on a public HTTPS link with one command.

Latest release

Running goport http 8080 prints a public https link, then logs each request as it arrives

GoPort is an open-source tunnel, similar to ngrok. Run goport http 8080 and the app on port 8080 becomes reachable at a link like https://abc123.goport.uz. You don't need a public IP, port forwarding or any router settings.

It's handy when you want to show someone a site that only runs on your machine, test webhooks from Telegram, payment providers or GitHub against local code, or open a local API from your phone.

Download

Download for Windows Download for macOS (Apple Silicon) Download for macOS (Intel) Download for Linux

Every button downloads the latest release. The Windows installer adds goport to your PATH and doesn't need admin rights. On macOS and Linux you get the program file itself, which needs one more step (see below), so Homebrew is the easier route on a Mac.

Getting started

1. Install

macOS with Homebrew:

brew install muhammad-deve/goport/goport

Windows: run the installer from the button above, or use Chocolatey or Scoop:

choco install goport
scoop bucket add goport https://github.com/muhammad-deve/scoop-goport
scoop install goport

Linux:

sudo curl -fsSL -o /usr/local/bin/goport \
  https://github.com/muhammad-deve/GoPort/releases/latest/download/goport-linux-amd64
sudo chmod +x /usr/local/bin/goport

If you used a download button on macOS or Linux, make the file runnable and move it onto your PATH. Use the name of the file you got, for example on an Apple Silicon Mac:

cd ~/Downloads
chmod +x goport-darwin-arm64
xattr -c goport-darwin-arm64    # macOS only: clears the download quarantine
sudo mv goport-darwin-arm64 /usr/local/bin/goport

Check that it worked:

goport --version

2. Connect your account

Sign up at goport.uz, then copy your token from the Tokens page of the dashboard:

goport auth <token>

The token is saved on your machine, so you only do this once.

3. Start a tunnel

goport http 8080

Use whatever port your app runs on. GoPort prints the public link and logs each request as it comes in. Press Ctrl+C to stop.

Everyday use

Your link stays the same. goport http reuses your last subdomain, so you can restart it without sending people a new link.

Get a new random link:

goport http 8080 --reset

Pick your own name (Pro):

goport http 8080 --custom myapp    # https://myapp.goport.uz

-n myapp does the same thing.

Look at the traffic. While a tunnel is running, open http://127.0.0.1:4040. You can see every request and response, replay a request, or copy it as a cURL command.

Dropped connections. If your Wi-Fi drops or your laptop goes to sleep, GoPort reconnects by itself and keeps the same link (since 0.1.8).

WebSockets work too, so things like Next.js hot reload behave normally through the tunnel.

Free and Pro

Free Pro
Tunnels at once 1 10
Traffic per month 5 GB 70 GB
Devices (tokens) 1 5
Custom subdomain No Yes

Prices are on the pricing page.

How it works

The CLI connects out to the server and keeps that one connection open. When a request arrives for your subdomain, the server opens a new stream on that connection using yamux, and the CLI hands it to your local port and sends the response back the same way.

Because your machine makes the connection, it works behind NAT and firewalls with no setup. The original Host header is kept, so apps that build links from it (Swagger UI, redirects, host-based routing) behave the same as in production.

Configuration

These environment variables are optional:

Variable What it does
GOPORT_TOKEN Use this token instead of the one saved by goport auth, e.g. in CI
GOPORT_SERVER_ADDR Tunnel server address. Default: goport.uz:7000
GOPORT_DOMAIN Domain for public links. Default: goport.uz
GOPORT_API_URL API address. Default: https://back.goport.uz

To run your own server, see goport.uz/self-hosting.

What's in this repo

Folder Contents
server/ The goport CLI, written in Go (despite the folder name)
backend/ The tunnel server and API, built on PocketBase
landing/ goport.uz and the account dashboard (Next.js)
Installers/ Windows installer, Homebrew, Scoop and Chocolatey packages

Each folder is its own repository, added as a submodule. To build the CLI from source:

git clone --recursive https://github.com/muhammad-deve/GoPort.git
cd GoPort/server
go build -o goport .

Contributing

Bug reports and pull requests are welcome. If something breaks, open an issue with the command you ran, your OS, the output of goport --version, and the error you saw.

License

MIT

Documentation

Overview

Package goport opens public GoPort tunnels to local TCP ports.

Index

Constants

View Source
const (
	// DefaultServer is the public GoPort TCP tunnel endpoint.
	DefaultServer = "goport.uz:7000"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is a small builder for opening GoPort tunnels.

func New

func New(token string, opts ...Option) *Client

New returns a tunnel client builder authenticated with token.

func (*Client) Open

func (c *Client) Open(port int) (Tunnel, error)

Open establishes a tunnel to localhost:port.

func (*Client) Reset

func (c *Client) Reset() *Client

Reset requests a fresh random subdomain for the tunnel.

func (*Client) Subdomain

func (c *Client) Subdomain(name string) *Client

Subdomain requests a custom public subdomain for the tunnel.

func (*Client) WithServer

func (c *Client) WithServer(addr string) *Client

WithServer overrides the default GoPort TCP tunnel server address.

type Option

type Option func(*Client)

Option configures a Client returned by New.

func WithServer

func WithServer(addr string) Option

WithServer overrides the default GoPort TCP tunnel server address.

type Tunnel

type Tunnel interface {
	URL() string
	Close() error
}

Tunnel is an active public tunnel to a local port.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL