emberstack/sftp

SFTP（SSH文件传输协议）服务器

镜像概述和主要用途

本项目提供基于OpenSSH的SFTP服务器Docker镜像，支持通过Docker CLI、Docker Compose及Kubernetes（kubectl和Helm）进行部署，适用于需要安全文件传输的场景，可灵活配置用户、权限及存储路径。

核心功能和特性

• 支持多架构：amd64、arm和arm64
• 基于JSON配置文件定义服务器全局选项和用户信息
• 支持用户chroot目录隔离，限制用户访问范围
• 可自定义用户主目录、起始路径及默认目录
• 支持密码认证和公钥认证
• 提供Docker、Docker Compose和Kubernetes多种部署方式

使用场景和适用范围

适用于企业内部文件共享、服务器间数据同步、开发环境文件传输等需要安全文件传输的场景，支持单机部署和容器集群部署，满足不同规模的文件传输需求。

详细的使用方法和配置说明

支持

若需要帮助或发现bug，请在https://github.com/emberstack/docker-sftp GitHub项目提交issue，也可加入Slack工作区交流：

配置

SFTP服务器使用JSON格式配置文件定义全局选项和用户信息，该文件需挂载到容器内/app/config/sftp.json路径。不支持环境变量配置（原因见下文"高级配置"部分）。

基础配置示例

json
{
    "Global": {
        "Chroot": {
            "Directory": "%h",
            "StartPath": "sftp"
        },
        "Directories": ["sftp"]
    },
    "Users": [
        {
            "Username": "demo",
            "Password": "demo"
        }
    ]
}

此配置创建用户demo（密码demo），在用户主目录下创建sftp目录并设为可读写，用户被chroot到/home/demo目录，连接后起始路径为sftp。可添加多用户、自定义目录或按用户覆盖起始路径，也可指定用户UID和GID（详见"高级配置"）。

部署方法

Docker CLI部署

简单启动

shellsession
$ docker run -p 22:22 -d --name sftp emberstack/sftp

使用默认配置启动SFTP容器，可通过用户demo、密码demo连接。

自定义配置

shellsession
$ docker run -p 22:22 -d --name sftp -v /host/sftp.json:/app/config/sftp.json:ro emberstack/sftp

使用主机/host/sftp.json文件覆盖默认配置。

挂载用户目录

shellsession
$ docker run -p 22:22 -d --name sftp -v /host/sftp.json:/app/config/sftp.json:ro -v /host/demo:/home/demo/sftp emberstack/sftp

将主机/host/demo目录挂载到demo用户的sftp目录。

Docker Compose部署

创建配置文件

yaml
version: '3'
services:
  sftp:
    image: "docker.xuanyuan.run/emberstack/sftp"
    ports:
      - "22:22"
    volumes:
      - ../config-samples/sample.sftp.json:/app/config/sftp.json:ro

启动服务

shellsession
$ docker-compose -p sftp -f docker-compose.yaml up -d

上述配置可在项目的deploy\docker-compose目录找到，可基于此自定义部署。

Kubernetes Helm部署

添加Helm仓库并安装

shellsession
$ helm repo add emberstack https://emberstack.github.io/helm-charts
$ helm repo update
$ helm upgrade --install sftp emberstack/sftp

自定义配置参数

可在https://hub.helm.sh/charts/emberstack查看更多信息。

高级配置

此部分因配置选项较多仍在开发中，如需帮助，请在https://github.com/emberstack/docker-sftp项目提交issue。