feat: docs

2025-02-12 14:27:39 +08:00
parent fa85521cfb
commit 36fe69e2a7
103 changed files with 1063 additions and 98 deletions
@@ -0,0 +1,6 @@
+import{_ as i,c as a,o as t,ag as s}from"./chunks/framework.BmLMQRXF.js";const k=JSON.parse('{"title":"Getting Started","description":"","frontmatter":{},"headers":[],"relativePath":"en/guide/getting-started.md","filePath":"en/guide/getting-started.md","lastUpdated":1739330962000}'),l={name:"en/guide/getting-started.md"};function n(o,e,d,h,r,p){return t(),a("div",null,e[0]||(e[0]=[s(`<h1 id="getting-started" tabindex="-1">Getting Started <a class="header-anchor" href="#getting-started" aria-label="Permalink to &quot;Getting Started&quot;"></a></h1><h2 id="introduction" tabindex="-1">Introduction <a class="header-anchor" href="#introduction" aria-label="Permalink to &quot;Introduction&quot;"></a></h2><p>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.</p><h2 id="features" tabindex="-1">Features <a class="header-anchor" href="#features" aria-label="Permalink to &quot;Features&quot;"></a></h2><ul><li>🚀 Quick Deployment: Support Docker one-click deployment</li><li>🔒 Secure &amp; Reliable: File access requires extraction code</li><li>⏱️ Time Control: Support setting file expiration time</li><li>📊 Download Limit: Can limit file download times</li><li>🖼️ File Preview: Support preview of images, videos, audio, and other formats</li><li>📱 Responsive Design: Perfect adaptation for mobile and desktop</li></ul><h2 id="deployment-methods" tabindex="-1">Deployment Methods <a class="header-anchor" href="#deployment-methods" aria-label="Permalink to &quot;Deployment Methods&quot;"></a></h2><h3 id="docker-deployment-recommended" tabindex="-1">Docker Deployment (Recommended) <a class="header-anchor" href="#docker-deployment-recommended" aria-label="Permalink to &quot;Docker Deployment (Recommended)&quot;"></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;"> \\</span></span>
+<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">  --name</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> filecodebox</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> \\</span></span>
+<span class="line"><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;"> \\</span></span>
+<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">  -v</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> /path/to/data:/app/data</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> \\</span></span>
+<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">  vastsa/filecodebox</span></span></code></pre></div><h3 id="manual-deployment" tabindex="-1">Manual Deployment <a class="header-anchor" href="#manual-deployment" aria-label="Permalink to &quot;Manual Deployment&quot;"></a></h3><ol><li>Clone the project</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>
+<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">cd</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> FileCodeBox</span></span></code></pre></div><ol start="2"><li>Install dependencies</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;">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>Start service</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="usage" tabindex="-1">Usage <a class="header-anchor" href="#usage" aria-label="Permalink to &quot;Usage&quot;"></a></h2><ol><li><p>Access the System Open browser and visit <code>http://localhost:12345</code></p></li><li><p>Upload Files</p><ul><li>Click upload button or drag files to upload area</li><li>Set file expiration time and download limit</li><li>Get share link and extraction code</li></ul></li><li><p>Download Files</p><ul><li>Visit share link</li><li>Enter extraction code</li><li>Download file</li></ul></li><li><p>Admin Panel</p><ul><li>Visit <code>http://localhost:12345/admin</code></li><li>Enter admin password: <code>FileCodeBox2023</code></li><li>Enter admin panel</li><li>View system information, file list, user management, etc.</li></ul></li></ol><h2 id="next-steps" tabindex="-1">Next Steps <a class="header-anchor" href="#next-steps" aria-label="Permalink to &quot;Next Steps&quot;"></a></h2><ul><li><a href="/en/guide/storage.html">Storage Configuration</a> - Learn how to configure different storage methods</li><li><a href="/en/guide/security.html">Security Settings</a> - Learn how to enhance system security</li><li><a href="/en/api/">API Documentation</a> - Learn how to integrate through API</li></ul>`,19)]))}const u=i(l,[["render",n]]);export{k as __pageData,u as default};