zctmdc/frp repository overview

⁠FRP

frp 是一个专注于内网穿透的高性能的反向代理应用，支持 TCP、UDP、HTTP、HTTPS 等多种协议。可以将内网服务以安全、便捷的方式通过具有公网 IP 节点的中转暴露到公网。

⁠其他镜像

官方: fatedier/frps - Docker Image | Docker Hub⁠

雪梦科技: snowdreamtech/frpc - Docker Image | Docker Hub⁠

⁠启动

⁠快速启动 FRPS

• docker cli

  docker run -ti --rm --network host -e SUBDOMAIN_HOST=frp.example.org zctmdc/frp:Alpha RUN_FRPS
  

  Copy

• docker-compose

  frps-demo:
      image: zctmdc/frp:alpha
      container_name: frps-demo
      restart: unless-stopped
      environment:
          - SUBDOMAIN_HOST=frp.example.org
          - MODE=RUN_FRPS
      network_mode: host
      # networks:
      #     net:
      # ports:
      #     - 7000:7000/tcp
      #     - 7000:7000/udp
      #     - 7001:7001/tcp
      #     - 7001:7001/udp
      #     - 7400:7400/tcp
  

  Copy

打开控制台 在浏览器中输入 http://localhost:7400⁠ 用户为 admin 密码为 admin

⁠快速启动 FRPC

• docker cli

  docker run -ti --rm -e MODE=RUN_FRPC -e SUBDOMAIN_HOST=frp.example.org -p 7500:7400 zctmdc/frp:Alpha
  

  Copy

• docker-compose

  frpc-demo:
      image: zctmdc/frp:alpha
      container_name: frpc-demo
      restart: unless-stopped
      environment:
          - SUBDOMAIN_HOST=frp.example.org
          - MODE=RUN_FRPC
      # network_mode: host
      networks:
          net:
      ports:
          - 7500:7400/tcp
  

  Copy

在浏览器中输入 http://localhost:7500⁠ 或者访问 http://frp.example.org:7400/static/#/proxies/http⁠ 用户为 admin 密码为 admin 点击 Configure，修改 frpc 配置后点击 upload 生效。

⁠配置

⁠本地配置文件

默认配置文件位置为/etc/frp/, 挂载自己的配置目录，覆盖默认配置文件。

• 推荐使用 其他镜像⁠

CONF_FRPS=/etc/frp/frps.ini
CONF_FRPC=/etc/frp/frpc.ini

    -v /you/conf/path/:/etc/frp/

    volumes:
        - /you/conf/path/:/etc/frp/

• 在容器 启动 时，将进行一次备份 默认配置文件 /etc/frp/

CONF_FRPS_BAK=/opt/frp/conf/frps_bak.ini
CONF_FRPC_BAK=/opt/frp/conf/frpc_bak.ini

以下情况除外

• 从网页修改过配置文件 通过frpc远程配置⁠
  即：配置文件不存在 Envs.SUBDOMAIN_HOST /etc/frp/

• 已附加配置文件
  即：配置文件中存在 ###DOCER_CONF_ADD###

⁠附加配置文件

see: docker-entrypoint.sh⁠

• 注意，检测到附加配置文件时，将会对 /etc/frp/ 进行修改！
• 在容器 启动 时，如果检测到 附加配置文件 ，将进行一次备份 附加配置文件 /opt/frp/conf/
• 如果检测到 附加配置文件 和存在的备份不一致，备份的 默认配置文件 将会还原 /etc/frp/ ，附加配置文件 覆盖上次备份 /opt/frp/conf/
• 备份结束后， 附加配置文件 会附加在 默认配置文件尾部

以下情况除外

• 从网页修改过配置文件 通过frpc远程配置⁠
  即：配置文件不存在 Envs.SUBDOMAIN_HOST /etc/frp/

CONF_FRPS_ADD=/opt/frp/conf/add/frps_add.ini
CONF_FRPC_ADD=/opt/frp/conf/add/frpc_add.ini

CONF_FRPS_ADD_BAK=/opt/frp/conf/frps_add_bak.ini
CONF_FRPC_ADD_BAK=/opt/frp/conf/frpc_add_bak.ini

⁠在线配置

⁠Pass_FRPC

1. 访问 https?://${客户端域名/IP}:${服务端口}/static/#/proxies/http⁠ admin_port ADMIN_PORT

2. 使用客户端账号密码登录 admin_user admin_pwd ADMIN_USER ADMIN_PWD

3. 点击 Configure ，进行相关配置

[http_admin_UI]
    type = http
    subdomain = {{ .Envs.HOSTNAME }}-admin
    local_ip = localhost
    local_port = {{ .Envs.ADMIN_PORT }}

⁠Pass_FRPS

1. 访问 https?://${服务端域名/IP}:${服务端口}/static/#/proxies/http⁠ SUBDOMAIN_HOST dashboard_port ADMIN_PORT

2. 使用服务端账号密码登录 dashboard_user dashboard_pwd ADMIN_USER ADMIN_PWD

3. 找到 -admin 结尾的名称

4. 访问 xxx-admin.服务端域名 SUBDOMAIN_HOST

5. 同 Pass_FRPC⁠

⁠通过frpc远程配置

1. 在服务端启动 frps，确保所有的客户端可以访问该主机。
2. 在被访问端启动 frpc remote frpc
3. 在访问客端启动 frpc local frpc
4. 配置访问端 frpc

• stcp

  • remote

    [stcp_admin_UI]
    type = stcp
    sk = {{ .Envs.SK }}
    local_ip = localhost
    local_port = {{ .Envs.ADMIN_PORT }}
    

    Copy

  • local

    [stcp_admin_UI_visitor]
    role = visitor
    type = stcp
    server_name = {{ .Envs.HOSTNAME }}.stcp_admin_UI
    sk = {{ .Envs.SK }}
    bind_addr = localhost
    bind_port = 9000
    

    Copy

• xtcp

  • remote

    [p2p_admin_UI]
    type = xtcp
    sk = {{ .Envs.SK }}
    local_ip = localhost
    local_port = {{ .Envs.ADMIN_PORT }}
    

    Copy

  • local

    [p2p_admin_UI_visitor]
    role = visitor
    type = xtcp
    server_name = {{ .Envs.HOSTNAME }}.p2p_admin_UI
    sk = {{ .Envs.SK }}
    bind_addr = localhost
    bind_port = 9001
    

    Copy

⁠容器环境变量说明

⁠自定义配置文件启动

使用 其他镜像⁠

⁠官方文档

项目官网: https://github.com/fatedier/frp⁠

文档官网: https://gofrp.org/docs/⁠

客户端配置: https://gofrp.org/docs/reference/client-configures/⁠

服务端配置: https://gofrp.org/docs/reference/server-configures/⁠

示例：https://gofrp.org/docs/examples/⁠