FileCodeBox

Anonymous File & Text Sharing with Passcode

Share files like picking up a package — no registration required, just enter the passcode

简体中文 | Live Demo | Documentation | FAQ

# 🚀 Quick Deploy
docker run -d -p 12345:12345 -v /opt/FileCodeBox:/app/data --name filecodebox lanol/filecodebox:latest
# China Mirror (if slow): docker.cnb.cool/aixk/filecodebox

Table of Contents

• Introduction
• Features
• Screenshots
• Quick Start
• Usage Guide
• Development
• FAQ
• Contributing
• Statistics
• Disclaimer

📝 Introduction

FileCodeBox is a lightweight file sharing tool built with FastAPI + Vue3. Users can anonymously share text and files, and recipients only need to enter a passcode to retrieve the content — just like picking up a package from a locker.

Use Cases

✨ Features

🖼️ Screenshots

Frontend repositories: 2024 Theme | 2023 Theme

🎨 New Interface (2024)

📦 Classic Interface (2023)

🚀 Quick Start

Docker Deployment (Recommended)

Option 1: Docker CLI

# Docker Hub (Recommended)
docker run -d --restart always -p 12345:12345 -v /opt/FileCodeBox:/app/data --name filecodebox lanol/filecodebox:latest

# China Mirror (if Docker Hub is slow)
docker run -d --restart always -p 12345:12345 -v /opt/FileCodeBox:/app/data --name filecodebox docker.cnb.cool/aixk/filecodebox

Option 2: Docker Compose

services:
  filecodebox:
    image: lanol/filecodebox:latest
    container_name: filecodebox
    restart: unless-stopped
    ports:
      - "12345:12345"
    volumes:
      - ./data:/app/data
    environment:
      - WORKERS=4
      - LOG_LEVEL=info

docker compose up -d

Environment Variables

Reverse Proxy Configuration

When using Nginx, add the following configuration to properly obtain client IP:

location / {
    proxy_pass http://127.0.0.1:12345;
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    client_max_body_size 100m;  # Adjust upload size limit as needed
}

Manual Deployment

# 1. Clone the repository
git clone https://github.com/vastsa/FileCodeBox.git
cd FileCodeBox

# 2. Install dependencies
pip install -r requirements.txt

# 3. Start the service
python main.py

📖 Usage Guide

Basic Operations

Command Line Usage (curl)

# Basic upload (default 1 day expiration)
curl -X POST "http://localhost:12345/share/file/" \
  -F "file=@/path/to/file.txt"

# Set 1 hour expiration
curl -X POST "http://localhost:12345/share/file/" \
  -F "file=@/path/to/file.txt" \
  -F "expire_value=1" \
  -F "expire_style=hour"

# Set expiration after 10 downloads
curl -X POST "http://localhost:12345/share/file/" \
  -F "file=@/path/to/file.txt" \
  -F "expire_value=10" \
  -F "expire_style=count"

curl -X POST "http://localhost:12345/share/text/" \
  -F "text=Text content to share"

curl -L "http://localhost:12345/share/select/?code=PASSCODE" -o filename

{
  "code": 200,
  "msg": "success",
  "detail": {
    "code": "abcd1234",
    "name": "file.txt"
  }
}

# 1. Get token
curl -X POST "http://localhost:12345/admin/login" \
  -H "Content-Type: application/json" \
  -d '{"password": "FileCodeBox2023"}'

# 2. Upload with token
curl -X POST "http://localhost:12345/share/file/" \
  -H "Authorization: Bearer <token>" \
  -F "file=@/path/to/file.txt"

🛠 Development

Project Structure

FileCodeBox/
├── apps/              # Application modules
│   ├── admin/         # Admin backend
│   └── base/          # Base functionality
├── core/              # Core modules
├── data/              # Data directory (generated at runtime)
├── docs/              # Documentation
└── main.py            # Entry point

Local Development

Backend

pip install -r requirements.txt
python main.py

Frontend

# Frontend repo: https://github.com/vastsa/FileCodeBoxFronted
cd fcb-fronted
npm install
npm run dev

Tech Stack

❓ FAQ

For more questions, visit Wiki

🤝 Contributing

Issues and Pull Requests are welcome!

# 1. Fork and clone
git clone https://github.com/your-username/FileCodeBox.git

# 2. Create branch
git checkout -b feature/your-feature

# 3. Commit changes
git commit -m "feat: add your feature"

# 4. Push and create PR
git push origin feature/your-feature

📊 Statistics

🗓 Roadmap

• 2025 New Theme
• File Collection Feature

📜 Disclaimer

This project is open-source for learning and communication purposes only. It should not be used for any illegal purposes. The author is not responsible for any consequences. Please retain the project address and copyright information when using it.