shkong/OpenShamrock
1
0
Fork 0
mirror of https://github.com/whitechi73/OpenShamrock.git synced 2024-08-14 13:12:17 +08:00
Code Issues Packages Projects Releases Wiki Activity
OpenShamrock/guide/configuration.html
github-actions[bot] 0f26387747 Deploy to GitHub pages
2024-03-24 07:47:33 +00:00

82 lines
36 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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-beta.67" />
<meta name="theme" content="VuePress Theme Hope" />
<meta name="viewport" content="width=device-width,initial-scale=1,user-scalable=no"><script async src="https://umami.zhenxin.me/script.js" data-website-id="a3220f2d-2267-4b95-b4aa-a5964cda0a0d"></script><link rel="icon" href="/OpenShamrock/shamrock.webp"><title>应用配置 | OpenShamrock</title><meta name="description" content="">
<style>
:root {
--bg-color: #fff;
}
html[data-theme="dark"] {
--bg-color: #1d1e1f;
}
html,
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="preload" href="/OpenShamrock/assets/style-842f0c71.css" as="style"><link rel="stylesheet" href="/OpenShamrock/assets/style-842f0c71.css">
<link rel="modulepreload" href="/OpenShamrock/assets/app-e0095480.js"><link rel="modulepreload" href="/OpenShamrock/assets/configuration.html-ba1a7bcd.js"><link rel="modulepreload" href="/OpenShamrock/assets/plugin-vue_export-helper-c27b6911.js"><link rel="modulepreload" href="/OpenShamrock/assets/configuration.html-eb910716.js"><link rel="prefetch" href="/OpenShamrock/assets/index.html-7ea406c2.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/index.html-f5c92ed1.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/voice.html-e8e18946.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/index.html-258d0d5f.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/general-data.html-b027dcd6.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/message.html-0ca9d8ee.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/notice.html-5519df6e.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/request.html-0743679e.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/index.html-983e0a4a.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/account.html-90bd473f.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/contact.html-3cff63b3.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/dispose.html-102b9d52.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/fav.html-20a3b00e.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/file.html-dfe880a4.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/group.html-ec66990a.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/guild.html-6966c300.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/message.html-01bc5fb8.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/other.html-32d2e4de.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/request-response.html-2fa1a2de.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/resources.html-205eae6c.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/shamrock.html-93415924.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/user.html-e225e670.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/index.html-0199c0aa.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/faq.html-b8980499.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/getting-started.html-717781e9.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/index.html-2510ab56.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/advanced.html-cf16f849.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/format.html-2e24f616.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/media.html-5b7447ab.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/normal.html-a29eb19d.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/special.html-2e3560dc.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/404.html-f04ced3e.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/index.html-82bb9cb2.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/index.html-27855498.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/voice.html-430951ec.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/index.html-bde65a9c.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/general-data.html-149dffbc.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/message.html-567cf616.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/notice.html-c1382a10.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/request.html-b3bc3192.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/index.html-94afd1df.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/account.html-50171750.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/contact.html-955c8c7e.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/dispose.html-aa43dd9b.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/fav.html-af222ac6.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/file.html-fc7de549.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/group.html-88befc49.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/guild.html-79376133.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/message.html-1c3957a0.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/other.html-5cfa1b52.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/request-response.html-38b3e006.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/resources.html-79c74429.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/shamrock.html-e168e5e6.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/user.html-248dbc66.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/index.html-140dedb8.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/faq.html-18ddfefb.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/getting-started.html-20859108.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/index.html-bd81cec9.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/advanced.html-9f0a3c6c.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/format.html-f69160c6.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/media.html-8c5ade33.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/normal.html-a0a3103e.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/special.html-006a5f2e.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/404.html-47704f15.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/photoswipe.esm-5762295a.js" as="script"><link rel="prefetch" href="/OpenShamrock/assets/SearchResult-76df690b.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="vp-link vp-brand vp-brand" href="/OpenShamrock/"><img class="vp-nav-logo" src="/OpenShamrock/shamrock.webp" alt="OpenShamrock"><!----><span class="vp-site-name hide-in-pad">OpenShamrock</span></a><!--]--><!--[--><!----><!--]--></div><div class="vp-navbar-center"><!--[--><!----><!--]--><!--[--><nav class="vp-nav-links"><div class="nav-item hide-in-mobile"><a aria-label="指南" class="vp-link nav-link active nav-link active" href="/OpenShamrock/guide.html"><span class="font-icon icon fa-fw fa-sm fas fa-lightbulb" style=""></span>指南<!----></a></div><div class="nav-item hide-in-mobile"><a aria-label="进阶" class="vp-link nav-link nav-link" href="/OpenShamrock/advanced.html"><span class="font-icon icon fa-fw fa-sm fas fa-gem" style=""></span>进阶<!----></a></div><div class="nav-item hide-in-mobile"><a aria-label="接口" class="vp-link nav-link nav-link" href="/OpenShamrock/api.html"><span class="font-icon icon fa-fw fa-sm fas fa-laptop-code" style=""></span>接口<!----></a></div><div class="nav-item hide-in-mobile"><a aria-label="消息" class="vp-link nav-link nav-link" href="/OpenShamrock/message.html"><span class="font-icon icon fa-fw fa-sm fas fa-comment" style=""></span>消息<!----></a></div><div class="nav-item hide-in-mobile"><a aria-label="事件" class="vp-link nav-link nav-link" href="/OpenShamrock/event.html"><span class="font-icon icon fa-fw fa-sm fas fa-bell" style=""></span>事件<!----></a></div></nav><!--]--><!--[--><!----><!--]--></div><div class="vp-navbar-end"><!--[--><!----><!--]--><!--[--><!----><div class="nav-item vp-repo"><a class="vp-repo-link" href="https://github.com/whitechi73/OpenShamrock" 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-80a40 40 0 0 1 0-80h80a40 40 0 0 1 0 80zM801.88 280.08a41 41 0 0 1-57.96-57.96l57.96-58a41.04 41.04 0 0 1 58 58l-58 57.96zM512 752a240 240 0 1 1 0-480 240 240 0 0 1 0 480zm0-560a40 40 0 0 1-40-40V72a40 40 0 0 1 80 0v80a40 40 0 0 1-40 40zm-289.88 88.08-58-57.96a41.04 41.04 0 0 1 58-58l57.96 58a41 41 0 0 1-57.96 57.96zM192 512a40 40 0 0 1-40 40H72a40 40 0 0 1 0-80h80a40 40 0 0 1 40 40zm30.12 231.92a41 41 0 0 1 57.96 57.96l-57.96 58a41.04 41.04 0 0 1-58-58l58-57.96zM512 832a40 40 0 0 1 40 40v80a40 40 0 0 1-80 0v-80a40 40 0 0 1 40-40zm289.88-88.08 58 57.96a41.04 41.04 0 0 1-58 58l-57.96-58a41 41 0 0 1 57.96-57.96z"></path></svg></button></div><!--[--><button type="button" class="search-pro-button" role="search" aria-label="搜索"><svg xmlns="http://www.w3.org/2000/svg" class="icon search-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="search icon"><path d="M192 480a256 256 0 1 1 512 0 256 256 0 0 1-512 0m631.776 362.496-143.2-143.168A318.464 318.464 0 0 0 768 480c0-176.736-143.264-320-320-320S128 303.264 128 480s143.264 320 320 320a318.016 318.016 0 0 0 184.16-58.592l146.336 146.368c12.512 12.48 32.768 12.48 45.28 0 12.48-12.512 12.48-32.768 0-45.28"></path></svg><div class="search-pro-placeholder">搜索</div><!----></button><!--]--><!--]--><!--[--><!----><!--]--><button type="button" class="vp-toggle-navbar-button" aria-label="Toggle Navbar" aria-expanded="false" aria-controls="nav-screen"><span><span class="vp-top"></span><span class="vp-middle"></span><span class="vp-bottom"></span></span></button></div></header><!----><!--]--><!----><div class="toggle-sidebar-wrapper"><span class="arrow start"></span></div><aside id="sidebar" class="vp-sidebar"><!--[--><!----><!--]--><ul class="vp-sidebar-links"><li><section class="vp-sidebar-group"><button class="vp-sidebar-heading clickable active" type="button"><span class="font-icon icon fa-fw fa-sm fas fa-lightbulb" style=""></span><span class="vp-sidebar-title">指南</span><span class="vp-arrow down"></span></button><ul class="vp-sidebar-links"><li><!--[--><a aria-label="快速开始" class="vp-link nav-link vp-sidebar-link vp-sidebar-page nav-link vp-sidebar-link vp-sidebar-page" href="/OpenShamrock/guide/getting-started.html"><span class="font-icon icon fa-fw fa-sm fas fa-rocket" style=""></span>快速开始<!----></a><ul class="vp-sidebar-sub-headers"></ul><!--]--></li><li><!--[--><a aria-label="应用配置" class="vp-link nav-link active vp-sidebar-link vp-sidebar-page active nav-link active vp-sidebar-link vp-sidebar-page active" href="/OpenShamrock/guide/configuration.html"><span class="font-icon icon fa-fw fa-sm fas fa-cog" style=""></span>应用配置<!----></a><ul class="vp-sidebar-sub-headers"><li class="vp-sidebar-sub-header"><a aria-label="配置选项" class="vp-link nav-link vp-sidebar-link vp-heading nav-link vp-sidebar-link vp-heading" href="/OpenShamrock/guide/configuration.html#配置选项"><!---->配置选项<!----></a><ul class="vp-sidebar-sub-headers"><li class="vp-sidebar-sub-header"><a aria-label="强制平板模式" class="vp-link nav-link vp-sidebar-link vp-heading nav-link vp-sidebar-link vp-heading" href="/OpenShamrock/guide/configuration.html#强制平板模式"><!---->强制平板模式<!----></a><ul class="vp-sidebar-sub-headers"></ul></li></ul></li><li class="vp-sidebar-sub-header"><a aria-label="目录定义" class="vp-link nav-link vp-sidebar-link vp-heading nav-link vp-sidebar-link vp-heading" href="/OpenShamrock/guide/configuration.html#目录定义"><!---->目录定义<!----></a><ul class="vp-sidebar-sub-headers"></ul></li><li class="vp-sidebar-sub-header"><a aria-label="配置文件" class="vp-link nav-link vp-sidebar-link vp-heading nav-link vp-sidebar-link vp-heading" href="/OpenShamrock/guide/configuration.html#配置文件"><!---->配置文件<!----></a><ul class="vp-sidebar-sub-headers"></ul></li><li class="vp-sidebar-sub-header"><a aria-label="WebSocket认证方法" class="vp-link nav-link vp-sidebar-link vp-heading nav-link vp-sidebar-link vp-heading" href="/OpenShamrock/guide/configuration.html#websocket认证方法"><!---->WebSocket认证方法<!----></a><ul class="vp-sidebar-sub-headers"></ul></li><li class="vp-sidebar-sub-header"><a aria-label="数据目录" class="vp-link nav-link vp-sidebar-link vp-heading nav-link vp-sidebar-link vp-heading" href="/OpenShamrock/guide/configuration.html#数据目录"><!---->数据目录<!----></a><ul class="vp-sidebar-sub-headers"></ul></li></ul><!--]--></li><li><!--[--><a aria-label="常见问题" class="vp-link nav-link vp-sidebar-link vp-sidebar-page nav-link vp-sidebar-link vp-sidebar-page" href="/OpenShamrock/guide/faq.html"><span class="font-icon icon fa-fw fa-sm fas fa-question-circle" style=""></span>常见问题<!----></a><ul class="vp-sidebar-sub-headers"></ul><!--]--></li></ul></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-heading clickable" type="button"><span class="font-icon icon fa-fw fa-sm fas fa-gem" style=""></span><span class="vp-sidebar-title">进阶</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-heading clickable" type="button"><span class="font-icon icon fa-fw fa-sm fas fa-laptop-code" style=""></span><span class="vp-sidebar-title">接口</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-heading clickable" type="button"><span class="font-icon icon fa-fw fa-sm fas fa-comment" style=""></span><span class="vp-sidebar-title">消息</span><span class="vp-arrow end"></span></button><!----></section></li><li><section class="vp-sidebar-group"><button class="vp-sidebar-heading clickable" type="button"><span class="font-icon icon fa-fw fa-sm fas fa-bell" style=""></span><span class="vp-sidebar-title">事件</span><span class="vp-arrow end"></span></button><!----></section></li></ul><!--[--><!----><!--]--></aside><!--[--><main id="main-content" class="vp-page"><!--[--><!----><!----><nav class="vp-breadcrumb disable"></nav><div class="vp-page-title"><h1><span class="font-icon icon fa-fw fa-sm fas fa-cog" style=""></span>应用配置</h1><div class="page-info"><!----><!----><span class="page-date-info" aria-label="写作日期📅" data-balloon-pos="down"><svg xmlns="http://www.w3.org/2000/svg" class="icon calendar-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="calendar icon"><path d="M716.4 110.137c0-18.753-14.72-33.473-33.472-33.473-18.753 0-33.473 14.72-33.473 33.473v33.473h66.993v-33.473zm-334.87 0c0-18.753-14.72-33.473-33.473-33.473s-33.52 14.72-33.52 33.473v33.473h66.993v-33.473zm468.81 33.52H716.4v100.465c0 18.753-14.72 33.473-33.472 33.473a33.145 33.145 0 01-33.473-33.473V143.657H381.53v100.465c0 18.753-14.72 33.473-33.473 33.473a33.145 33.145 0 01-33.473-33.473V143.657H180.6A134.314 134.314 0 0046.66 277.595v535.756A134.314 134.314 0 00180.6 947.289h669.74a134.36 134.36 0 00133.94-133.938V277.595a134.314 134.314 0 00-133.94-133.938zm33.473 267.877H147.126a33.145 33.145 0 01-33.473-33.473c0-18.752 14.72-33.473 33.473-33.473h736.687c18.752 0 33.472 14.72 33.472 33.473a33.145 33.145 0 01-33.472 33.473z"></path></svg><span><!----></span><meta property="datePublished" content="2023-10-28T03:41:51.000Z"></span><!----><span class="page-reading-time-info" aria-label="阅读时间⌛" data-balloon-pos="down"><svg xmlns="http://www.w3.org/2000/svg" class="icon timer-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="timer icon"><path d="M799.387 122.15c4.402-2.978 7.38-7.897 7.38-13.463v-1.165c0-8.933-7.38-16.312-16.312-16.312H256.33c-8.933 0-16.311 7.38-16.311 16.312v1.165c0 5.825 2.977 10.874 7.637 13.592 4.143 194.44 97.22 354.963 220.201 392.763-122.204 37.542-214.893 196.511-220.2 389.397-4.661 5.049-7.638 11.651-7.638 19.03v5.825h566.49v-5.825c0-7.379-2.849-13.981-7.509-18.9-5.049-193.016-97.867-351.985-220.2-389.527 123.24-37.67 216.446-198.453 220.588-392.892zM531.16 450.445v352.632c117.674 1.553 211.787 40.778 211.787 88.676H304.097c0-48.286 95.149-87.382 213.728-88.676V450.445c-93.077-3.107-167.901-81.297-167.901-177.093 0-8.803 6.99-15.793 15.793-15.793 8.803 0 15.794 6.99 15.794 15.793 0 80.261 63.69 145.635 142.01 145.635s142.011-65.374 142.011-145.635c0-8.803 6.99-15.793 15.794-15.793s15.793 6.99 15.793 15.793c0 95.019-73.789 172.82-165.96 177.093z"></path></svg><span>大约 2 分钟</span><meta property="timeRequired" content="PT2M"></span><!----><!----></div><hr></div><div class="toc-place-holder"><aside id="toc"><!--[--><!----><!--]--><div class="toc-header">此页内容<button type="button" class="print-button" title="打印"><svg xmlns="http://www.w3.org/2000/svg" class="icon print-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="print icon"><path d="M819.2 364.8h-44.8V128c0-17.067-14.933-32-32-32H281.6c-17.067 0-32 14.933-32 32v236.8h-44.8C145.067 364.8 96 413.867 96 473.6v192c0 59.733 49.067 108.8 108.8 108.8h44.8V896c0 17.067 14.933 32 32 32h460.8c17.067 0 32-14.933 32-32V774.4h44.8c59.733 0 108.8-49.067 108.8-108.8v-192c0-59.733-49.067-108.8-108.8-108.8zM313.6 160h396.8v204.8H313.6V160zm396.8 704H313.6V620.8h396.8V864zM864 665.6c0 25.6-19.2 44.8-44.8 44.8h-44.8V588.8c0-17.067-14.933-32-32-32H281.6c-17.067 0-32 14.933-32 32v121.6h-44.8c-25.6 0-44.8-19.2-44.8-44.8v-192c0-25.6 19.2-44.8 44.8-44.8h614.4c25.6 0 44.8 19.2 44.8 44.8v192z"></path></svg></button></div><div class="toc-wrapper"><ul class="toc-list"><!--[--><li class="toc-item"><a class="vp-link toc-link level2 toc-link level2" href="/OpenShamrock/#配置选项">配置选项</a></li><li><ul class="toc-list"><!--[--><li class="toc-item"><a class="vp-link toc-link level3 toc-link level3" href="/OpenShamrock/#强制平板模式">强制平板模式</a></li><!----><!--]--></ul></li><!--]--><!--[--><li class="toc-item"><a class="vp-link toc-link level2 toc-link level2" href="/OpenShamrock/#目录定义">目录定义</a></li><!----><!--]--><!--[--><li class="toc-item"><a class="vp-link toc-link level2 toc-link level2" href="/OpenShamrock/#配置文件">配置文件</a></li><!----><!--]--><!--[--><li class="toc-item"><a class="vp-link toc-link level2 toc-link level2" href="/OpenShamrock/#websocket认证方法">WebSocket认证方法</a></li><!----><!--]--><!--[--><li class="toc-item"><a class="vp-link toc-link level2 toc-link level2" href="/OpenShamrock/#数据目录">数据目录</a></li><!----><!--]--></ul><div class="toc-marker" style="top:-1.7rem;"></div></div><!--[--><!----><!--]--></aside></div><!----><div class="theme-hope-content"><div class="hint-container tip"><p class="hint-container-title">提示</p><p><code>Shamrock</code> 提供了一个图形化的配置界面，可进行简单的配置操作。<br> 大部分配置简单易于理解，我们仅仅介绍部分难于理解的配置选项。</p></div><h2 id="配置选项" tabindex="-1"><a class="header-anchor" href="#配置选项" aria-hidden="true">#</a> 配置选项</h2><h3 id="强制平板模式" tabindex="-1"><a class="header-anchor" href="#强制平板模式" aria-hidden="true">#</a> 强制平板模式</h3><p>让 <code>QQ 客户端</code> 识别设备为平板，使其账号可在安卓和平板同时在线。</p><div class="hint-container tip"><p class="hint-container-title">提示</p><p>除了 <code>WebSocket</code> 相关功能，其他功能的配置进行修改立即生效，无需重新启动 <code>QQ</code> 。 不建议使用 <code>CQ 码</code>，因为在新一代机器人设计理念中，该操作过于落后，可能会出现许多问题。</p></div><div class="hint-container warning"><p class="hint-container-title">注意</p><p>被动 <code>WebSocket</code> 在断线之后，每隔 <code>5</code> 秒尝试重新连接。</p></div><h2 id="目录定义" tabindex="-1"><a class="header-anchor" href="#目录定义" aria-hidden="true">#</a> 目录定义</h2><ul><li>内部存储目录: <code>/storage/emulated/0</code> 或 <code>/sdcard</code></li><li><code>QQ</code> 主目录: <code>内部存储目录 + /Android/data/com.tencent.mobileqq</code></li><li><code>Shamrock</code> 主目录: <code>QQ主目录 + /Tencent/Shamrock</code></li></ul><h2 id="配置文件" tabindex="-1"><a class="header-anchor" href="#配置文件" aria-hidden="true">#</a> 配置文件</h2><p>将下方 <code>JSON</code> 文件创建在 <code>Shamrock 主目录 + /config.json</code><br> 请确保 <code>JSON</code> 格式正确。</p><div class="language-json5 line-numbers-mode" data-ext="json5"><pre class="language-json5"><code><span class="token punctuation">{</span>
<span class="token property unquoted">rules</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token property unquoted">group_rule</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token property unquoted">black_list</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token number">12345678</span><span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token comment">// 如果群号是`12345678`就跳过了哦！</span>
<span class="token property unquoted">white_list</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token punctuation">]</span>
<span class="token punctuation">}</span><span class="token punctuation">,</span>
<span class="token property unquoted">private_rule</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token property unquoted">black_list</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token number">12345678</span><span class="token punctuation">]</span><span class="token punctuation">,</span>
<span class="token property unquoted">white_list</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token punctuation">]</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span><span class="token punctuation">,</span>
<span class="token property unquoted">default_token</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span>
<span class="token property unquoted">active_websocket</span><span class="token operator">:</span> <span class="token punctuation">{</span>
<span class="token property unquoted">port</span><span class="token operator">:</span> <span class="token number">5800</span><span class="token punctuation">,</span> <span class="token comment">// 主动WS监听的端口</span>
<span class="token property unquoted">token</span><span class="token operator">:</span> <span class="token string">&#39;aaaa1111,bbbb1111&#39;</span><span class="token punctuation">,</span> <span class="token comment">// 同时允许两个token可使用|或,作为分割</span>
<span class="token property unquoted">tokens</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token string">&#39;aaaa1111&#39;</span><span class="token punctuation">,</span> <span class="token string">&#39;aaaa2222&#39;</span><span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token comment">// 使用tokens实现多token，优先级比上面那个高</span>
<span class="token property unquoted">heartbeat_interval</span><span class="token operator">:</span> <span class="token number">15000</span> <span class="token comment">// 设置为null则默认15000毫秒作为心跳间隔，0则为无心跳</span>
<span class="token punctuation">}</span><span class="token punctuation">,</span>
<span class="token property unquoted">passive_websocket</span><span class="token operator">:</span> <span class="token punctuation">[</span>
<span class="token punctuation">{</span>
<span class="token property unquoted">address</span><span class="token operator">:</span> <span class="token string">&#39;ws://xxxxxxxxx&#39;</span> <span class="token comment">// 这里是个例子，如果默认tk存在则使用默认token鉴权</span>
<span class="token punctuation">}</span><span class="token punctuation">,</span>
<span class="token punctuation">{</span>
<span class="token property unquoted">address</span><span class="token operator">:</span> <span class="token string">&#39;ws://aaaaaaaaa&#39;</span><span class="token punctuation">,</span>
<span class="token property unquoted">token</span><span class="token operator">:</span> <span class="token string">&#39;aaa666&#39;</span><span class="token punctuation">,</span> <span class="token comment">// 提供了特例化token，将不使用默认token</span>
<span class="token property unquoted">heartbeat_interval</span><span class="token operator">:</span> <span class="token number">15000</span> <span class="token comment">// 设置为null则默认15000毫秒作为心跳间隔，0则为无心跳</span>
<span class="token punctuation">}</span>
<span class="token punctuation">]</span><span class="token punctuation">,</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 class="line-number"></div></div></div><blockquote><p>2024-3：allow-temp-session已经在后续版本中去除，未来需要在你自己的接收端对消息来源进行拦截或处理</p></blockquote><table><thead><tr><th>参数名称</th><th>类型</th><th>作用</th><th>例子</th></tr></thead><tbody><tr><td><code>default_token</code></td><td><code>string</code></td><td>默认 <code>token</code> ，<strong>HTTP接口/主被动WS</strong> 如果未单独定义 <code>token</code> ，则使用默认 <code>token</code></td><td><code>aaa123456</code></td></tr></tbody></table><blockquote><p>记得把注释删掉哦？JSON5貌似也没有完全支持呢？该配置文件采用Json5标准！</p></blockquote><h2 id="websocket认证方法" tabindex="-1"><a class="header-anchor" href="#websocket认证方法" aria-hidden="true">#</a> WebSocket认证方法</h2><p>在 <code>HTTP Upgrade</code> 请求头中添加 <code>access_token</code> 或 <code>ticket</code> 或 <code>Authorization</code> 头</p><p>例：</p><div class="language-http line-numbers-mode" data-ext="http"><pre class="language-http"><code><span class="token request-line"><span class="token method property">GET</span> <span class="token request-target url">/</span> <span class="token http-version property">HTTP/1.1</span></span>
<span class="token header"><span class="token header-name keyword">Host</span><span class="token punctuation">:</span> <span class="token header-value">192.168.3.4</span></span>
<span class="token header"><span class="token header-name keyword">Upgrade</span><span class="token punctuation">:</span> <span class="token header-value">websocket</span></span>
<span class="token header"><span class="token header-name keyword">Connection</span><span class="token punctuation">:</span> <span class="token header-value">upgrade</span></span>
<span class="token header"><span class="token header-name keyword">Sec-WebSocket-Key</span><span class="token punctuation">:</span> <span class="token header-value">wwwwwwwwwwwwwwwwwwwwww==</span></span>
<span class="token header"><span class="token header-name keyword">Sec-WebSocket-Version</span><span class="token punctuation">:</span> <span class="token header-value">13</span></span>
<span class="token header"><span class="token header-name keyword">Authorization</span><span class="token punctuation">:</span> <span class="token header-value">aaaa1111</span></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></div><h2 id="数据目录" tabindex="-1"><a class="header-anchor" href="#数据目录" aria-hidden="true">#</a> 数据目录</h2><p>大部分 <code>Shamrock</code> 的数据/缓存保存在 <code>Shamrock 主目录</code><br> 其中的日志可作为 <code>Issue</code> 内容，截取部分提交。</p><div class="language-bash line-numbers-mode" data-ext="sh"><pre class="language-bash"><code><span class="token builtin class-name">.</span>
├── tmpfiles <span class="token comment"># 临时文件目录</span>
│ ├── logs <span class="token comment"># 日志目录</span>
│ │ └── xxx.log <span class="token comment"># 日志文件</span>
├── config.json <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></div></div><!----><footer class="page-meta"><div class="meta-item edit-link"><a href="https://github.com/whitechi73/OpenShamrock/edit/docs/docs/guide/configuration.md" rel="noopener noreferrer" target="_blank" aria-label="编辑此页" 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><!--]-->编辑此页<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><!--[--><!--[--><span class="contributor" title="email: 98259561+whitechi73@users.noreply.github.com">白池</span>,<!--]--><!--[--><span class="contributor" title="email: 24893075+tobycroft@users.noreply.github.com">Tuuz</span>,<!--]--><!--[--><span class="contributor" title="email: aleck099@outlook.com">aleck099</span>,<!--]--><!--[--><span class="contributor" title="email: 2564076459@qq.com">huan_kong</span>,<!--]--><!--[--><span class="contributor" title="email: callng@qq.com">owo233</span>,<!--]--><!--[--><span class="contributor" title="email: qgzhenxin@qq.com">真心</span><!--]--><!--]--></div></div></footer><nav class="vp-page-nav"><a aria-label="快速开始" class="vp-link nav-link prev nav-link prev" href="/OpenShamrock/guide/getting-started.html"><div class="hint"><span class="arrow start"></span>上一页</div><div class="link"><span class="font-icon icon fa-fw fa-sm fas fa-rocket" style=""></span>快速开始</div></a><a aria-label="常见问题" class="vp-link nav-link next nav-link next" href="/OpenShamrock/guide/faq.html"><div class="hint">下一页<span class="arrow end"></span></div><div class="link">常见问题<span class="font-icon icon fa-fw fa-sm fas fa-question-circle" style=""></span></div></a></nav><!----><!----><!--]--></main><!--]--><!----></div><!--]--><!--]--><!----><!----><!--]--></div>
<script type="module" src="/OpenShamrock/assets/app-e0095480.js" defer></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink