LiteyukiBot/en/deploy/install.html

33 lines
34 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.Dez_Gkec.css" as="style">
<script type="module" src="/assets/app.Dgg6Wnos.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.Cms3Mxdp.js">
<link rel="modulepreload" href="/assets/chunks/framework.BcfwU5BI.js">
<link rel="modulepreload" href="/assets/en_deploy_install.md.ob-_utOU.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-0b0ac726 data-v-7e3343f7><!--[--><!--]--><!--[--><span tabindex="-1" data-v-a977b129></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-a977b129> Skip to content </a><!--]--><!----><header class="VPNav" data-v-7e3343f7 data-v-d52d372b><div class="VPNavBar has-sidebar top" data-v-d52d372b data-v-37a6b570><div class="wrapper" data-v-37a6b570><div class="container" data-v-37a6b570><div class="title" data-v-37a6b570><div class="VPNavBarTitle has-sidebar" data-v-37a6b570 data-v-de953605><a class="title" href="/en/" data-v-de953605><!--[--><!--]--><!--[--><!--[--><!--[--><img class="VPImage dark logo" src="/liteyuki-dark.svg" alt="LiteyukiBot Logo" data-v-6e911b93><!--]--><!--[--><img class="VPImage light logo" src="/liteyuki.svg" alt="LiteyukiBot Logo" data-v-6e911b93><!--]--><!--]--><!--]--><span data-v-de953605>LiteyukiBot</span><!--[--><!--]--></a></div></div><div class="content" data-v-37a6b570><div class="content-body" data-v-37a6b570><!--[--><!--]--><div class="VPNavBarSearch search" data-v-37a6b570><!--[--><!----><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-37a6b570 data-v-71183eee><span id="main-nav-aria-label" class="visually-hidden" data-v-71183eee> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink active" href="/en/deploy/install.html" tabindex="0" data-v-71183eee data-v-c423e9f4><!--[--><span data-v-c423e9f4>Deploy</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/en/usage/basic.html" tabindex="0" data-v-71183eee data-v-c423e9f4><!--[--><span data-v-c423e9f4>Usage</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/en/store/resource.html" tabindex="0" data-v-71183eee data-v-c423e9f4><!--[--><span data-v-c423e9f4>Extension</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/en/dev/guide.html" tabindex="0" data-v-71183eee data-v-c423e9f4><!--[--><span data-v-c423e9f4>Develop</span><!--]--></a><!--]--><!--]--></nav><div class="VPFlyout VPNavBarTranslations translations" data-v-37a6b570 data-v-d3047050 data-v-12ec5ee2><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="Change language" data-v-12ec5ee2><span class="text" data-v-12ec5ee2><span class="vpi-languages option-icon" data-v-12ec5ee2></span><!----><span class="vpi-chevron-down text-icon" data-v-12ec5ee2></span></span></button><div class="menu" data-v-12ec5ee2><div class="VPMenu" data-v-12ec5ee2 data-v-0e22c6c5><!----><!--[--><!--[--><div class="items" data-v-d3047050><p class="title" data-v-d3047050>English</p><!--[--><div class="VPMenuLink" data-v-d3047050 data-v-19363427><a class="VPLink link" href="/deploy/install.html" data-v-19363427><!--[-->简体中文<!--]--></a></div><!--]--></div><!--]--><!--]--></div></div></div><div class="VPNavBarAppearance appearance" data-v-37a6b570 data-v-0a1958c9><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title="Switch to dark theme" aria-checked="false" data-v-0a1958c9 data-v-0f382965 data-v-b19619af><span class="check" data-v-b19619af><span class="icon" data-v-b19619af><!--[--><span class="vpi-sun sun" data-v-0f382965></span><span class="vpi-moon moon" data-v-0f382965></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-37a6b570 data-v-edaebeb1 data-v-52782a78><!--[--><a class="VPSocialLink no-icon" href="https://github.com/LiteyukiStudio/LiteyukiBot" aria-label="github" target="_blank" rel="noopener" data-v-52782a78 data-v-974e0aed><span class="vpi-social-github" /></a><!--]--></div><div cla
<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-4981c415 data-v-e27a0cf7><!--[--><!--]--><div class="edit-info" data-v-e27a0cf7><div class="edit-link" data-v-e27a0cf7><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-e27a0cf7><!--[--><span class="vpi-square-pen edit-link-icon" data-v-e27a0cf7></span> E
<script>window.__VP_HASH_MAP__=JSON.parse("{\"deploy_config.md\":\"Djw712t7\",\"deploy_fandq.md\":\"DweQIxJo\",\"deploy_install.md\":\"AVzTB6vY\",\"dev_api_api.md\":\"RUfGXnkj\",\"dev_api_bot_bot.md\":\"C9Cpkpg_\",\"dev_api_bot_index.md\":\"CrDPctpC\",\"dev_api_bot_lifespan.md\":\"BU984KzE\",\"dev_api_comm_channel.md\":\"CwytKvrT\",\"dev_api_comm_comm.md\":\"C-amE9k3\",\"dev_api_comm_event.md\":\"DUFC13LG\",\"dev_api_comm_index.md\":\"BXy_nmC2\",\"dev_api_comm_rpc.md\":\"Wn15Npl7\",\"dev_api_comm_socks_channel.md\":\"D5ZXgepQ\",\"dev_api_comm_storage.md\":\"DUAYWnwl\",\"dev_api_config.md\":\"Czz81F4N\",\"dev_api_core_core.md\":\"25sszHh7\",\"dev_api_core_index.md\":\"CgpOuiTO\",\"dev_api_core_manager.md\":\"MpsjWLy-\",\"dev_api_dev_dev.md\":\"CWhXOFba\",\"dev_api_dev_index.md\":\"1DiaEAJR\",\"dev_api_dev_observer.md\":\"BnWk7zhU\",\"dev_api_dev_plugin.md\":\"DXIFAwci\",\"dev_api_exception.md\":\"XAB3m5tq\",\"dev_api_index.md\":\"DNIMI0Cd\",\"dev_api_log.md\":\"BEVXPOaA\",\"dev_api_message_event.md\":\"DR8twM19\",\"dev_api_message_index.md\":\"CarWlgRw\",\"dev_api_message_matcher.md\":\"DiG4Jj9f\",\"dev_api_message_message.md\":\"ig8AzQou\",\"dev_api_message_on.md\":\"6qObiKKv\",\"dev_api_message_rule.md\":\"wJ_5PKEX\",\"dev_api_message_session.md\":\"D58QTne1\",\"dev_api_mkdoc.md\":\"52nIaUyj\",\"dev_api_plugin_index.md\":\"IKeke_Xe\",\"dev_api_plugin_load.md\":\"CwZrz0QR\",\"dev_api_plugin_manager.md\":\"Bx31hPV6\",\"dev_api_plugin_model.md\":\"Cx-JTb39\",\"dev_api_plugin_plugin.md\":\"DwiAsEZo\",\"dev_api_plugins_index.md\":\"CbZRALXP\",\"dev_api_plugins_liteecho.md\":\"1lJWW5nJ\",\"dev_api_plugins_plugin_loader_index.md\":\"CBasyfcx\",\"dev_api_plugins_plugin_loader_plugin_loader.md\":\"DyozzCFp\",\"dev_api_plugins_plugins.md\":\"DtGVvFTi\",\"dev_api_utils.md\":\"BHNpOxd8\",\"dev_comm.md\":\"BP1aNiQy\",\"dev_guide.md\":\"CxgM1w0W\",\"dev_lyfunc.md\":\"BcDZ4JOM\",\"dev_plugin.md\":\"BPQFwJrk\",\"dev_resource.md\":\"BZC-IHJU\",\"en_deploy_config.md\":\"BhDIUS1R\",\"en_deploy_fandq.md\":\"CFdXBoPO\",\"en_deploy_install.md\":\"ob-_utOU\",\"en_dev_api_api.md\":\"iQ8xigEk\",\"en_dev_api_bot_bot.md\":\"BN1y5HH8\",\"en_dev_api_bot_index.md\":\"CNGLZo05\",\"en_dev_api_bot_lifespan.md\":\"CrIBmMCX\",\"en_dev_api_comm_channel.md\":\"X8lIoIjM\",\"en_dev_api_comm_comm.md\":\"DwWi28cJ\",\"en_dev_api_comm_event.md\":\"tzavRuKB\",\"en_dev_api_comm_index.md\":\"DYhtkRdo\",\"en_dev_api_comm_rpc.md\":\"B91PSIzb\",\"en_dev_api_comm_socks_channel.md\":\"Dkc7cDzg\",\"en_dev_api_comm_storage.md\":\"B-W3VQdt\",\"en_dev_api_config.md\":\"2LfmiPlT\",\"en_dev_api_core_core.md\":\"BhAqy2I3\",\"en_dev_api_core_index.md\":\"Ber2F-nh\",\"en_dev_api_core_manager.md\":\"D4_7Fd7q\",\"en_dev_api_dev_dev.md\":\"BIDkC3cT\",\"en_dev_api_dev_index.md\":\"Dktroz6v\",\"en_dev_api_dev_observer.md\":\"DMHcvEtg\",\"en_dev_api_dev_plugin.md\":\"Bt1Io9cm\",\"en_dev_api_exception.md\":\"BrVYkEoT\",\"en_dev_api_index.md\":\"BYCaVWFt\",\"en_dev_api_log.md\":\"Ca5CPc1j\",\"en_dev_api_message_event.md\":\"_5EHdhn1\",\"en_dev_api_message_index.md\":\"DdRqHj8i\",\"en_dev_api_message_matcher.md\":\"11WJi2GD\",\"en_dev_api_message_message.md\":\"BNv5AlLS\",\"en_dev_api_message_on.md\":\"DTuiNBGv\",\"en_dev_api_message_rule.md\":\"BcS9AOMS\",\"en_dev_api_message_session.md\":\"6zpABOpV\",\"en_dev_api_mkdoc.md\":\"C-F3VJWA\",\"en_dev_api_plugin_index.md\":\"Cc_S-VHI\",\"en_dev_api_plugin_load.md\":\"5MF5khvY\",\"en_dev_api_plugin_manager.md\":\"7R7Nz2Bg\",\"en_dev_api_plugin_model.md\":\"lg9E4DqV\",\"en_dev_api_plugin_plugin.md\":\"BXqxU3sQ\",\"en_dev_api_plugins_index.md\":\"_I5XqcHt\",\"en_dev_api_plugins_liteecho.md\":\"BPTN3bmi\",\"en_dev_api_plugins_plugin_loader_index.md\":\"piihm40M\",\"en_dev_api_plugins_plugin_loader_plugin_loader.md\":\"lHxRuP6D\",\"en_dev_api_plugins_plugins.md\":\"9iWDd5qp\",\"en_dev_api_utils.md\":\"lJX21x-M\",\"en_dev_comm.md\":\"BeMC4m5Q\",\"en_dev_guide.md\":\"DWW3r4oM\",\"en_dev_lyfunc.md\":\"C0l6G8E5\",\"en_dev_plugin.md\":\"DdfSg4XA\",\"en_dev_resource.md\":\"_dkQLp3q\",\"en_index.md\":\"C5nRrc59\",\"en_store_plugin.md\":\"T5zXk58O\"
</body>
</html>