sigoden/dufs

Dufs Docker镜像文档

镜像概述和主要用途

Dufs是一款功能独特的实用文件服务器，支持静态文件服务、文件上传、内容搜索、访问控制、WebDAV等多种功能。该Docker镜像封装了Dufs服务，可快速部署用于本地文件共享、开发环境资源服务、临时文件传输等场景。

核心功能与特性

• 静态文件服务：高效提供文件下载
• 文件夹打包下载：支持将文件夹压缩为ZIP格式下载
• 文件/文件夹上传：支持拖放操作上传
• 文件管理：创建、编辑、搜索文件
• 部分响应：支持断点续传和并行下载
• 访问控制：基于用户密码的权限管理
• HTTPS支持：可配置SSL/TLS加密传输
• WebDAV协议：兼容WebDAV客户端
• 命令行友好：支持通过curl进行操作

使用场景与适用范围

• 本地文件临时共享
• 开发环境静态资源服务
• 需要基础认证的文件访问控制
• 前端SPA（单页应用）部署
• 小型团队内部文件传输
• 支持WebDAV的客户端文件管理

快速开始

使用Docker Run部署

bash
docker run -v `pwd`:/data -p 5000:5000 --rm -it docker.xuanyuan.run/sigoden/dufs /data -A

使用Docker Compose部署

yaml
version: '3'
services:
  dufs:
    image: docker.xuanyuan.run/sigoden/dufs
    ports:
      - 5000:5000
    volumes:
      - .:/data
    command: /data -A

详细使用方法

CLI选项说明

环境变量配置

所有CLI选项均可通过环境变量设置，变量名以DUFS_为前缀：

配置文件使用

通过--config <file>选项指定配置文件（支持YAML格式），示例配置：

yaml
# 服务根目录
serve-path: '.'
# 绑定地址
bind: 0.0.0.0
# 监听端口
port: 5000
# 路径前缀
path-prefix: /dufs
# 隐藏路径列表
hidden:
  - tmp
  - '*.log'
  - '*.lock'
# 认证规则
auth:
  - admin:admin@/:rw          # admin用户对根目录有读写权限
  - user:pass@/src:rw,/share  # user用户对/src有读写权限，对/share有读权限
  - '@/'                      # 匿名用户对根目录有读权限（需引号包裹）
# 权限控制
allow-all: false
allow-upload: true
allow-delete: true
allow-search: true
allow-symlink: true
allow-archive: true
# CORS设置
enable-cors: true
# 渲染模式
render-index: true
render-try-index: true
render-spa: true
# 自定义资源目录
assets: ./assets/
# 日志配置
log-format: '$remote_addr "$request" $status $http_user_agent'
log-file: ./dufs.log
# 压缩设置
compress: low
# HTTPS配置
tls-cert: tests/data/cert.pem
tls-key: tests/data/key_pkcs1.pem

使用示例

1. 只读模式服务当前目录

bash
docker run -v `pwd`:/data -p 5000:5000 --rm docker.xuanyuan.run/sigoden/dufs /data

2. 允许所有操作（上传/删除/搜索等）

bash
docker run -v `pwd`:/data -p 5000:5000 --rm docker.xuanyuan.run/sigoden/dufs /data -A

3. 仅允许上传操作

bash
docker run -v `pwd`:/data -p 5000:5000 --rm docker.xuanyuan.run/sigoden/dufs /data --allow-upload

4. 服务指定目录

bash
docker run -v /path/to/Downloads:/data -p 5000:5000 --rm docker.xuanyuan.run/sigoden/dufs /data

5. 服务单个文件

bash
docker run -v /path/to/linux-distro.iso:/data/linux-distro.iso -p 5000:5000 --rm docker.xuanyuan.run/sigoden/dufs /data/linux-distro.iso

6. 部署SPA应用（如React/Vue）

bash
docker run -v `pwd`:/data -p 5000:5000 --rm docker.xuanyuan.run/sigoden/dufs /data --render-spa

7. 部署静态网站（带index.html）

bash
docker run -v `pwd`:/data -p 5000:5000 --rm docker.xuanyuan.run/sigoden/dufs /data --render-index

8. 配置用户名密码认证

bash
docker run -v `pwd`:/data -p 5000:5000 --rm docker.xuanyuan.run/sigoden/dufs /data -a admin:123@/:rw

9. 监听指定地址和端口

bash
docker run -v `pwd`:/data -p 80:80 --rm docker.xuanyuan.run/sigoden/dufs /data -b 127.0.0.1 -p 80

10. 启用HTTPS

bash
docker run -v `pwd`:/data -v /path/to/certs:/certs -p 443:5000 --rm docker.xuanyuan.run/sigoden/dufs /data --tls-cert /certs/my.crt --tls-key /certs/my.key

API接口

上传文件

bash
curl -T local-file.txt http://127.0.0.1:5000/remote-path/file.txt

下载文件

bash
# 下载文件
curl http://127.0.0.1:5000/path/to/file -o local-file

# 获取文件SHA256哈希
curl http://127.0.0.1:5000/path/to/file?hash

下载文件夹为ZIP

bash
curl -o folder.zip http://127.0.0.1:5000/path/to/folder?zip

删除文件/文件夹

bash
curl -X DELETE http://127.0.0.1:5000/path/to/file-or-folder

创建目录

bash
curl -X MKCOL http://127.0.0.1:5000/new-folder

移动文件/文件夹

bash
curl -X MOVE http://127.0.0.1:5000/old-path -H "Destination: http://127.0.0.1:5000/new-path"

列出/搜索目录内容

bash
# 搜索文件（类似`find -name Dockerfile`）
curl http://127.0.0.1:5000?q=Dockerfile

# 仅输出文件名（类似`ls -1`）
curl http://127.0.0.1:5000?simple

# JSON格式输出
curl http://127.0.0.1:5000?json

带认证访问

bash
# Basic认证
curl http://127.0.0.1:5000/file --user username:password

# Digest认证
curl http://127.0.0.1:5000/file --user username:password --digest

断点续传下载

bash
curl -C- -o file http://127.0.0.1:5000/large-file

断点续传上传

bash
# 获取已上传偏移量
upload_offset=$(curl -I -s http://127.0.0.1:5000/large-file | tr -d '\r' | sed -n 's/content-length: //p')

# 续传剩余部分
dd skip=$upload_offset if=large-file status=none ibs=1 | \
  curl -X PATCH -H "X-Update-Range: append" --data-binary @- http://127.0.0.1:5000/large-file

健康检查

bash
curl [***]