https://github.com/masx200/webdav-cli
A simple zero-configuration command-line webdav server
https://github.com/masx200/webdav-cli
webdav-cli webdav-server
Last synced: 11 months ago
JSON representation
A simple zero-configuration command-line webdav server
- Host: GitHub
- URL: https://github.com/masx200/webdav-cli
- Owner: masx200
- License: mit
- Created: 2020-09-01T07:41:02.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-12-19T01:26:43.000Z (over 1 year ago)
- Last Synced: 2025-05-07T14:23:25.488Z (11 months ago)
- Topics: webdav-cli, webdav-server
- Language: TypeScript
- Homepage:
- Size: 1.99 MB
- Stars: 7
- Watchers: 0
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WebDAV CLI
forked from svtslv/webdav-cli
https://github.com/svtslv/webdav-cli
Optimized a problem
https://github.com/OpenMarshal/npm-WebDAV-Server/issues/84
## Description
A simple zero-configuration command-line webdav server
给 "webdav" 服务器加上了 "etag" 头部和条件请求的功能
支持范围请求，跨域访问，支持内容压缩
支持在浏览器中展示文件夹内容了，使用"koa2-serve-index"
如果请求方法是"GET"或者"HEAD"，交给"koa"服务器处理，提供静态文件
使用 "http-auth"进行用户验证。
## Installation
#### Globally via yarn
```bash
yarn global add @masx200/webdav-cli
```
#### Running on-demand:
```bash
npx @masx200/webdav-cli [options]
```
## Examples
```bash
npx @masx200/webdav-cli --help
```
```txt
usage: webdav-cli [options]
options:
--path,-pa Path to folder [process.cwd()]
--host,-ho Host to use [0.0.0.0]
--port,-po Port to use [1900]
--digest,-dg Enable digest authentication [basic]
--username,-u Username for basic/digest authentication [random]
--password,-ps Password for basic/digest authentication [random]
--disableAuthentication,-da The server file becomes read-only without Authentication.[false]
--ssl,-s Enable https [false]
--methodsWithoutAuthentication methods Without Authentication[undefined]
--sslKey Path to ssl key file [self-signed]
--sslCert Path to ssl cert file [self-signed]
--help,-h Print this list and exit
--rights,-r Comma separated values without spaces [all]
'all', 'canCreate', 'canDelete', 'canMove', 'canRename',
'canAppend', 'canWrite', 'canRead', 'canSource',
'canGetMimeType', 'canGetSize', 'canListLocks',
'canSetLock', 'canRemoveLock', 'canGetAvailableLocks',
'canGetLock', 'canAddChild', 'canRemoveChild',
'canGetChildren', 'canSetProperty', 'canGetProperty',
'canGetProperties', 'canRemoveProperty', 'canGetCreationDate',
'canGetLastModifiedDate', 'canGetWebName', 'canGetType'
env:
WEBDAV_CLI_PATH, WEBDAV_CLI_HOST, WEBDAV_CLI_PORT,
WEBDAV_CLI_USERNAME, WEBDAV_CLI_PASSWORD, WEBDAV_CLI_DIGEST,
WEBDAV_CLI_SSL, WEBDAV_CLI_SSL_KEY, WEBDAV_CLI_SSL_CERT,
WEBDAV_CLI_AUTO_INDEX, WEBDAV_CLI_RIGHTS
WEBDAV_CLI_DISABLE_AUTHENTICATION
```
## TLS/SSL
First, you need to make sure that openssl is installed correctly, and you have `key.pem` and `cert.pem` files. You can generate them using this command:
```shell
openssl req -newkey rsa:2048 -new -nodes -x509 -days 3650 -keyout key.pem -out cert.pem
```
Use `0.0.0.0` as value for `Common name` if you want to be able to install the certificate in your OS's root certificate store or browser so that it is trusted.
Then you need to run the server with `--ssl` for enabling SSL and `--sslKey=key.pem --sslCert=cert.pem` for your certificate files.
## License
MIT
# changelog
2022 年 6 月 15 日 10:12:28
添加了可选参数 `methodsWithoutAuthentication`,可以允许某些方法不需要身份验证,例如:
```
'--methodsWithoutAuthentication=GET,HEAD,PROPFIND,OPTIONS'
```