tangowithfoxtrot/bw-cli

bw-cli Docker镜像

镜像概述

bw-cli是一个封装了最新版本Bitwarden CLI的Docker镜像，旨在提供容器化环境下的Bitwarden命令行工具运行能力。通过该镜像，用户可便捷地在隔离环境中使用Bitwarden CLI的全部功能，无需在主机系统直接安装。

项目仓库：https://github.com/tangowithfoxtrot/bw-docker

核心功能和特性

• 最新版本集成：包含最新稳定版Bitwarden CLI，确保功能与官方同步
• 交互式操作支持：可通过终端交互模式运行Bitwarden CLI命令
• API服务部署：支持部署本地Vault Management API服务，提供Vault管理接口
• 数据持久化：支持通过卷挂载将Bitwarden CLI数据目录映射到主机，实现数据持久化
• 灵活配置：通过环境变量和Docker Compose配置自定义服务端口、解锁状态等参数

使用场景和适用范围

• 容器化环境中需要使用Bitwarden CLI的自动化脚本或工具
• CI/CD流程中集成Bitwarden密钥管理操作
• 本地开发/测试环境部署Vault Management API服务
• 需隔离Bitwarden CLI运行环境的场景（如多版本并存、权限控制等）

使用方法和配置说明

交互式CLI

通过以下命令启动交互式Bitwarden CLI会话，卷挂载确保配置数据持久化：

bash
docker run -v $HOME/.config/Bitwarden\ CLI/:/root/.config/Bitwarden\ CLI/ -it tangowithfoxtrot/bw-cli:latest login

参数说明：

• -v $HOME/.config/Bitwarden CLI/:/root/.config/Bitwarden CLI/：将主机Bitwarden CLI配置目录映射到容器内，实现数据持久化
• -it：以交互终端模式运行容器
• login：启动后执行的Bitwarden CLI命令（可替换为其他命令如list、get等）

部署Vault Management API服务

通过Docker Compose部署本地Vault Management API服务：

docker-compose.yml配置

yaml
services:
  bw_api:
    container_name: bw_api
    hostname: bw_api
    platform: linux/amd64
    image: tangowithfoxtrot/bw-cli:${TAG:-latest}
    env_file:
      - .env
    environment:
      UNLOCK_VAULT: true  # 是否自动解锁Vault
    # volumes: # 取消注释以使用主机Bitwarden CLI数据
    #   - "$HOME/.config/Bitwarden CLI:/root/.config/Bitwarden CLI"  # Linux系统
    #   - "$HOME/Library/Application Support/Bitwarden CLI:/root/.config/Bitwarden CLI"  # macOS系统
    ports:
      - "127.0.0.1:${SERVE_PORT:-8087}:${SERVE_PORT:-8087}"  # 映射API服务端口（默认8087）
    healthcheck:
      test: curl -f http://localhost:${SERVE_PORT:-8087}/status || exit 1  # 健康检查命令
      interval: 5s  # 检查间隔
      timeout: 2s  # 超时时间
      retries: 3  # 重试次数
      start_period: 5s  # 启动等待时间

配置参数说明

• 环境变量：

  • TAG：镜像标签，默认使用latest
  • SERVE_PORT：API服务端口，默认8087
  • UNLOCK_VAULT：布尔值，设置为true时自动解锁Vault
  • .env文件：可在该文件中定义上述环境变量，避免硬编码

• 卷挂载：

  • 取消注释volumes部分可将主机Bitwarden CLI数据目录映射到容器，适用于需要复用主机已有配置的场景
  • 不同操作系统的主机数据目录路径不同，需根据实际系统选择对应配置行

• 健康检查：

  • 通过访问/status端点检查API服务状态，确保服务正常运行
  • 检查间隔5秒，超时2秒，最多重试3次，启动后5秒开始首次检查

启动服务

1. 创建.env文件（可选），定义自定义环境变量：

   TAG=latest
   SERVE_PORT=8087
   

2. 启动服务：

   bash
   docker-compose up -d
   

3. 验证服务状态：

   bash
   curl http://localhost:8087/status