2024-08-17 02:40:51 +08:00
|
|
|
|
<!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/config.html"><meta property="og:url" content="https://vuepress-theme-hope-docs-demo.netlify.app/en/deploy/config.html"><meta property="og:site_name" content="LiteyukiBot"><meta property="og:title" content="Configuration"><meta property="og:description" content="轻雪支持yaml、json和toml作为配置文件，取决于你个人的喜好 首次运行后生成config.yml和config目录，你可修改配置项后重启轻雪，绝大多数情况下，你只需要修改superusers及nickname字段即可 启动时会加载项目目录下config.yml/yaml/json/toml和config目录下的所有配置文件，你可在config目..."><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="Configuration"><meta property="article:modified_time" content="2024-08-16T18:24:25.000Z"><script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","headline":"Configuration","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>Configuration | LiteyukiBot</title><meta name="description" content="轻雪支持yaml、json和toml作为配置文件，取决于你个人的喜好 首次运行后生成config.yml和config目录，你可修改配置项后重启轻雪，绝大多数情况下，你只需要修改superusers及nickname字段即可 启动时会加载项目目录下config.yml/yaml/json/toml和config目录下的所有配置文件，你可在config目...">
|
|
|
|
|
|
<link rel="preload" href="/assets/style-CSEr-Ojo.css" as="style"><link rel="stylesheet" href="/assets/style-CSEr-Ojo.css">
|
2024-08-18 01:25:58 +08:00
|
|
|
|
<link rel="modulepreload" href="/assets/app-dSOjmdTh.js"><link rel="modulepreload" href="/assets/config.html--0ggcRxp.js">
|
|
|
|
|
|
<link rel="prefetch" href="/assets/index.html-DQBqhJmr.js" as="script"><link rel="prefetch" href="/assets/index.html-D4I0Zvb5.js" as="script"><link rel="prefetch" href="/assets/config.html-Be2yXyvg.js" as="script"><link rel="prefetch" href="/assets/fandq.html-BkZ2xrKW.js" as="script"><link rel="prefetch" href="/assets/install.html-qacRl-c_.js" as="script"><link rel="prefetch" href="/assets/index.html-BgoRCo7C.js" as="script"><link rel="prefetch" href="/assets/dev_comm.html-Cf-zcIcI.js" as="script"><link rel="prefetch" href="/assets/dev_lyfunc.html-l52E6kli.js" as="script"><link rel="prefetch" href="/assets/dev_lyplugin.html-Br3UntNN.js" as="script"><link rel="prefetch" href="/assets/dev_resource_pack.html-o6evK2TO.js" as="script"><link rel="prefetch" href="/assets/index.html-qDYvJWKc.js" as="script"><link rel="prefetch" href="/assets/index.html-ByWcAqVj.js" as="script"><link rel="prefetch" href="/assets/plugin.html-CtTOV-Ze.js" as="script"><link rel="prefetch" href="/assets/resource.html-CUWfQC3y.js" as="script"><link rel="prefetch" href="/assets/index.html-DB44UBfd.js" as="script"><link rel="prefetch" href="/assets/agreement.html-vKsJM8qF.js" as="script"><link rel="prefetch" href="/assets/basic_command.html-BdTHRIZ0.js" as="script"><link rel="prefetch" href="/assets/extra_command.html-CqrZd-aR.js" as="script"><link rel="prefetch" href="/assets/index.html-DwfUf7Ji.js" as="script"><link rel="prefetch" href="/assets/fandq.html-D3_1kOGQ.js" as="script"><link rel="prefetch" href="/assets/install.html-DfanflDD.js" as="script"><link rel="prefetch" href="/assets/index.html-B-_h3ph-.js" as="script"><link rel="prefetch" href="/assets/dev_comm.html-uereO-Ml.js" as="script"><link rel="prefetch" href="/assets/dev_lyfunc.html-BoGc2d_a.js" as="script"><link rel="prefetch" href="/assets/dev_lyplugin.html-vrZH0Bgc.js" as="script"><link rel="prefetch" href="/assets/dev_resource_pack.html-CqDSkLQZ.js" as="script"><link rel="prefetch" href="/assets/index.html-Dr-IiuGd.js" as="script"><link rel="prefetch" href="/assets/plugin.html-oCc7RJYS.js" as="script"><link rel="prefetch" href="/assets/resource.html-BiG_treu.js" as="script"><link rel="prefetch" href="/assets/index.html-BJDVCCVp.js" as="script"><link rel="prefetch" href="/assets/agreement.html-DK5CWQCl.js" as="script"><link rel="prefetch" href="/assets/basic_command.html-Q8zaeZCI.js" as="script"><link rel="prefetch" href="/assets/extra_command.html-g4__c7D6.js" as="script"><link rel="prefetch" href="/assets/404.html-Bblc6dHo.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">
|
2024-08-17 02:40:51 +08:00
|
|
|
|
</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/config.html" aria-label="简体中文"><!---->简体中文<!----></a></li><li class="dropdown-item"><a class="route-link nav-link active" href="/en/deploy/config.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 1002
|
|
|
|
|
|
<span class="token comment"># Nonebot机器人的配置，以前的最外层配置项仍可为Nonebot服务，但是部分内容会被覆盖，请尽快迁移</span>
|
|
|
|
|
|
<span class="token key atrule">command_start</span><span class="token punctuation">:</span> <span class="token punctuation">[</span> <span class="token string">"/"</span><span class="token punctuation">,</span> <span class="token string">""</span> <span class="token punctuation">]</span> <span class="token comment"># 指令前缀，若没有""空命令头，请开启alconna_use_command_start保证alconna解析正常</span>
|
|
|
|
|
|
<span class="token key atrule">host</span><span class="token punctuation">:</span> 127.0.0.1 <span class="token comment"># 监听地址，默认为本机，若要接收外部请求请填写0.0.0.0</span>
|
|
|
|
|
|
<span class="token key atrule">port</span><span class="token punctuation">:</span> <span class="token number">20216</span> <span class="token comment"># 绑定端口</span>
|
|
|
|
|
|
<span class="token key atrule">nickname</span><span class="token punctuation">:</span> <span class="token punctuation">[</span> <span class="token string">"liteyuki"</span> <span class="token punctuation">]</span> <span class="token comment"># 机器人昵称列表</span>
|
|
|
|
|
|
<span class="token key atrule">superusers</span><span class="token punctuation">:</span> <span class="token punctuation">[</span> <span class="token string">"1919810"</span> <span class="token punctuation">]</span> <span class="token comment"># 超级用户列表</span>
|
|
|
|
|
|
<span class="token key atrule">liteyuki</span><span class="token punctuation">:</span>
|
|
|
|
|
|
<span class="token comment"># 写在外层的配置项将会被覆盖，建议迁移到liteyuki下</span>
|
|
|
|
|
|
<span class="token key atrule">log_level</span><span class="token punctuation">:</span> <span class="token string">"INFO"</span> <span class="token comment"># 日志等级</span>
|
|
|
|
|
|
<span class="token key atrule">log_icon</span><span class="token punctuation">:</span> <span class="token boolean important">true</span> <span class="token comment"># 是否显示日志等级图标（某些控制台字体不可用）</span>
|
|
|
|
|
|
<span class="token key atrule">auto_report</span><span class="token punctuation">:</span> <span class="token boolean important">true</span> <span class="token comment"># 是否自动上报问题给轻雪服务器</span>
|
|
|
|
|
|
<span class="token key atrule">auto_update</span><span class="token punctuation">:</span> <span class="token boolean important">true</span> <span class="token comment"># 是否自动更新轻雪，每天4点检查更新</span>
|
|
|
|
|
|
<span class="token key atrule">plugins</span><span class="token punctuation">:</span> <span class="token punctuation">[</span> <span class="token punctuation">]</span> <span class="token comment"># 轻雪插件列表</span>
|
|
|
|
|
|
<span class="token key atrule">plugin_dirs</span><span class="token punctuation">:</span> <span class="token punctuation">[</span> <span class="token punctuation">]</span> <span class="token comment"># 轻雪插件目录列表</span>
|
|
|
|
|
|
</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 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><h2 id="其他配置" tabindex="-1"><a class="header-anchor" href="#其他配置"><span><strong>其他配置</strong></span></a></h2><p>以下为默认值，如需自定义请手动添加</p><div class="language-yaml line-numbers-mode" data-ext="yml" data-title="yml"><pre class="language-yaml"><code><span class="token comment"># 高级NoneBot配置</span>
|
|
|
|
|
|
<span class="token key atrule">nonebot</span><span class="token punctuation">:</span>
|
|
|
|
|
|
<span class="token key atrule">onebot_access_token</span><span class="token punctuation">:</span> <span class="token string">""</span> <span class="token comment"># 访问令牌，对公开放时建议设置</span>
|
|
|
|
|
|
<span class="token key atrule">default_language</span><span class="token punctuation">:</span> <span class="token string">"zh-CN"</span> <span class="token comment"># 默认语言</span>
|
|
|
|
|
|
<span class="token key atrule">alconna_auto_completion</span><span class="token punctuation">:</span> <span class="token boolean important">false</span> <span class="token comment"># alconna是否自动补全指令，默认false，建议开启</span>
|
|
|
|
|
|
<span class="token key atrule">safe_mode</span><span class="token punctuation">:</span> <span class="token boolean important">false</span> <span class="token comment"># 安全模式，开启后将不会加载任何第三方NoneBot插件</span>
|
|
|
|
|
|
<span class="token comment"># 其他Nonebot插件的配置项</span>
|
|
|
|
|
|
<span class="token key atrule">custom_config_1</span><span class="token punctuation">:</span> <span class="token string">"custom_value1"</span>
|
|
|
|
|
|
<span class="token key atrule">custom_config_2</span><span class="token punctuation">:</span> <span class="token string">"custom_value2"</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="token comment"># 开发者选项</span>
|
|
|
|
|
|
<span class="token key atrule">liteyuki</span><span class="token punctuation">:</span>
|
|
|
|
|
|
<span class="token key atrule">allow_update</span><span class="token punctuation">:</span> <span class="token boolean important">true</span> <span class="token comment"># 是否允许更新</span>
|
|
|
|
|
|
<span class="token key atrule">debug</span><span class="token punctuation">:</span> <span class="token boolean important">false</span> <span class="token comment"># 轻雪调试，开启会自动重载Bot或者资源，其他插件自带的调试功能也将开启</span>
|
|
|
|
|
|
<span class="token key atrule">dev_mode</span><span class="token punctuation">:</span> <span class="token boolean important">false</span> <span class="token comment"># 开发者模式，开启后将会启动监视者，监视文件变化并自动重载</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="token punctuation">...</span>
|
|
|
|
|
|
</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 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 class="line-number"></div></div></div><div class="hint-container tip"><p class="hint-container-title">Tips</p><p>如果要使用NoneBot和dotenv配置文件，请自行创建<code>.env.{ENVIRONMENT}</code>，并在<code>config.yml</code>中添加<code>nonebot.environment:{ENVIRONMENT}</code>字段</p></div><h2 id="与nonebot对接的onebot实现端配置" tabindex="-1"><a class="header-anchor" href="#与nonebot对接的onebot实现端配置"><span><strong>与NoneBot对接的OneBot实现端配置</strong></span></a></h2><p>生产环境中推荐反向WebSocket 不同的实现端给出的字段可能不同，但是基本上都是一样的，这里给出一个参考值</p><table><thead><tr><th>字段</th><th>参考值</th><th>说明</th></tr></thead><tbody><tr><td>协议</td><td>反向WebSocket</td><td>推荐使用反向ws协议进行通信，即轻雪作为服务端</td></tr><tr><td>地址</td><td>ws://127.0.0.1:20216/onebot/v11/ws</td><td>地址取决于配置文件，本机默认为<code>127.0.0.1:20216</code></td></tr><tr><td>AccessToken</td><td><code>""</code></td><td>如果你给轻雪配置了<code>AccessToken</code>，请在此填写相同的值</td></tr></tbody></table><h2 id="其他" tabindex="-1"><a class="header-anchor" href="#其他"><span><strong>其他</strong></span></a></h2><ul><li>要使用其他通信方式请访问<a href="https://onebot.adapters.nonebot.dev/" target="_blank" rel="noopener noreferrer">OneBot Adapter<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>轻雪不局限于OneBot适配器，你可以使用NoneBot2支持的任何适配器</li></ul></div><!--[--><!----><!--]--><footer class="page-meta"><div class="meta-item edit-link"><a href="https://github.com/LiteyukiStudio/LiteyukiBot/edit/main/docs/en/deploy/config.md" rel="noopener noreferrer" target="_blank" aria-label="在 GitHub 上编辑" class="nav-link label"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon edit-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="edit icon"><path d="M430.818 653.65a60.46 60.46 0 0 1-50.96-93.281l71.69-114.012 7.773-10.365L816.038 80.138A60.46 60.46 0 0 1 859.225 62a60.46 60.46 0 0 1 43.186 18.138l43.186 43.186a60.46 60.46 0 0 1 0 86.373L588.879 565.55l-8.637 8.637-117.466 68.234a60.46 60.46 0 0 1-31.958 11.229z"></path><path d="M728.802 962H252.891A190.883 190.883 0 0 1 62.008 771.98V296.934a190.883 190.883 0 0 1 190.883-192.61h267.754a60.46 60.46 0 0 1 0 120.92H252.891a69.962 69.962 0 0 0-69.098 69.099V771.98a69.962 69.962 0 0 0 69.098 69.098h475.911A69.962 69.962 0 0 0 797.9 771.98V503.363a60.46 60.46 0 1 1 120.922 0V771.98A190.883 190.883 0 0 1 728.802 962z"></path></svg><!--]-->在 GitHub 上编辑<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.1
|
2024-08-18 01:25:58 +08:00
|
|
|
|
<script type="module" src="/assets/app-dSOjmdTh.js" defer></script>
|
2024-08-17 02:40:51 +08:00
|
|
|
|
</body>
|
|
|
|
|
|
</html>
|
