Metadata-Version: 2.1
Name: aliyundrive-webdav
Version: 0.1.18
Summary: WebDAV server for AliyunDrive
Home-Page: https://github.com/messense/aliyundrive-webdav
License: MIT
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Source Code, https://github.com/messense/aliyundrive-webdav.git

# aliyundrive-webdav

[![GitHub Actions](https://github.com/messense/aliyundrive-webdav/workflows/CI/badge.svg)](https://github.com/messense/aliyundrive-webdav/actions?query=workflow%3ACI)
[![PyPI](https://img.shields.io/pypi/v/aliyundrive-webdav.svg)](https://pypi.org/project/aliyundrive-webdav)
[![Docker Image](https://img.shields.io/docker/pulls/messense/aliyundrive-webdav.svg?maxAge=2592000)](https://hub.docker.com/r/messense/aliyundrive-webdav/)

阿里云盘 WebDAV 服务

## 安装

可以从 [GitHub Releases](https://github.com/messense/aliyundrive-webdav/releases) 页面下载预先构建的二进制包，
也可以使用 pip 从 PyPI 下载:

```bash
pip install aliyundrive-webdav
```

### OpenWrt 路由器

[GitHub Releases](https://github.com/messense/aliyundrive-webdav/releases) 中有预编译的 ipk 文件，
目前提供了 aarch64 和 arm 两个版本，可以下载后使用 opkg 安装，比如

```bash
wget https://github.com/messense/aliyundrive-webdav/releases/download/v0.1.18/aliyundrive-webdav_0.1.18-0_aarch64_generic.ipk
wget https://github.com/messense/aliyundrive-webdav/releases/download/v0.1.18/luci-app-aliyundrive-webdav_0.1.18-0_all.ipk
opkg install aliyundrive-webdav_0.1.18-0_aarch64_generic.ipk
opkg install luci-app-aliyundrive-webdav_0.1.18-0_all.ipk
```

![OpenWrt 配置界面](./doc/openwrt.png)

### Koolshare 梅林固件

[GitHub Releases](https://github.com/messense/aliyundrive-webdav/releases) 中有预编译包 `aliyundrivewebdav-merlin-arm*.tar.gz`，
目前只提供了旧的 arm380 固件的版本，可在下载后在软件中心离线安装。

![梅林配置界面](./doc/merlin.png)

梅林 384/386 固件也可以离线安装，但后台管理界面可能不工作（暂无机器开发适配，欢迎 PR 修复），可以直接使用 `dbus` 命令进行配置

```bash
dbus set aliyundrivewebdav_refresh_token='xxx'  # 阿里云盘 refresh_token
dbus set aliyundrivewebdav_enable=1  # 设置为 0 禁用服务
dbus set aliyundrivewebdav_port=8080  # 监听端口
dbus set aliyundrivewebdav_auth_user=admin  # 用户名
dbus set aliyundrivewebdav_auth_password=admin  # 密码
```

并使用 `/koolshare/scripts/aliyundrivewebdav_config.sh` 命令启动/停止服务。

## Docker 运行

```bash
docker run -d --name=aliyundrive-webdav --restart=unless-stopped -p 8080:8080 -e REFRESH_TOKEN='refresh token' messense/aliyundrive-webdav
```

## 命令行用法

```bash
aliyundrive-webdav --help
aliyundrive-webdav 0.1.18

USAGE:
    aliyundrive-webdav [FLAGS] [OPTIONS] --refresh-token <refresh-token>

FLAGS:
    -I, --auto-index    Automatically generate index.html
    -h, --help          Prints help information
    -V, --version       Prints version information

OPTIONS:
    -W, --auth-password <auth-password>          WebDAV authentication password [env: WEBDAV_AUTH_PASSWORD=]
    -U, --auth-user <auth-user>                  WebDAV authentication username [env: WEBDAV_AUTH_USER=]
        --cache-size <cache-size>                Directory entries cache size [default: 1000]
        --host <host>                            Listen host [default: 127.0.0.1]
    -p, --port <port>                            Listen port [default: 8080]
    -S, --read-buffer-size <read-buffer-size>
            Read/download buffer size in bytes, defaults to 10MB [default: 10485760]

    -r, --refresh-token <refresh-token>          Aliyun drive refresh token [env: REFRESH_TOKEN=]
```

### 获取 refresh_token

登录[阿里云盘](https://www.aliyundrive.com/drive/)后，可以在开发者工具 ->
Application -> Local Storage 中的 `token` 字段中找到。

## License

This work is released under the MIT license. A copy of the license is provided in the [LICENSE](./LICENSE) file.

