数据彩虹桥文档

集中呈现核心功能与常见问题,帮助你快速理解数据彩虹桥的能力边界与使用方式。

Linux安装指南

数据彩虹桥支持通过 Homebrew 或 install.sh 在 Linux 上安装 CLI,此文档将指导您完成安装、初始化与基础使用。

1. 前置准备

  • 一台 Linux 设备( Linux 4.12.14+ )。
  • 网络连接正常,可访问官网或 GitHub Release。
  • 建议具备 curltar,若安装到 /usr/local/bin 可能还需要 sudo 权限。

2. 选择安装方式

数据彩虹桥 Linux CLI 当前提供两种安装方式:

  • Homebrew:适合已经使用 Homebrew 管理命令行工具的环境,升级与卸载更方便。
  • install.sh:适合没有 Homebrew 的服务器或希望直接安装二进制的环境。

两种方式都会安装 bifrostbifrost-ctl。前者是 CLI 主程序,后者用于初始化、启动、停止和查看运行状态。

3. 使用 Homebrew 安装

  1. 确认当前系统已安装 Homebrew。
  2. 执行以下命令安装 Bifrost:
brew install leoon-ding/tap/bifrost
  1. 安装完成后初始化默认配置:
bifrost-ctl init

后续升级可直接执行:

brew upgrade leoon-ding/tap/bifrost

4. 使用 install.sh 安装

  1. 执行官网安装脚本:
curl -fsSL https://www.databifrost.com/install.sh | bash

该脚本会自动完成以下工作:

  • 识别当前 Linux 架构(x86_64 / arm64)。
  • 下载对应版本归档与 checksums.txt
  • 校验 SHA-256 后安装 bifrostbifrost-ctl
  • 默认优先安装到 /usr/local/bin;若无写权限,则回退到 ~/.local/bin

常见附加参数:

  • --init:安装完成后直接执行 bifrost-ctl init
curl -fsSL https://www.databifrost.com/install.sh \
  | bash -s -- --init
  • --dir <path>:指定安装目录。
curl -fsSL https://www.databifrost.com/install.sh \
  | bash -s -- --dir /opt/bifrost/bin
  • --version <version>:安装特定版本。
curl -fsSL https://www.databifrost.com/install.sh \
  | bash -s -- --version v1.1.5

此外,脚本还支持 -h / --help 查看帮助。

5. 初始化与启动

  1. 首次安装完成后,执行初始化命令创建默认配置:
bifrost-ctl init
  1. 初始化后会生成配置文件:~/.bifrost/configure.json
  2. 如需后台运行,可使用以下命令:
  • 启动服务:
bifrost-ctl start
  • 查看运行状态:
bifrost-ctl status
  • 停止服务:
bifrost-ctl stop
  • 重启服务:
bifrost-ctl restart

如果只是临时进入交互模式,也可以直接执行:

bifrost

6. 配置说明

初始化后,Bifrost 使用 ~/.bifrost/configure.json 作为主配置文件。

主要配置项说明如下:

  • node_name:当前设备在局域网中的显示名称。默认可留空;留空时程序会自动生成 当前用户名@主机名 作为节点名,例如 leo@goon
  • log_level:日志级别,默认 0
  • ffmpeg_enable / exiftool_enable / libheif_enable:媒体能力开关,主要用于对备份照片的媒体分析,以提供更完整的浏览能力。建议开启,但需要安装对应工具(详细说明见下方)。
  • file_drop.enable:是否启用文件投送接收能力。
  • file_drop.save_dir:接收文件的默认保存目录,默认是 ~/Downloads
  • file_share.enable:是否启用文件共享服务。
  • file_share.share_dir:对外共享的本地目录,默认是 ~/Bifrost/Share
  • file_sync.backup.enable_src / file_sync.backup.enable_dst:是否启用照片/文件备份的源端与目标端能力。
  • file_sync.backup.backup_home:备份目标目录,默认是 ~/Bifrost/Backup
  • file_sync.document_sync.enable:是否启用文档同步。
  • file_sync.document_sync.document_dir:文档同步目录,默认是 ~/Documents
  • file_sync.document_sync.desktop_dir:桌面同步目录,默认是 ~/Desktop,可按需保留或调整。
  • 各模块下的 trusted:受信任节点列表。为空表示不预置受信任节点;填入具体节点 ID 表示只允许指定节点访问。若填写 *,表示允许所有节点访问该模块能力,存在明显安全风险,除非你完全信任当前局域网中的所有设备,否则不建议这样配置。

如果你准备开启这些媒体能力,通常还需要先在系统中安装对应工具:

  • ffmpeg_enable:需要系统中可执行的 ffmpeg
  • exiftool_enable:需要系统中可执行的 exiftool
  • libheif_enable:需要系统中可执行的 heif-convert,用于 HEIF/HEIC 相关处理。

常见安装方式可按发行版包管理器完成,例如在 Debian / Ubuntu 上使用 apt,在 openSUSE 上使用 zypper,在 Fedora 上使用 dnf。安装完成后,可分别执行 ffmpeg -versionexiftool -verheif-convert --help 验证命令已可用。

需要注意的是:配置中的相对路径会按配置文件所在目录解析,~/... 会展开为当前用户主目录;启用 file_dropfile_sharebackupdocument_sync 时,相关目录不能为空,且文档同步目录必须实际存在,否则服务启动时会报错。

下面是一份精简示例:

{
  "node_name": "",
  "log_level": 0,
  "ffmpeg_enable": false,
  "exiftool_enable": false,
  "libheif_enable": false,
  "file_drop": {
    "enable": true,
    "save_dir": "~/Downloads",
    "trusted": []
  },
  "file_share": {
    "enable": true,
    "share_dir": "~/Bifrost/Share",
    "trusted": []
  },
  "file_sync": {
    "backup": {
      "enable_src": false,
      "enable_dst": true,
      "backup_home": "~/Bifrost/Backup",
      "trusted": []
    },
    "document_sync": {
      "enable": false,
      "document_dir": "~/Documents",
      "desktop_dir": "~/Desktop",
      "trusted": []
    }
  }
}

7. 升级与卸载

升级

brew update
brew upgrade leoon-ding/tap/bifrost
  • install.sh:重新执行安装脚本即可覆盖升级;

卸载

brew uninstall bifrost
  • 脚本安装:删除安装目录中的 bifrostbifrost-ctl 即可。
  • 如果还要清理本地配置,可额外删除 ~/.bifrost 目录。

8. 常见问题

  • 命令找不到:若脚本安装到了 ~/.local/bin,请确认该目录已加入当前 shell 的 PATH
  • 权限不足:安装到 /usr/local/bin 时,可能需要 sudo;也可以通过 --dir 安装到当前用户可写目录。
  • 架构不支持:当前 Linux CLI 主要面向 x86_64 / arm64
  • 初始化后仍无法正常使用:优先检查配置文件、当前设备网络连接,以及服务是否已经成功启动。
  • 其他问题可参见 FAQs
Scroll to Top