Skip to content

Commit

Permalink
feat: add kodbox docs (#373)
Browse files Browse the repository at this point in the history
  • Loading branch information
yaoice authored Aug 21, 2024
1 parent b44d335 commit 2bc0174
Show file tree
Hide file tree
Showing 6 changed files with 134 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
66 changes: 66 additions & 0 deletions docs/guide/drivers/kodbox.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
# This is the icon of the page
icon: iconfont icon-state
# This control sidebar order
order: 38
# A page can have multiple categories
category:
- Guide
# A page can have multiple tags
tag:
- Storage
- Guide
- "302"
# this page is sticky in article list
sticky: true
# this page will appear in starred articles
star: true
---
# KodBox

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.

Use this driver to mount a KodBox netdisk space to Alist.

## **Root folder path**

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.

Example: How to get the path of KodBox network disk space `My File`, the result path is `{source:5}`
> 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.
![kodbox_root_folder_path](/img/drivers/kodbox/kodbox_root_folder_path_en.jpg)

## **Address**

Your kodbox server address, e.g.
- `https://kodcloud.cc`
- `http://192.168.1.24:8000`

## **Username**

The email or username used to log in to your KodBox server.

## **Password**

The password for your email or username.

### **The default download method used**

```mermaid
---
title: Which download method is used by default?
---
flowchart TB
style a1 fill:#bbf,stroke:#f66,stroke-width:2px,color:#fff
style a2 fill:#ff7575,stroke:#333,stroke-width:4px
subgraph ide1 [ ]
a1
end
a1[302]:::someclass====|default|a2[user equipment]
classDef someclass fill:#f96
c1[local proxy]-.alternative.->a2[user equipment]
b1[Download proxy URL]-.alternative.->a2[user equipment]
click a1 "../drivers/common.html#webdav-policy"
click b1 "../drivers/common.html#webdav-policy"
click c1 "../drivers/common.html#webdav-policy"
```
1 change: 1 addition & 0 deletions docs/guide/webdav.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ Can't fill in? [Click to view Fill in Example](#webdav-fill-in-example)
| YandexDisk ||||||||
| BaiduNetdisk ||||||||
| Quark ||||||||
| KodBox ||||||||

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

Expand Down
66 changes: 66 additions & 0 deletions docs/zh/guide/drivers/kodbox.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
# This is the icon of the page
icon: iconfont icon-state
# This control sidebar order
order: 38
# A page can have multiple categories
category:
- Guide
# A page can have multiple tags
tag:
- Storage
- Guide
- "302"
# this page is sticky in article list
sticky: true
# this page will appear in starred articles
star: true
---
# KodBox

KodBox可道云(原KodExplorer)是业内领先的企业私有云和在线文档管理系统,为个人网站、企业私有云部署、网络存储、在线文档管理、在线办公等提供安全可控,简便易用、可高度定制的私有云产品。采用windows风格界面、操作习惯,无需适应即可快速上手,支持几百种常用文件格式的在线预览、播放和编辑,环境友好,功能强大,是一款一经试用,就再也离不开的私有云产品。同时你也可以将此程序二次开发整合到你现有的系统。

使用本驱动可以挂载kodbox的网盘空间到Alist。

## **根文件夹ID**

假设你有一个网盘空间名为 `个人空间`,如果你只想挂载该网盘空间的内容,就要获取`个人空间`对应的path;如果你只想展示该网盘空间内一个名为 `abc` 的目录,就要获取`个人空间/abc`对应的path ,以此类推。

示例:如何获取KodBox网盘空间`个人空间`的path,得出path为`{source:5}`
> 在浏览器中打开KodBox网盘空间,在控制台模式下即可看到网盘空间对应的path,不可留空不填。
![kodbox_root_folder_path](/img/drivers/kodbox/kodbox_root_folder_path_zh.jpg)

## **地址**

你的kodbox服务器地址,形如:
- `https://kodcloud.cc`
- `http://192.168.1.24:8000`

## **用户名**

用于登录你的kodbox服务器的邮箱或用户名。

## **密码**

邮箱或用户名对应的密码。

### **默认使用的下载方式**

```mermaid
---
title: 默认使用的哪种下载方式?
---
flowchart TB
style a1 fill:#bbf,stroke:#f66,stroke-width:2px,color:#fff
style a2 fill:#ff7575,stroke:#333,stroke-width:4px
subgraph ide1 [ ]
a1
end
a1[302]:::someclass====|默认|a2[用户设备]
classDef someclass fill:#f96
c1[本机代理]-.备选.->a2[用户设备]
b1[代理URL]-.备选.->a2[用户设备]
click a1 "../drivers/common.html#webdav-策略"
click b1 "../drivers/common.html#webdav-策略"
click c1 "../drivers/common.html#webdav-策略"
```
1 change: 1 addition & 0 deletions docs/zh/guide/webdav.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ star: true
| YandexDisk ||||||||
| 百度网盘 ||||||||
| 夸克网盘 ||||||||
| KodBox ||||||||

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

Expand Down

0 comments on commit 2bc0174

Please sign in to comment.