Skip to content

快速开始 ​

本指南用 Docker Compose 在几分钟内跑起 Podux,并添加第一台服务器和第一个代理。其他安装方式见 Docker 安装 与 二进制安装。

前置条件 ​

  • 已安装 Docker 与 Docker Compose v2
  • 一台已部署 frps 的服务器(或第三方 frp 服务),版本要求见兼容性

第一步:启动 Podux ​

新建一个目录,在其中创建 docker-compose.yml:

yaml
services:
  podux:
    image: ghcr.io/derrors/podux:latest
    container_name: podux
    restart: unless-stopped
    # 使用宿主机网络:代理里的 127.0.0.1 指向宿主机本身
    network_mode: host
    volumes:
      - ./data:/app/pb_data
    environment:
      - TZ=Asia/Shanghai

容器内以 UID 1000 运行,需要先创建数据目录并交给它,然后启动:

bash
mkdir -p data && sudo chown 1000:1000 data
docker compose up -d

为什么用 host 网络

使用默认的 bridge 网络(ports: ["8090:8090"])时,代理"本地地址"里的 127.0.0.1 指向的是容器自身,而不是宿主机。要转发宿主机上的服务,请使用 network_mode: host,或在代理中填写宿主机的局域网 IP。

第二步:创建管理员账号 ​

浏览器访问 http://<主机>:8090,首次进入会引导你用邮箱和密码创建管理员账号,之后用它登录。

安全提示

如果 Podux 能从公网访问,请设置强密码,并尽量通过防火墙或反向代理限制 8090 端口的访问来源。

第三步:添加服务器 ​

  1. 点击左侧导航栏的 服务器,再点击 添加服务器

  2. 填写 frps 的连接信息:

    字段说明示例
    名称服务器的显示名称我的服务器
    服务器地址frps 所在主机的 IP 或域名your-server.com
    服务器端口frps 的 bindPort,默认 70007000
    认证与 frps 一致,常用 token(对应 frps 的 auth.token)your-token
  3. 保存后在服务器列表中启动它。开启 自动连接 的服务器会在 Podux 每次启动时自动上线。

连接成功后,服务器显示为运行中,并开始显示延迟和地理位置。

第四步:添加代理 ​

  1. 点击 代理,再点击 添加代理

  2. 选择代理类型并填写配置。以把本机 SSH(22 端口)映射到公网为例:

    字段值
    名称my-ssh
    类型TCP
    服务器选择上一步添加的服务器
    本地 IP127.0.0.1
    本地端口22
    远程端口6022
  3. 保存后 Podux 会自动热重载 frpc 配置,无需重启。

之后即可通过 ssh -p 6022 user@your-server.com 访问本机。

已有 frpc 配置?

在 导入 页面上传现有的 frpc.toml,预览后即可批量导入服务器、代理和访问端。服务器的认证设置(包括 OIDC)也会一起导入;无法识别的代理类型会被跳过并提示。

覆盖配置与运行中的连接

覆盖导入会替换所选记录的 frpc 配置,清除文件中已省略的插件、访问端回退等旧选项,而不是仅合并非空字段;Podux 的备注、自动连接设置和实际运行状态不会被导入直接重置。

手动编辑或覆盖导入改变了运行中服务器的地址、认证、传输等公共配置时,Podux 会自动重启该服务器的 frpc,隧道会短暂中断。仅修改代理或访问端时仍使用热重载。

PocketBase 管理后台(可选) ​

Podux 内置 PocketBase 管理后台(/_/),可以直接查看底层数据,日常使用不需要它。它使用独立的超级管理员账号,可以通过以下任一方式创建:

  • 首次启动时,PocketBase 会在启动日志里打印一个创建超级管理员的链接(docker compose logs podux 查看)

  • 或直接用命令创建:

    bash
    docker compose exec podux /app/podux superuser upsert admin@example.com <密码>

下一步 ​

基于 Apache 2.0 协议开源