filecodebox/docs/en/guide/getting-started.md

Getting Started

Introduction

FileCodeBox is a simple and efficient file sharing tool that supports temporary file transfer, sharing, and management. This guide will help you quickly deploy and use FileCodeBox.

Features

• 🚀 Quick Deployment: Support Docker one-click deployment
• 🔒 Secure & Reliable: File access requires extraction code
• ⏱️ Time Control: Support setting file expiration time
• 📊 Download Limit: Can limit file download times
• 🖼️ File Preview: Support preview of images, videos, audio, and other formats
• 📱 Responsive Design: Perfect adaptation for mobile and desktop

Deployment Methods

Docker Deployment (Recommended)

docker run -d \
  --name filecodebox \
  -p 12345:12345 \
  -v /path/to/data:/app/data \
  vastsa/filecodebox

Manual Deployment

1. Clone the project

git clone https://github.com/vastsa/FileCodeBox.git
cd FileCodeBox

2. Install dependencies

pip install -r requirements.txt

3. Start service

python main.py

Usage

1. Access the System Open browser and visit http://localhost:12345

2. Upload Files

   • Click upload button or drag files to upload area
   • Set file expiration time and download limit
   • Get share link and extraction code

3. Download Files

   • Visit share link
   • Enter extraction code
   • Download file

4. Admin Panel

   • Visit http://localhost:12345/admin
   • Enter admin password: FileCodeBox2023
   • Enter admin panel
   • View system information, file list, user management, etc.

Next Steps

• Storage Configuration - Learn how to configure different storage methods
• Security Settings - Learn how to enhance system security
• API Documentation - Learn how to integrate through API