Browse Source

chore: update readme

pull/52/head
sigoden 3 years ago
parent
commit
b67b64eae6
  1. 16
      README.md

16
README.md

@ -125,23 +125,21 @@ Delete a file/folder @@ -125,23 +125,21 @@ Delete a file/folder
curl -X DELETE http://127.0.0.1:5000/path-to-file
```
## Auth
Duf supports path level access control through option `--auth`/`-a`.
<details>
Grammar rule:
<summary>Duf supports path level access control with --auth/-a option.</summary>
```
<path>@<readwrite>[@<readonly>]
duf -a <path>@<readwrite>[@<readonly>]
```
- `<path>`: Path to protected
- `<readwrite>`: Account with readwrite permission
- `<readonly>`: Account with readonly permission
> If `<readonly>` is `*`, means `<path>` is public, everyone can acess/download it.
- `<readwrite>`: Account with readwrite permission, required
- `<readonly>`: Account with readonly permission, optional
> `*` as `<readonly>` means `<path>` is public, everyone can acess/download it.
For examples:
@ -158,6 +156,8 @@ Curl with auth: @@ -158,6 +156,8 @@ Curl with auth:
curl --digest -u designer:pass1 http://127.0.0.1:5000/ui/path-to-file
```
</details>
## License
Copyright (c) 2022 duf-developers.

Loading…
Cancel
Save