app/deployment/config.html

69 lines
30 KiB
HTML
Raw Normal View History

<!doctype html>
<html lang="zh-CN" 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>
<meta property="og:url" content="https://vuepress-theme-hope-docs-demo.netlify.app/deployment/config.html"><meta property="og:site_name" content="LiteyukiBot 轻雪机器人"><meta property="og:title" content="配置"><meta property="og:description" content="轻雪配置项(Nonebot插件配置项也可以写在此与dotenv格式不同应为小写) 配置文件会在首次启动后生成你可以在config.yml中修改配置项后重启轻雪绝大多数情况下你只需要修改superusers和nickname。如果不确定字段的含义请不要修改部分在自动生成配置文件中未列出需手动添加 Onebot实现端配置 不同的实现端给出..."><meta property="og:type" content="article"><meta property="og:locale" content="zh-CN"><meta property="og:updated_time" content="2024-04-05T12:07:33.000Z"><meta property="article:author" content="远野千束"><meta property="article:tag" content="配置"><meta property="article:tag" content="部署"><meta property="article:modified_time" content="2024-04-05T12:07:33.000Z"><script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","headline":"配置","image":[""],"dateModified":"2024-04-05T12:07:33.000Z","author":[{"@type":"Person","name":"远野千束","url":"https://snowykami.me"}]}</script><link rel="icon" href="https://cdn.liteyuki.icu/favicon.ico"><meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no"><title>配置 | LiteyukiBot 轻雪机器人</title><meta name="description" content="轻雪配置项(Nonebot插件配置项也可以写在此与dotenv格式不同应为小写) 配置文件会在首次启动后生成你可以在config.yml中修改配置项后重启轻雪绝大多数情况下你只需要修改superusers和nickname。如果不确定字段的含义请不要修改部分在自动生成配置文件中未列出需手动添加 Onebot实现端配置 不同的实现端给出...">
<link rel="preload" href="/assets/style-Bpf7vrTr.css" as="style"><link rel="stylesheet" href="/assets/style-Bpf7vrTr.css">
<link rel="modulepreload" href="/assets/app-D7Kj3wj1.js"><link rel="modulepreload" href="/assets/config.html-wG-iojgm.js"><link rel="modulepreload" href="/assets/plugin-vue_export-helper-DlAUqK2U.js">
<link rel="prefetch" href="/assets/index.html-DvLO-Ksi.js" as="script"><link rel="prefetch" href="/assets/foolsday.html-EExtjRD9.js" as="script"><link rel="prefetch" href="/assets/index.html-BNupV-mb.js" as="script"><link rel="prefetch" href="/assets/fandq.html-DytcXqqy.js" as="script"><link rel="prefetch" href="/assets/install.html-D-hMUQ3m.js" as="script"><link rel="prefetch" href="/assets/index.html-sPHkUQN9.js" as="script"><link rel="prefetch" href="/assets/index.html-COlJas0b.js" as="script"><link rel="prefetch" href="/assets/agreement.html-BmJpEXqu.js" as="script"><link rel="prefetch" href="/assets/basic_command.html-BO6J9Gb6.js" as="script"><link rel="prefetch" href="/assets/extra_command.html-z4gJfwCQ.js" as="script"><link rel="prefetch" href="/assets/404.html-BKpHM_b4.js" as="script"><link rel="prefetch" href="/assets/giscus-7BMGhbDA.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">跳至主要內容</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="/"><img class="vp-nav-logo" src="https://cdn.liteyuki.icu/static/img/logo.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="/" aria-label="首页"><span class="font-icon icon fa-fw fa-sm fas fa-home" style=""></span>首页<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link active" href="/deployment/" aria-label="项目部署"><!---->项目部署<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link" href="/usage/" aria-label="使用手册"><!---->使用手册<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link" href="/store/" aria-label="主题商店"><!---->主题商店<!----></a></div></nav><!--]--><!--[--><!----><!--]--></div><div class="vp-navbar-end"><!--[--><!----><!--]--><!--[--><!----><div class="nav-item vp-repo"><a class="vp-repo-link" href="https://github.com/snowykami/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.667 512c0-271.019-219.648-490.667-490.71-490.667z"></path></svg></a></div><div class="nav-item hide-in-mobile"><button type="button" id="appearance-switch"><svg xmlns="http://www.w3.org/2000/svg" class="icon auto-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="auto icon" style="display:block;"><path d="M512 992C246.92 992 32 777.08 32 512S246.92 32 512 32s480 214.92 480 480-214.92 480-480 480zm0-840c-198.78 0-360 161.22-360 360 0 198.84 161.22 360 360 360s360-161.16 360-360c0-198.78-161.22-360-360-360zm0 660V212c165.72 0 300 134.34 300 300 0 165.72-134.28 300-300 300z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="dark icon" style="display:none;"><path d="M524.8 938.667h-4.267a439.893 439.893 0 0 1-313.173-134.4 446.293 446.293 0 0 1-11.093-597.334A432.213 432.213 0 0 1 366.933 90.027a42.667 42.667 0 0 1 45.227 9.386 42.667 42.667 0 0 1 10.24 42.667 358.4 358.4 0 0 0 82.773 375.893 361.387 361.387 0 0 0 376.747 82.774 42.667 42.667 0 0 1 54.187 55.04 433.493 433.493 0 0 1-99.84 154.88 438.613 438.613 0 0 1-311.467 128z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="light icon" style="display:none;"><path d="M952 552h
<span class="token key atrule">command_start</span><span class="token punctuation">:</span> <span class="token punctuation">[</span> <span class="token string">&quot;/&quot;</span><span class="token punctuation">,</span> <span class="token string">&quot;&quot;</span> <span class="token punctuation">]</span> <span class="token comment"># 指令前缀,若没有&quot;&quot;空命令头请开启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或者你的公网IP</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">&quot;liteyuki&quot;</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">&quot;1919810&quot;</span> <span class="token punctuation">]</span> <span class="token comment"># 超级用户</span>
<span class="token comment"># 未列出的配置项(如要自定义请手动修改)</span>
<span class="token key atrule">onebot_access_token</span><span class="token punctuation">:</span> <span class="token string">&quot;&quot;</span> <span class="token comment"># 访问令牌,对公网开放时建议设置</span>
<span class="token key atrule">default_language</span><span class="token punctuation">:</span> <span class="token string">&quot;zh-CN&quot;</span> <span class="token comment"># 默认语言支持i18n部分语言和自行扩展的语言代码</span>
<span class="token key atrule">log_level</span><span class="token punctuation">:</span> <span class="token string">&quot;INFO&quot;</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">fake_device_info</span><span class="token punctuation">:</span> <span class="token comment"># 统计卡片显示的虚假设备信息,用于保护隐私</span>
<span class="token key atrule">cpu</span><span class="token punctuation">:</span>
<span class="token key atrule">brand</span><span class="token punctuation">:</span> AMD
<span class="token key atrule">cores</span><span class="token punctuation">:</span> <span class="token number">16</span> <span class="token comment"># 物理核心数</span>
<span class="token key atrule">logical_cores</span><span class="token punctuation">:</span> <span class="token number">32</span> <span class="token comment"># 逻辑核心数</span>
<span class="token key atrule">frequency</span><span class="token punctuation">:</span> <span class="token number">3600</span> <span class="token comment"># CPU主频MHz</span>
<span class="token key atrule">mem</span><span class="token punctuation">:</span>
<span class="token key atrule">total</span><span class="token punctuation">:</span> <span class="token number">32768000000</span> <span class="token comment"># 内存总数:字节</span>
<span class="token key atrule">alconna_use_command_start</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">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 comment"># 其他Nonebot插件的配置项</span>
<span class="token key atrule">custom_config_1</span><span class="token punctuation">:</span> <span class="token string">&quot;custom_value1&quot;</span>
<span class="token key atrule">custom_config_2</span><span class="token punctuation">:</span> <span class="token string">&quot;custom_value2&quot;</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 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><h3 id="onebot实现端配置" tabindex="-1"><a class="header-anchor" href="#onebot实现端配置"><span>Onebot实现端配置</span></a></h3><p>不同的实现端给出的字段可能不同,但是基本上都是一样的,这里给出一个参考值</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://<code>address</code>/onebot/v11/ws</td><td>地址取决于配置文件,本机默认为<code>127.0.0.1:20216</code></td></tr><tr><td>AccessToken</td><td><code>&quot;&quot;</code></td><td>如果你给轻雪配置了<code>AccessToken</code>,请在此填写相同的值</td></tr></tbody></table><h3 id="其他通信方式" tabindex="-1"><a class="header-anchor" href="#其他通信方式"><span>其他通信方式</span></a></h3><ul><li>实现端与轻雪的通信方式不局限为反向WebSocket但是推荐使用反向WebSocket。</li><li>反向WebSocket的优点是轻雪作为服务端可以更好的控制连接适用于生产环境。</li><li>在某些情况下你也可以使用正向WebSocket比如你在开发轻雪插件时可以使用正向WebSocket主动连接实现端</li></ul></div><!--[--><!----><!--]--><footer class="page-meta"><div class="meta-item edit-link"><a href="https://github.com/snowykami/LiteyukiBot/edit/main/docs/deployment/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.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></div><div class="meta-item git-info"><div class="update-time"><span class="label">上次编辑于: </span><!----></div><div class="contributors"><span class="label">贡献者: </span><!--[--><!--[--><s
<script type="module" src="/assets/app-D7Kj3wj1.js" defer></script>
</body>
</html>