mirror of
https://github.com/pterodactyl/documentation.git
synced 2025-12-10 10:44:43 -06:00
68 lines
26 KiB
HTML
68 lines
26 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en-US">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
<title>Additional Configuration | Pterodactyl</title>
|
|
<meta name="generator" content="VuePress 1.8.2">
|
|
<link rel="apple-touch-icon" sizes="180x180" href="/favicons/apple-touch-icon.png">
|
|
<link rel="icon" type="image/png" href="/favicons/favicon-32x32.png" sizes="32x32">
|
|
<link rel="icon" type="image/png" href="/favicons/favicon-16x16.png" sizes="16x16">
|
|
<link rel="mask-icon" href="/favicons/safari-pinned-tab.svg" color="#0e4688">
|
|
<link rel="manifest" href="/favicons/site.webmanifest">
|
|
<link rel="shortcut icon" href="/favicons/favicon.ico">
|
|
<meta name="description" content="Pterodactyl is an open-source game server management panel built with PHP 7, React, and Go. Designed with security in mind, Pterodactyl runs all game servers in isolated Docker containers while exposing a beautiful and intuitive UI to end users.">
|
|
<meta name="msapplication-config" content="/favicons/browserconfig.xml">
|
|
<meta name="theme-color" content="#0e4688">
|
|
|
|
<link rel="preload" href="/assets/css/0.styles.b4cb0fef.css" as="style"><link rel="preload" href="/assets/js/app.edb9b012.js" as="script"><link rel="preload" href="/assets/js/4.9dfb277d.js" as="script"><link rel="preload" href="/assets/js/1.d0c981d7.js" as="script"><link rel="preload" href="/assets/js/77.9dcea1bf.js" as="script"><link rel="prefetch" href="/assets/js/10.27cec751.js"><link rel="prefetch" href="/assets/js/11.53217705.js"><link rel="prefetch" href="/assets/js/12.9bbfc2f6.js"><link rel="prefetch" href="/assets/js/13.bd04c4ec.js"><link rel="prefetch" href="/assets/js/14.2e96f1b8.js"><link rel="prefetch" href="/assets/js/15.a6802091.js"><link rel="prefetch" href="/assets/js/16.f2dea920.js"><link rel="prefetch" href="/assets/js/17.67e35315.js"><link rel="prefetch" href="/assets/js/18.fcb158a9.js"><link rel="prefetch" href="/assets/js/19.bb80f931.js"><link rel="prefetch" href="/assets/js/2.21e1a937.js"><link rel="prefetch" href="/assets/js/20.d065b2c5.js"><link rel="prefetch" href="/assets/js/21.abae94a8.js"><link rel="prefetch" href="/assets/js/22.3ff292b3.js"><link rel="prefetch" href="/assets/js/23.6b778859.js"><link rel="prefetch" href="/assets/js/24.18e132d5.js"><link rel="prefetch" href="/assets/js/25.5a8ed612.js"><link rel="prefetch" href="/assets/js/26.0b63e77f.js"><link rel="prefetch" href="/assets/js/27.0711df74.js"><link rel="prefetch" href="/assets/js/28.17b33d85.js"><link rel="prefetch" href="/assets/js/29.9c25f524.js"><link rel="prefetch" href="/assets/js/30.34c4472a.js"><link rel="prefetch" href="/assets/js/31.4a35c00f.js"><link rel="prefetch" href="/assets/js/32.d98a3373.js"><link rel="prefetch" href="/assets/js/33.88a8819c.js"><link rel="prefetch" href="/assets/js/34.0edc39f4.js"><link rel="prefetch" href="/assets/js/35.969d92c8.js"><link rel="prefetch" href="/assets/js/36.49b831e2.js"><link rel="prefetch" href="/assets/js/37.46d8127b.js"><link rel="prefetch" href="/assets/js/38.9d9c367c.js"><link rel="prefetch" href="/assets/js/39.4e9577b6.js"><link rel="prefetch" href="/assets/js/40.273f9b41.js"><link rel="prefetch" href="/assets/js/41.32790d14.js"><link rel="prefetch" href="/assets/js/42.d9689e6d.js"><link rel="prefetch" href="/assets/js/43.9992155a.js"><link rel="prefetch" href="/assets/js/44.e7f6dd0e.js"><link rel="prefetch" href="/assets/js/45.32b9b890.js"><link rel="prefetch" href="/assets/js/46.c04b0749.js"><link rel="prefetch" href="/assets/js/47.8a528b5d.js"><link rel="prefetch" href="/assets/js/48.0bb564a9.js"><link rel="prefetch" href="/assets/js/49.70313a9d.js"><link rel="prefetch" href="/assets/js/5.73a53d7a.js"><link rel="prefetch" href="/assets/js/50.6b4f4718.js"><link rel="prefetch" href="/assets/js/51.75e9c6d8.js"><link rel="prefetch" href="/assets/js/52.5803bd20.js"><link rel="prefetch" href="/assets/js/53.c0284790.js"><link rel="prefetch" href="/assets/js/54.14aa3f16.js"><link rel="prefetch" href="/assets/js/55.4e7ca13f.js"><link rel="prefetch" href="/assets/js/56.cbbea30d.js"><link rel="prefetch" href="/assets/js/57.b9237770.js"><link rel="prefetch" href="/assets/js/58.df220808.js"><link rel="prefetch" href="/assets/js/59.06f08aee.js"><link rel="prefetch" href="/assets/js/6.8999fd8a.js"><link rel="prefetch" href="/assets/js/60.a3853cbe.js"><link rel="prefetch" href="/assets/js/61.360ebc59.js"><link rel="prefetch" href="/assets/js/62.db0d6812.js"><link rel="prefetch" href="/assets/js/63.8a89fed0.js"><link rel="prefetch" href="/assets/js/64.8fe43c5c.js"><link rel="prefetch" href="/assets/js/65.d4df1bb2.js"><link rel="prefetch" href="/assets/js/66.6cb57e40.js"><link rel="prefetch" href="/assets/js/67.cc039676.js"><link rel="prefetch" href="/assets/js/68.0031d838.js"><link rel="prefetch" href="/assets/js/69.74d5f183.js"><link rel="prefetch" href="/assets/js/7.9f1ce256.js"><link rel="prefetch" href="/assets/js/70.bd64671b.js"><link rel="prefetch" href="/assets/js/71.f94f8363.js"><link rel="prefetch" href="/assets/js/72.be219eed.js"><link rel="prefetch" href="/assets/js/73.11b803e4.js"><link rel="prefetch" href="/assets/js/74.282a4100.js"><link rel="prefetch" href="/assets/js/75.7fd29139.js"><link rel="prefetch" href="/assets/js/76.52a50904.js"><link rel="prefetch" href="/assets/js/78.36c13dcb.js"><link rel="prefetch" href="/assets/js/8.4c71898e.js"><link rel="prefetch" href="/assets/js/9.7af626f7.js">
|
|
<link rel="stylesheet" href="/assets/css/0.styles.b4cb0fef.css">
|
|
</head>
|
|
<body>
|
|
<div id="app" data-server-rendered="true"><div class="theme-container"><header class="nav"><div class="sidebar-button block md:hidden flex-no-shrink"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <div class="logo-container"><a href="/" class="home-link router-link-active"><img src="/logos/pterry.svg" class="logo"> <span class="site-name hidden md:inline can-hide">Pterodactyl</span></a></div> <div class="w-full"><div class="flex"><div class="search-box"><input aria-label="Search" placeholder="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links flex-no-shrink hidden md:flex"><div class="nav-item"><a href="/project/introduction.html" class="nav-link">Documentation
|
|
</a></div><div class="nav-item"><a href="/community/about.html" class="nav-link">Community Guides
|
|
</a></div><div class="nav-item"><a href="https://discord.gg/pterodactyl" target="_blank" rel="noopener noreferrer" class="nav-link external">
|
|
Get Help
|
|
<span><svg 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" class="icon outbound"><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="sr-only">(opens new window)</span></span></a></div><div class="nav-item"><a href="https://dashflo.net/docs/api/pterodactyl/v1/" target="_blank" rel="noopener noreferrer" class="nav-link external">
|
|
API
|
|
<span><svg 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" class="icon outbound"><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="sr-only">(opens new window)</span></span></a></div> <div class="nav-item"><a href="https://github.com/pterodactyl/panel" target="_blank" rel="noopener noreferrer" class="nav-link">
|
|
Contribute
|
|
<span><svg 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" class="icon outbound"><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="sr-only">(opens new window)</span></span></a></div></nav></div></div></header> <div class="sidebar-mask"></div> <div class="sidebar"><nav class="nav-links flex-no-shrink block md:hidden"><div class="nav-item"><a href="/project/introduction.html" class="nav-link">Documentation
|
|
</a></div><div class="nav-item"><a href="/community/about.html" class="nav-link">Community Guides
|
|
</a></div><div class="nav-item"><a href="https://discord.gg/pterodactyl" target="_blank" rel="noopener noreferrer" class="nav-link external">
|
|
Get Help
|
|
<span><svg 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" class="icon outbound"><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="sr-only">(opens new window)</span></span></a></div><div class="nav-item"><a href="https://dashflo.net/docs/api/pterodactyl/v1/" target="_blank" rel="noopener noreferrer" class="nav-link external">
|
|
API
|
|
<span><svg 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" class="icon outbound"><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="sr-only">(opens new window)</span></span></a></div> <div class="nav-item"><a href="https://github.com/pterodactyl/panel" target="_blank" rel="noopener noreferrer" class="nav-link">
|
|
Contribute
|
|
<span><svg 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" class="icon outbound"><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="sr-only">(opens new window)</span></span></a></div></nav> <ul class="sidebar-links"><li><div class="sidebar-group first"><p class="sidebar-heading open"><span>Project Information</span> <!----> <!----></p> <ul class="sidebar-group-items"><li><a href="/project/introduction.html" class="sidebar-link">Introduction</a></li><li><a href="/project/about.html" class="sidebar-link">About</a></li><li><a href="/project/terms.html" class="sidebar-link">Terminology</a></li><li><a href="/project/community.html" class="sidebar-link">Community Standards</a></li></ul></div></li><li><div class="sidebar-group"><p class="sidebar-heading"><span>Panel</span> <!----> <div tabindex="0" class="version-select custom-select float-right"><div class="selected"><div class="inline-block">
|
|
1.3
|
|
<span class="rounded-full ml-2 text-green-dark">current</span></div> <span class="arrow"></span></div> <div class="items hidden"><div class="item"><div class="inline-block">
|
|
1.3
|
|
<span class="rounded-full ml-2 text-green-dark">current</span></div></div></div></div></p> <ul class="sidebar-group-items"><li><a href="/panel/1.0/getting_started.html" class="sidebar-link">Getting Started</a></li><li><a href="/panel/1.0/webserver_configuration.html" class="sidebar-link">Webserver Configuration</a></li><li><a href="/panel/1.0/additional_configuration.html" class="sidebar-link">Additional Configuration</a></li><li><a href="/panel/1.0/updating.html" class="sidebar-link">Updating the Panel</a></li><li><a href="/panel/1.0/troubleshooting.html" class="sidebar-link">Troubleshooting</a></li><li><a href="/panel/1.0/legacy_upgrade.html" class="sidebar-link">Legacy Upgrades</a></li></ul></div></li><li><div class="sidebar-group"><p class="sidebar-heading"><span>Wings</span> <!----> <div tabindex="0" class="version-select custom-select float-right"><div class="selected"><div class="inline-block">
|
|
1.3
|
|
<span class="rounded-full ml-2 text-green-dark">current</span></div> <span class="arrow"></span></div> <div class="items hidden"><div class="item"><div class="inline-block">
|
|
1.3
|
|
<span class="rounded-full ml-2 text-green-dark">current</span></div></div></div></div></p> <ul class="sidebar-group-items"><li><a href="/wings/1.0/installing.html" class="sidebar-link">Installing Wings</a></li><li><a href="/wings/1.0/upgrading.html" class="sidebar-link">Upgrading Wings</a></li><li><a href="/wings/1.0/migrating.html" class="sidebar-link">Migrating to Wings</a></li><li><a href="/wings/1.0/configuration.html" aria-current="page" class="active sidebar-link">Additional Configuration</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/wings/1.0/configuration.html#private-registries" class="sidebar-link">Private Registries</a></li><li class="sidebar-sub-header"><a href="/wings/1.0/configuration.html#custom-network-interfaces" class="sidebar-link">Custom Network Interfaces</a></li><li class="sidebar-sub-header"><a href="/wings/1.0/configuration.html#enabling-cloudflare-proxy" class="sidebar-link">Enabling Cloudflare proxy</a></li><li class="sidebar-sub-header"><a href="/wings/1.0/configuration.html#throttles-limits" class="sidebar-link">Throttles Limits</a></li><li class="sidebar-sub-header"><a href="/wings/1.0/configuration.html#other-values" class="sidebar-link">Other values</a></li></ul></li></ul></div></li><li><div class="sidebar-group"><p class="sidebar-heading"><span>Tutorials</span> <!----> <!----></p> <ul class="sidebar-group-items"><li><a href="/tutorials/mysql_setup.html" class="sidebar-link">Setting up MySQL</a></li><li><a href="/tutorials/creating_ssl_certificates.html" class="sidebar-link">Creating SSL Certificates</a></li></ul></div></li><li><div class="sidebar-group"><p class="sidebar-heading"><span>Guides</span> <!----> <!----></p> <ul class="sidebar-group-items"><li><a href="/guides/mounts.html" class="sidebar-link">Using Mounts</a></li></ul></div></li><li><div class="sidebar-group collapsable"><p class="sidebar-heading"><span>Development & Ops</span> <span class="arrow right"></span> <!----></p> <!----></div></li></ul> </div> <div class="page"> <div class="content content__default"><h1 id="additional-configuration"><a href="#additional-configuration" class="header-anchor">#</a> Additional Configuration</h1> <p></p><div class="table-of-contents"><ul><li><a href="#private-registries">Private Registries</a><ul><li><a href="#available-keys">Available Keys</a></li><li><a href="#example-of-usage">Example of usage</a></li></ul></li><li><a href="#custom-network-interfaces">Custom Network Interfaces</a><ul><li><a href="#example-of-usage">Example of usage</a></li></ul></li><li><a href="#enabling-cloudflare-proxy">Enabling Cloudflare proxy</a></li><li><a href="#throttles-limits">Throttles Limits</a><ul><li><a href="#example-of-usage">Example of usage</a></li></ul></li><li><a href="#other-values">Other values</a></li></ul></div><p></p> <div class="custom-block warning"><p class="custom-block-title">WARNING</p> <p>These are advanced configurations for Wings. You risk breaking Wings and making containers unusable if
|
|
you misconfigure something. Proceed only if you know what each configuration value does.</p></div> <p>You must apply all changes to your Wings <code>config.yml</code> file located at <code>/etc/pterodactyl</code>. Verify your config file using <a href="http://www.yamllint.com/" target="_blank" rel="noopener noreferrer">Yaml Lint<span><svg 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" class="icon outbound"><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="sr-only">(opens new window)</span></span></a> should you receive errors related to YAML parsing.</p> <h2 id="private-registries"><a href="#private-registries" class="header-anchor">#</a> Private Registries</h2> <p>You can use these settings to authenticate against (private) docker registries when pulling images.</p> <h3 id="available-keys"><a href="#available-keys" class="header-anchor">#</a> Available Keys</h3> <table><thead><tr><th>Setting Key</th> <th style="text-align:center;">Default Value</th> <th>Notes</th></tr></thead> <tbody><tr><td>name</td> <td style="text-align:center;">null</td> <td>Registry address</td></tr> <tr><td>username</td> <td style="text-align:center;">null</td> <td>Registry username</td></tr> <tr><td>password</td> <td style="text-align:center;">null</td> <td>Registry password</td></tr></tbody></table> <h3 id="example-of-usage"><a href="#example-of-usage" class="header-anchor">#</a> Example of usage</h3> <div class="language-yml extra-class"><pre class="language-yml"><code><span class="token key atrule">docker</span><span class="token punctuation">:</span>
|
|
<span class="token key atrule">registries</span><span class="token punctuation">:</span>
|
|
<span class="token key atrule">registry.example.com</span><span class="token punctuation">:</span>
|
|
<span class="token key atrule">username</span><span class="token punctuation">:</span> <span class="token string">"registryusername"</span>
|
|
<span class="token key atrule">password</span><span class="token punctuation">:</span> <span class="token string">"registrypassword"</span>
|
|
</code></pre></div><h2 id="custom-network-interfaces"><a href="#custom-network-interfaces" class="header-anchor">#</a> Custom Network Interfaces</h2> <p>You can change the network interface that Wings uses for all containers by editing the network name; it is by default set to <code>pterodactyl_nw</code>. For example, to enable Docker host mode change the network name to <code>host</code>.</p> <div class="custom-block warning"><p class="custom-block-title">WARNING</p> <p>Changing network mode to <code>host</code> grants Pterodactyl direct access to all machine interfaces and Panel users can bind to any IP or Port even if it's not allocated to their container. You will lose all benefits of Docker network isolation. It is not recommended for public installations that are hosting other users' servers.</p></div> <h3 id="example-of-usage-2"><a href="#example-of-usage-2" class="header-anchor">#</a> Example of usage</h3> <div class="language-yml extra-class"><pre class="language-yml"><code><span class="token key atrule">docker</span><span class="token punctuation">:</span>
|
|
<span class="token key atrule">network</span><span class="token punctuation">:</span>
|
|
<span class="token key atrule">name</span><span class="token punctuation">:</span> host
|
|
<span class="token key atrule">network_mode</span><span class="token punctuation">:</span> host
|
|
</code></pre></div><p>After making changes, the following commands will stop the Wings, remove the Pterodactyl network, and start the Wings again. Run at your own risk.
|
|
<code>systemctl stop wings && docker network rm pterodactyl_nw && systemctl start wings</code></p> <h2 id="enabling-cloudflare-proxy"><a href="#enabling-cloudflare-proxy" class="header-anchor">#</a> Enabling Cloudflare proxy</h2> <p>Cloudflare proxying of the Wings isn't beneficial since users will be connecting to the machine directly and bypassing any Cloudflare protection. As such, your Node machine IP will still be exposed.</p> <p>To enable Cloudflare proxy, you must change the Wings port to one of the Cloudflare HTTPS ports, such as 8443, because Cloudflare only supports HTTP on port 8080. Select your Node in the Admin Panel, and on the settings tab, change the port.</p> <p>You are unable to proxy the SFTP port through Cloudflare unless you have their enterprise plan.</p> <h2 id="throttles-limits"><a href="#throttles-limits" class="header-anchor">#</a> Throttles Limits</h2> <p>You can use these settings to adjust or completely disable throttling.</p> <table><thead><tr><th style="text-align:left;">Setting Key</th> <th style="text-align:center;">Default Value</th> <th>Notes</th></tr></thead> <tbody><tr><td style="text-align:left;">enabled</td> <td style="text-align:center;">true</td> <td>Whether or not the throttler is enabled</td></tr> <tr><td style="text-align:left;">lines</td> <td style="text-align:center;">2000</td> <td>Total lines that can be output in a given line_reset_interval period</td></tr> <tr><td style="text-align:left;">maximum_trigger_count</td> <td style="text-align:center;">5</td> <td>Amount of times throttle limit can be triggered before the server will be stopped</td></tr> <tr><td style="text-align:left;">line_reset_interval</td> <td style="text-align:center;">100</td> <td>The amount of time after which the number of lines processed is reset to 0</td></tr> <tr><td style="text-align:left;">decay_interval</td> <td style="text-align:center;">10000</td> <td>Time in milliseconds that must pass without triggering throttle limit before trigger count is decremented</td></tr> <tr><td style="text-align:left;">stop_grace_period</td> <td style="text-align:center;">15</td> <td>Time that a server is allowed to be stopping for before it is terminated forcefully if it triggers output throttle</td></tr> <tr><td style="text-align:left;">write_limit</td> <td style="text-align:center;">0</td> <td>Impose I/O write limit for backups to the disk, 0 = unlimited. Value greater than 0 throttles write speed to the set value in MiB/s</td></tr> <tr><td style="text-align:left;">download_limit</td> <td style="text-align:center;">0</td> <td>Impose a Network I/O read limit for archives, 0 = unlimited. Value greater than 0 throttles read speed to the set value in MiB/s.</td></tr></tbody></table> <h3 id="example-of-usage-3"><a href="#example-of-usage-3" class="header-anchor">#</a> Example of usage</h3> <div class="language-yml extra-class"><pre class="language-yml"><code><span class="token key atrule">throttles</span><span class="token punctuation">:</span>
|
|
<span class="token key atrule">enabled</span><span class="token punctuation">:</span> <span class="token boolean important">true</span>
|
|
<span class="token key atrule">lines</span><span class="token punctuation">:</span> <span class="token number">2000</span>
|
|
<span class="token key atrule">maximum_trigger_count</span><span class="token punctuation">:</span> <span class="token number">5</span>
|
|
<span class="token key atrule">line_reset_interval</span><span class="token punctuation">:</span> <span class="token number">100</span>
|
|
<span class="token key atrule">decay_interval</span><span class="token punctuation">:</span> <span class="token number">10000</span>
|
|
<span class="token key atrule">stop_grace_period</span><span class="token punctuation">:</span> <span class="token number">15</span>
|
|
</code></pre></div><h2 id="other-values"><a href="#other-values" class="header-anchor">#</a> Other values</h2> <p>More commonly discussed values. View all Wings config values and explanations in <a href="https://github.com/pterodactyl/wings/tree/develop/config" target="_blank" rel="noopener noreferrer">these two files.<span><svg 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" class="icon outbound"><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="sr-only">(opens new window)</span></span></a></p> <table><thead><tr><th>Setting Key</th> <th style="text-align:center;">Default Value</th> <th>Notes</th></tr></thead> <tbody><tr><td>debug</td> <td style="text-align:center;">false</td> <td>Force Wings to run in debug mode</td></tr> <tr><td>tmpfs_size</td> <td style="text-align:center;">100</td> <td>The size of the /tmp directory in MB when mounted into a container</td></tr> <tr><td>websocket_log_count</td> <td style="text-align:center;">150</td> <td>The number of lines to display in the console</td></tr> <tr><td>detect_clean_exit_as_crash</td> <td style="text-align:center;">true</td> <td>Mark server as crashed if it's stopped without user interaction, e.g., not pressing stop button</td></tr> <tr><td>(crash detection) timeout</td> <td style="text-align:center;">60</td> <td>Timeout between server crashes that will not cause the server to be automatically restarted</td></tr> <tr><td>app_name</td> <td style="text-align:center;">"Pterodactyl"</td> <td>Changes the name of the daemon, shown in the panel's game console</td></tr></tbody></table></div> <div class="page-edit"><div class="edit-link"><a href="https://github.com/pterodactyl/documentation/edit/master/wings/1.0/configuration.md" target="_blank" rel="noopener noreferrer">Help us improve this page.</a> <span><svg 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" class="icon outbound"><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="sr-only">(opens new window)</span></span></div> <!----></div> <!----> </div></div><div class="global-ui"></div></div>
|
|
<script src="/assets/js/app.edb9b012.js" defer></script><script src="/assets/js/4.9dfb277d.js" defer></script><script src="/assets/js/1.d0c981d7.js" defer></script><script src="/assets/js/77.9dcea1bf.js" defer></script>
|
|
</body>
|
|
</html>
|