Quick Start

Exposing a local service takes three steps: install the client, download a tunnel config, and run it.

1. Install the client

Linux / macOS

curl -fsSL https://console.nicefrp.com/install.sh | bash

The script detects your OS and CPU architecture, downloads the official frpc release, and installs it to /usr/local/bin (falling back to ~/.local/bin). Set NICEFRP_FRP_VERSION to pin a specific frp release.

Windows (PowerShell)

irm https://console.nicefrp.com/install.ps1 | iex

This installs frpc.exe under %LOCALAPPDATA%\NiceFRP\bin and adds it to your user PATH.

Verify the install:

frpc -v

2. Download your tunnel config

Log in to the console, open a tunnel, and download its nicefrp-<tunnel-id>.toml. Store the file with chmod 600 — it contains your access token.

3. Run frpc

frpc -c nicefrp-<tunnel-id>.toml

The tunnel is live when you see start proxy success. Visit the tunnel's domain or use the remote port shown in the console.

Diagnostics

If a tunnel does not come up, run:

curl -fsSL https://console.nicefrp.com/nicefrp-diag.sh | bash

The script checks that frpc is installed, the config is present, the node endpoint is reachable, and the local service is listening — then points you to the specific failing step.

Common issues

• login to server failed — the node may be offline or your firewall blocks the control port. Confirm with the diagnostic script.
• Local service not reachable — start your service first; frpc only forwards to it, it does not start it.
• frpc not found — reopen your terminal after installing so the PATH change takes effect, or add the install directory to PATH manually.

Still stuck? Email support@nicefrp.com.