Lan
34 lines
34 KiB
Python
34 lines
34 KiB
Python
<!DOCTYPE html>
|
||
<html lang="zh-CN" dir="ltr">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
<title>FileCodeBox</title>
|
||
<meta name="description" content="匿名口令分享文本，文件">
|
||
<meta name="generator" content="VitePress v1.6.3">
|
||
<link rel="preload stylesheet" href="/assets/style.8SUn7xXl.css" as="style">
|
||
<link rel="preload stylesheet" href="/vp-icons.css" as="style">
|
||
|
||
<script type="module" src="/assets/app._8rCwCso.js"></script>
|
||
<link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
|
||
<link rel="modulepreload" href="/assets/chunks/theme.BNBC0yme.js">
|
||
<link rel="modulepreload" href="/assets/chunks/framework.BmLMQRXF.js">
|
||
<link rel="modulepreload" href="/assets/guide_introduction.md.CebWHzyk.lean.js">
|
||
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
|
||
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
|
||
</head>
|
||
<body>
|
||
<div id="app"><div class="Layout" data-v-b6c923d7><!--[--><!--]--><!--[--><span tabindex="-1" data-v-efe7d6be></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-efe7d6be>Skip to content</a><!--]--><!----><header class="VPNav" data-v-b6c923d7 data-v-b6ac2530><div class="VPNavBar" data-v-b6ac2530 data-v-79868b1d><div class="wrapper" data-v-79868b1d><div class="container" data-v-79868b1d><div class="title" data-v-79868b1d><div class="VPNavBarTitle has-sidebar" data-v-79868b1d data-v-0c6c2dd6><a class="title" href="/" data-v-0c6c2dd6><!--[--><!--]--><!--[--><img class="VPImage logo" src="/logo_small.png" alt data-v-1499dcbc><!--]--><span data-v-0c6c2dd6>FileCodeBox</span><!--[--><!--]--></a></div></div><div class="content" data-v-79868b1d><div class="content-body" data-v-79868b1d><!--[--><!--]--><div class="VPNavBarSearch search" data-v-79868b1d><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-79868b1d data-v-28279947><span id="main-nav-aria-label" class="visually-hidden" data-v-28279947> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/" tabindex="0" data-v-28279947 data-v-ee14b6c7><!--[--><span data-v-ee14b6c7>首页</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/guide/getting-started.html" tabindex="0" data-v-28279947 data-v-ee14b6c7><!--[--><span data-v-ee14b6c7>指南</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/api/" tabindex="0" data-v-28279947 data-v-ee14b6c7><!--[--><span data-v-ee14b6c7>API</span><!--]--></a><!--]--><!--[--><div class="VPFlyout VPNavBarMenuGroup" data-v-28279947 data-v-839a11df><button type="button" class="button" aria-haspopup="true" aria-expanded="false" data-v-839a11df><span class="text" data-v-839a11df><!----><span data-v-839a11df>了解更多</span><span class="vpi-chevron-down text-icon" data-v-839a11df></span></span></button><div class="menu" data-v-839a11df><div class="VPMenu" data-v-839a11df data-v-2b491744><div class="items" data-v-2b491744><!--[--><!--[--><div class="VPMenuLink" data-v-2b491744 data-v-b04e260a><a class="VPLink link" href="/changelog.html" data-v-b04e260a><!--[--><span data-v-b04e260a>更新日志</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-2b491744 data-v-b04e260a><a class="VPLink link" href="/contributing.html" data-v-b04e260a><!--[--><span data-v-b04e260a>贡献指南</span><!--]--></a></div><!--]--><!--]--></div><!--[--><!--]--></div></div></div><!--]--><!--]--></nav><div class="VPFlyout VPNavBarTranslations translations" data-v-79868b1d data-v-adf6da57 data-v-839a11df><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="切换语言" data-v-839a11df><span class="text" data-v-839a11df><span class="vpi-languages option-icon" data-v-839a11df></span><!----><span class="vpi-chevron-down text-icon" data-v-839a11df></span></span></button><div class="menu" data-v-839a11df><div class="VPMenu" data-v-839a11df data-v-2b491744><!----><!--[--><!--[--><div class="items" data-v-adf6da57><p class="title" data-v-adf6da57>简体中文</p><!--[--><div class="VPMenuLink" data-v-adf6da57 data-v-b04e260a><a class="VPLink link" href="/en/guide/introduction.html" data-v-b04e260a><!--[--><span data-v-b04e260a>English</span><!--]--></a></div><!--]--></div><!--]--><!--]--></div></div></div><div class="VPNavBarAppearance appearance" data-v-79868b1d data-v-7e6f0956><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-7e6f0956 data-v-2fc9caea data-v-8e683565><span class="check" data-v-8e683565><span class="icon" data-v-8e683565><!--[--><span class="vpi-sun sun" data-v-2fc9caea></span><span class="vpi-moon moon" data-v-2fc9caea></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-79868b1d data-v-91a2f046 data-v-607f35a4><!--[--><a class="VPSocialLink no-icon" href="https://github.com/vastsa/FileCodeBox" aria-label="github" target="_blank" rel="noopener" data-v-607f35a4 data-v-84a70180><span class="vpi-social-github"></span></a><!--]--></div><div class="VPFlyout VPNavBarExtra extra" data-v-79868b1d data-v-c6f77877 data-v-839a11df><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-839a11df><span class="vpi-more-horizontal icon" data-v-839a11df></span></button><div class="menu" data-v-839a11df><div class="VPMenu" data-v-839a11df data-v-2b491744><!----><!--[--><!--[--><div class="group translations" data-v-c6f77877><p class="trans-title" data-v-c6f77877>简体中文</p><!--[--><div class="VPMenuLink" data-v-c6f77877 data-v-b04e260a><a class="VPLink link" href="/en/guide/introduction.html" data-v-b04e260a><!--[--><span data-v-b04e260a>English</span><!--]--></a></div><!--]--></div><div class="group" data-v-c6f77877><div class="item appearance" data-v-c6f77877><p class="label" data-v-c6f77877>Appearance</p><div class="appearance-action" data-v-c6f77877><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-c6f77877 data-v-2fc9caea data-v-8e683565><span class="check" data-v-8e683565><span class="icon" data-v-8e683565><!--[--><span class="vpi-sun sun" data-v-2fc9caea></span><span class="vpi-moon moon" data-v-2fc9caea></span><!--]--></span></span></button></div></div></div><div class="group" data-v-c6f77877><div class="item social-links" data-v-c6f77877><div class="VPSocialLinks social-links-list" data-v-c6f77877 data-v-607f35a4><!--[--><a class="VPSocialLink no-icon" href="https://github.com/vastsa/FileCodeBox" aria-label="github" target="_blank" rel="noopener" data-v-607f35a4 data-v-84a70180><span class="vpi-social-github"></span></a><!--]--></div></div></div><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-79868b1d data-v-ab6fcae6><span class="container" data-v-ab6fcae6><span class="top" data-v-ab6fcae6></span><span class="middle" data-v-ab6fcae6></span><span class="bottom" data-v-ab6fcae6></span></span></button></div></div></div></div><div class="divider" data-v-79868b1d><div class="divider-line" data-v-79868b1d></div></div></div><!----></header><div class="VPLocalNav has-sidebar empty" data-v-b6c923d7 data-v-3ab135ad><div class="container" data-v-3ab135ad><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-3ab135ad><span class="vpi-align-left menu-icon" data-v-3ab135ad></span><span class="menu-text" data-v-3ab135ad>Menu</span></button><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-3ab135ad data-v-b4822720><button data-v-b4822720>Return to top</button><!----></div></div></div><aside class="VPSidebar" data-v-b6c923d7 data-v-4cb10d83><div class="curtain" data-v-4cb10d83></div><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-4cb10d83><span class="visually-hidden" id="sidebar-aria-label" data-v-4cb10d83> Sidebar Navigation </span><!--[--><!--]--><!--[--><div class="no-transition group" data-v-f4a843d6><section class="VPSidebarItem level-0 has-active" data-v-f4a843d6 data-v-074d9f77><div class="item" role="button" tabindex="0" data-v-074d9f77><div class="indicator" data-v-074d9f77></div><h2 class="text" data-v-074d9f77>介绍</h2><!----></div><div class="items" data-v-074d9f77><!--[--><div class="VPSidebarItem level-1 is-link" data-v-074d9f77 data-v-074d9f77><div class="item" data-v-074d9f77><div class="indicator" data-v-074d9f77></div><a class="VPLink link link" href="/guide/introduction.html" data-v-074d9f77><!--[--><p class="text" data-v-074d9f77>什么是 FileCodeBox</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-074d9f77 data-v-074d9f77><div class="item" data-v-074d9f77><div class="indicator" data-v-074d9f77></div><a class="VPLink link link" href="/guide/getting-started.html" data-v-074d9f77><!--[--><p class="text" data-v-074d9f77>快速开始</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-f4a843d6><section class="VPSidebarItem level-0" data-v-f4a843d6 data-v-074d9f77><div class="item" role="button" tabindex="0" data-v-074d9f77><div class="indicator" data-v-074d9f77></div><h2 class="text" data-v-074d9f77>基础功能</h2><!----></div><div class="items" data-v-074d9f77><!--[--><div class="VPSidebarItem level-1 is-link" data-v-074d9f77 data-v-074d9f77><div class="item" data-v-074d9f77><div class="indicator" data-v-074d9f77></div><a class="VPLink link link" href="/guide/upload.html" data-v-074d9f77><!--[--><p class="text" data-v-074d9f77>文件上传</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-074d9f77 data-v-074d9f77><div class="item" data-v-074d9f77><div class="indicator" data-v-074d9f77></div><a class="VPLink link link" href="/guide/share.html" data-v-074d9f77><!--[--><p class="text" data-v-074d9f77>文件分享</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-074d9f77 data-v-074d9f77><div class="item" data-v-074d9f77><div class="indicator" data-v-074d9f77></div><a class="VPLink link link" href="/guide/management.html" data-v-074d9f77><!--[--><p class="text" data-v-074d9f77>文件管理</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-f4a843d6><section class="VPSidebarItem level-0" data-v-f4a843d6 data-v-074d9f77><div class="item" role="button" tabindex="0" data-v-074d9f77><div class="indicator" data-v-074d9f77></div><h2 class="text" data-v-074d9f77>高级特性</h2><!----></div><div class="items" data-v-074d9f77><!--[--><div class="VPSidebarItem level-1 is-link" data-v-074d9f77 data-v-074d9f77><div class="item" data-v-074d9f77><div class="indicator" data-v-074d9f77></div><a class="VPLink link link" href="/guide/storage.html" data-v-074d9f77><!--[--><p class="text" data-v-074d9f77>存储配置</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-074d9f77 data-v-074d9f77><div class="item" data-v-074d9f77><div class="indicator" data-v-074d9f77></div><a class="VPLink link link" href="/guide/security.html" data-v-074d9f77><!--[--><p class="text" data-v-074d9f77>安全设置</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-074d9f77 data-v-074d9f77><div class="item" data-v-074d9f77><div class="indicator" data-v-074d9f77></div><a class="VPLink link link" href="/guide/configuration.html" data-v-074d9f77><!--[--><p class="text" data-v-074d9f77>系统配置</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><!--]--><!--[--><!--]--></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-b6c923d7 data-v-62f80edf><div class="VPDoc has-sidebar has-aside" data-v-62f80edf data-v-c7e25d19><!--[--><!--]--><div class="container" data-v-c7e25d19><div class="aside" data-v-c7e25d19><div class="aside-curtain" data-v-c7e25d19></div><div class="aside-container" data-v-c7e25d19><div class="aside-content" data-v-c7e25d19><div class="VPDocAside" data-v-c7e25d19 data-v-a7c337e5><!--[--><!--]--><!--[--><!--]--><nav aria-labelledby="doc-outline-aria-label" class="VPDocAsideOutline" data-v-a7c337e5 data-v-30bc7595><div class="content" data-v-30bc7595><div class="outline-marker" data-v-30bc7595></div><div aria-level="2" class="outline-title" id="doc-outline-aria-label" role="heading" data-v-30bc7595>目录</div><ul class="VPDocOutlineItem root" data-v-30bc7595 data-v-697bcd1c><!--[--><!--]--></ul></div></nav><!--[--><!--]--><div class="spacer" data-v-a7c337e5></div><!--[--><!--]--><!----><!--[--><!--]--><!--[--><!--]--></div></div></div></div><div class="content" data-v-c7e25d19><div class="content-container" data-v-c7e25d19><!--[--><!--]--><main class="main" data-v-c7e25d19><div style="position:relative;" class="vp-doc _guide_introduction" data-v-c7e25d19><div><div align="center"><img src="https://fastly.jsdelivr.net/gh/vastsa/FileCodeBox@V1.6/static/banners/img_1.png" alt="FileCodeBox Logo"><p><em>匿名口令分享文本和文件，像拿快递一样取文件</em></p><p><a href="https://github.com/vastsa/FileCodeBox/stargazers" target="_blank" rel="noreferrer"><img src="https://img.shields.io/github/stars/vastsa/FileCodeBox" alt="GitHub stars"></a><a href="https://github.com/vastsa/FileCodeBox/network" target="_blank" rel="noreferrer"><img src="https://img.shields.io/github/forks/vastsa/FileCodeBox" alt="GitHub forks"></a><a href="https://github.com/vastsa/FileCodeBox/issues" target="_blank" rel="noreferrer"><img src="https://img.shields.io/github/issues/vastsa/FileCodeBox" alt="GitHub issues"></a><a href="https://github.com/vastsa/FileCodeBox/blob/master/LICENSE" target="_blank" rel="noreferrer"><img src="https://img.shields.io/github/license/vastsa/FileCodeBox" alt="GitHub license"></a><a href="https://qm.qq.com/q/PemPzhdEIM" target="_blank" rel="noreferrer"><img src="https://img.shields.io/badge/QQ%20Group-739673698-blue.svg" alt="QQ Group"></a><a href="https://www.python.org" target="_blank" rel="noreferrer"><img src="https://img.shields.io/badge/Python-3.8+-blue.svg" alt="Python Version"></a><a href="https://fastapi.tiangolo.com" target="_blank" rel="noreferrer"><img src="https://img.shields.io/badge/FastAPI-0.68+-green.svg" alt="FastAPI"></a><a href="https://v3.vuejs.org" target="_blank" rel="noreferrer"><img src="https://img.shields.io/badge/Vue.js-3.x-brightgreen.svg" alt="Vue Version"></a></p></div><h2 id="🚀-更新计划" tabindex="-1">🚀 更新计划 <a class="header-anchor" href="#🚀-更新计划" aria-label="Permalink to "🚀 更新计划""></a></h2><ul><li>[ ] 切片上传，同文件秒传，断点续传</li><li>[ ] 用户登录重构</li><li>[x] webdav存储</li><li>[x] 存储支持自定义路径</li><li>[x] s3优化，不修改昵称为uuid，新建目录</li></ul><h2 id="📝-项目简介" tabindex="-1">📝 项目简介 <a class="header-anchor" href="#📝-项目简介" aria-label="Permalink to "📝 项目简介""></a></h2><p>FileCodeBox 是一个基于 FastAPI + Vue3 开发的轻量级文件分享工具。它允许用户通过简单的方式分享文本和文件，接收者只需要一个提取码就可以取得文件，就像从快递柜取出快递一样简单。</p><h2 id="🎯-应用场景" tabindex="-1">🎯 应用场景 <a class="header-anchor" href="#🎯-应用场景" aria-label="Permalink to "🎯 应用场景""></a></h2><table><tr><td align="center"><h4>📁 临时文件分享</h4> 快速分享单个文件，无需注册登录 </td><td align="center"><h4>📝 文本快速分享</h4> 分享代码片段、文本内容等 </td><td align="center"><h4>🕶️ 匿名文件传输</h4> 保护隐私的文件传输方式 </td></tr><tr><td align="center"><h4>💾 临时文件存储</h4> 支持设置过期时间的文件存储 </td><td align="center"><h4>🔄 跨平台传输</h4> 在不同设备间快速传输文件 </td><td align="center"><h4>🌐 小型分享服务</h4> 搭建私有的文件分享服务 </td></tr></table><h2 id="✨-核心特性" tabindex="-1">✨ 核心特性 <a class="header-anchor" href="#✨-核心特性" aria-label="Permalink to "✨ 核心特性""></a></h2><table><tr><td align="center"><h4>🚀 轻量简洁</h4> 基于 FastAPI + SQLite3 + Vue3 + ElementUI，部署简单，性能出色 </td><td align="center"><h4>📤 便捷上传</h4> 支持复制粘贴、拖拽上传，操作简单直观 </td><td align="center"><h4>📦 多种类型</h4> 支持文本和各类文件的分享 </td></tr><tr><td align="center"><h4>🔒 安全机制</h4><ul><li>IP 限制上传次数</li><li>错误次数限制</li><li>文件过期机制</li></ul></td><td align="center"><h4>🎫 提取码分享</h4> 随机提取码，可自定义次数及有效期 </td><td align="center"><h4>🌍 多语言支持</h4> 支持中文简体、繁体及英文 </td></tr><tr><td align="center"><h4>🎭 匿名分享</h4> 无需注册登录，保护隐私 </td><td align="center"><h4>🛠 管理面板</h4> 文件管理和系统配置 </td><td align="center"><h4>🐳 容器部署</h4> 支持 Docker 一键部署 </td></tr><tr><td align="center"><h4>💾 存储扩展</h4> 支持本地存储、S3 协议、OneDrive 等 </td><td align="center"><h4>📱 响应式设计</h4> 支持移动端访问 </td><td align="center"><h4>💻 终端支持</h4> 支持命令行下载 </td></tr></table><h2 id="🚀-快速开始" tabindex="-1">🚀 快速开始 <a class="header-anchor" href="#🚀-快速开始" aria-label="Permalink to "🚀 快速开始""></a></h2><h3 id="docker-部署" tabindex="-1">Docker 部署 <a class="header-anchor" href="#docker-部署" aria-label="Permalink to "Docker 部署""></a></h3><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">docker</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> run</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -d</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> --restart=always</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -p</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> 12345:12345</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -v</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> /opt/FileCodeBox/:/app/data</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> --name</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> filecodebox</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> lanol/filecodebox:beta</span></span></code></pre></div><h3 id="手动部署" tabindex="-1">手动部署 <a class="header-anchor" href="#手动部署" aria-label="Permalink to "手动部署""></a></h3><ol><li>克隆项目</li></ol><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">git</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> clone</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> https://github.com/vastsa/FileCodeBox.git</span></span></code></pre></div><ol start="2"><li>安装依赖</li></ol><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">cd</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> FileCodeBox</span></span>
|
||
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">pip</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> install</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -r</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> requirements.txt</span></span></code></pre></div><ol start="3"><li>启动服务</li></ol><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">python</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> main.py</span></span></code></pre></div><h2 id="📖-使用说明" tabindex="-1">📖 使用说明 <a class="header-anchor" href="#📖-使用说明" aria-label="Permalink to "📖 使用说明""></a></h2><h3 id="分享文件" tabindex="-1">分享文件 <a class="header-anchor" href="#分享文件" aria-label="Permalink to "分享文件""></a></h3><ol><li>打开网页，点击"分享文件"</li><li>选择或拖拽文件</li><li>设置过期时间和次数</li><li>获取提取码</li></ol><h3 id="获取文件" tabindex="-1">获取文件 <a class="header-anchor" href="#获取文件" aria-label="Permalink to "获取文件""></a></h3><ol><li>打开网页，输入提取码</li><li>点击获取</li><li>下载文件或查看文本</li></ol><h3 id="管理面板" tabindex="-1">管理面板 <a class="header-anchor" href="#管理面板" aria-label="Permalink to "管理面板""></a></h3><ol><li>访问 <code>/admin</code></li><li>输入管理员密码</li><li>管理文件和配置</li></ol><h2 id="🛠-开发指南" tabindex="-1">🛠 开发指南 <a class="header-anchor" href="#🛠-开发指南" aria-label="Permalink to "🛠 开发指南""></a></h2><h3 id="项目结构" tabindex="-1">项目结构 <a class="header-anchor" href="#项目结构" aria-label="Permalink to "项目结构""></a></h3><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>FileCodeBox/</span></span>
|
||
<span class="line"><span>├── apps/ # 应用代码</span></span>
|
||
<span class="line"><span>│ ├── admin/ # 管理后台</span></span>
|
||
<span class="line"><span>│ └── base/ # 基础功能</span></span>
|
||
<span class="line"><span>├── core/ # 核心功能</span></span>
|
||
<span class="line"><span>├── data/ # 数据目录</span></span>
|
||
<span class="line"><span>└── fcb-fronted/ # 前端代码</span></span></code></pre></div><h3 id="开发环境" tabindex="-1">开发环境 <a class="header-anchor" href="#开发环境" aria-label="Permalink to "开发环境""></a></h3><ul><li>Python 3.8+</li><li>Node.js 14+</li><li>Vue 3</li><li>FastAPI</li></ul><h3 id="本地开发" tabindex="-1">本地开发 <a class="header-anchor" href="#本地开发" aria-label="Permalink to "本地开发""></a></h3><ol><li>后端开发</li></ol><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">python</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> main.py</span></span></code></pre></div><ol start="2"><li>前端开发</li></ol><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">cd</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> fcb-fronted</span></span>
|
||
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">npm</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> install</span></span>
|
||
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">npm</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> run</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> dev</span></span></code></pre></div><h2 id="🤝-贡献指南" tabindex="-1">🤝 贡献指南 <a class="header-anchor" href="#🤝-贡献指南" aria-label="Permalink to "🤝 贡献指南""></a></h2><ol><li>Fork 本项目</li><li>创建新分支 <code>git checkout -b feature/xxx</code></li><li>提交更改 <code>git commit -m 'Add xxx'</code></li><li>推送到分支 <code>git push origin feature/xxx</code></li><li>提交 Pull Request</li></ol><h2 id="❓-常见问题" tabindex="-1">❓ 常见问题 <a class="header-anchor" href="#❓-常见问题" aria-label="Permalink to "❓ 常见问题""></a></h2><h3 id="q-如何修改上传大小限制" tabindex="-1">Q: 如何修改上传大小限制？ <a class="header-anchor" href="#q-如何修改上传大小限制" aria-label="Permalink to "Q: 如何修改上传大小限制？""></a></h3><p>A: 在管理面板中修改配置项 <code>uploadSize</code></p><h3 id="q-如何配置存储引擎" tabindex="-1">Q: 如何配置存储引擎？ <a class="header-anchor" href="#q-如何配置存储引擎" aria-label="Permalink to "Q: 如何配置存储引擎？""></a></h3><p>A: 在管理面板中选择存储引擎并配置相应参数</p><h3 id="q-如何备份数据" tabindex="-1">Q: 如何备份数据？ <a class="header-anchor" href="#q-如何备份数据" aria-label="Permalink to "Q: 如何备份数据？""></a></h3><p>A: 备份 <code>data</code> 目录即可</p><p>更多问题请访问 <a href="https://github.com/vastsa/FileCodeBox/wiki/%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98" target="_blank" rel="noreferrer">Wiki</a></p><h2 id="📊-项目统计" tabindex="-1">📊 项目统计 <a class="header-anchor" href="#📊-项目统计" aria-label="Permalink to "📊 项目统计""></a></h2><div align="center"><a href="https://hellogithub.com/repository/75ad7ffedd404a6485b4d621ec5b47e6" target="_blank"><img src="https://api.hellogithub.com/v1/widgets/recommend.svg?rid=75ad7ffedd404a6485b4d621ec5b47e6&claim_uid=beSz6INEkCM4mDH" alt="Featured｜HelloGitHub" style="width:200px;height:45px;" width="200" height="45"></a><p><img src="https://repobeats.axiom.co/api/embed/7a6c92f1d96ee57e6fb67f0df371528397b0c9ac.svg" alt="Repobeats"></p><p><a href="https://star-history.com/#vastsa/FileCodeBox&Date" target="_blank" rel="noreferrer"><img src="https://api.star-history.com/svg?repos=vastsa/FileCodeBox&type=Date" alt="Star History"></a></p></div><h2 id="📜-免责声明" tabindex="-1">📜 免责声明 <a class="header-anchor" href="#📜-免责声明" aria-label="Permalink to "📜 免责声明""></a></h2><p>本项目开源仅供学习使用，不得用于任何违法用途，否则后果自负，与作者无关。使用时请保留项目地址和版权信息。</p></div></div></main><footer class="VPDocFooter" data-v-c7e25d19 data-v-2dcb78e4><!--[--><!--]--><div class="edit-info" data-v-2dcb78e4><!----><div class="last-updated" data-v-2dcb78e4><p class="VPLastUpdated" data-v-2dcb78e4 data-v-afb38d82>Last updated: <time datetime="2025-02-12T03:29:22.000Z" data-v-afb38d82></time></p></div></div><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-2dcb78e4><span class="visually-hidden" id="doc-footer-aria-label" data-v-2dcb78e4>Pager</span><div class="pager" data-v-2dcb78e4><!----></div><div class="pager" data-v-2dcb78e4><a class="VPLink link pager-link next" href="/guide/getting-started.html" data-v-2dcb78e4><!--[--><span class="desc" data-v-2dcb78e4>Next page</span><span class="title" data-v-2dcb78e4>快速开始</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-b6c923d7 data-v-22dc8f31><div class="container" data-v-22dc8f31><p class="message" data-v-22dc8f31>基于 LGPL 许可发布</p><p class="copyright" data-v-22dc8f31>Copyright © 2023-present FileCodeBox</p></div></footer><!--[--><!--]--></div></div>
|
||
<script>window.__VP_HASH_MAP__=JSON.parse("{\"api_index.md\":\"qG09VB3V\",\"changelog.md\":\"C8aI6QEN\",\"contributing.md\":\"k9HB5RBU\",\"en_api_index.md\":\"DowD_P4F\",\"en_changelog.md\":\"BcADjzAG\",\"en_contributing.md\":\"PVT9OVBi\",\"en_guide_configuration.md\":\"B0l-oJMx\",\"en_guide_getting-started.md\":\"Dn8s1IIJ\",\"en_guide_introduction.md\":\"BD40RLpr\",\"en_guide_management.md\":\"B7zTh6Wx\",\"en_guide_security.md\":\"Cviop6qN\",\"en_guide_share.md\":\"76VwCXWs\",\"en_guide_storage.md\":\"BYAxNGDy\",\"en_guide_upload copy.md\":\"DjRt4QqF\",\"en_guide_upload.md\":\"DUnZK1hP\",\"en_index.md\":\"tZNBw7JM\",\"guide_configuration.md\":\"BIXg2nLZ\",\"guide_getting-started.md\":\"BG1qGt6J\",\"guide_introduction.md\":\"CebWHzyk\",\"guide_management.md\":\"eUCTNsEJ\",\"guide_security.md\":\"-P7VdlH3\",\"guide_share.md\":\"CQJMq2_v\",\"guide_storage.md\":\"OPzq4lQ1\",\"guide_upload.md\":\"BGoSj7Ei\",\"index.md\":\"BrsJo2Pg\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"zh-CN\",\"dir\":\"ltr\",\"title\":\"FileCodeBox\",\"description\":\"简单高效的文件分享工具\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"langMenuLabel\":\"切换语言\",\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/vastsa/FileCodeBox\"}],\"footer\":{\"message\":\"基于 MIT 许可发布\",\"copyright\":\"Copyright © 2023-present FileCodeBox\"},\"search\":{\"provider\":\"local\",\"options\":{\"locales\":{\"zh\":{\"translations\":{\"button\":{\"buttonText\":\"搜索文档\",\"buttonAriaLabel\":\"搜索文档\"},\"modal\":{\"noResultsText\":\"无法找到相关结果\",\"resetButtonTitle\":\"清除查询条件\",\"footer\":{\"selectText\":\"选择\",\"navigateText\":\"切换\"}}}}}}},\"outline\":{\"level\":[2,3],\"label\":\"目录\"}},\"locales\":{\"root\":{\"label\":\"简体中文\",\"lang\":\"zh-CN\",\"title\":\"FileCodeBox\",\"description\":\"匿名口令分享文本，文件\",\"themeConfig\":{\"logo\":\"/logo_small.png\",\"nav\":[{\"text\":\"首页\",\"link\":\"/\"},{\"text\":\"指南\",\"link\":\"/guide/getting-started\"},{\"text\":\"API\",\"link\":\"/api/\"},{\"text\":\"了解更多\",\"items\":[{\"text\":\"更新日志\",\"link\":\"/changelog\"},{\"text\":\"贡献指南\",\"link\":\"/contributing\"}]}],\"sidebar\":{\"/guide/\":[{\"text\":\"介绍\",\"items\":[{\"text\":\"什么是 FileCodeBox\",\"link\":\"/guide/introduction\"},{\"text\":\"快速开始\",\"link\":\"/guide/getting-started\"}]},{\"text\":\"基础功能\",\"items\":[{\"text\":\"文件上传\",\"link\":\"/guide/upload\"},{\"text\":\"文件分享\",\"link\":\"/guide/share\"},{\"text\":\"文件管理\",\"link\":\"/guide/management\"}]},{\"text\":\"高级特性\",\"items\":[{\"text\":\"存储配置\",\"link\":\"/guide/storage\"},{\"text\":\"安全设置\",\"link\":\"/guide/security\"},{\"text\":\"系统配置\",\"link\":\"/guide/configuration\"}]}],\"/api/\":[{\"text\":\"API 参考\",\"items\":[{\"text\":\"分享接口\",\"link\":\"/api/#分享接口\"},{\"text\":\"管理接口\",\"link\":\"/api/#管理接口\"},{\"text\":\"错误响应\",\"link\":\"/api/#错误响应\"},{\"text\":\"状态码说明\",\"link\":\"/api/#状态码说明\"}]}]},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/vastsa/FileCodeBox\"}],\"footer\":{\"message\":\"基于 LGPL 许可发布\",\"copyright\":\"Copyright © 2023-present FileCodeBox\"},\"search\":{\"provider\":\"local\"},\"outline\":{\"level\":[2,3],\"label\":\"目录\"}}},\"en\":{\"label\":\"English\",\"lang\":\"en-US\",\"title\":\"FileCodeBox\",\"description\":\"Simple and efficient file sharing tool\",\"themeConfig\":{\"logo\":\"/logo_small.png\",\"nav\":[{\"text\":\"Home\",\"link\":\"/en/\"},{\"text\":\"Guide\",\"link\":\"/en/guide/getting-started\"},{\"text\":\"API\",\"link\":\"/en/api/\"},{\"text\":\"More\",\"items\":[{\"text\":\"Changelog\",\"link\":\"/en/changelog\"},{\"text\":\"Contributing\",\"link\":\"/en/contributing\"}]}],\"sidebar\":{\"/en/guide/\":[{\"text\":\"Introduction\",\"items\":[{\"text\":\"What is FileCodeBox\",\"link\":\"/en/guide/introduction\"},{\"text\":\"Getting Started\",\"link\":\"/en/guide/getting-started\"}]},{\"text\":\"Basic Features\",\"items\":[{\"text\":\"File Upload\",\"link\":\"/en/guide/upload\"},{\"text\":\"File Sharing\",\"link\":\"/en/guide/share\"},{\"text\":\"File Management\",\"link\":\"/en/guide/management\"}]},{\"text\":\"Advanced Features\",\"items\":[{\"text\":\"Storage Configuration\",\"link\":\"/en/guide/storage\"},{\"text\":\"Security Settings\",\"link\":\"/en/guide/security\"},{\"text\":\"System Configuration\",\"link\":\"/en/guide/configuration\"}]}],\"/en/api/\":[{\"text\":\"API Reference\",\"items\":[{\"text\":\"Share API\",\"link\":\"/en/api/#share-api\"},{\"text\":\"Admin API\",\"link\":\"/en/api/#admin-api\"},{\"text\":\"Error Response\",\"link\":\"/en/api/#error-response\"},{\"text\":\"Status Codes\",\"link\":\"/en/api/#status-codes\"}]}]},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/vastsa/FileCodeBox\"}],\"footer\":{\"message\":\"基于 MIT 许可发布\",\"copyright\":\"Copyright © 2023-present FileCodeBox\"},\"search\":{\"provider\":\"local\"},\"outline\":{\"level\":[2,3],\"label\":\"目录\"}}}},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
|
||
|
||
</body>
|
||
</html> |