LinuxCommandLibrary

bore-local

Expose local port to internet

TLDR

Expose a local port to a remote Bore server

$ bore local [[-t|--to]] [remote_server_address] [local_port]
copy

Expose a specific local host instead of localhost
$ bore local [[-l|--local-host]] [host] [[-t|--to]] [remote_server_address] [local_port]
copy

Specify a remote server port explicitly
$ bore local [[-t|--to]] [remote_server_address] [[-p|--port]] [remote_port] [local_port]
copy

Use a secret for authentication
$ bore local [[-t|--to]] [remote_server_address] [[-s|--secret]] [your_secret] [local_port]
copy

Display help
$ bore local [[-h|--help]]
copy

SYNOPSIS

bore local [OPTIONS] <LOCAL_PORT>

PARAMETERS

--to <ADDR>
    Server address to connect to (e.g., bore.pub; defaults to random public server)

--port <PORT>
    Request specific public port number (random by default)

--socks5
    Expose SOCKS5 proxy instead of direct TCP forward

-s, --subdomain <NAME>
    Request custom subdomain (server-dependent)

-a, --auth <TOKEN>
    Authentication token for private servers

-v, --verbose
    Enable verbose logging

-h, --help
    Print help

-V, --version
    Print version

DESCRIPTION

bore local is a subcommand of the bore CLI tool, a lightweight, modern utility for creating TCP tunnels to expose local services to the internet. Developed as an open-source alternative to tools like ngrok, it forwards traffic from a public endpoint to a specified local port on your machine.

It connects to public bore relay servers (or a custom one) to establish the tunnel. Usage is simple: run bore local 8080 to expose port 8080, and it prints a public URL like bore.pub:XXXXX. No account or signup required by default.

Key features include SOCKS5 proxy support, subdomain requests (on compatible servers), authentication tokens, and verbose logging. It's written in Rust for efficiency and security, using QUIC for low-latency connections. Ideal for quick demos, webhooks, or testing without complex setup. However, public exposure means securing your service is crucial. Servers are community-hosted, with options for self-hosting via bore server.

CAVEATS

Public exposure risks unauthorized access; use auth/firewalls. Relies on third-party servers (outages possible). Not for production; rate-limited. Install via cargo install bore-cli; Rust required.

INSTALLATION

Requires Rust: cargo install bore-cli. Binaries available on GitHub releases.

EXAMPLE

bore local 8080 --to bore.pub → Outputs bore.pub:12345; curl from anywhere reaches localhost:8080.

SERVERS

Public: bore.pub. Self-host: bore server --port 2222.

HISTORY

Created by Ekho Zhang in 2022 as a Rust-based ngrok alternative. Gained popularity for simplicity and open servers at bore.pub. Active on GitHub with regular updates for QUIC support and features.

SEE ALSO

ngrok(1), ssh(1), socat(1), frp(8), localtunnel(1)

Copied to clipboard