Files

Sun-ZhenXing ece59b42bf Add environment configuration and documentation for various services

- Created .env.example files for Kafka, Kibana, KodBox, Kong, Langfuse, Logstash, n8n, Nginx, OceanBase, OpenCoze, RocketMQ, TiDB, and TiKV.
- Added README.md and README.zh.md files for OceanBase, RocketMQ, TiDB, and TiKV, detailing usage, configuration, and access instructions.
- Implemented docker-compose.yaml files for OceanBase, RocketMQ, TiDB, and TiKV, defining service configurations, health checks, and resource limits.
- Included broker.conf for RocketMQ to specify broker settings.
- Established a consistent timezone (UTC) across all services.
- Provided optional port overrides in .env.example files for flexibility in deployment.

2025-10-22 11:46:50 +08:00

.env.example

Add environment configuration and documentation for various services

2025-10-22 11:46:50 +08:00

docker-compose.yaml

feat: update Guidelines

2025-10-15 14:00:03 +08:00

README.md

feat: add more

2025-10-06 21:48:39 +08:00

README.zh.md

feat: add more

2025-10-06 21:48:39 +08:00

README.md

Kodbox

English | 中文

This service deploys Kodbox, a powerful web-based file manager and cloud storage platform with Windows-like user experience.

Services

kodbox: The main Kodbox application server.
kodbox-db: MySQL database for Kodbox.
kodbox-redis: Redis for caching and session management.

Environment Variables

Variable Name	Description	Default Value
KODBOX_VERSION	Kodbox image version	`1.62`
KODBOX_PORT	Host port mapping for Kodbox web interface	`80`
MYSQL_VERSION	MySQL image version	`9.4.0`
MYSQL_HOST	MySQL host	`kodbox-db`
MYSQL_PORT	MySQL port	`3306`
MYSQL_DATABASE	MySQL database name	`kodbox`
MYSQL_USER	MySQL username	`kodbox`
MYSQL_PASSWORD	MySQL password	`kodbox123`
MYSQL_ROOT_PASSWORD	MySQL root password	`root123`
REDIS_VERSION	Redis image version	`8.2.1-alpine3.22`
REDIS_HOST	Redis host	`kodbox-redis`
REDIS_PORT	Redis port	`6379`
REDIS_PASSWORD	Redis password (leave empty for no auth)	`""`

Please create a .env file and modify it as needed for your use case.

Volumes

kodbox_data: A volume for storing Kodbox application and user files.
kodbox_db_data: A volume for storing MySQL data.
kodbox_redis_data: A volume for storing Redis data.

Getting Started

(Optional) Create a .env file to customize settings:

KODBOX_PORT=8080
MYSQL_PASSWORD=your-secure-password
MYSQL_ROOT_PASSWORD=your-secure-root-password

Start the services:
```
docker compose up -d
```
Access Kodbox at http://localhost (or your configured port)
Follow the installation wizard on first access

Initial Setup

On first access, the installation wizard will guide you through:

Database configuration (automatically filled from environment variables)
Admin account creation
Basic settings configuration

Note: If you change database credentials in .env, make sure to update them during the installation wizard as well.

Features

Windows-like Interface: Familiar desktop experience in web browser
Multi-cloud Support: Connect to local disk, FTP, WebDAV, and various cloud storage services
File Management: Full-featured file operations with drag-and-drop support
Online Preview: Preview 100+ file formats including Office, PDF, images, videos
Online Editing: Built-in text editor with syntax highlighting for 120+ languages
Team Collaboration: Fine-grained permission control and file sharing
Plugin System: Extend functionality with plugins

Documentation

For more information, visit the official Kodbox documentation.

Security Notes

Change all default passwords in production
Use HTTPS in production environments
Regularly backup all data volumes
Keep Kodbox, MySQL, and Redis updated to the latest stable versions
Consider setting a Redis password in production environments