casperklein/sftp

docker-sftp 镜像文档

镜像概述

docker-sftp 是一个轻量级Docker镜像，旨在通过SFTP协议快速共享主机当前目录中的文件。该镜像无需复杂配置，支持即时部署，适用于临时文件传输、本地开发测试等场景，可快速搭建SFTP服务并共享指定目录内容。

核心功能与特性

• 目录挂载：将主机当前工作目录（$(pwd)）挂载至容器内/mnt路径，实现文件实时共享
• 端口自定义：支持通过端口映射（-p）指定主机端口，灵活适配本地端口占用情况
• 密码配置：通过password环境变量设置SFTP访问密码，简化认证配置
• 临时运行：默认使用--rm参数，容器退出后自动清理，避免残留数据
• 交互模式：支持-it参数提供交互能力，便于查看容器运行状态和调试

使用场景

• 临时文件共享：需快速与他人共享当前目录文件（如本地文档、临时数据）
• 开发环境测试：本地开发中临时搭建SFTP服务，测试文件上传/下载功能
• 简单文件传输：替代复杂SFTP服务器配置，满足少量文件即时传输需求

使用方法与配置说明

基本部署命令

通过以下命令可快速启动SFTP服务，共享当前目录文件：

bash
# 设置环境变量（密码和端口）
PASSWORD='!insecure!'  # SFTP访问密码，建议自定义
PORT=222               # 主机映射端口（避免与本地22端口冲突）

# 启动容器
docker run --rm -it -v $(pwd):/mnt -p $PORT:22 --env password="$PASSWORD" casperklein/sftp

参数说明：

• --rm：容器退出后自动删除，避免残留
• -it：以交互模式运行，支持查看容器输出
• -v $(pwd):/mnt：将主机当前目录挂载到容器/mnt路径（共享文件存放位置）
• -p $PORT:22：将主机$PORT端口映射到容器22端口（SFTP默认端口）
• --env password="$PASSWORD"：设置SFTP访问密码

设置命令别名（Alias）

为简化重复使用，可创建命令别名：

bash
alias sftphere='docker run --rm -it -v $(pwd):/mnt -p 222:22 --env password="!insecure!" casperklein/sftp'

设置后，直接执行 sftphere 即可启动服务（默认使用端口222和密码!insecure!，建议修改密码）。

连接SFTP服务

服务启动后，通过本地SFTP客户端连接：

bash
# 设置连接参数
HOST=localhost  # SFTP服务主机（本地部署时为localhost）
PORT=222        # 与启动时设置的PORT一致

# 连接SFTP服务
sftp -P $PORT root@"$HOST"

连接时输入之前设置的PASSWORD，成功后即可访问共享的当前目录文件（位于远程/mnt路径下）。