# Dufs [![CI](https://github.com/sigoden/dufs/actions/workflows/ci.yaml/badge.svg)](https://github.com/sigoden/dufs/actions/workflows/ci.yaml) [![Crates](https://img.shields.io/crates/v/dufs.svg)](https://crates.io/crates/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) ## Features - Serve static files - Download folder as zip file - Upload files and folders (Drag & Drop) - Create/Edit/Search files - Partial responses (Parallel/Resume download) - Access control - Support https - Support webdav - Easy to use with curl ## Install ### With cargo ``` cargo install dufs ``` ### With docker ``` docker run -v `pwd`:/data -p 5000:5000 --rm -it sigoden/dufs /data -A ``` ### With [Homebrew](https://brew.sh) ``` 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 ``` 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: -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, separated by `,` -a, --auth Add auth role --auth-method Select auth method [default: digest] [possible values: basic, digest] -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 Use custom assets to override builtin assets --tls-cert Path to an SSL/TLS certificate to serve with HTTPS --tls-key Path to the SSL/TLS certificate's private key --log-format Customize http log format --completions Print shell completion script for [possible values: bash, elvish, fish, powershell, zsh] -h, --help Print help -V, --version Print version ``` ## Examples Serve current working directory in readonly mode ``` dufs ``` Allow all operations like upload/delete/search/create/edit... ``` dufs -A ``` Only allow upload operation ``` dufs --allow-upload ``` Serve a specific directory ``` dufs Downloads ``` Serve a single file ``` dufs linux-distro.iso ``` Serve a single-page application like react/vue ``` dufs --render-spa ``` Serve a static website with index.html ``` dufs --render-index ``` Require username/password ``` dufs -a admin:123@/:rw ``` Listen on specific host:ip ``` dufs -b 127.0.0.1 -p 80 ``` Listen on unix socket ``` dufs -b /tmp/dufs.socket ``` Use https ``` dufs --tls-cert my.crt --tls-key my.key ``` ## API Upload a file ``` curl -T path-to-file http://127.0.0.1:5000/new-path/path-to-file ``` 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 ``` Delete a file/folder ``` curl -X DELETE http://127.0.0.1:5000/path-to-file-or-folder ``` Create a directory ``` curl -X MKCOL https://127.0.0.1:5000/path-to-folder ``` Move the file/folder to the new path ``` curl -X MOVE https://127.0.0.1:5000/path -H "Destination: https://127.0.0.1:5000/new-path" ``` List/search directory contents ``` curl http://127.0.0.1:5000?simple # output names only, just like `ls -1` curl http://127.0.0.1:5000?json # output paths in json format curl http://127.0.0.1:5000?q=Dockerfile&simple # search for files, just like `find -name Dockerfile` ``` With authorization ``` curl --user user:pass --digest http://192.168.8.10:5000/file # digest auth curl --user user:pass http://192.168.8.10:5000/file # basic auth ```

Advanced topics

 ### Access Control Dufs supports account based access control. You can control who can do what on which path with `--auth`/`-a`. ``` dufs -a [user:pass]@path[:rw][,path[:rw]...][|...] ``` 1. Multiple rules are separated by "|" 2. User and pass are the account name and password, if omitted, it is an anonymous user 3. One rule can set multiple paths, separated by "," 4. Add `:rw` after the path to indicate that the path has read and write permissions, otherwise the path has readonly permissions. ``` dufs -A -a admin:admin@/:rw ``` `admin` has all permissions for all paths. ``` dufs -A -a admin:admin@/:rw -a guest:guest@/ ``` `guest` has readonly permissions for all paths. ``` dufs -A -a admin:admin@/:rw -a @/ ``` All paths is public, everyone can view/download it. ``` dufs -A -a admin:admin@/:rw -a user1:pass1@/user1:rw -a user2:pass2@/user2 dufs -A -a "admin:admin@/:rw|user1:pass1@/user1:rw|user2:pass2@/user2" ``` `user1` has all permissions for `/user1/*` path. `user2` has all permissions for `/user2/*` path. ``` dufs -A -a user:pass@/dir1:rw,/dir2:rw,dir3 ``` `user` has all permissions for `/dir1/*` and `/dir2/*`, has readonly permissions for `/dir3/`. ``` dufs -a admin:admin@/ ``` Since dufs only allows viewing/downloading, `admin` can only view/download files. ### Hide Paths Dufs supports hiding paths from directory listings via option `--hidden ,...`. ``` dufs --hidden .git,.DS_Store,tmp ``` > The glob used in --hidden only matches file and directory names, not paths. So `--hidden dir1/file` is invalid. ```sh dufs --hidden '.*' # hidden dotfiles dufs --hidden '*/' # hidden all folders dufs --hidden '*.log,*.lock' # hidden by exts ``` ### Log Format Dufs supports customize http log format with option `--log-format`. The log format can use following variables. | variable | description | | ------------ | ------------------------------------------------------------------------- | | $remote_addr | client address | | $remote_user | user name supplied with authentication | | $request | full original request line | | $status | response status | | $http_ | arbitrary request header field. examples: $http_user_agent, $http_referer | The default log format is `'$remote_addr "$request" $status'`. ``` 2022-08-06T06:59:31+08:00 INFO - 127.0.0.1 "GET /" 200 ``` Disable http log ``` dufs --log-format='' ``` Log user-agent ``` 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 ``` Log remote-user ``` 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 ``` ## Environment variables All options can be set using environment variables prefixed with `DUFS_`. ``` [SERVE_PATH] DUFS_SERVE_PATH=/dir -b, --bind DUFS_BIND=0.0.0.0 -p, --port DUFS_PORT=5000 --path-prefix DUFS_PATH_PREFIX=/path --hidden DUFS_HIDDEN=*.log -a, --auth DUFS_AUTH="admin:admin@/:rw|@/" --auth-method DUFS_AUTH_METHOD=basic -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 DUFS_ASSETS=/assets --tls-cert DUFS_TLS_CERT=cert.pem --tls-key DUFS_TLS_KEY=key.pem --log-format DUFS_LOG_FORMAT="" ``` ### Customize UI Dufs allows users to customize the UI with your own assets. ``` dufs --assets my-assets-dir/ ``` Your assets folder must contains a `index.html` file. `index.html` can use the following placeholder variables to retrieve internal data. - `__INDEX_DATA__`: directory listing data - `__ASSETS_PREFIX__`: assets url prefix
## License Copyright (c) 2022 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.