kodbox Documentation

Kodbox (formerly KodExplorer) is a private cloud and online document management system. Key capabilities include:

• Multi-Cloud Storage: Supports local disk, FTP, WebDAV, Alibaba Cloud OSS, Tencent Cloud COS, Qiniu, MinIO, and S3-compatible protocols.
• File Management: Windows-style interface with drag-and-drop, keyboard shortcuts (Ctrl+C/X/V, F2, etc.), and various view modes (Icon, List, Split).
• Online Preview & Editing: Supports hundreds of formats including Office documents, PDFs, images, video, and code (120+ languages).
• Collaboration: Granular permission control, file versioning, document discussions, and external link sharing with passwords/expiry.
• Security: Login device control, 2FA, IP filtering, audit logs, and data backup.

In version 1.17, the Notification Center has been enhanced to include unified management for:

• System notification events
• Notification gateways
• Notification logs

Kodbox requires specific Nginx rewrite configurations depending on whether it is installed in the root directory or a subdirectory. This ensures that requests are correctly routed to index.php.

# Root directory deployment
location / {
    try_files $uri $uri/ /index.php?$query_string;
}

# Subdirectory deployment (e.g., /kodbox/)
location /kodbox/ {
    try_files $uri $uri/ /kodbox/index.php?$query_string;
}

To customize the PDF.js viewer in Kodbox, you can inject custom options by modifying pdfjs/web/viewer.js. The viewer looks for a window.pdfOptions object. If present, these options will be merged with the default userOptions.

// In pdfjs/web/viewer.js
var userOptions = Object.create(null);
userOptions = window.pdfOptions || userOptions;

When manually mounting Kodbox via a WebDAV client, if your username contains Chinese characters, you must encode the username using the format $$ followed by the URL-encoded username to ensure successful login.

Example: If the username is 张三, use $$%E5%BC%A0%E4%B8%89.

Depending on where you install kodbox, you must configure Nginx rewrite rules to ensure correct routing.

If installed in the Root Directory, use:

location / {
    try_files $uri $uri/ /index.php?$query_string;
}

If installed in a Subdirectory (e.g., /kodbox/), use:

location /kodbox/ {
    try_files $uri $uri/ /kodbox/index.php?$query_string;
}

# Installed in the Root Directory
location / {
    try_files $uri $uri/ /index.php?$query_string;
}

# Installed in a Subdirectory (e.g., /kodbox/)
location /kodbox/ {
    try_files $uri $uri/ /kodbox/index.php?$query_string;
}

To install kodbox by cloning the repository directly, use the following commands. Ensure you set the appropriate permissions for the web server to access the files.

git clone https://github.com/kalcaddle/kodbox.git
chmod -Rf 777 ./kodbox/*

To install Kodbox using the pre-packaged ZIP archive, download the main branch archive, unzip it, and set the directory permissions.

wget https://github.com/kalcaddle/kodbox/archive/refs/heads/main.zip
unzip main.zip
chmod -Rf 777 ./*

The WebDAV plugin provides compatibility for several synchronization and note-taking tools. You can use Kodbox as a backend for:

• File Sync: goodSync (supports direct binding and network drive mounting; supports two-way sync) and FreeFileSync (supports direct binding and network drive mounting; supports two-way sync).
• Note-taking: joplin (syncing notes).
• Reference Management: Zotero.
• Bookmarks: floccus.
• Other: Noteshelf and super-productivity (via browser-based client compatibility).