| <!doctype html> |
| <html lang="en" dir="ltr"> |
| <head> |
| <meta charset="UTF-8"> |
| <meta name="viewport" content="width=device-width,initial-scale=1"> |
| <meta name="generator" content="Docusaurus v2.0.0-beta.4"> |
| <link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Apache ShenYu Blog RSS Feed"> |
| <link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Apache ShenYu Blog Atom Feed"> |
| <link rel="search" type="application/opensearchdescription+xml" title="Apache ShenYu" href="/opensearch.xml"> |
| <link rel="alternate" type="application/rss+xml" href="/news/rss.xml" title="Apache ShenYu Blog RSS Feed"> |
| <link rel="alternate" type="application/atom+xml" href="/news/atom.xml" title="Apache ShenYu Blog Atom Feed"><title data-react-helmet="true">Admin Property Config | Apache ShenYu</title><meta data-react-helmet="true" property="og:url" content="https://shenyu.apache.org//docs/2.6.0/user-guide/property-config/admin-property-config"><meta data-react-helmet="true" name="docsearch:language" content="en"><meta data-react-helmet="true" name="docsearch:version" content="2.6.0"><meta data-react-helmet="true" name="docsearch:docusaurus_tag" content="docs-default-2.6.0"><meta data-react-helmet="true" property="og:title" content="Admin Property Config | Apache ShenYu"><meta data-react-helmet="true" name="description" content="Admin Property Config"><meta data-react-helmet="true" property="og:description" content="Admin Property Config"><meta data-react-helmet="true" name="keywords" content="Config"><link data-react-helmet="true" rel="shortcut icon" href="/img/favicon.svg"><link data-react-helmet="true" rel="canonical" href="https://shenyu.apache.org//docs/2.6.0/user-guide/property-config/admin-property-config"><link data-react-helmet="true" rel="alternate" href="https://shenyu.apache.org//docs/2.6.0/user-guide/property-config/admin-property-config" hreflang="en"><link data-react-helmet="true" rel="alternate" href="https://shenyu.apache.org//zh/docs/2.6.0/user-guide/property-config/admin-property-config" hreflang="zh"><link data-react-helmet="true" rel="alternate" href="https://shenyu.apache.org//docs/2.6.0/user-guide/property-config/admin-property-config" hreflang="x-default"><link data-react-helmet="true" rel="preconnect" href="https://BH4D9OD16A-dsn.algolia.net" crossorigin="anonymous"><link rel="stylesheet" href="/assets/css/styles.b6f9a199.css"> |
| <link rel="preload" href="/assets/js/runtime~main.490de106.js" as="script"> |
| <link rel="preload" href="/assets/js/main.cb386500.js" as="script"> |
| </head> |
| <body> |
| <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus"> |
| <div><a href="#" class="skipToContent_OuoZ">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Navigation bar toggle" class="navbar__toggle clean-btn" type="button" tabindex="0"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><img src="/img/logo.svg" alt="Apache ShenYu Logo" class="themedImage_TMUO themedImage--light_4Vu1 navbar__logo"><img src="/img/logo-light.svg" alt="Apache ShenYu Logo" class="themedImage_TMUO themedImage--dark_uzRr navbar__logo"></a></div><div class="navbar__items navbar__items--right"><a class="navbar__item navbar__link" href="/download">Download</a><a class="navbar__item navbar__link" href="/document">Docs</a><a class="navbar__item navbar__link" href="/community/contributor-guide">Community</a><a class="navbar__item navbar__link" href="/team">Team</a><a class="navbar__item navbar__link" href="/event">Event</a><a class="navbar__item navbar__link" href="/news">News</a><a class="navbar__item navbar__link" href="/blog">Blog</a><a class="navbar__item navbar__link" href="/users">Users</a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a class="navbar__item navbar__link">ASF</a><ul class="dropdown__menu"><li><a href="https://www.apache.org/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Foundation</a></li><li><a href="https://www.apache.org/licenses/" target="_blank" rel="noopener noreferrer" class="dropdown__link">License</a></li><li><a href="https://www.apache.org/events/current-event" target="_blank" rel="noopener noreferrer" class="dropdown__link">Events</a></li><li><a href="https://www.apache.org/security/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Security</a></li><li><a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Sponsorship</a></li><li><a href="https://www.apache.org/foundation/policies/privacy.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Privacy</a></li><li><a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Thanks</a></li></ul></div><a href="https://github.com/apache/shenyu" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link"><span>GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_wgqa"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" class="navbar__item navbar__link"><span><svg t="1631348384596" class="icon" viewBox="0 0 1024 1024" version="1.1" style="vertical-align:text-bottom;margin-right:5px" p-id="557" width="20" height="20"><path d="M547.797333 638.208l-104.405333-103.168 1.237333-1.28a720.170667 720.170667 0 0 0 152.490667-268.373333h120.448V183.082667h-287.744V100.906667H347.605333v82.218666H59.818667V265.386667h459.178666a648.234667 648.234667 0 0 1-130.304 219.946666 643.242667 643.242667 0 0 1-94.976-137.728H211.541333a722.048 722.048 0 0 0 122.453334 187.434667l-209.194667 206.378667 58.368 58.368 205.525333-205.525334 127.872 127.829334 31.232-83.84m231.424-208.426667h-82.218666l-184.96 493.312h82.218666l46.037334-123.306667h195.242666l46.464 123.306667h82.218667l-185.002667-493.312m-107.690666 287.744l66.56-178.005333 66.602666 178.005333z" fill="currentColor" p-id="558"></path></svg><span>English</span></span></a><ul class="dropdown__menu"><li><a href="/docs/2.6.0/user-guide/property-config/admin-property-config" target="_self" rel="noopener noreferrer" class="dropdown__link dropdown__link--active" style="text-transform:capitalize">English</a></li><li><a href="/zh/docs/2.6.0/user-guide/property-config/admin-property-config" target="_self" rel="noopener noreferrer" class="dropdown__link" style="text-transform:capitalize">简体中文</a></li></ul></div><div class="react-toggle toggle_2i4l react-toggle--disabled"><div class="react-toggle-track" role="button" tabindex="-1"><div class="react-toggle-track-check"><span class="toggle_iYfV">🌜</span></div><div class="react-toggle-track-x"><span class="toggle_iYfV">🌞</span></div><div class="react-toggle-thumb"></div></div><input type="checkbox" class="react-toggle-screenreader-only" aria-label="Switch between dark and light mode"></div><div class="searchBox_Bc3W"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20" aria-hidden="true"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div class="main-wrapper docs-wrapper doc-page"><div class="docPage_lDyR"><button class="clean-btn backToTopButton_i9tI" type="button" title="Scroll to top"><svg viewBox="0 0 24 24" width="28"><path d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z" fill="currentColor"></path></svg></button><aside class="docSidebarContainer_0YBq"><div class="sidebar_a3j0"><nav class="menu thin-scrollbar menu_cyFh menuWithAnnouncementBar_+O1J"><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/docs/2.6.0/index">Overview</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">Design</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">Deployment</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">Quick Start</a></li><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#">User Guide</a><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="0">Admin Usage</a></li><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#" tabindex="0">Property Config</a><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="menu__list-item"><a aria-current="page" class="menu__link menu__link--active active" tabindex="0" href="/docs/2.6.0/user-guide/property-config/admin-property-config">Admin Property Config</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/2.6.0/user-guide/property-config/client-property-config">Client Property Config</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/2.6.0/user-guide/property-config/gateway-property-config">Gateway Property Config</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/2.6.0/user-guide/property-config/register-center-access">Application Client Access Config</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/2.6.0/user-guide/property-config/register-center-instance">Register Center Instance Config</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/2.6.0/user-guide/property-config/use-data-sync">Data Synchronization Config</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="0">Shenyu-Sdk Usage</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="0">Quick Connect to Your Service</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="0">Kubernetes Controller</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="0">API Document Aggregation</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">Plugin Center</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">Developer</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">Benchmark Test</a></li></ul></nav></div></aside><main class="docMainContainer_r8cw"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_zHA2"><div class="alert alert--warning margin-bottom--md" role="alert"><div>This is documentation for Apache ShenYu <b>2.6.0</b>, which is no longer actively maintained.</div><div class="margin-top--md">For up-to-date documentation, see the <b><a href="/docs/user-guide/property-config/admin-property-config">latest version</a></b> (2.6.1).</div></div><div class="docItemContainer_oiyr"><article><span class="badge badge--secondary">Version: 2.6.0</span><div class="tocCollapsible_aw-L tocMobile_Tx6Y"><button type="button" class="clean-btn tocCollapsibleButton_zr6a">On this page</button></div><div class="markdown"><header><h1 class="h1Heading_dC7a">Admin Property Config</h1></header><p>This paper mainly explains how to configure Apache ShenYu properties on the admin side.</p><img src="/img/shenyu/config/shenyu_admin_application_config.png" width="80%" height="70%"><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="property-config"></a>Property Config<a class="hash-link" href="#property-config" title="Direct link to heading">#</a></h3><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI yaml"><pre tabindex="0" class="prism-code language-yaml codeBlock_rtdJ thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#393A34"><span class="token key atrule" style="color:#00a4db">shenyu</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">register</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">registerType</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> http </span><span class="token comment" style="color:#999988;font-style:italic">#http #zookeeper #etcd #nacos #consul</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">serverLists</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">#localhost:2181 #http://localhost:2379 #localhost:8848</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">props</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">sessionTimeout</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">5000</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">connectionTimeout</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2000</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">checked</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token boolean important" style="color:#36acaa">true</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">zombieCheckTimes</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">5</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">scheduledTime</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">10</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">nacosNameSpace</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> ShenyuRegisterCenter</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">sync</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">websocket</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">enabled</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token boolean important" style="color:#36acaa">true</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">messageMaxSize</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">10240</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">allowOrigins</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> ws</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain">//localhost</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain">9095;ws</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain">//localhost</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain">9195;</span></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic"># zookeeper:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic"># url: localhost:2181</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic"># sessionTimeout: 5000</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic"># connectionTimeout: 2000</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic"># http:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic"># enabled: true</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic"># nacos:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic"># url: localhost:8848</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic"># namespace: 1c10d748-af86-43b9-8265-75f487d20c6c</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic"># username:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic"># password:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic"># acm:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic"># enabled: false</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic"># endpoint: acm.aliyun.com</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic"># namespace:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic"># accessKey:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic"># secretKey:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic"># etcd:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic"># url: http://localhost:2379</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic"># consul:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic"># url: http://localhost:8500</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">aes</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">secret</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">key</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">2095132720951327</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">iv</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">6075877187097700</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">ldap</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">enabled</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token boolean important" style="color:#36acaa">false</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">url</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> ldap</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain">//xxxx</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain">xxx</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">bind-dn</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> cn=xxx</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain">dc=xxx</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain">dc=xxx</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">password</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> xxxx</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">base-dn</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> ou=xxx</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain">dc=xxx</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain">dc=xxx</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">object-class</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> person</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">login-field</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> cn</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">jwt</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">expired-seconds</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">86400000</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">shiro</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">white-list</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">-</span><span class="token plain"> /</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">-</span><span class="token plain"> /favicon.*</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">-</span><span class="token plain"> /static/</span><span class="token important">**</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">-</span><span class="token plain"> /index</span><span class="token important">**</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">-</span><span class="token plain"> /plugin</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">-</span><span class="token plain"> /platform/</span><span class="token important">**</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">-</span><span class="token plain"> /websocket</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">-</span><span class="token plain"> /configs/</span><span class="token important">**</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">-</span><span class="token plain"> /shenyu</span><span class="token punctuation" style="color:#393A34">-</span><span class="token plain">client/</span><span class="token important">**</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">-</span><span class="token plain"> /error</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">-</span><span class="token plain"> /actuator/health</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">-</span><span class="token plain"> /swagger</span><span class="token punctuation" style="color:#393A34">-</span><span class="token plain">ui.html</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">-</span><span class="token plain"> /webjars/</span><span class="token important">**</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">-</span><span class="token plain"> /swagger</span><span class="token punctuation" style="color:#393A34">-</span><span class="token plain">resources/</span><span class="token important">**</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">-</span><span class="token plain"> /v2/api</span><span class="token punctuation" style="color:#393A34">-</span><span class="token plain">docs</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">-</span><span class="token plain"> /csrf</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">swagger</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">enable</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token boolean important" style="color:#36acaa">true</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="property-detail"></a>Property Detail<a class="hash-link" href="#property-detail" title="Direct link to heading">#</a></h3><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="shenyuregister-config"></a>shenyu.register config<a class="hash-link" href="#shenyuregister-config" title="Direct link to heading">#</a></h5><p>This section describes configurations related to client access. For details about client access principles, see: <a href="/docs/2.6.0/design/register-center-design">Application Client Access</a> , for client access configuration, see: <a href="/docs/2.6.0/user-guide/property-config/docs/user-guide/property-config/register-center-access.md">Application Client Access Config</a> .</p><table><thead><tr><th align="left">Name</th><th align="left">Type</th><th align="center">Default</th><th align="center">Required</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">registerType</td><td align="left">String</td><td align="center">http</td><td align="center">Yes</td><td align="left">Which mode to use for registry. Currently, http, zookeeper, etcd, consul and nacos are supported.</td></tr><tr><td align="left">serverLists</td><td align="left">String</td><td align="center">null</td><td align="center">No</td><td align="left">Configure the address of the registry. If <code>http</code> is used, you do not need to enter this parameter. In clustering, multiple addresses are separated by commas (,).</td></tr><tr><td align="left">props</td><td align="left"></td><td align="center"></td><td align="center"></td><td align="left">The value of the property varies according to the registerType.</td></tr></tbody></table><ul><li><code>props</code> config</li></ul><p>The value of the attribute varies according to the registerType.</p><p>When the registerType is <code>http</code>, the supported properties are as follows.</p><table><thead><tr><th align="left">Name</th><th align="left">Type</th><th align="center">Default</th><th align="center">Required</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">checked</td><td align="left">boolean</td><td align="center">false</td><td align="center">No</td><td align="left">is checked</td></tr><tr><td align="left">zombieCheckTimes</td><td align="left">int</td><td align="center">5</td><td align="center">No</td><td align="left">how many times does it fail to detect the service.</td></tr><tr><td align="left">scheduledTime</td><td align="left">int</td><td align="center">10</td><td align="center">No</td><td align="left">timed detection interval time</td></tr></tbody></table><p>When the registerType is <code>zookeeper</code>, the supported properties are as follows.</p><table><thead><tr><th align="left">Name</th><th align="left">Type</th><th align="center">Default</th><th align="center">Required</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">sessionTimeout</td><td align="left">int</td><td align="center">30000</td><td align="center">No</td><td align="left">session timeout(millisecond)</td></tr><tr><td align="left">connectionTimeout</td><td align="left">int</td><td align="center">3000</td><td align="center">No</td><td align="left">connection timeout(millisecond)</td></tr></tbody></table><p>When the registerType is <code>etcd</code>, no properties are provided for the time being.</p><p>When the registerType is <code>nacos</code>, the supported properties are as follows.</p><table><thead><tr><th align="left">Name</th><th align="left">Type</th><th align="center">Default</th><th align="center">Required</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">nacosNameSpace</td><td align="left">String</td><td align="center">null</td><td align="center">Yes</td><td align="left">namespace</td></tr><tr><td align="left">username</td><td align="left">String</td><td align="center">""</td><td align="center">No</td><td align="left">username</td></tr><tr><td align="left">password</td><td align="left">String</td><td align="center">""</td><td align="center">No</td><td align="left">password</td></tr><tr><td align="left">accessKey</td><td align="left">String</td><td align="center">""</td><td align="center">No</td><td align="left">accessKey</td></tr><tr><td align="left">secretKey</td><td align="left">String</td><td align="center">""</td><td align="center">No</td><td align="left">secretKey</td></tr></tbody></table><p>When the registerType is <code>consul</code>, the supported properties are as follows.</p><table><thead><tr><th align="left">Name</th><th align="left">Type</th><th align="center">Default</th><th align="center">Required</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">delay</td><td align="left">int</td><td align="center">1</td><td align="center">No</td><td align="left">The interval of each polling of monitoring metadata, in seconds, the default value is 1 second.</td></tr><tr><td align="left">wait-time</td><td align="left">int</td><td align="center">55</td><td align="center">No</td><td align="left"># wait-time: The waiting time for each polling of metadata monitoring, in seconds, the default value is 55 second .</td></tr><tr><td align="left">metadata-path</td><td align="left">String</td><td align="center"><code>shenyu/register</code></td><td align="center">No</td><td align="left">Metadata path name, default is <code>shenyu/register</code>.</td></tr></tbody></table><p>When the registerType is <code>apollo</code>, the supported properties are as follows.</p><table><thead><tr><th align="left">Name</th><th align="left">Type</th><th align="center">Default</th><th align="center">Required</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">appId</td><td align="left">String</td><td align="center">null</td><td align="center">Yes</td><td align="left">Apollo appId</td></tr><tr><td align="left">namespace</td><td align="left">String</td><td align="center">null</td><td align="center">Yes</td><td align="left">Apollo namespace</td></tr><tr><td align="left">portalUrl</td><td align="left">String</td><td align="center">null</td><td align="center">Yes</td><td align="left">Apollo portalUrl</td></tr><tr><td align="left">env</td><td align="left">String</td><td align="center">null</td><td align="center">Yes</td><td align="left">Apollo env</td></tr><tr><td align="left">clusterName</td><td align="left">String</td><td align="center">null</td><td align="center">Yes</td><td align="left">Apollo clusterName</td></tr><tr><td align="left">token</td><td align="left">String</td><td align="center">null</td><td align="center">Yes</td><td align="left">Apollo token</td></tr></tbody></table><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="shenyusync-config"></a>shenyu.sync config<a class="hash-link" href="#shenyusync-config" title="Direct link to heading">#</a></h5><p>The Admin System and the Apache ShenYu gateway use data synchronization configurations.</p><p>The following properties are configured for data synchronization using <code>websocket</code> :</p><table><thead><tr><th align="left">Name</th><th align="left">Type</th><th align="center">Default</th><th align="center">Required</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">enabled</td><td align="left">boolean</td><td align="center">true</td><td align="center">No</td><td align="left">whether to enable websocket for data synchronization.</td></tr><tr><td align="left">messageMaxSize</td><td align="left">int</td><td align="center">0</td><td align="center">No</td><td align="left">Set the <code>websocket</code> max buffer size in bytes.</td></tr><tr><td align="left">allowOrigins</td><td align="left">String</td><td align="center">""</td><td align="center">No</td><td align="left">Set allowed <code>origins</code>, multiple parameters separated by <code>;</code>.</td></tr></tbody></table><p>The following properties are configured for data synchronization using <code>zookeeper</code> :</p><table><thead><tr><th align="left">Name</th><th align="left">Type</th><th align="center">Default</th><th align="center">Required</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">url</td><td align="left">String</td><td align="center">null</td><td align="center">Yes</td><td align="left">zookeeper server url</td></tr><tr><td align="left">sessionTimeout</td><td align="left">int</td><td align="center">null</td><td align="center">Yes</td><td align="left">session timeout(millisecond)</td></tr><tr><td align="left">connectionTimeout</td><td align="left">int</td><td align="center">null</td><td align="center">Yes</td><td align="left">connection timeout(millisecond)</td></tr></tbody></table><p>The following properties are configured for data synchronization using <code>http long polling</code> :</p><table><thead><tr><th align="left">Name</th><th align="left">Type</th><th align="center">Default</th><th align="center">Required</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">enabled</td><td align="left">boolean</td><td align="center">true</td><td align="center">No</td><td align="left">whether to enable.</td></tr><tr><td align="left">refreshInterval</td><td align="left">int</td><td align="center">5(minute)</td><td align="center">No</td><td align="left">Periodically fetch data from the database and load it into memory.</td></tr><tr><td align="left">notifyBatchSize</td><td align="left">int</td><td align="center">100</td><td align="center">No</td><td align="left">notify clients in batches</td></tr></tbody></table><p>The following properties are configured for data synchronization using <code>nacos</code> :</p><table><thead><tr><th align="left">Name</th><th align="left">Type</th><th align="center">Default</th><th align="center">Required</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">url</td><td align="left">String</td><td align="center">null</td><td align="center">是</td><td align="left">nacos url</td></tr><tr><td align="left">namespace</td><td align="left">String</td><td align="center">null</td><td align="center">Yes</td><td align="left">namespace</td></tr><tr><td align="left">username</td><td align="left">String</td><td align="center">null</td><td align="center">No</td><td align="left">username</td></tr><tr><td align="left">password</td><td align="left">String</td><td align="center">null</td><td align="center">No</td><td align="left">password</td></tr><tr><td align="left">acm</td><td align="left"></td><td align="center"></td><td align="center">No</td><td align="left">aliyun ACM service configuration</td></tr></tbody></table><ul><li><code>acm</code> config</li></ul><table><thead><tr><th align="left">Name</th><th align="left">Type</th><th align="center">Default</th><th align="center">Required</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">enabled</td><td align="left">boolean</td><td align="center">false</td><td align="center">No</td><td align="left">whether to enable</td></tr><tr><td align="left">endpoint</td><td align="left">String</td><td align="center">null</td><td align="center">No</td><td align="left">ACM service address</td></tr><tr><td align="left">namespace</td><td align="left">String</td><td align="center">null</td><td align="center">No</td><td align="left">namespace</td></tr><tr><td align="left">accessKey</td><td align="left">String</td><td align="center">null</td><td align="center">No</td><td align="left">accessKey</td></tr><tr><td align="left">secretKey</td><td align="left">String</td><td align="center">null</td><td align="center">No</td><td align="left">secretKey</td></tr></tbody></table><p>The following properties are configured for data synchronization using <code>etcd</code> :</p><table><thead><tr><th align="left">Name</th><th align="left">Type</th><th align="center">Default</th><th align="center">Required</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">url</td><td align="left">String</td><td align="center">null</td><td align="center">Yes</td><td align="left">etcd url</td></tr></tbody></table><p>The following properties are configured for data synchronization using <code>consul</code> :</p><table><thead><tr><th align="left">Name</th><th align="left">Type</th><th align="center">Default</th><th align="center">Required</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">url</td><td align="left">String</td><td align="center">null</td><td align="center">Yes</td><td align="left">consul url</td></tr></tbody></table><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="shenyuaessecret-config"></a>shenyu.aes.secret config<a class="hash-link" href="#shenyuaessecret-config" title="Direct link to heading">#</a></h5><p>aes secret properties:</p><table><thead><tr><th align="left">Name</th><th align="left">Type</th><th align="center">Default</th><th align="center">Required</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">key</td><td align="left">String</td><td align="center"><code>2095132720951327</code></td><td align="center">No</td><td align="left">key</td></tr><tr><td align="left">iv</td><td align="left">String</td><td align="center">null</td><td align="center">No</td><td align="left">iv</td></tr></tbody></table><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="shenyuldap-config"></a>shenyu.ldap config<a class="hash-link" href="#shenyuldap-config" title="Direct link to heading">#</a></h5><p>Spring ldap properties:</p><table><thead><tr><th align="left">Name</th><th align="left">Type</th><th align="center">Default</th><th align="center">Required</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">enabled</td><td align="left">boolean</td><td align="center">true</td><td align="center">No</td><td align="left">whether to enable</td></tr><tr><td align="left">url</td><td align="left">String</td><td align="center">null</td><td align="center">No</td><td align="left">ldap url</td></tr><tr><td align="left">bind-dn</td><td align="left">String</td><td align="center">null</td><td align="center">No</td><td align="left">UserDn</td></tr><tr><td align="left">password</td><td align="left">String</td><td align="center">null</td><td align="center">No</td><td align="left">password</td></tr><tr><td align="left">base-dn</td><td align="left">String</td><td align="center">null</td><td align="center">No</td><td align="left">searchBase</td></tr><tr><td align="left">object-class</td><td align="left">String</td><td align="center"><code>person</code></td><td align="center">No</td><td align="left">filter</td></tr><tr><td align="left">login-field</td><td align="left">String</td><td align="center"><code>cn</code></td><td align="center">No</td><td align="left">searchBase</td></tr><tr><td align="left">connectTimeout</td><td align="left">int</td><td align="center">3000</td><td align="center">No</td><td align="left">connect timeout(millisecond)</td></tr><tr><td align="left">readTimeout</td><td align="left">int</td><td align="center">3000</td><td align="center">No</td><td align="left">read timeout(millisecond)</td></tr></tbody></table><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="shenyujwt-config"></a>shenyu.jwt config<a class="hash-link" href="#shenyujwt-config" title="Direct link to heading">#</a></h5><p><code>jwt</code> properties:</p><table><thead><tr><th align="left">Name</th><th align="left">Type</th><th align="center">Default</th><th align="center">Required</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">expired-seconds</td><td align="left">long</td><td align="center">24 <em>60</em> 60 * 1000L</td><td align="center">No</td><td align="left">expiration time(millisecond)</td></tr></tbody></table><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="shenyushiro-config"></a>shenyu.shiro config<a class="hash-link" href="#shenyushiro-config" title="Direct link to heading">#</a></h5><p><code>shiro</code> properties:</p><table><thead><tr><th align="left">Name</th><th align="left">Type</th><th align="center">Default</th><th align="center">Required</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">white-list</td><td align="left">List</td><td align="center">null</td><td align="center">No</td><td align="left">white list</td></tr></tbody></table></div><footer class="row docusaurus-mt-lg"><div class="col"><a href="https://github.com/apache/shenyu-website/edit/main/versioned_docs/version-2.6.0/user-guide/property-config/admin-property-config.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_mS5F" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_wj+Z"></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/docs/2.6.0/user-guide/admin-usage/selector-and-rule"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">« Selector And Rule Config</div></a></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/docs/2.6.0/user-guide/property-config/client-property-config"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Client Property Config »</div></a></div></nav></div></div><div class="col col--3"><div class="tableOfContents_vrFS thin-scrollbar"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#property-config" class="table-of-contents__link">Property Config</a></li><li><a href="#property-detail" class="table-of-contents__link">Property Detail</a></li></ul></div></div></div></div></main></div></div></div> |
| <script src="/assets/js/runtime~main.490de106.js"></script> |
| <script src="/assets/js/main.cb386500.js"></script> |
| </body> |
| </html> |
