From fbc73c4d48adab2c25966b689efd83dd7539b666 Mon Sep 17 00:00:00 2001 From: reruin Date: Thu, 14 Oct 2021 14:48:50 +0800 Subject: [PATCH] docs: docs for sharelsit-next --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- README.md | 3 ++ docs/.nojekyll | 0 docs/README.md | 13 +++++++ docs/_navbar.md | 3 ++ docs/en/README.md | 13 +++++++ docs/en/_navbar.md | 3 ++ docs/en/_sidebar.md | 3 ++ docs/en/installation.md | 3 ++ docs/index.html | 51 +++++++++++++++++++++++++++ docs/zh-cn/README.md | 10 ++++++ docs/zh-cn/_navbar.md | 3 ++ docs/zh-cn/_sidebar.md | 3 ++ docs/zh-cn/advance.md | 39 ++++++++++++++++++++ docs/zh-cn/configuration.md | 37 +++++++++++++++++++ docs/zh-cn/installation.md | 13 +++++++ 16 files changed, 198 insertions(+), 1 deletion(-) create mode 100644 docs/.nojekyll create mode 100644 docs/README.md create mode 100644 docs/_navbar.md create mode 100644 docs/en/README.md create mode 100644 docs/en/_navbar.md create mode 100644 docs/en/_sidebar.md create mode 100644 docs/en/installation.md create mode 100644 docs/index.html create mode 100644 docs/zh-cn/README.md create mode 100644 docs/zh-cn/_navbar.md create mode 100644 docs/zh-cn/_sidebar.md create mode 100644 docs/zh-cn/advance.md create mode 100644 docs/zh-cn/configuration.md create mode 100644 docs/zh-cn/installation.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 17b14b3c..635b100a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -19,7 +19,7 @@ body: description: Sharelist Version options: - v0.1 - - v0.2 + - latest validations: required: true - type: textarea diff --git a/README.md b/README.md index 7f86499f..e5412dcf 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,9 @@ ShareList 是一个易用的网盘工具，支持快速挂载 GoogleDrive、OneDrive ，可通过插件扩展功能。 新版正在开发中，欢迎[提交反馈](https://github.com/reruin/sharelist/issues/new/choose)。[查看旧版](https://github.com/reruin/sharelist/tree/0.1)。 +## 文档 +[查看文档](https://reruin.github.io/sharelist/docs/#/zh-cn/) + ## 进度 - [x] 核心库支持 - [x] 新主题 diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..f4e1d9db --- /dev/null +++ b/docs/README.md @@ -0,0 +1,13 @@ +# ShareList + +[![Build Status](https://github.com/reruin/sharelist/actions/workflows/ci.yml/badge.svg)](https://github.com/reruin/sharelist/actions/workflows/ci.yml) + +## Introduction +ShareList is an easy-to-use netdisk tool which supports that quickly mount GoogleDrive and OneDrive, and extends functions with plugins. + +## Documentation +Check out [docs](https://reruin.github.io/sharelist/#/en/). + +## License +[Apache-2](http://www.apache.org/licenses/LICENSE-2.0) +Copyright (c) 2018-present, Reruin \ No newline at end of file diff --git a/docs/_navbar.md b/docs/_navbar.md new file mode 100644 index 00000000..f92eba2c --- /dev/null +++ b/docs/_navbar.md @@ -0,0 +1,3 @@ +- Translations + - [:uk: English](/) + - [:cn: 中文](/zh-cn/) diff --git a/docs/en/README.md b/docs/en/README.md new file mode 100644 index 00000000..a3f6aa42 --- /dev/null +++ b/docs/en/README.md @@ -0,0 +1,13 @@ +# ShareList + +[![Build Status](https://api.travis-ci.com/reruin/sharelist.svg?branch=master)](https://travis-ci.com/reruin/sharelist) + +## Introduction +ShareList is an easy-to-use netdisk tool which supports that quickly mount GoogleDrive and OneDrive, and extends functions with plugins. + +## Documentation +Check out [docs](https://reruin.github.io/sharelist/#/en/). + +## License +[Apache-2](http://www.apache.org/licenses/LICENSE-2.0) +Copyright (c) 2018-present, Reruin \ No newline at end of file diff --git a/docs/en/_navbar.md b/docs/en/_navbar.md new file mode 100644 index 00000000..07f02701 --- /dev/null +++ b/docs/en/_navbar.md @@ -0,0 +1,3 @@ +- Translations + - [中文](/zh-cn/) + - [English](/en/) \ No newline at end of file diff --git a/docs/en/_sidebar.md b/docs/en/_sidebar.md new file mode 100644 index 00000000..633eed74 --- /dev/null +++ b/docs/en/_sidebar.md @@ -0,0 +1,3 @@ +* [Installation](en/installation.md) +* [Configuration](en/configuration.md) +* [Advance](en/advance.md) \ No newline at end of file diff --git a/docs/en/installation.md b/docs/en/installation.md new file mode 100644 index 00000000..9fb42fbc --- /dev/null +++ b/docs/en/installation.md @@ -0,0 +1,3 @@ +# Installation + +Translation needed! diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 00000000..4f63fe73 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,51 @@ + + + + + + ShareList Docs + + + + + + + + + +
+ + + + + + \ No newline at end of file diff --git a/docs/zh-cn/README.md b/docs/zh-cn/README.md new file mode 100644 index 00000000..b1a00ecb --- /dev/null +++ b/docs/zh-cn/README.md @@ -0,0 +1,10 @@ +# ShareList + +[![Build Status](https://github.com/reruin/sharelist/actions/workflows/ci.yml/badge.svg)](https://github.com/reruin/sharelist/actions/workflows/ci.yml) + +## 介绍 +ShareList 是一个易用的网盘工具，支持快速挂载 GoogleDrive、OneDrive ，可通过插件扩展功能。 + +## 许可 +[Apache-2](http://www.apache.org/licenses/LICENSE-2.0) +Copyright (c) 2018-present, Reruin \ No newline at end of file diff --git a/docs/zh-cn/_navbar.md b/docs/zh-cn/_navbar.md new file mode 100644 index 00000000..07f02701 --- /dev/null +++ b/docs/zh-cn/_navbar.md @@ -0,0 +1,3 @@ +- Translations + - [中文](/zh-cn/) + - [English](/en/) \ No newline at end of file diff --git a/docs/zh-cn/_sidebar.md b/docs/zh-cn/_sidebar.md new file mode 100644 index 00000000..884242ac --- /dev/null +++ b/docs/zh-cn/_sidebar.md @@ -0,0 +1,3 @@ +* [安装](zh-cn/installation.md) +* [后台配置](zh-cn/configuration.md) +* [高级用法]](zh-cn/advance.md) \ No newline at end of file diff --git a/docs/zh-cn/advance.md b/docs/zh-cn/advance.md new file mode 100644 index 00000000..a0ecef22 --- /dev/null +++ b/docs/zh-cn/advance.md @@ -0,0 +1,39 @@ +## 目录加密 +在需加密目录内新建 ```.passwd``` 文件（此项可修改），```type```为验证方式，```data```为验证内容。 +例如： +```yaml +type: basic +data: + - 123456 + - abcdef +``` + +可使用密码```123456```，```abcdef```验证。 + +*** + +## Nginx(Caddy)反向代理 +使用反代时，请添加以下配置。 + +#### Nginx +```ini + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Proto $scheme; + + proxy_set_header Range $http_range; + proxy_set_header If-Range $http_if_range; + proxy_no_cache $http_range $http_if_range; +``` +如果使用上传功能，请调整 nginx 上传文件大小限制。 +``` + client_max_body_size 8000m; +``` +#### Caddy +```ini + header_upstream Host {host} + header_upstream X-Real-IP {remote} + header_upstream X-Forwarded-For {remote} + header_upstream X-Forwarded-Proto {scheme} +``` \ No newline at end of file diff --git a/docs/zh-cn/configuration.md b/docs/zh-cn/configuration.md new file mode 100644 index 00000000..0a3afb20 --- /dev/null +++ b/docs/zh-cn/configuration.md @@ -0,0 +1,37 @@ +# 后台管理 +访问 ```http://localhost:33001/manage```，填写口令即可进入后台管理。 + +## 常规 + +### 后台管理 +设置后台管理密码。默认 ```sharelist```。 + +### 网站标题 +设置网站标题。 + +### 目录索引 +默认启用。如果只提供下载功能，可禁用此项。 + +### 展开单一挂载盘 +默认启用。如果只有一个挂载盘，将默认展开。 + +### 允许下载 +默认启用。 + +### 忽略路径 +设置禁止访问的目录/文件路径。支持 [gitignore](http://git-scm.com/docs/gitignore) 表达式 + +### 加密文件名 +默认```.passwd```，修改此项自定义加密文件名。 + +### WebDAV 路径 +WebDAV路径。 + +### WebDAV 代理 +默认启用。 + +### WebDAV 用户 +默认 ```admin```。 + +### WebDAV 密码 +默认 ```sharelist```。 \ No newline at end of file diff --git a/docs/zh-cn/installation.md b/docs/zh-cn/installation.md new file mode 100644 index 00000000..9b917f61 --- /dev/null +++ b/docs/zh-cn/installation.md @@ -0,0 +1,13 @@ +# 安装 +Sharelist支持多种安装方式。 + +## Docker +```bash +docker run -d -v /etc/sharelist:/sharelist/cache -p 33001:33001 --name="sharelist" reruin/sharelist:next +``` + +## 二进制版 +[release](https://github.com/reruin/sharelist/releases)下载二进制版。 + + +安装完成首次访问 `http://localhost:33001`地址，将进入默认界面。访问`http://localhost:33001/@manage` 进入后台管理，默认口令为 ```sharelist```。 \ No newline at end of file