import{_ as a,c as i,o as t,ag as s}from"./chunks/framework.BmLMQRXF.js";const g=JSON.parse('{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"en/guide/introduction.md","filePath":"en/guide/introduction.md","lastUpdated":1739330962000}'),n={name:"en/guide/introduction.md"};function l(r,e,o,h,d,p){return t(),i("div",null,e[0]||(e[0]=[s(`
FileCodeBox Logo

Share text and files anonymously with a passcode, like picking up a package

GitHub starsGitHub forksGitHub issuesGitHub licenseQQ GroupPython VersionFastAPIVue Version

πŸ“ Introduction ​

FileCodeBox is a lightweight file sharing tool developed with FastAPI + Vue3. It allows users to share text and files easily, where recipients only need a passcode to retrieve the files, just like picking up a package from a delivery locker.

πŸ–ΌοΈ Preview ​

Frontend Repository Β Β Β  Demo Site

🎯 Use Cases ​

πŸ“ Temporary File Sharing

Quick file sharing without registration

πŸ“ Quick Text Sharing

Share code snippets and text content

πŸ•ΆοΈ Anonymous Transfer

Privacy-protected file transfer

πŸ’Ύ Temporary Storage

File storage with expiration time

πŸ”„ Cross-platform Transfer

Quick file transfer between devices

🌐 Private Share Service

Build your own file sharing service

✨ Core Features ​

πŸš€ Lightweight

Based on FastAPI + SQLite3 + Vue3 + ElementUI

πŸ“€ Easy Upload

Support copy-paste and drag-drop

πŸ“¦ Multiple Types

Support text and various file types

πŸ”’ Security

  • IP upload limits
  • Error attempt limits
  • File expiration

🎫 Passcode Sharing

Random codes with customizable limits

🌍 Multi-language

Support for Simplified Chinese, Traditional Chinese, and English

🎭 Anonymous

No registration required

πŸ›  Admin Panel

File and system management

🐳 Docker

One-click deployment

πŸ’Ύ Storage Options

Local, S3, OneDrive support

πŸ“± Responsive

Mobile-friendly design

πŸ’» CLI Support

Command-line download

πŸš€ Quick Start ​

Docker Deployment ​

bash
docker run -d --restart=always -p 12345:12345 -v /opt/FileCodeBox/:/app/data --name filecodebox lanol/filecodebox:beta

Manual Deployment ​

  1. Clone the repository
bash
git clone https://github.com/vastsa/FileCodeBox.git
  1. Install dependencies
bash
cd FileCodeBox
pip install -r requirements.txt
  1. Start the service
bash
python main.py

πŸ“– Usage Guide ​

Share Files ​

  1. Open the website, click "Share File"
  2. Select or drag files
  3. Set expiration time and count
  4. Get the passcode

Retrieve Files ​

  1. Open the website, enter passcode
  2. Click retrieve
  3. Download file or view text

Admin Panel ​

  1. Visit /admin
  2. Enter admin password
  3. Manage files and settings

πŸ›  Development Guide ​

Project Structure ​

FileCodeBox/
β”œβ”€β”€ apps/           # Application code
β”‚   β”œβ”€β”€ admin/     # Admin backend
β”‚   └── base/      # Base functions
β”œβ”€β”€ core/          # Core functions
β”œβ”€β”€ data/          # Data directory
└── fcb-fronted/   # Frontend code

Development Environment ​

Local Development ​

  1. Backend development
bash
python main.py
  1. Frontend development
bash
cd fcb-fronted
npm install
npm run dev

🀝 Contributing ​

  1. Fork the project
  2. Create your feature branch git checkout -b feature/xxx
  3. Commit your changes git commit -m 'Add xxx'
  4. Push to the branch git push origin feature/xxx
  5. Open a Pull Request

❓ FAQ ​

Q: How to modify upload size limit? ​

A: Change uploadSize in admin panel

Q: How to configure storage engine? ​

A: Select storage engine and configure parameters in admin panel

Q: How to backup data? ​

A: Backup the data directory

For more questions, visit Wiki

πŸ˜€ Project Statistics and Analytics ​

Featured｜HelloGitHub

Repobeats

Star History

πŸ“œ Disclaimer ​

This project is open-source for learning 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.

`,50)]))}const u=a(n,[["render",l]]);export{g as __pageData,u as default};