Skip to content

Getting Started

This guide helps you install and configure Frpc-Hub in under 5 minutes using Docker.

Prerequisites

  • Docker installed
  • A public server with frps deployed (or a third-party frp service)
  • The machine running Frpc-Hub must have internet access

Don't have a public server yet?

Check out RainYun — an affordable and reliable cloud server provider, great for hosting frps and other self-hosted services.

Step 1: Start the Container

bash
docker run -d \
  --name frpc-hub \
  --restart unless-stopped \
  -p 8090:8090 \
  -v ./frpc-hub-data:/app/pb_data \
  ghcr.io/luckjiawei/frpc-hub:latest

On successful startup, the terminal will display:

text
App:   http://0.0.0.0:8090
Admin: http://0.0.0.0:8090/_/

Using Docker Compose

You can also manage it with Docker Compose:

yaml
services:
  frpc-hub:
    image: ghcr.io/luckjiawei/frpc-hub:latest
    container_name: frpc-hub
    restart: unless-stopped
    ports:
      - "8090:8090"
    volumes:
      - ./frpc-hub-data:/app/pb_data
bash
docker compose up -d

Step 2: Create an Account

Open your browser and navigate to the main interface:

text
http://localhost:8090

On the first visit, you will be guided to create an account. Enter your username and password and submit.

Step 3: Create a Backend Account (Optional)

If you need access to the backend management panel, navigate to the Admin UI:

text
http://localhost:8090/_/

On the first visit, you will be guided to create a backend account. Enter your email and password and submit.

Security Notice

If Frpc-Hub is accessible from the public internet, use a strong password and consider restricting access to port 8090 via your firewall.

Step 4: Open the Main Interface

Visit the application dashboard:

text
http://localhost:8090

You will see the Frpc-Hub main console.

Step 5: Add a Server

  1. Click Servers in the left navigation

  2. Click Add Server and fill in the following:

    FieldDescriptionExample
    NameDisplay name for this serverMy Server
    Server AddressIP or domain of your frps hostyour-server.com
    Server Portfrps listening port, default 70007000
    Auth TokenThe auth.token from your frps configyour-token
  3. Enable Auto Connect and save — Frpc-Hub will connect immediately.

Once connected, the server card will show an Online status and current latency.

Step 6: Add a Proxy

  1. Click Proxies, then Add Proxy

  2. Choose a proxy type (TCP / UDP / HTTP / HTTPS, etc.) and fill in the config:

    Example: Expose local SSH (port 22) to the internet

    FieldValue
    Namemy-ssh
    TypeTCP
    ServerSelect the server you added
    Local IP127.0.0.1
    Local Port22
    Remote Port6022
  3. Save — Frpc-Hub will automatically hot-reload the frpc config, no restart needed.

You can then connect via ssh -p 6022 user@your-server.com.

Released under the MIT License.