KataGo Remote One-Click

September 5, 2026 · View on GitHub

KataGo Remote One-Click

Turn a Linux NVIDIA GPU server into a private KataGo WSS endpoint with one command.

CI Release License

中文说明 | Troubleshooting | Security

No firewall rule, domain, TLS certificate, Python environment, or Cloudflare account is required. The installer prepares KataGo, a strong official Transformer model, an authenticated local bridge, and an encrypted temporary tunnel. It then prints the private WSS link and a QR code that LizzieYzy Next can use directly.

One command

Use a Linux x86_64 server with an NVIDIA GPU. Choose a CUDA 12 image with cuDNN 9 when your provider offers one, then run:

curl -fsSL https://raw.githubusercontent.com/wimi321/katago-remote-one-click/v0.1.0/install.sh | bash

The command downloads several hundred megabytes. Every downloaded file is checked against a pinned SHA-256 digest before it is used.

When setup finishes, the terminal displays a private link similar to:

wss://example-name.trycloudflare.com/katago/<private-token>

In LizzieYzy Next, open Remote Compute > Custom Compute, paste the complete link, and choose Enable Custom Compute. You can import the generated QR code instead.

Treat the full WSS link like a password. Anyone who has it can use the running KataGo process until the link is revoked or the service stops.

Google Colab

You can also use the guided notebook. Colab GPU availability and session duration are controlled by Google and are not guaranteed.

Open In Colab

What gets installed

ComponentPinned versionPurpose
KataGo1.18.2 CUDA 12.1Official analysis engine
Transformer 10Bofficial medium modelStrong default model with practical GPU usage
cloudflared2026.8.3Encrypted temporary WSS tunnel
katago-remote0.1.0Authenticated analysis-protocol bridge and service manager

Files are installed under ~/.local/share/katago-remote-one-click. The bridge listens only on 127.0.0.1; no inbound server port is opened. A random 256-bit token protects the WebSocket path, and only one client can use the engine at a time.

Everyday commands

katago-remote show        # Show the current private link and QR code
katago-remote status      # Check whether the service is running
katago-remote logs        # Show recent diagnostics
katago-remote restart     # Restart KataGo and create a new temporary hostname
katago-remote stop        # Stop KataGo and the tunnel
katago-remote reset-link  # Revoke the old token and create a new private link
katago-remote doctor      # Check GPU, files, and KataGo startup

If katago-remote is not found in a new terminal, run it as:

~/.local/bin/katago-remote show

The trycloudflare.com hostname is temporary and usually changes after a restart or server reboot. Run katago-remote show, then update the link in LizzieYzy Next.

Use your own KataGo files

The installer can keep an existing KataGo executable, model, or analysis config in place. Download the reviewed installer first so the variables are passed to Bash rather than only to curl:

curl -fsSLo /tmp/katago-remote-install.sh \
  https://raw.githubusercontent.com/wimi321/katago-remote-one-click/v0.1.0/install.sh

KATAGO_REMOTE_KATAGO_PATH=/opt/katago/katago \
KATAGO_REMOTE_MODEL_PATH=/opt/katago/model.bin.gz \
KATAGO_REMOTE_CONFIG_PATH=/opt/katago/analysis.cfg \
bash /tmp/katago-remote-install.sh

The paths must already exist on the server. The installer does not copy or modify these custom files.

Scope

Version 0.1 supports Linux x86_64 NVIDIA GPU servers and clients that implement KataGo's line-delimited Analysis Engine protocol over WebSocket, including LizzieYzy Next and KaTrain-compatible clients. It does not support raw GTP-over-WebSocket, multi-user hosting, CPU-only servers, Windows servers, or permanent production tunnels.

See the protocol and architecture notes for technical details and troubleshooting for copy-and-run fixes.

Maintainers can run scripts/test-public-tunnel.sh to verify a real authenticated WSS round trip through a pinned cloudflared binary. The normal test suite skips this network integration test.

Acknowledgements

This project integrates the public interfaces of KataGo, KaTrain, and cloudflared. It is an independent community project and is not affiliated with those projects or Cloudflare.