app/en/deploy/install.html

33 lines
39 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="en-US" dir="ltr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Install | LiteyukiBot</title>
<meta name="description" content="A high-performance, easy-to-use chatbot framework and application">
<meta name="generator" content="VitePress v1.3.4">
<link rel="preload stylesheet" href="/assets/style.ClhDnXHO.css" as="style">
<script type="module" src="/assets/app.BH8blj-J.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.DnpbS9Kh.js">
<link rel="modulepreload" href="/assets/chunks/framework.C4_mTacX.js">
<link rel="modulepreload" href="/assets/en_deploy_install.md.C00Sx2cS.lean.js">
<link rel="icon" type="image/x-icon" href="favicon.ico">
<link rel="stylesheet" href="https://fonts.font.im/css?family=Cousine:400,400i,700,700i|Poppins:100,100i,200,200i,300,300i,400,400i,500,500i,600,600i,700,700i,800,800i,900,900i">
<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-2391887b data-v-5047c77d><!--[--><!--]--><!--[--><span tabindex="-1" data-v-5ffb6bc3></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-5ffb6bc3> Skip to content </a><!--]--><!----><header class="VPNav" data-v-5047c77d data-v-3aff48bd><div class="VPNavBar has-sidebar top" data-v-3aff48bd data-v-6db865c9><div class="wrapper" data-v-6db865c9><div class="container" data-v-6db865c9><div class="title" data-v-6db865c9><div class="VPNavBarTitle has-sidebar" data-v-6db865c9 data-v-d1e2cfaa><a class="title" href="/en/" data-v-d1e2cfaa><!--[--><!--]--><!--[--><!--[--><!--[--><img class="VPImage dark logo" src="/liteyuki-dark.svg" alt="LiteyukiBot Logo" data-v-e2df84be><!--]--><!--[--><img class="VPImage light logo" src="/liteyuki.svg" alt="LiteyukiBot Logo" data-v-e2df84be><!--]--><!--]--><!--]--><span data-v-d1e2cfaa>LiteyukiBot</span><!--[--><!--]--></a></div></div><div class="content" data-v-6db865c9><div class="content-body" data-v-6db865c9><!--[--><!--]--><div class="VPNavBarSearch search" data-v-6db865c9><!--[--><!----><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-6db865c9 data-v-dc270a69><span id="main-nav-aria-label" class="visually-hidden" data-v-dc270a69> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink active" href="/en/deploy/install.html" tabindex="0" data-v-dc270a69 data-v-2a328df5><!--[--><span data-v-2a328df5>Deploy</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/en/usage/basic.html" tabindex="0" data-v-dc270a69 data-v-2a328df5><!--[--><span data-v-2a328df5>Usage</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/en/store/resource.html" tabindex="0" data-v-dc270a69 data-v-2a328df5><!--[--><span data-v-2a328df5>Extension</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/en/dev/guide.html" tabindex="0" data-v-dc270a69 data-v-2a328df5><!--[--><span data-v-2a328df5>Develop</span><!--]--></a><!--]--><!--]--></nav><div class="VPFlyout VPNavBarTranslations translations" data-v-6db865c9 data-v-1cf30254 data-v-062a5734><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="Language" data-v-062a5734><span class="text" data-v-062a5734><span class="vpi-languages option-icon" data-v-062a5734></span><!----><span class="vpi-chevron-down text-icon" data-v-062a5734></span></span></button><div class="menu" data-v-062a5734><div class="VPMenu" data-v-062a5734 data-v-ce2cf657><!----><!--[--><!--[--><div class="items" data-v-1cf30254><p class="title" data-v-1cf30254>English</p><!--[--><div class="VPMenuLink" data-v-1cf30254 data-v-01a82388><a class="VPLink link" href="/deploy/install.html" data-v-01a82388><!--[-->简体中文<!--]--></a></div><!--]--></div><!--]--><!--]--></div></div></div><div class="VPNavBarAppearance appearance" data-v-6db865c9 data-v-06e253f6><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title="Dark Mode" aria-checked="false" data-v-06e253f6 data-v-d86ee44f data-v-be0da757><span class="check" data-v-be0da757><span class="icon" data-v-be0da757><!--[--><span class="vpi-sun sun" data-v-d86ee44f></span><span class="vpi-moon moon" data-v-d86ee44f></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-6db865c9 data-v-489228c3 data-v-ca9cff1c><!--[--><a class="VPSocialLink no-icon" href="https://github.com/LiteyukiStudio/LiteyukiBot" aria-label="github" target="_blank" rel="noopener" data-v-ca9cff1c data-v-99aaa61b><span class="vpi-social-github" /></a><a class="VPSocialLink no-icon" href="ht
<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/LiteyukiStudio/LiteyukiBot</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> --depth=1</span></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># change directory</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">cd</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> LiteyukiBot</span></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># install dependencies</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>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># start the bot!</span></span>
<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><div class="tip custom-block github-alert"><p class="custom-block-title">TIP</p><p>It is recommended to use a virtual environment to run Liteyuki to avoid dependency conflicts. You can use <code>python -m venv .venv</code> to create a virtual environment, and then use <code>.venv\Scripts\activate</code> to activate the virtual environment (use <code>source .venv/bin/activate</code> to activate on Linux).</p></div><h2 id="run-with-docker" tabindex="-1"><strong>Run with Docker</strong> <a class="header-anchor" href="#run-with-docker" aria-label="Permalink to &quot;**Run with Docker**&quot;"></a></h2><ol><li>Install <a href="https://docs.docker.com/get-docker/" target="_blank" rel="noreferrer"><code>Docker</code></a></li><li>Clone Repo <code>git clone https://github.com/LiteyukiStudio/LiteyukiBot --depth=1</code></li><li>Change directory <code>cd LiteyukiBot</code></li><li>Build docker image <code>docker build -t liteyukibot .</code></li><li>Run container <code>docker run -p 20216:20216 -v $(pwd):/liteyukibot -v $(pwd)/.cache:/root/.cache liteyukibot</code></li></ol><div class="tip custom-block github-alert"><p class="custom-block-title">TIP</p><p>If you are using Windows, please use the absolute project directory <code>/path/to/LiteyukiBot</code> instead of <code>$&amp;#40;pwd&amp;#41;</code> <br> If you have modified the port number, please replace <code>20216:20216</code> with your port number</p></div><h2 id="use-trss-script" tabindex="-1"><strong>Use TRSS Script</strong> <a class="header-anchor" href="#use-trss-script" aria-label="Permalink to &quot;**Use TRSS Script**&quot;"></a></h2><p><a href="https://timerainstarsky.github.io/TRSS_Liteyuki/" target="_blank" rel="noreferrer">TRSS_Liteyuki Management Script</a>, which provides a more convenient way to manage LiteyukiBot, recommended to use <code>Arch Linux</code></p><h2 id="device-requirements" tabindex="-1"><strong>Device Requirements</strong> <a class="header-anchor" href="#device-requirements" aria-label="Permalink to &quot;**Device Requirements**&quot;"></a></h2><ul><li>Windows system version minimum <code>Windows10+</code>/<code>Windows Server 2019+</code></li><li>Linux system requires Python3.10+, recommended <code>Ubuntu 20.04+</code></li><li>CPU: at least <code>1vCPU</code></li><li>Memory: Bot without other plugins will occupy <code>300~500MB</code>, including <code>chromium</code> and <code>node</code> processes, other plugins depend on specific plugins, recommended <code>1GB</code> or more</li><li>Disk: at least <code>1GB</code> of space</li></ul><div class="warning custom-block github-alert"><p class="custom-block-title">WARNING</p><p>If there are multiple environments on the device, please use <code>path/to/python -m pip install -r requirements.txt</code> to install dependencies, <code>path/to/python</code> is the path to your Python executable</p></div><div class="warning custom-block github-alert"><p class="custom-block-title">WARNING</p><p>Liteyuki&#39;s update function depends on Git. If you do not have Git installed and run the source code directly, you will not be able to use the update function</p></div><h4 id="for-other-questions-please-refer-to-faq" tabindex="-1">For other questions, please refer to <a href="./fandq.html">FAQ</a> <a class="header-anchor" href="#for-other-questions-please-refer-to-faq" aria-label="Permalink to &quot;For other questions, please refer to [FAQ](./fandq)&quot;"></a></h4></div></div></main><footer class="VPDocFooter" data-v-1c9751e9 data-v-655c432b><!--[--><!--]--><div class="edit-info" data-v-655c432b><div class="edit-link" data-v-655c432b><a class="VPLink link vp-external-link-icon no-icon edit-link-button" href="https://github.com/LiteyukiStudio/LiteyukiBot/tree/main/docs/en/deploy/install.md" target="_blank" rel="noreferrer" data-v-655c432b><!--[--><span class="vpi-square-pen edit-link-icon" data-v-655c432b></span> E
<script>window.__VP_HASH_MAP__=JSON.parse("{\"deploy_config.md\":\"BBoJ_SVs\",\"deploy_fandq.md\":\"D3AaSKzf\",\"deploy_install.md\":\"DMcLeaSP\",\"dev_api_bot_index.md\":\"CygawBD3\",\"dev_api_bot_lifespan.md\":\"DBf_PC3G\",\"dev_api_comm_channel.md\":\"B_Q8RkLg\",\"dev_api_comm_event.md\":\"Dkw9vL8j\",\"dev_api_comm_index.md\":\"BubSUNVe\",\"dev_api_comm_rpc.md\":\"ZF5gW_b7\",\"dev_api_comm_socks_channel.md\":\"D0z-3box\",\"dev_api_comm_storage.md\":\"DlCQ-bAW\",\"dev_api_config.md\":\"BWciqFj4\",\"dev_api_core_index.md\":\"B0E7Phf1\",\"dev_api_core_manager.md\":\"B3hq0Rpu\",\"dev_api_dev_index.md\":\"Chgr0inF\",\"dev_api_dev_observer.md\":\"DXfnQgLO\",\"dev_api_dev_plugin.md\":\"Cops7KZu\",\"dev_api_exception.md\":\"Bo7F9S9r\",\"dev_api_index.md\":\"mhROT_CR\",\"dev_api_log.md\":\"B0RBm2Ui\",\"dev_api_message_event.md\":\"DyDwsc6d\",\"dev_api_message_index.md\":\"Ox32xQC5\",\"dev_api_message_matcher.md\":\"DVuQfqJD\",\"dev_api_message_on.md\":\"CApMkdr1\",\"dev_api_message_rule.md\":\"DtsqYM0_\",\"dev_api_message_session.md\":\"Dvgy6WBS\",\"dev_api_mkdoc.md\":\"BQNdAtbl\",\"dev_api_plugin_index.md\":\"DyFjlTCa\",\"dev_api_plugin_load.md\":\"CqVkk0P5\",\"dev_api_plugin_manager.md\":\"WWoouVFL\",\"dev_api_plugin_model.md\":\"BmVr2u82\",\"dev_api_plugins_index.md\":\"kWwCXP54\",\"dev_api_plugins_liteecho.md\":\"sryx6SuS\",\"dev_api_plugins_plugin_loader_index.md\":\"DVvGETw-\",\"dev_api_utils.md\":\"wryzX8vr\",\"dev_comm.md\":\"cMJIV6AK\",\"dev_guide.md\":\"DQi_bEyk\",\"dev_lyfunc.md\":\"D4LU5X67\",\"dev_plugin.md\":\"phZolwS6\",\"dev_resource.md\":\"CiEukBtC\",\"en_deploy_config.md\":\"DdMT5vqs\",\"en_deploy_fandq.md\":\"BKc7kj27\",\"en_deploy_install.md\":\"C00Sx2cS\",\"en_dev_api_bot_index.md\":\"C4r8HhEl\",\"en_dev_api_bot_lifespan.md\":\"B-nofctY\",\"en_dev_api_comm_channel.md\":\"VoA9irwY\",\"en_dev_api_comm_event.md\":\"Crpo-bJ4\",\"en_dev_api_comm_index.md\":\"BghEev94\",\"en_dev_api_comm_rpc.md\":\"DKVp72_P\",\"en_dev_api_comm_socks_channel.md\":\"B8_s4Hv_\",\"en_dev_api_comm_storage.md\":\"WX6gT40z\",\"en_dev_api_config.md\":\"CRNFMcJd\",\"en_dev_api_core_index.md\":\"NuGEgKq2\",\"en_dev_api_core_manager.md\":\"D7QE1GyX\",\"en_dev_api_dev_index.md\":\"UZwSl7RN\",\"en_dev_api_dev_observer.md\":\"DAh-d3XU\",\"en_dev_api_dev_plugin.md\":\"ByOqvpeD\",\"en_dev_api_exception.md\":\"HPP9FBE6\",\"en_dev_api_index.md\":\"Bem5oMXv\",\"en_dev_api_log.md\":\"t5U3-0Tg\",\"en_dev_api_message_event.md\":\"C6I96y2L\",\"en_dev_api_message_index.md\":\"CTleW7FS\",\"en_dev_api_message_matcher.md\":\"CtCEbUVJ\",\"en_dev_api_message_on.md\":\"DOPTBR4O\",\"en_dev_api_message_rule.md\":\"BBaFECzV\",\"en_dev_api_message_session.md\":\"BJvZrFxU\",\"en_dev_api_mkdoc.md\":\"B0odpxJC\",\"en_dev_api_plugin_index.md\":\"ibr3u-4e\",\"en_dev_api_plugin_load.md\":\"BqElTQmm\",\"en_dev_api_plugin_manager.md\":\"LGDmEnuh\",\"en_dev_api_plugin_model.md\":\"C8mVVzkp\",\"en_dev_api_plugins_index.md\":\"CBJItUz2\",\"en_dev_api_plugins_liteecho.md\":\"BkpA_Gke\",\"en_dev_api_plugins_plugin_loader_index.md\":\"cG7vDNwD\",\"en_dev_api_utils.md\":\"DKuaapxu\",\"en_dev_comm.md\":\"DWySVBZ2\",\"en_dev_guide.md\":\"DPaEHhwA\",\"en_dev_lyfunc.md\":\"BhYjNK3N\",\"en_dev_plugin.md\":\"CKzO3RVR\",\"en_dev_resource.md\":\"Q8AwzAyN\",\"en_index.md\":\"DS37TlOH\",\"en_store_plugin.md\":\"C0UyBVv2\",\"en_store_resource.md\":\"Ci-LBCav\",\"en_usage_agreement.md\":\"vFfahjeR\",\"en_usage_basic.md\":\"DVpsBy5w\",\"en_usage_extra.md\":\"DU-WQhbO\",\"index.md\":\"Dl11pd1E\",\"store_plugin.md\":\"BhQadjel\",\"store_resource.md\":\"CgUrr2wJ\",\"usage_agreement.md\":\"BYijSUyJ\",\"usage_basic.md\":\"CS9J19pD\",\"usage_extra.md\":\"CPLcG44C\"}");function deserializeFunctions(r){return Array.isArray(r)?r.map(deserializeFunctions):typeof r=="object"&&r!==null?Object.keys(r).reduce((t,n)=>(t[n]=deserializeFunctions(r[n]),t),{}):typeof r=="string"&&r.startsWith("_vp-fn_")?new Function(`return ${r.slice(7)}`)():r};window.__VP_SITE_DATA__=deserializeFunctions(JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"VitePress\",\"description\":\"A VitePress site\",\"base\
</body>
</html>