Skip to content
/ untun Public

πŸš‡ Tunnel your local HTTP(s) server to the world! powered by Cloudflare Quick Tunnels.

License

Notifications You must be signed in to change notification settings

unjs/untun

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

43 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸš‡ untun

npm version npm downloads bundle

License

Tunnel your local HTTP(s) server to the world!

Powered by πŸ”₯ Cloudflare Quick Tunnels and used by πŸ‘‚ unjs/listhen.

Usage (CLI)

Globally run tunnel with npx:

npx untun@latest tunnel http://localhost:3000
◐ Starting cloudflared tunnel to http://localhost:3000
β„Ή Waiting for tunnel URL...
βœ” Tunnel ready at https://unjs-is-awesome.trycloudflare.com

Use npx untun tunnel --help for more usage info.

Usage (API)

Install package:

# npm
npm install untun

# yarn
yarn add untun

# pnpm
pnpm install untun

Import:

// ESM
import { startTunnel } from "untun";

// CommonJS
const { startTunnel } = require("untun");

Start tunnel:

const tunnel = await startTunnel({ port: 3000 });

Options

url

  • Default: {protocol}://{hostname}:{port}

The local server URL to tunnel.

port

  • Default: 3000

The local server PORT (only effective if url is not provided).

hostname

  • Default: localhost

The local server hostname (only effective if url is not provided).

protocol

  • Default: http

The local server protocol (only effective if url is not provided).

verifyTLS

  • Default: false

Verify local server TLS certificate.

acceptCloudflareNotice

  • Default: false
  • Environment variable: UNTUN_ACCEPT_CLOUDFLARE_NOTICE

Accept cloudflare TOS by default.

Development

  • Clone this repository
  • Install latest LTS version of Node.js
  • Enable Corepack using corepack enable
  • Install dependencies using pnpm install
  • Run interactive tests using pnpm dev

License

Made with πŸ’›

Published under MIT License.

cloudflared integration based on a fork of JacobLinCool/node-cloudflared

Your installation of cloudflared software constitutes a symbol of your signature indicating that you accept the terms of the Cloudflare License, Terms and Privacy Policy.

About

πŸš‡ Tunnel your local HTTP(s) server to the world! powered by Cloudflare Quick Tunnels.

Resources

License

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •