Skip to content

Commit 2bc0174

Browse files
authored
feat: add kodbox docs (#373)
- kodbox: https://github.com/kalcaddle/kodbox
1 parent b44d335 commit 2bc0174

File tree

6 files changed

+134
-0
lines changed

6 files changed

+134
-0
lines changed
Loading
Loading

docs/guide/drivers/kodbox.md

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
# This is the icon of the page
3+
icon: iconfont icon-state
4+
# This control sidebar order
5+
order: 38
6+
# A page can have multiple categories
7+
category:
8+
- Guide
9+
# A page can have multiple tags
10+
tag:
11+
- Storage
12+
- Guide
13+
- "302"
14+
# this page is sticky in article list
15+
sticky: true
16+
# this page will appear in starred articles
17+
star: true
18+
---
19+
# KodBox
20+
21+
KodBox is a file manager for web. It is also a web code editor, which allows you to develop websites directly within the web browser. Self-hosted file management system with muilt-cloud support. You can run kodbox either online or locally,on Linux, Windows or Mac based platforms. The only requirement is to have PHP 5 available.
22+
23+
Use this driver to mount a KodBox netdisk space to Alist.
24+
25+
## **Root folder path**
26+
27+
Suppose you have a network disk space named `My Files`. If you remount the contents of the network disk space, you need to obtain the path corresponding to `My File`; if you re-display a name in the network disk space for For the directory of `abc`, you must obtain the path corresponding to `My File/abc`, and so on.
28+
29+
Example: How to get the path of KodBox network disk space `My File`, the result path is `{source:5}`
30+
> Open the KodBox network disk space in the browser. In the console mode, you can see the path corresponding to the network disk space. Do not leave it blank.
31+
![kodbox_root_folder_path](/img/drivers/kodbox/kodbox_root_folder_path_en.jpg)
32+
33+
## **Address**
34+
35+
Your kodbox server address, e.g.
36+
- `https://kodcloud.cc`
37+
- `http://192.168.1.24:8000`
38+
39+
## **Username**
40+
41+
The email or username used to log in to your KodBox server.
42+
43+
## **Password**
44+
45+
The password for your email or username.
46+
47+
### **The default download method used**
48+
49+
```mermaid
50+
---
51+
title: Which download method is used by default?
52+
---
53+
flowchart TB
54+
style a1 fill:#bbf,stroke:#f66,stroke-width:2px,color:#fff
55+
style a2 fill:#ff7575,stroke:#333,stroke-width:4px
56+
subgraph ide1 [ ]
57+
a1
58+
end
59+
a1[302]:::someclass====|default|a2[user equipment]
60+
classDef someclass fill:#f96
61+
c1[local proxy]-.alternative.->a2[user equipment]
62+
b1[Download proxy URL]-.alternative.->a2[user equipment]
63+
click a1 "../drivers/common.html#webdav-policy"
64+
click b1 "../drivers/common.html#webdav-policy"
65+
click c1 "../drivers/common.html#webdav-policy"
66+
```

docs/guide/webdav.md

+1
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ Can't fill in? [Click to view Fill in Example](#webdav-fill-in-example)
5656
| YandexDisk ||||||||
5757
| BaiduNetdisk ||||||||
5858
| Quark ||||||||
59+
| KodBox ||||||||
5960

6061
## **Software that can be used to mount WebDav**
6162

docs/zh/guide/drivers/kodbox.md

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
# This is the icon of the page
3+
icon: iconfont icon-state
4+
# This control sidebar order
5+
order: 38
6+
# A page can have multiple categories
7+
category:
8+
- Guide
9+
# A page can have multiple tags
10+
tag:
11+
- Storage
12+
- Guide
13+
- "302"
14+
# this page is sticky in article list
15+
sticky: true
16+
# this page will appear in starred articles
17+
star: true
18+
---
19+
# KodBox
20+
21+
KodBox可道云(原KodExplorer)是业内领先的企业私有云和在线文档管理系统,为个人网站、企业私有云部署、网络存储、在线文档管理、在线办公等提供安全可控,简便易用、可高度定制的私有云产品。采用windows风格界面、操作习惯,无需适应即可快速上手,支持几百种常用文件格式的在线预览、播放和编辑,环境友好,功能强大,是一款一经试用,就再也离不开的私有云产品。同时你也可以将此程序二次开发整合到你现有的系统。
22+
23+
使用本驱动可以挂载kodbox的网盘空间到Alist。
24+
25+
## **根文件夹ID**
26+
27+
假设你有一个网盘空间名为 `个人空间`,如果你只想挂载该网盘空间的内容,就要获取`个人空间`对应的path;如果你只想展示该网盘空间内一个名为 `abc` 的目录,就要获取`个人空间/abc`对应的path ,以此类推。
28+
29+
示例:如何获取KodBox网盘空间`个人空间`的path,得出path为`{source:5}`
30+
> 在浏览器中打开KodBox网盘空间,在控制台模式下即可看到网盘空间对应的path,不可留空不填。
31+
![kodbox_root_folder_path](/img/drivers/kodbox/kodbox_root_folder_path_zh.jpg)
32+
33+
## **地址**
34+
35+
你的kodbox服务器地址,形如:
36+
- `https://kodcloud.cc`
37+
- `http://192.168.1.24:8000`
38+
39+
## **用户名**
40+
41+
用于登录你的kodbox服务器的邮箱或用户名。
42+
43+
## **密码**
44+
45+
邮箱或用户名对应的密码。
46+
47+
### **默认使用的下载方式**
48+
49+
```mermaid
50+
---
51+
title: 默认使用的哪种下载方式?
52+
---
53+
flowchart TB
54+
style a1 fill:#bbf,stroke:#f66,stroke-width:2px,color:#fff
55+
style a2 fill:#ff7575,stroke:#333,stroke-width:4px
56+
subgraph ide1 [ ]
57+
a1
58+
end
59+
a1[302]:::someclass====|默认|a2[用户设备]
60+
classDef someclass fill:#f96
61+
c1[本机代理]-.备选.->a2[用户设备]
62+
b1[代理URL]-.备选.->a2[用户设备]
63+
click a1 "../drivers/common.html#webdav-策略"
64+
click b1 "../drivers/common.html#webdav-策略"
65+
click c1 "../drivers/common.html#webdav-策略"
66+
```

docs/zh/guide/webdav.md

+1
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ star: true
5656
| YandexDisk ||||||||
5757
| 百度网盘 ||||||||
5858
| 夸克网盘 ||||||||
59+
| KodBox ||||||||
5960

6061
## **可以用来挂载WebDav的软件**
6162

0 commit comments

Comments
 (0)