Dufs

Dufs是一个独特的实用文件服务器，支持静态服务、上传、搜索、访问控制、WebDAV等功能。

特性

提供静态文件服务
将文件夹下载为zip文件
上传文件和文件夹（支持拖放）
创建/编辑/搜索文件
可恢复/部分上传和下载
访问控制
支持HTTPS
支持WebDAV
易于使用curl

安装

使用cargo

cargo install dufs

使用Docker

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

使用Homebrew

brew install dufs

macOS、Linux、Windows二进制文件

从Github Releases下载，解压并将dufs添加到您的$PATH中。

命令行界面

Dufs是一个独特的实用文件服务器 - https://github.com/sigoden/dufs

用法: dufs [选项] [服务路径]

参数:
  [服务路径]  指定要服务的路径 [默认: .]

选项:
  -c, --config <文件>        指定配置文件
  -b, --bind <地址>          指定绑定地址或unix套接字
  -p, --port <端口>          指定监听端口 [默认: 5000]
      --path-prefix <路径>   指定路径前缀
      --hidden <值>          从目录列表中隐藏路径，例如 tmp,*.log,*.lock
  -a, --auth <规则>          添加认证角色，例如 user:pass@/dir1:rw,/dir2
  -A, --allow-all            允许所有操作
      --allow-upload         允许上传文件/文件夹
      --allow-delete         允许删除文件/文件夹
      --allow-search         允许搜索文件/文件夹
      --allow-symlink        允许链接到根目录外的文件/文件夹
      --allow-archive        允许生成zip归档
      --enable-cors          启用CORS，设置 `Access-Control-Allow-Origin: *`
      --render-index         请求目录时提供index.html，如果未找到index.html则返回404
      --render-try-index     请求目录时提供index.html，如果未找到index.html则返回目录列表
      --render-spa           服务单页应用程序(SPA)
      --assets <路径>        设置资产目录的路径，用于覆盖内置资产
      --log-format <格式>    自定义HTTP日志格式
      --log-file <文件>      指定保存日志的文件，而不是stdout/stderr
      --compress <级别>      设置zip压缩级别 [默认: low] [可能的值: none, low, medium, high]
      --completions <shell>  为<shell>打印shell补全脚本 [可能的值: bash, elvish, fish, powershell, zsh]
      --tls-cert <路径>      用于HTTPS的SSL/TLS证书路径
      --tls-key <路径>       SSL/TLS证书私钥的路径
  -h, --help                 打印帮助信息
  -V, --version              打印版本信息

示例

以只读模式服务当前工作目录

dufs

允许所有操作，如上传/删除/搜索/创建/编辑等

dufs -A

仅允许上传操作

dufs --allow-upload

服务特定目录

dufs Downloads

服务单个文件

dufs linux-distro.iso

服务单页应用程序，如react/vue

dufs --render-spa

服务带有index.html的静态网站

dufs --render-index

需要用户名/密码

dufs -a admin:123@/:rw

监听特定主机:ip

dufs -b 127.0.0.1 -p 80

监听unix套接字

dufs -b /tmp/dufs.socket

使用https

dufs --tls-cert my.crt --tls-key my.key

API

上传文件

curl -T 文件路径 http://127.0.0.1:5000/新路径/文件路径

下载文件

curl http://127.0.0.1:5000/文件路径           # 下载文件
curl http://127.0.0.1:5000/文件路径?hash      # 获取文件的sha256哈希值

将文件夹下载为zip文件

curl -o 文件夹路径.zip http://127.0.0.1:5000/文件夹路径?zip

删除文件/文件夹

curl -X DELETE http://127.0.0.1:5000/文件或文件夹路径

创建目录

curl -X MKCOL http://127.0.0.1:5000/文件夹路径

将文件/文件夹移动到新路径

curl -X MOVE http://127.0.0.1:5000/路径 -H "Destination: http://127.0.0.1:5000/新路径"

列出/搜索目录内容

curl http://127.0.0.1:5000?q=Dockerfile           # 搜索文件，类似于 `find -name Dockerfile`
curl http://127.0.0.1:5000?simple                 # 仅输出名称，类似于 `ls -1`
curl http://127.0.0.1:5000?json                   # 以json格式输出路径

使用授权（基本认证和摘要认证都可以）

curl http://127.0.0.1:5000/file --user user:pass                 # 基本认证
curl http://127.0.0.1:5000/file --user user:pass --digest        # 摘要认证

可恢复下载

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

可恢复上传

upload_offset=$(curl -I -s http://127.0.0.1:5000/file | tr -d '\r' | sed -n 's/content-length: //p')
dd skip=$upload_offset if=file status=none ibs=1 | \
  curl -X PATCH -H "X-Update-Range: append" --data-binary @- http://127.0.0.1:5000/file

访问控制

Dufs支持基于账户的访问控制。您可以使用--auth/-a来控制谁可以在哪个路径上执行什么操作。

dufs -a admin:admin@/:rw -a guest:guest@/
dufs -a user:pass@/:rw,/dir1 -a @/

使用@分隔账户和路径。没有账户表示匿名用户。
使用:分隔账户的用户名和密码。
使用,分隔路径。
使用路径后缀:rw/:ro设置权限：读写/只读。:ro可以省略。

-a admin:admin@/:rw: admin对所有路径有完全权限。
-a guest:guest@/: guest对所有路径有只读权限。
-a user:pass@/:rw,/dir1: user对/*有读写权限，对/dir1/*有只读权限。
-a @/: 所有路径公开可访问，所有人都可以查看/下载。

在密码中使用':'和'@'字符没有限制。例如，user:pa:ss@1@/:rw是有效的，密码是pa:ss@1。

哈希密码

DUFS支持使用sha-512哈希密码。

创建哈希密码

$ mkpasswd  -m sha-512 -s
Password: 123456 
$6$tWMB51u6Kb2ui3wd$5gVHP92V9kZcMwQeKTjyTRgySsYJu471Jb1I6iHQ8iZ6s07GgCIO69KcPBRuwPE5tDq05xMAzye0NxVKuJdYs/

使用哈希密码

dufs -a 'admin:$6$tWMB51u6Kb2ui3wd$5gVHP92V9kZcMwQeKTjyTRgySsYJu471Jb1I6iHQ8iZ6s07GgCIO69KcPBRuwPE5tDq05xMAzye0NxVKuJdYs/@/:rw'

哈希密码的两个重要事项：

Dufs只支持sha-512哈希密码，所以确保密码字符串总是以 $6$ 开头。
摘要认证对哈希密码不起作用。

隐藏路径

Dufs支持通过选项--hidden <glob>,...从目录列表中隐藏路径。

dufs --hidden .git,.DS_Store,tmp

--hidden中使用的glob只匹配文件和目录名，不匹配路径。所以--hidden dir1/file是无效的。

dufs --hidden '.*'                          # 隐藏点文件
dufs --hidden '*/'                          # 隐藏所有文件夹
dufs --hidden '*.log,*.lock'                # 按扩展名隐藏
dufs --hidden '*.log' --hidden '*.lock'

日志格式

Dufs 支持通过 --log-format 选项自定义 HTTP 日志格式。

日志格式可以使用以下变量。

变量	描述
$remote_addr	客户端地址
$remote_user	认证提供的用户名
$request	完整的原始请求行
$status	响应状态
$http_	任意请求头字段。例如：$http_user_agent, $http_referer

默认的日志格式是 '$remote_addr "$request" $status'。

2022-08-06T06:59:31+08:00 INFO - 127.0.0.1 "GET /" 200

禁用 HTTP 日志

dufs --log-format=''

记录用户代理

dufs --log-format '$remote_addr "$request" $status $http_user_agent'

2022-08-06T06:53:55+08:00 INFO - 127.0.0.1 "GET /" 200 Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36

记录远程用户

dufs --log-format '$remote_addr $remote_user "$request" $status' -a /@admin:admin -a /folder1@user1:pass1

2022-08-06T07:04:37+08:00 INFO - 127.0.0.1 admin "GET /" 200

环境变量

所有选项都可以使用以 DUFS_ 为前缀的环境变量进行设置。

[serve-path]                DUFS_SERVE_PATH="."
    --config <file>         DUFS_CONFIG=config.yaml
-b, --bind <addrs>          DUFS_BIND=0.0.0.0
-p, --port <port>           DUFS_PORT=5000
    --path-prefix <path>    DUFS_PATH_PREFIX=/dufs
    --hidden <value>        DUFS_HIDDEN=tmp,*.log,*.lock
-a, --auth <rules>          DUFS_AUTH="admin:admin@/:rw|@/" 
-A, --allow-all             DUFS_ALLOW_ALL=true
    --allow-upload          DUFS_ALLOW_UPLOAD=true
    --allow-delete          DUFS_ALLOW_DELETE=true
    --allow-search          DUFS_ALLOW_SEARCH=true
    --allow-symlink         DUFS_ALLOW_SYMLINK=true
    --allow-archive         DUFS_ALLOW_ARCHIVE=true
    --enable-cors           DUFS_ENABLE_CORS=true
    --render-index          DUFS_RENDER_INDEX=true
    --render-try-index      DUFS_RENDER_TRY_INDEX=true
    --render-spa            DUFS_RENDER_SPA=true
    --assets <path>         DUFS_ASSETS=./assets
    --log-format <format>   DUFS_LOG_FORMAT=""
    --log-file <file>       DUFS_LOG_FILE=./dufs.log
    --compress <compress>   DUFS_COMPRESS=low
    --tls-cert <path>       DUFS_TLS_CERT=cert.pem
    --tls-key <path>        DUFS_TLS_KEY=key.pem

配置文件

你可以通过选择 --config <配置文件路径.yaml> 选项来指定并使用配置文件。

以下是配置项：

serve-path: '.'
bind: 0.0.0.0
port: 5000
path-prefix: /dufs
hidden:
  - tmp
  - '*.log'
  - '*.lock'
auth:
  - admin:admin@/:rw
  - user:pass@/src:rw,/share
  - '@/'  # 根据 YAML 规范，需要引号。
allow-all: false
allow-upload: true
allow-delete: true
allow-search: true
allow-symlink: true
allow-archive: true
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
tls-cert: tests/data/cert.pem
tls-key: tests/data/key_pkcs1.pem