{ "componentChunkName": "component---src-templates-issues-tsx", "path": "/issues/139", "result": {"data":{"issuesJson":{"id":"fb2c5d75-9ed6-52ee-8c33-5db96370ccc6","title":"sigoden/dufs: 一个独特的实用文件服务器，支持静态服务、上传、搜索、访问控制、webdav","number":139,"bodyHTML":"
\n



\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Repossigoden/dufs
Views\"views\"
Stars\"stars\"
Forks\"forks\"
License\"license\"
UpdatedAt\"last-commit\"
CreatedAt\"create-at\"
\n\n

\"\"

\n\n
\n

Dufs

\n

\"CI\"
\n\"Crates\"
\n\"Docker

\n

Dufs is a distinctive utility file server that supports static serving, uploading, searching, accessing control, webdav...

\n

\"demo\"

\n

Features

\n\n

Install

\n

With cargo

\n
cargo install dufs\n
\n

With docker

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

With Homebrew

\n
brew install dufs\n
\n

Binaries on macOS, Linux, Windows

\n

Download from Github Releases, unzip and add dufs to your $PATH.

\n

CLI

\n
Dufs is a distinctive utility file server - https://github.com/sigoden/dufs\n\nUsage: dufs [OPTIONS] [serve-path]\n\nArguments:\n  [serve-path]  Specific path to serve [default: .]\n\nOptions:\n  -c, --config <file>        Specify configuration file\n  -b, --bind <addrs>         Specify bind address or unix socket\n  -p, --port <port>          Specify port to listen on [default: 5000]\n      --path-prefix <path>   Specify a path prefix\n      --hidden <value>       Hide paths from directory listings, e.g. tmp,*.log,*.lock\n  -a, --auth <rules>         Add auth roles, e.g. user:pass@/dir1:rw,/dir2\n  -A, --allow-all            Allow all operations\n      --allow-upload         Allow upload files/folders\n      --allow-delete         Allow delete files/folders\n      --allow-search         Allow search files/folders\n      --allow-symlink        Allow symlink to files/folders outside root directory\n      --allow-archive        Allow download folders as archive file\n      --enable-cors          Enable CORS, sets `Access-Control-Allow-Origin: *`\n      --render-index         Serve index.html when requesting a directory, returns 404 if not found index.html\n      --render-try-index     Serve index.html when requesting a directory, returns directory listing if not found index.html\n      --render-spa           Serve SPA(Single Page Application)\n      --assets <path>        Set the path to the assets directory for overriding the built-in assets\n      --log-format <format>  Customize http log format\n      --log-file <file>      Specify the file to save logs to, other than stdout/stderr\n      --compress <level>     Set zip compress level [default: low] [possible values: none, low, medium, high]\n      --completions <shell>  Print shell completion script for <shell> [possible values: bash, elvish, fish, powershell, zsh]\n      --tls-cert <path>      Path to an SSL/TLS certificate to serve with HTTPS\n      --tls-key <path>       Path to the SSL/TLS certificate's private key\n  -h, --help                 Print help\n  -V, --version              Print version\n
\n

Examples

\n

Serve current working directory in read-only mode

\n
dufs\n
\n

Allow all operations like upload/delete/search/create/edit...

\n
dufs -A\n
\n

Only allow upload operation

\n
dufs --allow-upload\n
\n

Serve a specific directory

\n
dufs Downloads\n
\n

Serve a single file

\n
dufs linux-distro.iso\n
\n

Serve a single-page application like react/vue

\n
dufs --render-spa\n
\n

Serve a static website with index.html

\n
dufs --render-index\n
\n

Require username/password

\n
dufs -a admin:123@/:rw\n
\n

Listen on specific host:ip

\n
dufs -b 127.0.0.1 -p 80\n
\n

Listen on unix socket

\n
dufs -b /tmp/dufs.socket\n
\n

Use https

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

API

\n

Upload a file

\n
curl -T path-to-file http://127.0.0.1:5000/new-path/path-to-file
\n

Download a file

\n
curl http://127.0.0.1:5000/path-to-file           # download the file\ncurl http://127.0.0.1:5000/path-to-file?hash      # retrieve the sha256 hash of the file
\n

Download a folder as zip file

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

Delete a file/folder

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

Create a directory

\n
curl -X MKCOL http://127.0.0.1:5000/path-to-folder
\n

Move the file/folder to the new path

\n
curl -X MOVE http://127.0.0.1:5000/path -H \"Destination: http://127.0.0.1:5000/new-path\"
\n

List/search directory contents

\n
curl http://127.0.0.1:5000?q=Dockerfile           # search for files, similar to `find -name Dockerfile`\ncurl http://127.0.0.1:5000?simple                 # output names only, similar to `ls -1`\ncurl http://127.0.0.1:5000?json                   # output paths in json format
\n

With authorization (Both basic or digest auth works)

\n
curl http://127.0.0.1:5000/file --user user:pass                 # basic auth\ncurl http://127.0.0.1:5000/file --user user:pass --digest        # digest auth
\n

Resumable downloads

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

Resumable uploads

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

Health checks

\n
curl http://127.0.0.1:5000/__dufs__/health
\n
\n

Advanced Topics

\n

Access Control

\n

Dufs supports account based access control. You can control who can do what on which path with --auth/-a.

\n
dufs -a admin:admin@/:rw -a guest:guest@/\ndufs -a user:pass@/:rw,/dir1 -a @/\n
\n
    \n
  1. Use @ to separate the account and paths. No account means anonymous user.
    2. \n
  2. Use : to separate the username and password of the account.
    3. \n
  3. Use , to separate paths.
    4. \n
  4. Use path suffix :rw/:ro set permissions: read-write/read-only. :ro can be omitted.
    5. \n
\n\n

Auth permissions are restricted by dufs global permissions. If dufs does not enable upload permissions via --allow-upload, then the account will not have upload permissions even if it is granted read-write(:rw) permissions.

\n

Hashed Password

\n

DUFS supports the use of sha-512 hashed password.

\n

Create hashed password:

\n
$ openssl passwd -6 123456 # or `mkpasswd -m sha-512 123456`\n$6$tWMB51u6Kb2ui3wd$5gVHP92V9kZcMwQeKTjyTRgySsYJu471Jb1I6iHQ8iZ6s07GgCIO69KcPBRuwPE5tDq05xMAzye0NxVKuJdYs/
\n

Use hashed password:

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

The hashed password contains $6, which can expand to a variable in some shells, so you have to use single quotes to wrap it.

\n
\n

Two important things for hashed passwords:

\n
    \n
  1. Dufs only supports sha-512 hashed passwords, so ensure that the password string always starts with $6$.
    2. \n
  2. Digest authentication does not function properly with hashed passwords.
    3. \n
\n

Hide Paths

\n

Dufs supports hiding paths from directory listings via option --hidden <glob>,....

\n
dufs --hidden .git,.DS_Store,tmp\n
\n
\n

The glob used in --hidden only matches file and directory names, not paths. So --hidden dir1/file is invalid.

\n
\n\n

Log Format

\n

Dufs supports customize http log format with option --log-format.

\n

The log format can use following variables.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
variabledescription
$remote_addrclient address
$remote_useruser name supplied with authentication
$requestfull original request line
$statusresponse status
$http_arbitrary request header field. examples: $http_user_agent, $http_referer
\n

The default log format is '$remote_addr \"$request\" $status'.

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

Disable http log

\n
dufs --log-format=''\n
\n

Log user-agent

\n
dufs --log-format '$remote_addr \"$request\" $status $http_user_agent'\n
\n
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\n
\n

Log remote-user

\n
dufs --log-format '$remote_addr $remote_user \"$request\" $status' -a /@admin:admin -a /folder1@user1:pass1\n
\n
2022-08-06T07:04:37+08:00 INFO - 127.0.0.1 admin \"GET /\" 200\n
\n

Environment variables

\n

All options can be set using environment variables prefixed with DUFS_.

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

Configuration File

\n

You can specify and use the configuration file by selecting the option --config <path-to-config.yaml>.

\n

The following are the configuration items:

\n
serve-path: '.'\nbind: 0.0.0.0\nport: 5000\npath-prefix: /dufs\nhidden:\n  - tmp\n  - '*.log'\n  - '*.lock'\nauth:\n  - admin:admin@/:rw\n  - user:pass@/src:rw,/share\n  - '@/'  # According to the YAML spec, quoting is required.\nallow-all: false\nallow-upload: true\nallow-delete: true\nallow-search: true\nallow-symlink: true\nallow-archive: true\nenable-cors: true\nrender-index: true\nrender-try-index: true\nrender-spa: true\nassets: ./assets/\nlog-format: '$remote_addr \"$request\" $status $http_user_agent'\nlog-file: ./dufs.log\ncompress: low\ntls-cert: tests/data/cert.pem\ntls-key: tests/data/key_pkcs1.pem
\n

Customize UI

\n

Dufs allows users to customize the UI with your own assets.

\n
dufs --assets my-assets-dir/\n
\n
\n

If you only need to make slight adjustments to the current UI, you copy dufs's assets directory and modify it accordingly. The current UI doesn't use any frameworks, just plain HTML/JS/CSS. As long as you have some basic knowledge of web development, it shouldn't be difficult to modify.

\n
\n

Your assets folder must contains a index.html file.

\n

index.html can use the following placeholder variables to retrieve internal data.

\n\n
\n

License

\n

Copyright (c) 2022-2024 dufs-developers.

\n

dufs is made available under the terms of either the MIT License or the Apache License 2.0, at your option.

\n

See the LICENSE-APACHE and LICENSE-MIT files for license details.

","updatedAt":"2025-05-21T15:55:55Z","upvoteCount":null,"author":{"login":"eryajf","avatarUrl":"https://avatars.githubusercontent.com/u/33259379?u=e4a4090a38ac2473aaed4ef9945233636776c6c3&v=4","url":"https://github.com/eryajf"},"category":null,"labels":{"edges":[{"node":{"name":"更多","color":"25B472"}},{"node":{"name":"文件管理系统","color":"0eb870"}},{"node":{"name":"sigoden","color":"b5cd4f"}}]},"comments":{"edges":[]}}},"pageContext":{"number":139,"previous":{"title":"qiaolin-li/dubbo-desktop-manager: 一个Dubbo的桌面管理软件","number":138},"next":{"title":"muesli/duf: 比 du 更好看的磁盘空间占用查看工具","number":140}}}, "staticQueryHashes": ["151096407","2861350382"]}