# Sigoden/Dufs Dufs is a distinctive utility file server that supports static serving, uploading, searching, accessing control, webdav... [![demo](https://user-images.githubusercontent.com/4012553/220513063-ff0f186b-ac54-4682-9af4-47a9781dee0d.png align="left")](https://user-images.githubusercontent.com/4012553/220513063-ff0f186b-ac54-4682-9af4-47a9781dee0d.png) ## Features * Serve static files * Download folder as zip file * Upload files and folders (Drag & Drop) * Create/Edit/Search files * Resumable/partial uploads/downloads * Access control * Support https * Support webdav * Easy to use with curl ## Install ### With cargo ```plaintext cargo install dufs ``` ### With docker ```plaintext docker run -v `pwd`:/data -p 5000:5000 --rm sigoden/dufs /data -A ``` ### With [Homebrew](https://brew.sh/) ```plaintext brew install dufs ``` ### Binaries on macOS, Linux, Windows Download from [Github Releases](https://github.com/sigoden/dufs/releases), unzip and add dufs to your $PATH. ## CLI ```plaintext Dufs is a distinctive utility file server - https://github.com/sigoden/dufs Usage: dufs [OPTIONS] [serve-path] Arguments: [serve-path] Specific path to serve [default: .] Options: -c, --config Specify configuration file -b, --bind Specify bind address or unix socket -p, --port Specify port to listen on [default: 5000] --path-prefix Specify a path prefix --hidden Hide paths from directory listings, e.g. tmp,*.log,*.lock -a, --auth Add auth roles, e.g. user:pass@/dir1:rw,/dir2 -A, --allow-all Allow all operations --allow-upload Allow upload files/folders --allow-delete Allow delete files/folders --allow-search Allow search files/folders --allow-symlink Allow symlink to files/folders outside root directory --allow-archive Allow zip archive generation --enable-cors Enable CORS, sets `Access-Control-Allow-Origin: *` --render-index Serve index.html when requesting a directory, returns 404 if not found index.html --render-try-index Serve index.html when requesting a directory, returns directory listing if not found index.html --render-spa Serve SPA(Single Page Application) --assets Set the path to the assets directory for overriding the built-in assets --log-format Customize http log format --log-file Specify the file to save logs to, other than stdout/stderr --compress Set zip compress level [default: low] [possible values: none, low, medium, high] --completions Print shell completion script for [possible values: bash, elvish, fish, powershell, zsh] --tls-cert Path to an SSL/TLS certificate to serve with HTTPS --tls-key Path to the SSL/TLS certificate's private key -h, --help Print help -V, --version Print version ``` ## Examples Serve current working directory in read-only mode ```plaintext dufs ``` Allow all operations like upload/delete/search/create/edit... ```plaintext dufs -A ``` Only allow upload operation ```plaintext dufs --allow-upload ``` Serve a specific directory ```plaintext dufs Downloads ``` Serve a single file ```plaintext dufs linux-distro.iso ``` Serve a single-page application like react/vue ```plaintext dufs --render-spa ``` Serve a static website with index.html ```plaintext dufs --render-index ``` Require username/password ```plaintext dufs -a admin:123@/:rw ``` Listen on specific host:ip ```plaintext dufs -b 127.0.0.1 -p 80 ``` Listen on unix socket ```plaintext dufs -b /tmp/dufs.socket ``` Use https ```plaintext dufs --tls-cert my.crt --tls-key my.key ``` ## API Upload a file ```plaintext curl -T path-to-file http://127.0.0.1:5000/new-path/path-to-file ``` Download a file ```plaintext curl http://127.0.0.1:5000/path-to-file # download the file curl http://127.0.0.1:5000/path-to-file?hash # retrieve the sha256 hash of the file ``` Download a folder as zip file ```plaintext curl -o path-to-folder.zip http://127.0.0.1:5000/path-to-folder?zip ``` Delete a file/folder ```plaintext curl -X DELETE http://127.0.0.1:5000/path-to-file-or-folder ``` Create a directory ```plaintext curl -X MKCOL http://127.0.0.1:5000/path-to-folder ``` Move the file/folder to the new path ```plaintext curl -X MOVE http://127.0.0.1:5000/path -H "Destination: http://127.0.0.1:5000/new-path" ``` List/search directory contents ```plaintext curl http://127.0.0.1:5000?q=Dockerfile # search for files, similar to `find -name Dockerfile` curl http://127.0.0.1:5000?simple # output names only, similar to `ls -1` curl http://127.0.0.1:5000?json # output paths in json format ``` With authorization (Both basic or digest auth works) ```plaintext curl http://127.0.0.1:5000/file --user user:pass # basic auth curl http://127.0.0.1:5000/file --user user:pass --digest # digest auth ``` Resumable downloads ```plaintext curl -C- -o file http://127.0.0.1:5000/file ``` Resumable uploads ```plaintext 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 ```

Advanced topics

## License Copyright (c) 2022-2024 dufs-developers. dufs 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.