serv/dufs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: update readme

Browse source
This commit is contained in:
sigoden 2022-08-01 15:12:25 +08:00
parent a493c13734
commit a39065beff
1 changed files with 32 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
README.md
View file

@ -128,12 +128,6 @@ Listen on a specific port
dufs -p 80 dufs -p 80
``` ```
Hide directories from directory listings
```
dufs --hidden .git,.DS_Store
```
Use https Use https
``` ```
@ -165,6 +159,9 @@ Delete a file/folder
curl -X DELETE http://127.0.0.1:5000/path-to-file-or-folder curl -X DELETE http://127.0.0.1:5000/path-to-file-or-folder
``` ```
<details>
<summary>Advance topics</summary>
## Access Control ## Access Control
Dufs supports path level access control. You can control who can do what on which path with `--auth`/`-a`. Dufs supports path level access control. You can control who can do what on which path with `--auth`/`-a`.
@ -188,15 +185,36 @@ dufs -a /@admin:pass1@* -a /ui@designer:pass2 -A
- Account `admin:pass1` can upload/delete/view/download any files/folders. - Account `admin:pass1` can upload/delete/view/download any files/folders.
- Account `designer:pass2` can upload/delete/view/download any files/folders in the `ui` folder. - Account `designer:pass2` can upload/delete/view/download any files/folders in the `ui` folder.
## Hidden
Dufs supports hide directories/files via option `--hidden`.
List the directories to be hidden for directory listings
```
dufs --hidden .git,.DS_Store
```
`--hidden` supports a variant glob:
- `?` matches any single character
- `*` matches any (possibly empty) sequence of characters
- no `**`, `[..]`, `[!..]`
Hide all hidden directories/files
```
dufs --hidden '.*'
```
## Log format ## Log format
dufs supports customize http log format via option `--log-format`. Dufs supports customize http log format via option `--log-format`.
The default format is `$remote_addr "$request" $status`. The default format is `'$remote_addr "$request" $status'`.
All variables list below: | variable | description |
| name | description |
| ------------ | ------------------------------------------------------------------------- | | ------------ | ------------------------------------------------------------------------- |
| $remote_addr | client address | | $remote_addr | client address |
| $remote_user | user name supplied with authentication | | $remote_user | user name supplied with authentication |
@ -205,6 +223,9 @@ All variables list below:
| $http_ | arbitrary request header field. examples: $http_user_agent, $http_referer | | $http_ | arbitrary request header field. examples: $http_user_agent, $http_referer |
> use `dufs --log-format=''` to disable http log > use `dufs --log-format=''` to disable http log
</details>
## License ## License
Copyright (c) 2022 dufs-developers. Copyright (c) 2022 dufs-developers.