hyperized/openssh-client

docker-openssh-client 镜像文档

镜像概述

docker-openssh-client 是一个基于 Alpine Linux 的轻量级 Docker 镜像，内置 OpenSSH 客户端工具。该镜像继承了 Alpine 系统的轻量级特性（体积小、资源占用低），同时提供完整的 OpenSSH 客户端功能，专为需要在容器环境中使用 SSH 客户端工具的场景设计。

核心功能与特性

• 轻量级基础：基于 Alpine Linux，镜像体积小巧，启动快速，适合资源受限的环境
• 完整客户端工具集：包含 ssh、scp、sftp、ssh-add、ssh-agent 等 OpenSSH 核心客户端工具
• 标准协议支持：兼容 SSH 协议标准，可与各类 SSH 服务器正常通信
• 灵活集成：可无缝集成到 CI/CD 流程、容器化应用或开发测试环境中

使用场景

• CI/CD 流程中，需通过 SSH 连接远程服务器执行部署、文件传输或命令执行操作
• 容器化应用内需要发起 SSH 连接（如跨主机通信、远程资源访问）的场景
• 开发/测试环境中，临时需要隔离的 SSH 客户端工具环境
• 需要轻量级 SSH 客户端工具的自动化脚本或任务

使用方法与配置说明

基本使用

通过 docker run 命令启动容器，直接使用 SSH 客户端工具：

bash
# 连接远程主机
docker run --rm -it docker-openssh-client ssh username@remote-host

# 传输文件（SCP示例）
docker run --rm -it docker-openssh-client scp local-file username@remote-host:/remote/path

挂载 SSH 密钥

如需使用本地 SSH 密钥进行认证，可将主机的 .ssh 目录挂载至容器的 /root/.ssh 目录：

bash
docker run --rm -it -v ~/.ssh:/root/.ssh docker-openssh-client ssh username@remote-host

使用 ssh-agent 管理密钥

通过 ssh-agent 实现密钥免密管理：

bash
# 启动容器并进入交互式终端
docker run --rm -it -v ~/.ssh:/root/.ssh docker-openssh-client sh

# 在容器内启动 ssh-agent
eval $(ssh-agent -s)
# 输出示例：Agent pid 5

# 添加 SSH 密钥
ssh-add /root/.ssh/id_rsa
# 输出示例：Identity added: /root/.ssh/id_rsa (/root/.ssh/id_rsa)

# 连接远程主机（无需重复输入密钥密码）
ssh username@remote-host

与 docker-compose 集成

在 docker-compose.yml 中定义服务：

yaml
version: '3'
services:
  ssh-client:
    image: docker-openssh-client
    volumes:
      - ~/.ssh:/root/.ssh:ro  # 只读挂载密钥目录，增强安全性
    command: ssh username@remote-host -p 2222  # 自定义SSH命令及端口

启动服务：

bash
docker-compose up

注意事项

• 默认以 root 用户运行容器，挂载主机目录时需确保权限正确（建议设置 ro 只读权限保护密钥）
• 敏感操作建议通过环境变量或安全挂载方式传递配置，避免硬编码敏感信息
• 如需持久化 SSH 配置（如 known_hosts），可单独挂载配置文件或使用数据卷

常用工具说明

• ssh：SSH 协议客户端，用于远程登录
• scp：基于 SSH 的文件传输工具
• sftp：SSH 文件传输协议客户端
• ssh-add：向认证代理添加私钥
• ssh-agent：SSH 认证代理，管理私钥及密码