noc0lour/sftp

镜像概述

本镜像基于Debian和Alpine系统构建，提供安全易用的SFTP（SSH文件传输协议）、SCP和RSYNC服务，通过rssh限制用户仅能使用这些文件传输服务，确保服务的安全性和合规性。

核心功能

• 支持SFTP/SCP/RSYNC三种文件传输协议
• 灵活的用户配置：可通过命令行、配置文件或STDIN定义用户（支持密码、加密密码、密钥认证）
• 卷挂载：允许将主机目录挂载到用户主目录，实现文件共享
• 自定义脚本：支持在容器启动时执行/etc/sftp.d/目录下的自定义脚本
• 支持指定用户UID/GID，确保文件权限与主机系统匹配

使用场景

• 安全地在不同主机间传输文件
• 为团队或外部用户提供受控的文件上传/下载服务
• 开发环境中快速搭建临时文件传输节点
• 与其他容器配合实现数据共享

配置说明

用户定义方式

• 命令行参数：格式为user:pass[:e][:uid[:gid[:dir1[,dir2]...]]]（:e表示加密密码）
• 配置文件：将用户列表写入文件并挂载到/etc/sftp-users.conf
• STDIN输入：通过标准输入传递用户配置

密钥认证

将用户的公钥文件挂载到/home/[user]/.ssh/keys/目录下，容器会自动将其添加到authorized_keys中

使用示例

最简Docker Run示例

bash
docker run -p 22:22 -d atmoz/sftp foo:pass:::upload

用户foo使用密码pass登录，可上传文件到upload目录

共享主机目录

bash
docker run \
    -v /host/upload:/home/foo/upload \
    -v /host/ssh_host_rsa_key:/etc/ssh/ssh_host_rsa_key \
    -v /host/ssh_host_rsa_key.pub:/etc/ssh/ssh_host_rsa_key.pub \
    -p 2222:22 -d atmoz/sftp \
    foo:pass:1001

将主机/host/upload目录挂载到用户foo的upload目录，指定用户UID为1001

Docker Compose示例

yaml
sftp:
    image: atmoz/sftp
    volumes:
        - /host/upload:/home/foo/upload
        - /host/ssh_host_rsa_key:/etc/ssh/ssh_host_rsa_key
        - /host/ssh_host_rsa_key.pub:/etc/ssh/ssh_host_rsa_key.pub
    ports:
        - "2222:22"
    command: foo:pass:1001

密钥认证示例

bash
docker run \
    -v /host/id_rsa.pub:/home/foo/.ssh/keys/id_rsa.pub:ro \
    -v /host/share:/home/foo/share \
    -p 2222:22 -d atmoz/sftp \
    foo::1001

用户foo使用密钥登录，无密码，UID为1001

执行自定义脚本

将脚本文件挂载到/etc/sftp.d/目录，容器启动时自动执行，例如：

bash
#!/bin/bash
# 绑定挂载目录
function bindmount() {
    if [ -d "$1" ]; then
        mkdir -p "$2"
    fi
    mount --bind $3 "$1" "$2"
}
bindmount /data/common /home/dave/common
bindmount /data/docs /home/peter/docs --read-only