documentation/panel/1.0/additional_configuration.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, 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.b3d0dfa6.css" as="style"><link rel="preload" href="/assets/js/app.e5d692cc.js" as="script"><link rel="preload" href="/assets/js/4.c34bdd00.js" as="script"><link rel="preload" href="/assets/js/1.19e16341.js" as="script"><link rel="preload" href="/assets/js/63.2fe954fd.js" as="script"><link rel="prefetch" href="/assets/js/10.cdd4a61d.js"><link rel="prefetch" href="/assets/js/11.edf57bce.js"><link rel="prefetch" href="/assets/js/12.70f651d9.js"><link rel="prefetch" href="/assets/js/13.bd04c4ec.js"><link rel="prefetch" href="/assets/js/14.574fe6a2.js"><link rel="prefetch" href="/assets/js/15.e88515bc.js"><link rel="prefetch" href="/assets/js/16.24317aa9.js"><link rel="prefetch" href="/assets/js/17.99a727ea.js"><link rel="prefetch" href="/assets/js/18.fcb158a9.js"><link rel="prefetch" href="/assets/js/19.5c29a0ca.js"><link rel="prefetch" href="/assets/js/2.21e1a937.js"><link rel="prefetch" href="/assets/js/20.e4bdca81.js"><link rel="prefetch" href="/assets/js/21.aba75f57.js"><link rel="prefetch" href="/assets/js/22.e3d1f582.js"><link rel="prefetch" href="/assets/js/23.2e2e0abb.js"><link rel="prefetch" href="/assets/js/24.cef1e6d4.js"><link rel="prefetch" href="/assets/js/25.0d90b696.js"><link rel="prefetch" href="/assets/js/26.199e42e5.js"><link rel="prefetch" href="/assets/js/27.53b2955f.js"><link rel="prefetch" href="/assets/js/28.b1cca863.js"><link rel="prefetch" href="/assets/js/29.34880c0e.js"><link rel="prefetch" href="/assets/js/30.6cc47499.js"><link rel="prefetch" href="/assets/js/31.db5aa011.js"><link rel="prefetch" href="/assets/js/32.d21489df.js"><link rel="prefetch" href="/assets/js/33.1a1ebdff.js"><link rel="prefetch" href="/assets/js/34.f044669f.js"><link rel="prefetch" href="/assets/js/35.92028599.js"><link rel="prefetch" href="/assets/js/36.e7b7e83e.js"><link rel="prefetch" href="/assets/js/37.c5e4e1df.js"><link rel="prefetch" href="/assets/js/38.b5b4f5ac.js"><link rel="prefetch" href="/assets/js/39.582c9238.js"><link rel="prefetch" href="/assets/js/40.7ac7df6e.js"><link rel="prefetch" href="/assets/js/41.d1176c80.js"><link rel="prefetch" href="/assets/js/42.42b795d0.js"><link rel="prefetch" href="/assets/js/43.87824034.js"><link rel="prefetch" href="/assets/js/44.73bec5d3.js"><link rel="prefetch" href="/assets/js/45.d370a0c3.js"><link rel="prefetch" href="/assets/js/46.7e0f2b72.js"><link rel="prefetch" href="/assets/js/47.e804c12a.js"><link rel="prefetch" href="/assets/js/48.28d35671.js"><link rel="prefetch" href="/assets/js/49.3bc646ce.js"><link rel="prefetch" href="/assets/js/5.2366f5e0.js"><link rel="prefetch" href="/assets/js/50.72a8a2f1.js"><link rel="prefetch" href="/assets/js/51.c78b748d.js"><link rel="prefetch" href="/assets/js/52.c69a9cce.js"><link rel="prefetch" href="/assets/js/53.9c3cab69.js"><link rel="prefetch" href="/assets/js/54.5fed4f57.js"><link rel="prefetch" href="/assets/js/55.398d2689.js"><link rel="prefetch" href="/assets/js/56.206b0ab1.js"><link rel="prefetch" href="/assets/js/57.fdfaf056.js"><link rel="prefetch" href="/assets/js/58.9cc1b910.js"><link rel="prefetch" href="/assets/js/59.443c58f6.js"><link rel="prefetch" href="/assets/js/6.92501184.js"><link rel="prefetch" href="/assets/js/60.f253682c.js"><link rel="prefetch" href="/assets/js/61.e1b2bc1e.js"><link rel="prefetch" href="/assets/js/62.b082266a.js"><link rel="prefetch" href="/assets/js/64.0dffd897.js"><link rel="prefetch" href="/assets/js/65.98dc8be8.js"><link rel="prefetch" href="/assets/js/66.74f688e5.js"><link rel="prefetch" href="/assets/js/67.45d379df.js"><link rel="prefetch" href="/assets/js/68.ff8298fd.js"><link rel="prefetch" href="/assets/js/69.145d59c4.js"><link rel="prefetch" href="/assets/js/7.c41300e2.js"><link rel="prefetch" href="/assets/js/70.3ecf8a31.js"><link rel="prefetch" href="/assets/js/71.6b549e82.js"><link rel="prefetch" href="/assets/js/72.95e9bf6c.js"><link rel="prefetch" href="/assets/js/73.880125ed.js"><link rel="prefetch" href="/assets/js/74.7f4bdb91.js"><link rel="prefetch" href="/assets/js/75.b97c5e9c.js"><link rel="prefetch" href="/assets/js/8.324a951f.js"><link rel="prefetch" href="/assets/js/9.28a16f41.js">
    <link rel="stylesheet" href="/assets/css/0.styles.b3d0dfa6.css">
  </head>
  <body>
    <div id="app" data-server-rendered="true"><div><div class="fixed h-12 w-full z-50 top-0"><div class="h-12 w-full bg-black flex items-center justify-center px-4"><p class="text-grey-lightest font-semibold">
        Stand with Ukraine 🇺🇦
        <a href="https://www.savethechildren.org/us/where-we-work/ukraine" target="_blank" rel="noindex nofollow noopener" class="text-blue-lighter">Donate</a> <a href="https://razomforukraine.org/" target="_blank" rel="noindex nofollow noopener" class="text-blue-lighter">Today.</a></p></div></div> <div class="theme-container mt-12"><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">
            GitHub
            <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">
            GitHub
            <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.11
  <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.11
  <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" aria-current="page" class="active sidebar-link">Additional Configuration</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/panel/1.0/additional_configuration.html#backups" class="sidebar-link">Backups</a></li><li class="sidebar-sub-header"><a href="/panel/1.0/additional_configuration.html#reverse-proxy-setup" class="sidebar-link">Reverse Proxy Setup</a></li><li class="sidebar-sub-header"><a href="/panel/1.0/additional_configuration.html#recaptcha" class="sidebar-link">reCAPTCHA</a></li><li class="sidebar-sub-header"><a href="/panel/1.0/additional_configuration.html#_2fa" class="sidebar-link">2FA</a></li><li class="sidebar-sub-header"><a href="/panel/1.0/additional_configuration.html#telemetry" class="sidebar-link">Telemetry</a></li></ul></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.11
  <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.11
  <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" class="sidebar-link">Additional Configuration</a></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></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="#backups">Backups</a><ul><li><a href="#using-local-backups">Using Local Backups</a></li><li><a href="#using-s3-backups">Using S3 Backups</a></li></ul></li><li><a href="#reverse-proxy-setup">Reverse Proxy Setup</a><ul><li><a href="#nginx-specific-configuration">NGINX Specific Configuration</a></li><li><a href="#cloudflare-specific-configuration">Cloudflare Specific Configuration</a></li></ul></li><li><a href="#recaptcha">reCAPTCHA</a><ul><li><a href="#configuring-recaptcha">Configuring reCAPTCHA</a></li><li><a href="#disabling-recaptcha">Disabling reCAPTCHA</a></li></ul></li><li><a href="#_2fa">2FA</a><ul><li><a href="#disable-2fa-requirement">Disable 2FA requirement</a></li><li><a href="#disable-2fa-for-a-specific-user">Disable 2FA for a specific user</a></li></ul></li><li><a href="#telemetry">Telemetry</a><ul><li><a href="#how-does-it-work">How does it work?</a></li><li><a href="#what-data-is-collected">What data is collected?</a></li><li><a href="#how-is-the-data-stored">How is the data stored?</a></li><li><a href="#why">Why?</a></li><li><a href="#enabling-telemetry">Enabling Telemetry</a></li><li><a href="#disabling-telemetry">Disabling Telemetry</a></li></ul></li></ul></div><p></p> <h2 id="backups"><a href="#backups" class="header-anchor">#</a> Backups</h2> <p>Pterodactyl Panel allows users to create backups of their servers. In order to create backups, a backup storage method has to be configured.</p> <p>When changing Pterodactyl Panel's backup storage method, users may still download or delete existing backups from the prior storage driver. In the instance of migrating from S3 to local backups, S3 credentials must remain configured after switching to the local backup storage method.</p> <h3 id="using-local-backups"><a href="#using-local-backups" class="header-anchor">#</a> Using Local Backups</h3> <p>By default, Pterodactyl Panel uses local storage via Wings for backups. That said, this method of backup storage can be explicitly set with the following configuration in the <code>.env</code> file:</p> <div class="language-bash extra-class"><pre class="language-bash"><code><span class="token comment"># Sets your panel to use local storage via Wings for backups</span>
<span class="token assign-left variable">APP_BACKUP_DRIVER</span><span class="token operator">=</span>wings
</code></pre></div><p>Do note that, when using local storage via Wings, the destination for backups is set in Wings' <code>config.yml</code> with the following setting key:</p> <div class="language-yml extra-class"><pre class="language-yml"><code><span class="token key atrule">system</span><span class="token punctuation">:</span>
  <span class="token key atrule">backup_directory</span><span class="token punctuation">:</span> /path/to/backup/storage
</code></pre></div><h3 id="using-s3-backups"><a href="#using-s3-backups" class="header-anchor">#</a> Using S3 Backups</h3> <p>AWS S3 (or compatible storage) can be used to store remote or cloud-based backups. The following configuration options have to be set in the <code>.env</code> file or as environment variables in order to enable it:</p> <div class="language-bash extra-class"><pre class="language-bash"><code><span class="token comment"># Sets your panel to use s3 for backups</span>
<span class="token assign-left variable">APP_BACKUP_DRIVER</span><span class="token operator">=</span>s3

<span class="token comment"># Info to actually use s3</span>
<span class="token assign-left variable">AWS_DEFAULT_REGION</span><span class="token operator">=</span>
<span class="token assign-left variable">AWS_ACCESS_KEY_ID</span><span class="token operator">=</span>
<span class="token assign-left variable">AWS_SECRET_ACCESS_KEY</span><span class="token operator">=</span>
<span class="token assign-left variable">AWS_BACKUPS_BUCKET</span><span class="token operator">=</span>
<span class="token assign-left variable">AWS_ENDPOINT</span><span class="token operator">=</span>
</code></pre></div><p>For some configurations, you might have to change your S3 URL from <code>bucket.domain.com</code> to <code>domain.com/bucket</code>. To accomplish this, add <code>AWS_USE_PATH_STYLE_ENDPOINT=true</code> to your <code>.env</code> file.</p> <h4 id="multipart-upload"><a href="#multipart-upload" class="header-anchor">#</a> Multipart Upload</h4> <p>The S3 backup is using the S3 multipart upload capabilities. In rare situations, you might want to adjust the size of a single part or the lifespan of the generated pre-signed URLs. The default part size is 5GB, and the default pre-signed URL lifespan is 60 minutes.</p> <p>You can configure the maximal part size using the <code>BACKUP_MAX_PART_SIZE</code> environment variable. You must specify the size in bytes. To define the pre-signed URL lifespan, use the <code>BACKUP_PRESIGNED_URL_LIFESPAN</code> variable. The expected unit is minutes.</p> <p>The following <code>.env</code> snippet configures 1GB parts and uses 120 minutes as the pre-signed URL lifespan:</p> <div class="language-bash extra-class"><pre class="language-bash"><code><span class="token assign-left variable">BACKUP_MAX_PART_SIZE</span><span class="token operator">=</span><span class="token number">1073741824</span>
<span class="token assign-left variable">BACKUP_PRESIGNED_URL_LIFESPAN</span><span class="token operator">=</span><span class="token number">120</span>
</code></pre></div><h4 id="storage-class"><a href="#storage-class" class="header-anchor">#</a> Storage Class</h4> <p>Should you need to specify a storage class, use the <code>AWS_BACKUPS_STORAGE_CLASS</code> environment variable. Default option is <code>STANDARD</code> (S3 Standard).</p> <p>The following <code>.env</code> snippet sets the class to <code>STANDARD_IA</code> (this is an example).</p> <div class="language-bash extra-class"><pre class="language-bash"><code><span class="token comment"># STANDARD_IA is an example.</span>
<span class="token assign-left variable">AWS_BACKUPS_STORAGE_CLASS</span><span class="token operator">=</span>STANDARD_IA
</code></pre></div><h2 id="reverse-proxy-setup"><a href="#reverse-proxy-setup" class="header-anchor">#</a> Reverse Proxy Setup</h2> <p>When running Pterodactyl behind a reverse proxy, such as <a href="https://support.cloudflare.com/hc/en-us/articles/200170416-What-do-the-SSL-options-mean-" target="_blank" rel="noopener noreferrer">Cloudflare's Flexible SSL<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>
or Nginx/Apache/Caddy, etc., you will need to make a quick modification to the Panel to ensure things continue to work as expected. By default, when using these reverse proxies,
your Panel will not correctly handle requests. You'll most likely be unable to login or see security warnings in your browser console as it attempts to load insecure assets.
This is because the internal logic the Panel uses to determine how links should be generated thinks it is running over HTTP and not over HTTPS.</p> <p>You will need to edit the <code>.env</code> file in the Panel's root directory to contain <code>TRUSTED_PROXIES=*</code> at minimum. We highly suggest providing a specific IP address
(or comma-separated list of IPs) rather than allowing <code>*</code>. For example, if your proxy is running on the same machine as the server,
the chances are that something like <code>TRUSTED_PROXIES=127.0.0.1</code> will work for you.</p> <h3 id="nginx-specific-configuration"><a href="#nginx-specific-configuration" class="header-anchor">#</a> NGINX Specific Configuration</h3> <p>For Pterodactyl to properly respond to an NGINX reverse proxy, the NGINX <code>location</code> config must contain the following lines:</p> <div class="language-Nginx extra-class"><pre class="language-nginx"><code><span class="token keyword">proxy_set_header</span> X<span class="token operator">-</span>Real<span class="token operator">-</span>IP <span class="token variable">$remote_addr</span><span class="token punctuation">;</span>
<span class="token keyword">proxy_set_header</span> Host <span class="token variable">$host</span><span class="token punctuation">;</span>
<span class="token keyword">proxy_set_header</span> X<span class="token operator">-</span>Forwarded<span class="token operator">-</span>For <span class="token variable">$proxy_add_x_forwarded_for</span><span class="token punctuation">;</span>
<span class="token keyword">proxy_set_header</span> X<span class="token operator">-</span>Forwarded<span class="token operator">-</span>Proto <span class="token variable">$scheme</span><span class="token punctuation">;</span>
<span class="token keyword">proxy_redirect</span> off<span class="token punctuation">;</span>
<span class="token keyword">proxy_buffering</span> off<span class="token punctuation">;</span>
proxy_request_buffering off<span class="token punctuation">;</span>
</code></pre></div><h3 id="cloudflare-specific-configuration"><a href="#cloudflare-specific-configuration" class="header-anchor">#</a> Cloudflare Specific Configuration</h3> <p>If you're using Cloudflare's Flexible SSL you should set <code>TRUSTED_PROXIES</code> to contain <a href="https://www.cloudflare.com/ips/" target="_blank" rel="noopener noreferrer">their IP addresses<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>.
Below is an example of how to set this.</p> <div class="language-text extra-class"><pre class="language-text"><code>TRUSTED_PROXIES=173.245.48.0/20,103.21.244.0/22,103.22.200.0/22,103.31.4.0/22,141.101.64.0/18,108.162.192.0/18,190.93.240.0/20,188.114.96.0/20,197.234.240.0/22,198.41.128.0/17,162.158.0.0/15,104.16.0.0/13,104.24.0.0/14,172.64.0.0/13,131.0.72.0/22
</code></pre></div><h2 id="recaptcha"><a href="#recaptcha" class="header-anchor">#</a> reCAPTCHA</h2> <p>The Panel uses invisible reCAPTCHA to secure the login page from brute-force attacks. If the login attempt is considered suspicious, users may be required to perform a reCAPTCHA challenge.</p> <h3 id="configuring-recaptcha"><a href="#configuring-recaptcha" class="header-anchor">#</a> Configuring reCAPTCHA</h3> <p>While we provide a global Site Key and Secret Key by default, we highly recommend changing it for your own setup.</p> <p>You can generate your own keys in the <a href="https://www.google.com/recaptcha/admin" target="_blank" rel="noopener noreferrer">reCAPTCHA Admin Console<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> <p>The keys can then be applied using the Settings in the admin panel. The reCAPTCHA settings can be found on the <strong>Advanced</strong> tab.</p> <h3 id="disabling-recaptcha"><a href="#disabling-recaptcha" class="header-anchor">#</a> Disabling reCAPTCHA</h3> <div class="custom-block warning"><p class="custom-block-title">SECURITY WARNING</p> <p>We do not recommend disabling reCAPTCHA. It is a security mechanism that makes it harder to perform brute-force attacks on user accounts.</p></div> <p>If users have trouble logging in, or your Panel isn't exposed to the internet, it can make sense to disable reCAPTCHA.</p> <p>reCAPTCHA can easily be disabled using the admin panel. In the Settings, select the <strong>Advanced</strong> tab and set the <strong>Status</strong> of reCAPTCHA to <strong>disabled</strong>.</p> <h4 id="editing-your-database"><a href="#editing-your-database" class="header-anchor">#</a> Editing your database</h4> <p>If you cannot access your panel, you can modify the database directly using the following commands.</p> <div class="language-sql extra-class"><pre class="language-sql"><code>mysql <span class="token operator">-</span>u root <span class="token operator">-</span>p
<span class="token keyword">UPDATE</span> panel<span class="token punctuation">.</span>settings <span class="token keyword">SET</span> <span class="token keyword">value</span> <span class="token operator">=</span> <span class="token string">'false'</span> <span class="token keyword">WHERE</span> <span class="token punctuation">`</span><span class="token keyword">key</span><span class="token punctuation">`</span> <span class="token operator">=</span> <span class="token string">'settings::recaptcha:enabled'</span><span class="token punctuation">;</span>
</code></pre></div><h2 id="_2fa"><a href="#_2fa" class="header-anchor">#</a> 2FA</h2> <p>If possible you should use the panel to update your 2FA settings. If you can't access your panel for what ever reason you can use the following steps.</p> <h3 id="disable-2fa-requirement"><a href="#disable-2fa-requirement" class="header-anchor">#</a> Disable 2FA requirement</h3> <div class="language-sql extra-class"><pre class="language-sql"><code>mysql <span class="token operator">-</span>u root <span class="token operator">-</span>p
<span class="token keyword">UPDATE</span> panel<span class="token punctuation">.</span>settings <span class="token keyword">SET</span> <span class="token keyword">value</span> <span class="token operator">=</span> <span class="token number">0</span> <span class="token keyword">WHERE</span> <span class="token punctuation">`</span><span class="token keyword">key</span><span class="token punctuation">`</span> <span class="token operator">=</span> <span class="token string">'settings::pterodactyl:auth:2fa_required'</span><span class="token punctuation">;</span>
</code></pre></div><h3 id="disable-2fa-for-a-specific-user"><a href="#disable-2fa-for-a-specific-user" class="header-anchor">#</a> Disable 2FA for a specific user</h3> <p>Run the following command in your <code>/var/www/pterodactyl</code> directory.</p> <div class="language-bash extra-class"><pre class="language-bash"><code>php artisan p:user:disable2fa
</code></pre></div><h2 id="telemetry"><a href="#telemetry" class="header-anchor">#</a> Telemetry</h2> <p>Since 1.11, the Panel collects anonymous metrics about the Panel and all connected nodes.
This feature is enabled by default, but can be disabled.</p> <p>The data collected by this feature is not sold or used for advertising purposes.  Aggregate statistics
may be made public or shared with third-parties for the purposes of improving the software.</p> <h3 id="how-does-it-work"><a href="#how-does-it-work" class="header-anchor">#</a> How does it work?</h3> <p>The Telemetry system works by first generating a random UUIDv4 identifier for the Panel installation.
This identifier is stored in the database so people load-balancing multiple Panel instances can still
have a unique identifier.  This identifier is then sent to a remote server, along the associated
telemetry data.  The telemetry data is collected every 24 hours, there is no ongoing collection
or local storage of the telemetry data, we collect the data right before we send it to the remote
server.</p> <p>Currently, all telemetry collection logic is handled by the <a href="https://github.com/pterodactyl/panel/blob/1.0-develop/app/Services/Telemetry/TelemetryCollectionService.php#L53" target="_blank" rel="noopener noreferrer">TelemetryCollectionService<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>
on the panel.  This service is responsible for collecting all the data that is sent to the remote
server.</p> <h3 id="what-data-is-collected"><a href="#what-data-is-collected" class="header-anchor">#</a> What data is collected?</h3> <p>If you wish to see the full data that is collected, please look at the TelemetryCollectionService
(as linked above), or use the <code>php artisan p:telemetry</code> command to view the exact data that will
be sent to the remote server.</p> <p>As of 2022-12-12, the data collected consists of:</p> <ul><li>Unique identifier for the Panel</li> <li>Version of the Panel</li> <li>PHP version</li> <li>Backup storage driver (S3, Local, etc.)</li> <li>Cache driver (Redis, Memcached, etc.)</li> <li>Database driver and version (MySQL, MariaDB, PostgreSQL, etc.)</li> <li>Resources
<ul><li>Allocations
<ul><li>Total number</li> <li>Total number of used allocations (assigned to a server)</li></ul></li> <li>Backups
<ul><li>Total number</li> <li>Sum of the total amount of bytes stored by backups</li></ul></li> <li>Eggs
<ul><li>Total number</li> <li><s>Map of egg UUIDs to the number of servers using that egg</s> (removed in 1.11.2)</li></ul></li> <li>Locations
<ul><li>Total number</li></ul></li> <li>Mounts
<ul><li>Total number</li></ul></li> <li>Nests
<ul><li>Total number</li> <li><s>Map of nest UUIDs to the number of servers using eggs in that nest</s> (removed in 1.11.2)</li></ul></li> <li>Nodes
<ul><li>Total number</li></ul></li> <li>Servers
<ul><li>Total number</li> <li>Number of servers that are suspended</li></ul></li> <li>Users
<ul><li>Total number</li> <li>Number of users that are admins</li></ul></li></ul></li> <li>Nodes
<ul><li>Node UUID</li> <li>Version of Wings on the node</li> <li>Docker
<ul><li>Version</li> <li>Cgroups
<ul><li>Driver</li> <li>Version</li></ul></li> <li>Containers
<ul><li>Total</li> <li>Running</li> <li>Paused</li> <li>Stopped</li></ul></li> <li>Storage
<ul><li>Driver</li> <li>Filesystem</li></ul></li> <li>runc
<ul><li>Version</li></ul></li></ul></li> <li>System
<ul><li>Architecture (<code>amd64</code>, <code>arm64</code>, etc.)</li> <li>CPU Threads</li> <li>Memory Bytes</li> <li>Kernel Version</li> <li>Operating System (Debian, Fedora, RHEL, Ubuntu, etc.)</li> <li>Operating System Type (bsd, linux, windows, etc.)</li></ul></li></ul></li></ul> <h3 id="how-is-the-data-stored"><a href="#how-is-the-data-stored" class="header-anchor">#</a> How is the data stored?</h3> <p>Currently, the data is stored with Cloudflare, we ingest all telemetry data with a Worker which does
basic processing such as validation and then inserts it into Cloudflare D1.  Right now, there is not
an API or visualization for any of the data collected, and it can only be manually queried.  Only
Matthew is able to query the data at this time, but we are working on alternatives to make this data
more accessible.</p> <h3 id="why"><a href="#why" class="header-anchor">#</a> Why?</h3> <p>The primary reason for collecting this data is to help us make better decisions about the future of
this software.  With the release of 1.11, the minimum PHP version requirement jumped from 7.4 to 8.0,
however, we wanted to add a feature that required PHP 8.1 which would've made the version requirement
jump larger and potentially cause issues for some users.  By collecting this data, we can hopefully
have more insight to how changes like this will affect the community and make better decisions in the
future.  This is especially important for information like the architecture, kernel version, and
operating system nodes are using.  For example, we want to utilize a feature that is only present in
some filesystems, but we have no idea how many people are using those filesystems, so we cannot
determine if it's worth the effort to implement.</p> <p>Some of the data is not as useful for making decisions, but is still useful for us to know.
For example, have you ever wondered how many Panel instances there are?  How many servers are being
ran across all of those instances?  How many users are using the Panel?  How many of those users are
admins?  How many servers are using a specific egg?  How many servers are using a specific nest?
All of these questions can be answered by the data we collect, and can help us and the community
better understand how the software is being used.</p> <p>If you have any questions about the data we collect, please feel free to reach out to us on Discord.
Our goal is to be as transparent as possible, and we want to make sure that the community understands
what we are doing and why.</p> <h3 id="enabling-telemetry"><a href="#enabling-telemetry" class="header-anchor">#</a> Enabling Telemetry</h3> <p>Telemetry is enabled by default, if you want to enable it after disabling it, edit your <code>.env</code> file
and either remove the <code>PTERODACTYL_TELEMETRY_ENABLED</code> line, or set it to <code>true</code>.</p> <div class="language-text extra-class"><pre class="language-text"><code>PTERODACTYL_TELEMETRY_ENABLED=true
</code></pre></div><p>You may also use the <code>php artisan p:environment:setup</code> command to enable telemetry, optionally with
the <code>--telemetry</code> flag for a non-interactive setup.</p> <h3 id="disabling-telemetry"><a href="#disabling-telemetry" class="header-anchor">#</a> Disabling Telemetry</h3> <p>To disable telemetry, edit your <code>.env</code> file and set <code>PTERODACTYL_TELEMETRY_ENABLED</code> to <code>false</code>.</p> <div class="language-text extra-class"><pre class="language-text"><code>PTERODACTYL_TELEMETRY_ENABLED=false
</code></pre></div><p>You may also use the <code>php artisan p:environment:setup</code> command to disable telemetry, optionally with
the <code>--telemetry=false</code> flag for a non-interactive setup.</p></div> <div class="page-edit"><div class="edit-link"><a href="https://github.com/pterodactyl/documentation/edit/master/panel/1.0/additional_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><div class="global-ui"></div></div>
    <script src="/assets/js/app.e5d692cc.js" defer></script><script src="/assets/js/4.c34bdd00.js" defer></script><script src="/assets/js/1.19e16341.js" defer></script><script src="/assets/js/63.2fe954fd.js" defer></script>
  </body>
</html>