README
¶
KhulnaSoft Tunnel client
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 get started
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:
Installing netscale
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.khulnasoft.com/khulnasoft-one/connections/connect-apps
Creating Tunnels and routing traffic
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
TryKhulnaSoft
Want to test KhulnaSoft Tunnel before adding a website to KhulnaSoft? You can do so with TryKhulnaSoft using the documentation available here.
Deprecated versions
KhulnaSoft currently supports versions of netscale 2020.5.1 and later. Breaking changes unrelated to feature availability may be introduced that will impact versions released prior to 2020.5.1. You can read more about upgrading netscale in our developer documentation.
| Version(s) | Deprecation status |
|---|---|
| 2020.5.1 and later | Supported |
| Versions prior to 2020.5.1 | No longer supported |
Directories
¶
| Path | Synopsis |
|---|---|
|
Package carrier provides a WebSocket proxy to carry or proxy a connection from the local client to the edge.
|
Package carrier provides a WebSocket proxy to carry or proxy a connection from the local client to the edge. |
|
cmd
|
|
|
internal
|
|
|
Package tlsconfig provides convenience functions for configuring TLS connections from the command line.
|
Package tlsconfig provides convenience functions for configuring TLS connections from the command line. |
|
Package encrypter is suitable for encrypting messages you would like to securely share between two points.
|
Package encrypter is suitable for encrypting messages you would like to securely share between two points. |
|
Package logtransport provides a transport that logs all of its messages.
|
Package logtransport provides a transport that logs all of its messages. |