privaterouterllc/frpc repository overview

⁠Private Router FRP Client

This container aims to make it easy for the average docker user to easily spin up a FRP Client. The config is generated from environment variables passed as you will find in the example below.

⁠Docker-Compose Example

If you have a FRP Server (we suggest PrivateRouter's Reverse Proxy Service⁠) then you will have a server IP and an authentication token. Just fill those in to the example below.

version: "3"

services:
  frpc:
    image: privaterouterllc/frpc
    restart: unless-stopped
    network_mode: host
    environment:
      # These are required to run
      FRPC_IP: "FILL_THIS_IN"
      FRPC_TOKEN: "FILL_THIS_IN"
      FRPC_PORT: "7000" # This is optional
      # Required Minimum Format: service_name,service_protocol,service_port
      # Optional Format: service_name,service_protocol,local_service_port,remote_service_port
      # Optional Format: service_name,service_protocol,local_service_port,remote_service_port,local_service_ip
      # Each service must be separated by a space
      FRPC_SERVICES: "http,tcp,80 https,tcp,443,443 home_assistant,tcp,8123,8123,192.168.1.10"

⁠Format Examples

You can use one of three formats for the FRPC_SERVICES entry.

⁠Definitions

• Service Name: This is the simple name of your service with no spaces.
• Service Protocol: This is which protocol your services is listening on (TCP or UDP).
• Service Port: This is the port your service is listening on, which is the same local and remote.
• Local Service Port: This is the LOCAL port your service is listening on.
• Remote Service Port: This is the REMOTE port your service is listening on.
• Local Service IP: This is the LOCAL IP (if not 127.0.0.1) that you want to direct the traffic to.

⁠Format

• Service Name (,) Service Protocol (,) Service Port
• Service Name (,) Service Protocol (,) Local Service Port (,) Remote Service Port
• Service Name (,) Service Protocol (,) Local Service Port (,) Remote Service Port (,) Local Service IP

⁠At minimum you need to have service_name,service_protocol,service_port

⁠Expert Mode Options

If you have custom configs you need included that do not fit into the template above, you can mount a folder inside the container to /frpc such as [- "./frpc:/frpc"].

⁠You must name each file to be loaded as (file-name).ini

You can put each service into its own .ini file or combine them into one, but they must follow the valid examples listed in frpc_full.ini⁠ file.

⁠Example dns.ini (taken from frpc_full.ini linked above)

[dns]
type = udp
local_ip = 114.114.114.114
local_port = 53
remote_port = 6002
use_encryption = false
use_compression = false