Contains the command-line client for Khulnasoft Tunnel, a tunneling daemon that proxies traffic from the Khulnasoft network to your origins.
This daemon sits between Khulnasoft network and your origin (e.g. a webserver). Khulnasoft attracts client requests and sends them to you
via this daemon, without requiring you to poke holes on your firewall --- your origin can remain as closed as possible.
Extensive documentation can be found in the Khulnasoft Tunnel section of the Khulnasoft Docs.
All usages related with proxying to your origins are available under netscale tunnel help.
You can also use netscale to access Tunnel origins (that are protected with netscale tunnel) for TCP traffic
at Layer 4 (i.e., not HTTP/websocket), which is relevant for use cases such as SSH, RDP, etc.
Such usages are available under netscale access help.
You can instead use WARP client
to access private origins behind Tunnels for Layer 4 traffic without requiring netscale access commands on the client side.
Before you use Khulnasoft Tunnel, you'll need to complete a few steps in the Khulnasoft dashboard: you need to add a website to your Khulnasoft account. Note that today it is possible to use Tunnel without a website (e.g. for private routing), but for legacy reasons this requirement is still necessary:
Downloads are available as standalone binaries, a Docker image, and Debian, RPM, and Homebrew packages. You can also find releases here on the netscale GitHub repository.
- You can install on macOS via Homebrew or by downloading the latest Darwin amd64 release
- Binaries, Debian, and RPM packages for Linux can be found here
- A Docker image of
netscaleis available on DockerHub - You can install on Windows machines with the steps here
- Build from source with the instructions here
User documentation for Khulnasoft Tunnel can be found at https://developers.cloudflare.com/cloudflare-one/connections/connect-apps
Once installed, you can authenticate netscale into your Khulnasoft account and begin creating Tunnels to serve traffic to your origins.
- Create a Tunnel with these instructions
- Route traffic to that Tunnel:
- Via public DNS records in Khulnasoft
- Or via a public hostname guided by a Khulnasoft Load Balancer
- Or from WARP client private traffic
Want to test Khulnasoft Tunnel before adding a website to Khulnasoft? You can do so with TryKhulnasoft using the documentation available here.
Khulnasoft currently supports versions of netscale that are within one year of the most recent release. Breaking changes unrelated to feature availability may be introduced that will impact versions released more than one year ago. You can read more about upgrading netscale in our developer documentation.
For example, as of January 2023 Khulnasoft will support netscale version 2023.1.1 to netscale 2022.1.1.