LiteyukiBot/en/deploy/install.html

49 lines
33 KiB
HTML
Raw Normal View History

<!doctype html>
<html lang="en-US" data-theme="light">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width,initial-scale=1" />
<meta name="generator" content="VuePress 2.0.0-rc.9" />
<meta name="theme" content="VuePress Theme Hope 2.0.0-rc.32" />
<style>
html {
background: var(--bg-color, #fff);
}
html[data-theme="dark"] {
background: var(--bg-color, #1d1e1f);
}
body {
background: var(--bg-color);
}
</style>
<script>
const userMode = localStorage.getItem("vuepress-theme-hope-scheme");
const systemDarkMode =
window.matchMedia &&
window.matchMedia("(prefers-color-scheme: dark)").matches;
if (userMode === "dark" || (userMode !== "light" && systemDarkMode)) {
document.documentElement.setAttribute("data-theme", "dark");
}
</script>
<link rel="alternate" hreflang="zh-cn" href="https://vuepress-theme-hope-docs-demo.netlify.app/deploy/install.html"><meta property="og:url" content="https://vuepress-theme-hope-docs-demo.netlify.app/en/deploy/install.html"><meta property="og:site_name" content="LiteyukiBot"><meta property="og:title" content="Installation"><meta property="og:description" content="Installation Conventional deployment Install Git and Python3.10+ environment Tips Recommended to use venv to run Liteyuki to avoid dependency conflicts, you can use python -m ve..."><meta property="og:type" content="article"><meta property="og:locale" content="en-US"><meta property="og:locale:alternate" content="zh-CN"><meta property="og:updated_time" content="2024-08-16T18:24:25.000Z"><meta property="article:tag" content="安装"><meta property="article:modified_time" content="2024-08-16T18:24:25.000Z"><script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","headline":"Installation","image":[""],"dateModified":"2024-08-16T18:24:25.000Z","author":[]}</script><script src="/js/en/get_data.js" type="module"></script><script src="/js/style.js" type="module"></script><link rel="icon" href="https://cdn.liteyuki.icu/favicon.ico"><link rel="stylesheet" href="https://cdn.bootcdn.net/ajax/libs/firacode/6.2.0/fira_code.min.css"><meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no"><title>Installation | LiteyukiBot</title><meta name="description" content="Installation Conventional deployment Install Git and Python3.10+ environment Tips Recommended to use venv to run Liteyuki to avoid dependency conflicts, you can use python -m ve...">
<link rel="preload" href="/assets/style-CSEr-Ojo.css" as="style"><link rel="stylesheet" href="/assets/style-CSEr-Ojo.css">
<link rel="modulepreload" href="/assets/app-DPmiG-YD.js"><link rel="modulepreload" href="/assets/install.html-BQR7aMg5.js">
<link rel="prefetch" href="/assets/index.html-CfXumrF_.js" as="script"><link rel="prefetch" href="/assets/index.html-CPXHij7h.js" as="script"><link rel="prefetch" href="/assets/config.html-B6OSAC42.js" as="script"><link rel="prefetch" href="/assets/fandq.html-Bnj7qZ2N.js" as="script"><link rel="prefetch" href="/assets/install.html-JzaqjaIk.js" as="script"><link rel="prefetch" href="/assets/index.html-DgGyKvwC.js" as="script"><link rel="prefetch" href="/assets/dev_comm.html-DnZg2vRV.js" as="script"><link rel="prefetch" href="/assets/dev_lyfunc.html-ByZWQLmI.js" as="script"><link rel="prefetch" href="/assets/dev_lyplugin.html-Dqdxi392.js" as="script"><link rel="prefetch" href="/assets/dev_resource_pack.html-Dj-6obHU.js" as="script"><link rel="prefetch" href="/assets/index.html-CP8LqF4T.js" as="script"><link rel="prefetch" href="/assets/index.html-C7G6d1EW.js" as="script"><link rel="prefetch" href="/assets/plugin.html-DlGN2K6-.js" as="script"><link rel="prefetch" href="/assets/resource.html-BWOXuCpc.js" as="script"><link rel="prefetch" href="/assets/index.html-KHAjawTj.js" as="script"><link rel="prefetch" href="/assets/agreement.html-B_KaiEYQ.js" as="script"><link rel="prefetch" href="/assets/basic_command.html-6xpBSSd2.js" as="script"><link rel="prefetch" href="/assets/extra_command.html-VU0D-nsB.js" as="script"><link rel="prefetch" href="/assets/index.html-Do5t4o_f.js" as="script"><link rel="prefetch" href="/assets/config.html-BMwIDSdh.js" as="script"><link rel="prefetch" href="/assets/fandq.html-DjHNBr0m.js" as="script"><link rel="prefetch" href="/assets/index.html-DFXwMx1T.js" as="script"><link rel="prefetch" href="/assets/dev_comm.html-Dmbd5U36.js" as="script"><link rel="prefetch" href="/assets/dev_lyfunc.html-BesmI2dJ.js" as="script"><link rel="prefetch" href="/assets/dev_lyplugin.html-BlNvJtrH.js" as="script"><link rel="prefetch" href="/assets/dev_resource_pack.html-D20cmiKy.js" as="script"><link rel="prefetch" href="/assets/index.html-CIFBt9Z9.js" as="script"><link rel="prefetch" href="/assets/plugin.html-u1dFMYJH.js" as="script"><link rel="prefetch" href="/assets/resource.html-DYdClEmR.js" as="script"><link rel="prefetch" href="/assets/index.html-C6ueMrL4.js" as="script"><link rel="prefetch" href="/assets/agreement.html-C_u7r4DD.js" as="script"><link rel="prefetch" href="/assets/basic_command.html-Bzqz98Qz.js" as="script"><link rel="prefetch" href="/assets/extra_command.html-BiibfrTU.js" as="script"><link rel="prefetch" href="/assets/404.html-D18STgPI.js" as="script"><link rel="prefetch" href="/assets/giscus-7BMGhbDA.js" as="script"><link rel="prefetch" href="/assets/index-Cw_AvLww.js" as="script"><link rel="prefetch" href="/assets/photoswipe.esm-SzV8tJDW.js" as="script">
</head>
<body>
<div id="app"><!--[--><!--[--><!--[--><span tabindex="-1"></span><a href="#main-content" class="vp-skip-link sr-only">Skip to main content</a><!--]--><div class="theme-container has-toc"><!--[--><header id="navbar" class="vp-navbar"><div class="vp-navbar-start"><button type="button" class="vp-toggle-sidebar-button" title="Toggle Sidebar"><span class="icon"></span></button><!--[--><!----><!--]--><!--[--><a class="route-link vp-brand" href="/en/"><img class="vp-nav-logo" src="https://cdn.liteyuki.icu/static/img/liteyuki_icon_640.png" alt><!----><span class="vp-site-name hide-in-pad">LiteyukiBot</span></a><!--]--><!--[--><!----><!--]--></div><div class="vp-navbar-center"><!--[--><!----><!--]--><!--[--><nav class="vp-nav-links"><div class="nav-item hide-in-mobile"><a class="route-link nav-link" href="/en/" aria-label="Home"><span class="font-icon icon fa-fw fa-sm fas fa-home" style=""></span>Home<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link active" href="/en/deploy/" aria-label="Deploy"><!---->Deploy<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link" href="/en/usage/" aria-label="Usage"><!---->Usage<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link" href="/en/store/" aria-label="Extensions"><!---->Extensions<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link" href="/en/dev/" aria-label="Contribute"><!---->Contribute<!----></a></div></nav><!--]--><!--[--><!----><!--]--></div><div class="vp-navbar-end"><!--[--><!----><!--]--><!--[--><div class="nav-item"><div class="dropdown-wrapper i18n-dropdown"><button type="button" class="dropdown-title" aria-label="Select language"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon i18n-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="i18n icon" style="width:1rem;height:1rem;vertical-align:middle;"><path d="M379.392 460.8 494.08 575.488l-42.496 102.4L307.2 532.48 138.24 701.44l-71.68-72.704L234.496 460.8l-45.056-45.056c-27.136-27.136-51.2-66.56-66.56-108.544h112.64c7.68 14.336 16.896 27.136 26.112 35.84l45.568 46.08 45.056-45.056C382.976 312.32 409.6 247.808 409.6 204.8H0V102.4h256V0h102.4v102.4h256v102.4H512c0 70.144-37.888 161.28-87.04 210.944L378.88 460.8zM576 870.4 512 1024H409.6l256-614.4H768l256 614.4H921.6l-64-153.6H576zM618.496 768h196.608L716.8 532.48 618.496 768z"></path></svg><!--]--><span class="arrow"></span><ul class="nav-dropdown"><li class="dropdown-item"><a class="route-link nav-link" href="/deploy/install.html" aria-label="简体中文"><!---->简体中文<!----></a></li><li class="dropdown-item"><a class="route-link nav-link active" href="/en/deploy/install.html" aria-label="English"><!---->English<!----></a></li></ul></button></div></div><div class="nav-item vp-repo"><a class="vp-repo-link" href="https://github.com/LiteyukiStudio/LiteyukiBot" target="_blank" rel="noopener noreferrer" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="icon github-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="github icon" style="width:1.25rem;height:1.25rem;vertical-align:middle;"><path d="M511.957 21.333C241.024 21.333 21.333 240.981 21.333 512c0 216.832 140.544 400.725 335.574 465.664 24.49 4.395 32.256-10.07 32.256-23.083 0-11.69.256-44.245 0-85.205-136.448 29.61-164.736-64.64-164.736-64.64-22.315-56.704-54.4-71.765-54.4-71.765-44.587-30.464 3.285-29.824 3.285-29.824 49.195 3.413 75.179 50.517 75.179 50.517 43.776 75.008 114.816 53.333 142.762 40.79 4.523-31.66 17.152-53.377 31.19-65.537-108.971-12.458-223.488-54.485-223.488-242.602 0-53.547 19.114-97.323 50.517-131.67-5.035-12.33-21.93-62.293 4.779-129.834 0 0 41.258-13.184 134.912 50.346a469.803 469.803 0 0 1 122.88-16.554c41.642.213 83.626 5.632 122.88 16.554 93.653-63.488 134.784-50.346 134.784-50.346 26.752 67.541 9.898 117.504 4.864 129.834 31.402 34.347 50.474 78.123 50.474 131.67 0 188.586-114.73 230.016-224.042 242.09 17.578 15.232 33.578 44.672 33.578 90.454v135.85c0 13.142 7.936 27.606 32.854 22.87C862.25 912.597 1002.667 728.747 10
<span class="token function">git</span> clone https://github.com/LiteyukiStudio/LiteyukiBot <span class="token parameter variable">--depth</span><span class="token operator">=</span><span class="token number">1</span>
<span class="token comment"># change the directory to the project root</span>
<span class="token builtin class-name">cd</span> LiteyukiBot
<span class="token comment"># install the project dependencies</span>
pip <span class="token function">install</span> <span class="token parameter variable">-r</span> requirements.txt
<span class="token comment"># start bot</span>
python main.py
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><div class="hint-container tip"><p class="hint-container-title">Tips</p><p>Recommended to use <code>venv</code> 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><h3 id="use-docker" tabindex="-1"><a class="header-anchor" href="#use-docker"><span><strong>Use docker</strong></span></a></h3><ol><li>Install <a href="https://docs.docker.com/get-docker/" target="_blank" rel="noopener noreferrer"><code>Docker</code><span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span></a></li><li>Clone project repo <code>git clone https://github.com/LiteyukiStudio/LiteyukiBot --depth=1</code></li><li>change directory <code>cd LiteyukiBot</code></li><li>build image with <code>docker build -t liteyukibot .</code></li><li>start container <code>docker run -p 20216:20216 -v $(pwd):/liteyukibot -v $(pwd)/.cache:/root/.cache liteyukibot</code></li></ol><div class="hint-container tip"><p class="hint-container-title">Tips</p><p>For Windows, please use the absolute project directory <code>/path/to/LiteyukiBot</code> instead of $(pwd)</p><p>If you have changed the port number, replace <code>20216</code> in <code>20216:20216</code> with your port number</p></div><h3 id="use-trss-scripts" tabindex="-1"><a class="header-anchor" href="#use-trss-scripts"><span><strong>Use TRSS Scripts</strong></span></a></h3><p><a href="https://timerainstarsky.github.io/TRSS_Liteyuki/" target="_blank" rel="noopener noreferrer">TRSS_Liteyuki LiteyukiBot manage script<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span></a>, This feature is supported by TRSS and is not an official feature of LiteyukiBot. It is recommended to use Arch Linux.</p><h2 id="device-requirements" tabindex="-1"><a class="header-anchor" href="#device-requirements"><span><strong>Device requirements</strong></span></a></h2><ul><li>Minimum Windows system version: <code>Windows 10+</code> / <code>Windows Server 2019+</code></li><li>Linux systems need to support Python 3.10+, with <code>Ubuntu 20.04+</code> recommended</li><li>CPU: <code>1 vCPU</code> and more(Bot is multi processes, the more cores, the better the performance)</li><li>Memory: Without other plugins, the Bot will occupy <code>300~500MB</code>, including processes like <code>chromium</code> and <code>node</code>. The memory occupied by other plugins depends on the specific plugins, and it is recommended to have more than <code>1GB</code>.</li><li>Storage: At least <code>1GB</code> of space is required.</li></ul><div class="hint-container warning"><p class="hint-container-title">Warning</p><p>If there are multiple environments on the device, pl
<script type="module" src="/assets/app-DPmiG-YD.js" defer></script>
</body>
</html>