Keybase Docker 镜像文档

镜像概述和主要用途

Keybase 是一个密钥目录服务，可将社交媒体身份映射到加密密钥（包括但不限于 PGP 密钥），并以公开可审计的方式进行管理。Keybase 提供端到端加密聊天（Keybase Chat）和云存储系统（Keybase 文件系统，KBFS）。放置在文件系统公共部分的文件可通过公共端点提供，同时也可通过 Keybase 客户端挂载的本地文件系统访问。

本镜像为 Keybase CLI 客户端的*** Docker 分发版本，用于在容器环境中运行 Keybase 服务及相关功能。

!logo

核心功能和特性

• 身份映射：将社交身份（如 ***、GitHub 等）与加密密钥关联，实现公开可审计的身份验证
• 端到端加密通信：通过 Keybase Chat 提供安全聊天功能
• 加密文件存储：通过 KBFS 提供加密文件系统，支持本地挂载和远程访问
• CLI 工具支持：提供完整的 Keybase 命令行工具，用于身份管理、文件操作、聊天交互等
• 多版本支持：提供标准版、精简版及包含 Node.js/Python 环境的变体，满足不同场景需求

支持的标签和 Dockerfile 链接

• 标准镜像
• 精简变体（slim）
• Node 变体（基于 Node LTS 版本的标准镜像）
• Node 精简变体（基于 Node LTS 版本的 slim 镜像）
• Python 变体（基于 Python 3.8 的标准镜像）
• Python 精简变体（基于 Python 3.8 的 slim 镜像）

快速参考

• 获取帮助： Keybase 上的 keybasefriends 团队、Keybase 上的社区运营 mkbot 团队

• 提交问题： [***]

• 支持的架构： 目前仅支持 amd64，如需其他架构支持，请提交工单。

使用场景和适用范围

• 启动 Keybase 服务并后台运行
• 针对运行中的 Keybase 服务执行 CLI 命令（如登录、发送消息、文件操作等）
• 部署基于 Keybase 的自动化工具或机器人（如聊天机器人、文件同步服务）
• 在容器化环境中集成 Keybase 加密通信或文件存储功能

详细使用方法和配置说明

环境变量

启动 Keybase 服务

console
$ docker run --name some-keybase -d keybaseio/client

对运行中的 Keybase 服务执行命令

console
$ docker run --rm -it --volumes-from some-keybase keybaseio/client keybase login

部署发送消息的 Bash 机器人

bot.sh

bash
#!/usr/bin/env bash
MSG="发送于 $(date)"
keybase chat send $CHAT_TARGET "$MSG"

Dockerfile

dockerfile
FROM keybaseio/client
ENV KEYBASE_SERVICE=1
COPY bot.sh /bot.sh
RUN chmod +x /bot.sh
CMD /bot.sh

运行一次性配置容器

console
# 同时设置 KEYBASE_USERNAME 和 KEYBASE_PAPERKEY 会自动以"一次性模式"配置服务
# 服务将使用传入的纸密钥进行身份验证

$ docker run --rm \
    -e KEYBASE_USERNAME="botname" \
    -e KEYBASE_PAPERKEY="纸密钥内容" \
    -e KEYBASE_SERVICE="1" \
    yournewimage

自动配置新设备

首先启动服务

console
$ docker run --name some-keybase -d keybaseio/client

provision.sh

bash
#!/usr/bin/env bash
keybase --no-auto-fork \
    --debug \
    login \
    -paperkey "$KEYBASE_PAPERKEY" \
    -devicename "$KEYBASE_DEVICENAME" \
    $KEYBASE_USERNAME

Dockerfile

dockerfile
FROM keybaseio/client
COPY provision.sh /provision.sh
RUN chmod +x /provision.sh
CMD ["/provision.sh"]

运行机器人

console
$ docker run --rm \
    -e KEYBASE_USERNAME="botname" \
    -e KEYBASE_PAPERKEY="纸密钥内容" \
    -e KEYBASE_DEVICENAME="randomname123" \
    yournewimage

镜像变体

keybaseio/client:stable、keybaseio/client:<version>

包含 Keybase 客户端的完整功能，支持通过 CLI 工具 keybase fs 操作 KBFS。

keybaseio/client:stable-slim、keybaseio/client:<version>-slim

仅包含 keybase 二进制文件和入口脚本，不支持 KBFS，适用于简单聊天机器人等轻量场景。

keybaseio/client:nightly、keybaseio/client:<version>-<date>-<commit>

标准 stable 镜像的夜间构建版本，支持 KBFS。

keybaseio/client:nightly-slim、keybaseio/client:<version>-<date>-<commit>-slim

slim 镜像的夜间构建版本，不支持 KBFS，适用于简单聊天机器人。

许可证

Keybase 软件采用 BSD 3-clause 许可证 授权。

本 README 基于 Docker Inc. 发布的 Redis README 编写，采用 MIT 许可证授权。

与所有 Docker 镜像一样，本镜像可能包含其他软件，这些软件可能采用其他许可证（如基础发行版中的 Bash 等，以及主软件的任何直接或间接依赖项）。

对于任何预构建镜像的使用，镜像用户有责任确保对本镜像的任何使用均符合其中包含的所有软件的相关许可证要求。