24 releases (breaking)
0.19.0 | Jun 19, 2022 |
---|---|
0.17.1 | Jun 16, 2022 |
#1358 in HTTP server
27 downloads per month
100KB
2K
SLoC
Duf (Renamed To: Dufs)
Note: The duf crate will no longer be updated, check out dufs crate for latest version.
Duf is a simple file server. Support static serve, search, upload, webdav...
Features
- Serve static files
- Download folder as zip file
- Upload files and folders (Drag & Drop)
- Search files
- Partial responses (Parallel/Resume download)
- Path level access control
- Support https
- Support webdav
- Easy to use with curl
Install
With cargo
cargo install duf
With docker
docker run -v `pwd`:/data -p 5000:5000 --rm -it sigoden/duf /data
Binaries on macOS, Linux, Windows
Download from Github Releases, unzip and add duf to your $PATH.
CLI
Duf is a simple file server. - https://github.com/sigoden/duf
USAGE:
duf [OPTIONS] [--] [path]
ARGS:
<path> Path to a root directory for serving files [default: .]
OPTIONS:
-b, --bind <addr>... Specify bind address
-p, --port <port> Specify port to listen on [default: 5000]
--path-prefix <path> Specify an url path prefix
-a, --auth <rule>... Add auth for path
-A, --allow-all Allow all operations
--allow-upload Allow upload files/folders
--allow-delete Allow delete files/folders
--allow-symlink Allow symlink to files/folders outside root directory
--enable-cors Enable CORS, sets `Access-Control-Allow-Origin: *`
--render-index Render index.html when requesting a directory
--render-try-index Render index.html if it exists when requesting a directory
--render-spa Render for single-page application
--tls-cert <path> Path to an SSL/TLS certificate to serve with HTTPS
--tls-key <path> Path to the SSL/TLS certificate's private key
-h, --help Print help information
-V, --version Print version information
Examples
Serve current working directory, no upload/delete
duf
Allow upload/delete
duf -A
Listen on a specific port
duf -p 80
For a single page application (SPA)
duf --render-spa
Use https
duf --tls-cert my.crt --tls-key my.key
API
Download a file
curl http://127.0.0.1:5000/path-to-file
Download a folder as zip file
curl -o path-to-folder.zip http://127.0.0.1:5000/path-to-folder?zip
Upload a file
curl --upload-file path-to-file http://127.0.0.1:5000/path-to-file
Delete a file/folder
curl -X DELETE http://127.0.0.1:5000/path-to-file
Details
1. Control render logic
The default render logic is:
- If request for a folder, rendering the directory listing.
- If request for a file, rendering the file.
- If request target does not exist, returns 404.
The --render-*
options change the render logic:
--render-index
: If request for a folder, rendering index.html in the folder. If the index.html file does not exist, return 404.--render-try-index
: Like--render-index
, rendering the directory listing if the index.html file does not exist, other than return 404.--render-spa
: If request target does not exist, rendering/index.html
2. Path level access control
duf -a <path>@<readwrite>[@<readonly>]
<path>
: Path to protected<readwrite>
: Account with readwrite permission, required<readonly>
: Account with readonly permission, optional
*
as<readonly>
means<path>
is public, everyone can access/download it.
For example:
duf -a /@admin:pass@* -a /ui@designer:pass1 -A
- All files/folders are public to access/download.
- Account
admin:pass
can upload/delete/download any files/folders. - Account
designer:pass1
can upload/delete/download any files/folders in theui
folder.
Curl with digest auth:
curl --digest -u designer:pass1 http://127.0.0.1:5000/ui/path-to-file
License
Copyright (c) 2022 duf-developers.
duf is made available under the terms of either the MIT License or the Apache License 2.0, at your option.
See the LICENSE-APACHE and LICENSE-MIT files for license details.
Dependencies
~24–36MB
~639K SLoC