app/assets/config.html-BLPfgc64.js

import{_ as e,r as t,o,c,b as n,d as s,a as l,e as p}from"./app-B6b73EUM.js";const i={},u=p(`<p>轻雪支持<code>yaml</code>、<code>json</code>和<code>toml</code>作为配置文件，取决于你个人的喜好</p><p>首次运行后生成<code>config.yml</code>和<code>config</code>目录，你可修改配置项后重启轻雪，绝大多数情况下，你只需要修改<code>superusers</code>及<code>nickname</code>字段即可</p><p>启动时会加载项目目录下<code>config.yml/yaml/json/toml</code>和<code>config</code>目录下的所有配置文件，你可在<code>config</code>目录下创建多个配置文件，轻雪会自动合并这些配置文件</p><h2 id="基础配置项" tabindex="-1"><a class="header-anchor" href="#基础配置项"><span><strong>基础配置项</strong></span></a></h2><div class="language-yaml line-numbers-mode" data-ext="yml" data-title="yml"><pre class="language-yaml"><code><span class="token key atrule">nonebot</span><span class="token punctuation">:</span>
  <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">&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</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 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">&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">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">&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"># 默认语言</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">&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 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>&quot;&quot;</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>`,13),r={href:"https://onebot.adapters.nonebot.dev/",target:"_blank",rel:"noopener noreferrer"},d=n("li",null,"轻雪不局限于OneBot适配器，你可以使用NoneBot2支持的任何适配器",-1);function m(k,v){const a=t("ExternalLinkIcon");return o(),c("div",null,[u,n("ul",null,[n("li",null,[s("要使用其他通信方式请访问"),n("a",r,[s("OneBot Adapter"),l(a)]),s("获取详细信息")]),d])])}const b=e(i,[["render",m],["__file","config.html.vue"]]),y=JSON.parse('{"path":"/en/deploy/config.html","title":"Configuration","lang":"en-US","frontmatter":{"title":"Configuration","icon":"cog","order":2,"category":"deployment","tag":["Configuration"],"description":"轻雪支持yaml、json和toml作为配置文件，取决于你个人的喜好 首次运行后生成config.yml和config目录，你可修改配置项后重启轻雪，绝大多数情况下，你只需要修改superusers及nickname字段即可 启动时会加载项目目录下config.yml/yaml/json/toml和config目录下的所有配置文件，你可在config目...","head":[["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\\":[]}"]]},"headers":[{"level":2,"title":"基础配置项","slug":"基础配置项","link":"#基础配置项","children":[]},{"level":2,"title":"其他配置","slug":"其他配置","link":"#其他配置","children":[]},{"level":2,"title":"与NoneBot对接的OneBot实现端配置","slug":"与nonebot对接的onebot实现端配置","link":"#与nonebot对接的onebot实现端配置","children":[]},{"level":2,"title":"其他","slug":"其他","link":"#其他","children":[]}],"git":{"createdTime":1723832665000,"updatedTime":1723832665000,"contributors":[{"name":"snowy","email":"snowykami@outlook.com","commits":1}]},"readingTime":{"minutes":2.42,"words":726},"filePathRelative":"en/deploy/config.md","localizedDate":"August 16, 2024","autoDesc":true}');export{b as comp,y as data};