Dufs

Access Control

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

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

• Use @ to separate the account and paths. No account means anonymous user.
• Use : to separate the username and password of the account.
• Use , to separate paths.
• Use path suffix :rw/:ro set permissions: read-write/read-only. :ro can be omitted.

• -a admin:admin@/:rw: admin has complete permissions for all paths.
• -a guest:guest@/: guest has read-only permissions for all paths.
• -a user:pass@/:rw,/dir1: user has read-write permissions for /, has read-only permissions for /dir1/.
• -a @/: All paths is publicly accessible, everyone can view/download it.

Hashed Password

DUFS supports the use of sha-512 hashed password.

Create hashed password:

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

Use hashed password:

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

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

Two important things for hashed passwords:

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

Hide Paths

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

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.

dufs --hidden '.*'                          # hidden dotfiles
dufs --hidden '*/'                          # hidden all folders
dufs --hidden '.log,.lock'                # hidden by exts
dufs --hidden '.log' --hidden '.lock'

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: $httpuseragent, $httpreferer |

The default log format is '$timeiso8601 $loglevel - $remote_addr "$request" $status.

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

A json log format is also supported.

dufs --log-format '{"time":"$timelocal","addr":"$remoteaddr","uri":"$requesturi", "method":"$requestmethod","status":$status}'

{"time":"2022-08-06T06:59:31+08:00","addr":"127.0.0.1","uri":"/", "method":"GET","status":200}

Disable http log

dufs --log-format=''

Log user-agent

dufs --log-format '$remoteaddr "$request" $status $httpuser_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 '$remoteaddr $remoteuser "$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]                DUFSSERVEPATH="."
    --config <file>         DUFS_CONFIG=config.yaml
-b, --bind <addrs>          DUFS_BIND=0.0.0.0
-p, --port <port>           DUFS_PORT=5000
    --path-prefix <path>    DUFSPATHPREFIX=/dufs
    --hidden <value>        DUFS_HIDDEN=tmp,.log,.lock
-a, --auth <rules>          DUFS_AUTH="admin:admin@/:rw|@/" 
-A, --allow-all             DUFSALLOWALL=true
    --allow-upload          DUFSALLOWUPLOAD=true
    --allow-delete          DUFSALLOWDELETE=true
    --allow-search          DUFSALLOWSEARCH=true
    --allow-symlink         DUFSALLOWSYMLINK=true
    --allow-archive         DUFSALLOWARCHIVE=true
    --allow-hash            DUFSALLOWHASH=true
    --enable-cors           DUFSENABLECORS=true
    --render-index          DUFSRENDERINDEX=true
    --render-try-index      DUFSRENDERTRY_INDEX=true
    --render-spa            DUFSRENDERSPA=true
    --assets <path>         DUFS_ASSETS=./assets
    --log-format <format>   DUFSLOGFORMAT=""
    --log-file <file>       DUFSLOGFILE=./dufs.log
    --compress <compress>   DUFS_COMPRESS=low
    --tls-cert <path>       DUFSTLSCERT=cert.pem
    --tls-key <path>        DUFSTLSKEY=key.pem

Configuration File

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

The following are the configuration items:

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
  - '@/'  # According to the YAML spec, quoting is required.
allow-all: false
allow-upload: true
allow-delete: true
allow-search: true
allow-symlink: true
allow-archive: true
allow-hash: true
enable-cors: true
render-index: true
render-try-index: true
render-spa: true
assets: ./assets/
log-format: '$remoteaddr "$request" $status $httpuser_agent'
log-file: ./dufs.log
compress: low
tls-cert: tests/data/cert.pem
tls-key: tests/data/key_pkcs1.pem

Customize UI

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

dufs --assets my-assets-dir/

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.

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

A customized 404.html page is also supported.

Here are some Third-party customize UI project:

• https://github.com/TransparentLC/dufs-material-assets
• https://github.com/cercky/dufs_web
• https://github.com/52funny/dufs-tabler-web