Quick Start

This is the shortest stable v2.1.2 path from an empty server to a working remote SSH connection.

What you are building

Before you start

You need:

a Linux/systemd server that remote clients can reach through a public entry point
a Linux/systemd client
an SSH account that already exists on that client
server firewall/NAT rules for the chosen deployment
sudo/root privileges for installation

For a first deployment, Ubuntu 24.04 x86_64 is the clearest real-validated baseline.

Direct mode network requirements

Direction	Purpose	Default TCP
Client → Server	FRP control	443
Client → Server	Enrollment / management HTTPS	6099
User → Server	Published services	6000-6098 as assigned

FRP Auto Deploy does not automatically change cloud security groups, external firewalls, NAT rules, UFW, firewalld, or iptables.

1. Install the server

curl -fsSL \
  https://raw.githubusercontent.com/datarelay-labs/frp-auto-deploy/v2.1.2/dist/bootstrap-server.sh \
  | sudo bash

The interactive installer asks for the public endpoint, optional published-service hostname, internal IP, deployment mode, and port settings. If the server is behind a firewall/NAT device, read Firewall & NAT before accepting the defaults.

2. Verify the server

sudo frpctl show version
sudo frpctl show status
sudo frpctl doctor

Continue only after the expected services are active and doctor does not report a blocking configuration/trust problem.

3. Create the client enrollment

Easiest interactive path

Start the CLI:

sudo frpctl

Then use:

create zero-touch

This is the recommended everyday onboarding path.

Explicit SSH one-liner profile

For a predictable SSH profile from the shell:

sudo frpctl create enrollment \
  --one-line \
  --ssh \
  --ssh-user aella \
  --label branch-a

Replace aella with an SSH user that already exists on the remote client. FRP Auto Deploy does not create OS users, install/configure sshd, change passwords, or manage SSH keys.

4. Run the generated command on the client

Send the exact generated command to the remote operator through an appropriate private channel and run it once on the Linux client. Treat the generated bootstrap command as sensitive until it is used, expires, or is revoked.

5. Verify on the client

sudo frpctl show version
sudo frpctl show status
sudo frpctl show services
sudo frpctl show info
sudo frpctl doctor

6. Verify on the server

sudo frpctl show clients
sudo frpctl show enrollments

Then inspect the assigned service port:

sudo frpctl show client <CLIENT-ID> services

The client receives a persistent CLIENT ID and the SSH service receives a persistent public-port reservation.

7. Connect over SSH

ssh -p <public-port> aella@<FRP-server-public-IP>

With an optional public service hostname:

ssh -p <public-port> aella@fw.example.com

Success checklist

You are finished when all of these are true:

the client appears in show clients
the client has a CLIENT ID
the SSH service has an assigned public port
the client reports healthy FRP state
the public service port is allowed through the server-side firewall/NAT
SSH reaches the intended target

If it does not work

Use Troubleshooting and run frpctl doctor on both sides before editing generated config, registry, identity, or PKI files.

Getting Started

Client & Services

frpctl

Deployment

Operations

Security & Reference

Quick Start

Quick Start

What you are building

Before you start

Direct mode network requirements

1. Install the server

2. Verify the server

3. Create the client enrollment

Easiest interactive path

Explicit SSH one-liner profile

4. Run the generated command on the client

5. Verify on the client

6. Verify on the server

7. Connect over SSH

Success checklist

If it does not work

Next steps

​Quick Start

​What you are building

​Before you start

​Direct mode network requirements

​1. Install the server

​2. Verify the server

​3. Create the client enrollment

​Easiest interactive path

​Explicit SSH one-liner profile

​4. Run the generated command on the client

​5. Verify on the client

​6. Verify on the server

​7. Connect over SSH

​Success checklist

​If it does not work

​Next steps

Quick Start

What you are building

Before you start

Direct mode network requirements

1. Install the server

2. Verify the server

3. Create the client enrollment

Easiest interactive path

Explicit SSH one-liner profile

4. Run the generated command on the client

5. Verify on the client

6. Verify on the server

7. Connect over SSH

Success checklist

If it does not work

Next steps