Skip to content

hunghg255/ctun

Repository files navigation

logo

A script create a tunnel to your localhost use Cloudflare Argo Tunnel

NPM Version NPM Downloads Minizip Contributors License

Usage (CLI)

Globally run tunnel with npx:

npx ctun@latest --url http://localhost:3000

Use npx ctun --help for more usage info.

Result

ads

Usage (API)

Install package:

# npm
npm install ctun

# yarn
yarn add ctun

# pnpm
pnpm install ctun

Import:

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

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.

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 use cloudflare

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published