mirror of
https://github.com/pterodactyl/documentation.git
synced 2025-12-12 00:34:12 -06:00
106 lines
27 KiB
HTML
106 lines
27 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en-US">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
<title>Installing Wings | Pterodactyl</title>
|
|
<meta name="generator" content="VuePress 1.5.4">
|
|
<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/manifest.json">
|
|
<link rel="shortcut icon" href="/favicons/favicon.ico">
|
|
<meta name="description" content="The open-source server management solution.">
|
|
<meta name="msapplication-config" content="/favicons/browserconfig.xml">
|
|
<meta name="theme-color" content="#0e4688">
|
|
<link rel="preload" href="/assets/css/0.styles.6fa99e09.css" as="style"><link rel="preload" href="/assets/js/app.6b39bcf0.js" as="script"><link rel="preload" href="/assets/js/4.e413141f.js" as="script"><link rel="preload" href="/assets/js/1.ee4ff4e2.js" as="script"><link rel="preload" href="/assets/js/21.7d0bf491.js" as="script"><link rel="prefetch" href="/assets/js/10.041c438a.js"><link rel="prefetch" href="/assets/js/11.efec8f80.js"><link rel="prefetch" href="/assets/js/12.7214ee65.js"><link rel="prefetch" href="/assets/js/13.7b958e39.js"><link rel="prefetch" href="/assets/js/14.3700aaa2.js"><link rel="prefetch" href="/assets/js/15.43153aa4.js"><link rel="prefetch" href="/assets/js/16.90c5b55f.js"><link rel="prefetch" href="/assets/js/17.f2ef94ea.js"><link rel="prefetch" href="/assets/js/18.2e49d336.js"><link rel="prefetch" href="/assets/js/19.6b7a12e9.js"><link rel="prefetch" href="/assets/js/2.f895a645.js"><link rel="prefetch" href="/assets/js/20.a8186273.js"><link rel="prefetch" href="/assets/js/22.ff372b4a.js"><link rel="prefetch" href="/assets/js/23.6388ee5d.js"><link rel="prefetch" href="/assets/js/24.433197bc.js"><link rel="prefetch" href="/assets/js/25.f87fba53.js"><link rel="prefetch" href="/assets/js/26.e0451f04.js"><link rel="prefetch" href="/assets/js/27.778d7f34.js"><link rel="prefetch" href="/assets/js/28.653b63a6.js"><link rel="prefetch" href="/assets/js/29.895e3725.js"><link rel="prefetch" href="/assets/js/30.c937ce7b.js"><link rel="prefetch" href="/assets/js/31.12a37f92.js"><link rel="prefetch" href="/assets/js/32.ebe99c03.js"><link rel="prefetch" href="/assets/js/33.e1838ab2.js"><link rel="prefetch" href="/assets/js/34.6788ea1f.js"><link rel="prefetch" href="/assets/js/35.12687306.js"><link rel="prefetch" href="/assets/js/36.b55749f6.js"><link rel="prefetch" href="/assets/js/37.03135ad8.js"><link rel="prefetch" href="/assets/js/38.c0059690.js"><link rel="prefetch" href="/assets/js/39.5a8f2652.js"><link rel="prefetch" href="/assets/js/40.d63a99ee.js"><link rel="prefetch" href="/assets/js/41.f3ddbe24.js"><link rel="prefetch" href="/assets/js/42.20c949e2.js"><link rel="prefetch" href="/assets/js/43.5569655e.js"><link rel="prefetch" href="/assets/js/44.7df07373.js"><link rel="prefetch" href="/assets/js/45.bd7ba52f.js"><link rel="prefetch" href="/assets/js/46.8ab282e9.js"><link rel="prefetch" href="/assets/js/47.fa07205f.js"><link rel="prefetch" href="/assets/js/48.ff554eb8.js"><link rel="prefetch" href="/assets/js/49.a1a8ccd8.js"><link rel="prefetch" href="/assets/js/5.1bddf890.js"><link rel="prefetch" href="/assets/js/50.0ff5425f.js"><link rel="prefetch" href="/assets/js/51.9d0817fd.js"><link rel="prefetch" href="/assets/js/52.3486b1ed.js"><link rel="prefetch" href="/assets/js/53.ee081f66.js"><link rel="prefetch" href="/assets/js/54.cb3a1a7e.js"><link rel="prefetch" href="/assets/js/55.17a8afef.js"><link rel="prefetch" href="/assets/js/56.9477714d.js"><link rel="prefetch" href="/assets/js/57.13409baa.js"><link rel="prefetch" href="/assets/js/58.5ff02f81.js"><link rel="prefetch" href="/assets/js/59.25e773f7.js"><link rel="prefetch" href="/assets/js/6.d7837586.js"><link rel="prefetch" href="/assets/js/60.7ec6926f.js"><link rel="prefetch" href="/assets/js/61.a44ed8e0.js"><link rel="prefetch" href="/assets/js/62.7f84d180.js"><link rel="prefetch" href="/assets/js/63.da0ad056.js"><link rel="prefetch" href="/assets/js/64.91b02e66.js"><link rel="prefetch" href="/assets/js/65.78d56c27.js"><link rel="prefetch" href="/assets/js/66.acab6190.js"><link rel="prefetch" href="/assets/js/67.8f4ed01f.js"><link rel="prefetch" href="/assets/js/68.afe3b4b3.js"><link rel="prefetch" href="/assets/js/69.64223e2f.js"><link rel="prefetch" href="/assets/js/7.ad189dcf.js"><link rel="prefetch" href="/assets/js/70.8dd44fe5.js"><link rel="prefetch" href="/assets/js/71.af7c9f39.js"><link rel="prefetch" href="/assets/js/72.8b910c00.js"><link rel="prefetch" href="/assets/js/73.4bb789f2.js"><link rel="prefetch" href="/assets/js/74.423c0efe.js"><link rel="prefetch" href="/assets/js/75.40f09363.js"><link rel="prefetch" href="/assets/js/76.40d6e329.js"><link rel="prefetch" href="/assets/js/77.2d204f9a.js"><link rel="prefetch" href="/assets/js/78.e49870cd.js"><link rel="prefetch" href="/assets/js/8.f208d3ff.js"><link rel="prefetch" href="/assets/js/9.56fc48a0.js">
|
|
<link rel="stylesheet" href="/assets/css/0.styles.6fa99e09.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="/pterodactyl-flat.png" 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://pterodactyl.io/discord" target="_blank" rel="noopener noreferrer" class="nav-link external">
|
|
Get Help
|
|
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" 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></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
|
|
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" 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></a></div> <div class="nav-item"><a href="https://github.com/pterodactyl/panel" target="_blank" rel="noopener noreferrer" class="nav-link">
|
|
Contribute
|
|
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" 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></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://pterodactyl.io/discord" target="_blank" rel="noopener noreferrer" class="nav-link external">
|
|
Get Help
|
|
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" 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></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
|
|
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" 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></a></div> <div class="nav-item"><a href="https://github.com/pterodactyl/panel" target="_blank" rel="noopener noreferrer" class="nav-link">
|
|
Contribute
|
|
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" 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></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.0
|
|
<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">
|
|
0.7
|
|
<span class="rounded-full ml-2 text-grey">legacy</span></div></div><div class="item"><div class="inline-block">
|
|
1.0
|
|
<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/upgrading.html" class="sidebar-link">Upgrading</a></li><li><a href="/panel/1.0/additional_configuration.html" class="sidebar-link">Additional Configuration</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.0
|
|
<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.0
|
|
<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="active sidebar-link">Installing Wings</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/wings/1.0/installing.html#supported-systems" class="sidebar-link">Supported Systems</a></li><li class="sidebar-sub-header"><a href="/wings/1.0/installing.html#system-requirements" class="sidebar-link">System Requirements</a></li><li class="sidebar-sub-header"><a href="/wings/1.0/installing.html#dependencies" class="sidebar-link">Dependencies</a></li><li class="sidebar-sub-header"><a href="/wings/1.0/installing.html#installing-wings-2" class="sidebar-link">Installing Wings</a></li><li class="sidebar-sub-header"><a href="/wings/1.0/installing.html#configure" class="sidebar-link">Configure</a></li></ul></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>Daemon</span> <!----> <div tabindex="0" class="version-select custom-select float-right"><div class="selected"><div class="inline-block">
|
|
0.6
|
|
<span class="rounded-full ml-2 text-grey">legacy</span></div> <span class="arrow"></span></div> <div class="items hidden"><div class="item"><div class="inline-block">
|
|
0.6
|
|
<span class="rounded-full ml-2 text-grey">legacy</span></div></div></div></div></p> <ul class="sidebar-group-items"><li><a href="/daemon/0.6/installing.html" class="sidebar-link">Installation</a></li><li><a href="/daemon/0.6/upgrading.html" class="sidebar-link">Upgrading</a></li><li><a href="/daemon/0.6/configuration.html" class="sidebar-link">Additional Configuration</a></li><li><a href="/daemon/0.6/kernel_modifications.html" class="sidebar-link">Kernel Modifications</a></li><li><a href="/daemon/0.6/debian_8_docker.html" class="sidebar-link">Docker on Debian 8</a></li><li><a href="/daemon/0.6/standalone_sftp.html" class="sidebar-link">Standalone SFTP Server</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><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="installing-wings"><a href="#installing-wings" class="header-anchor">#</a> Installing Wings</h1> <p>Wings is the next generation server control plane from Pterodactyl. It has been rebuilt from the
|
|
ground up using Go and lessons learned from our first Nodejs Daemon.</p> <div class="custom-block warning"><p class="custom-block-title">WARNING</p> <p>You should only install Wings if you are running <strong>Pterodactyl 1.0</strong>. Do not install this software
|
|
for previous versions of Pterodactyl.</p></div> <h2 id="supported-systems"><a href="#supported-systems" class="header-anchor">#</a> Supported Systems</h2> <table><thead><tr><th>Operating System</th> <th>Version</th> <th style="text-align:center;">Supported</th> <th>Notes</th></tr></thead> <tbody><tr><td><strong>Ubuntu</strong></td> <td>18.04</td> <td style="text-align:center;">✅</td> <td>Documentation written assuming Ubuntu 18.04 as the base OS.</td></tr> <tr><td></td> <td>20.04</td> <td style="text-align:center;">✅</td> <td></td></tr> <tr><td><strong>CentOS</strong></td> <td>7</td> <td style="text-align:center;">✅</td> <td></td></tr> <tr><td></td> <td>8</td> <td style="text-align:center;">✅</td> <td></td></tr> <tr><td><strong>Debian</strong></td> <td>9</td> <td style="text-align:center;">✅</td> <td></td></tr> <tr><td></td> <td>10</td> <td style="text-align:center;">✅</td> <td></td></tr></tbody></table> <h2 id="system-requirements"><a href="#system-requirements" class="header-anchor">#</a> System Requirements</h2> <p>In order to run Wings you will need a system capable of running Docker containers. Most VPS and almost all
|
|
dedicated servers should be capable of running Docker, but there are edge cases.</p> <p>If your provider makes use of <code>Virtuozzo</code>, <code>OpenVZ</code> (or <code>OVZ</code>), or <code>LXC</code> then you will most likely be unable to
|
|
run Wings. If you are unsure what your host is using there are a couple of options. The easiest is to check
|
|
their website, or reach out to their support team.</p> <p>If you want to take a different approach, try using <code>lscpu</code> and checking what the virtualization type listed is. An
|
|
example of this is shown below which shows my hypervisor running with full virtualization — this means it will
|
|
support Docker without issues. If you see <code>KVM</code> for the vendor, chances are you're fine as well.</p> <div class="language-bash extra-class"><pre class="language-bash"><code>dane@pterodactyl:~$ lscpu <span class="token operator">|</span> <span class="token function">grep</span> <span class="token string">'vendor\|type'</span>
|
|
Hypervisor vendor: VMware
|
|
Virtualization type: full
|
|
</code></pre></div><p>If that doesn't work for some reason, or you're still unsure, you can also run the command below and as long as it
|
|
doesn't report <code>Xen</code> or <code>LXC</code> you're probably okay to continue.</p> <div class="language-bash extra-class"><pre class="language-bash"><code>dane@pterodactyl:~$ <span class="token function">sudo</span> dmidecode -s system-manufacturer
|
|
VMware, Inc.
|
|
</code></pre></div><h2 id="dependencies"><a href="#dependencies" class="header-anchor">#</a> Dependencies</h2> <ul><li>curl</li> <li>Docker</li></ul> <h3 id="installing-docker"><a href="#installing-docker" class="header-anchor">#</a> Installing Docker</h3> <p>For a quick install of Docker CE, you can execute the command below:</p> <div class="language-bash extra-class"><pre class="language-bash"><code><span class="token function">curl</span> -sSL https://get.docker.com/ <span class="token operator">|</span> <span class="token assign-left variable">CHANNEL</span><span class="token operator">=</span>stable <span class="token function">bash</span>
|
|
</code></pre></div><p>If you would rather do a manual installation, please reference the official Docker documentation for how to install Docker CE on your server. Some quick links
|
|
are listed below for commonly supported systems.</p> <ul><li><a href="https://docs.docker.com/install/linux/docker-ce/ubuntu/#install-docker-ce" target="_blank" rel="noopener noreferrer">Ubuntu<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" 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></a></li> <li><a href="https://docs.docker.com/install/linux/docker-ce/centos/#install-docker-ce" target="_blank" rel="noopener noreferrer">CentOS<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" 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></a></li> <li><a href="https://docs.docker.com/install/linux/docker-ce/debian/#install-docker-ce" target="_blank" rel="noopener noreferrer">Debian<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" 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></a></li></ul> <div class="custom-block warning"><p class="custom-block-title">Check your Kernel</p> <p>Please be aware that some hosts install a modified kernel that does not support important docker features. Please
|
|
check your kernel by running <code>uname -r</code>. If your kernel ends in <code>-xxxx-grs-ipv6-64</code> or <code>-xxxx-mod-std-ipv6-64</code> you're
|
|
probably using a non-supported kernel. Check our <a href="/wings/1.0/kernel_modifications.html">Kernel Modifications</a> guide for details.</p></div> <h4 id="start-docker-on-boot"><a href="#start-docker-on-boot" class="header-anchor">#</a> Start Docker on Boot</h4> <p>If you are on an operating system with systemd (Ubuntu 16+, Debian 8+, CentOS 7+) run the command below to have Docker start when you boot your machine.</p> <div class="language-bash extra-class"><pre class="language-bash"><code>systemctl <span class="token builtin class-name">enable</span> --now docker
|
|
</code></pre></div><h4 id="enabling-swap"><a href="#enabling-swap" class="header-anchor">#</a> Enabling Swap</h4> <p>On most systems, docker will be unable to setup swap space, you can check if this is the case by running <code>docker info</code>.
|
|
If it outputs <code>WARNING: No swap limit support</code> near the bottom, this is the case. Enabling swap is completely optional,
|
|
but we recommended doing it if you will be hosting for others, and to prevent OOM errors.</p> <p>To do so, open <code>/etc/default/grub</code> as a root user, and find the line starting with <code>GRUB_CMDLINE_LINUX_DEFAULT</code>. Make
|
|
sure the line includes <code>swapaccount=1</code>.</p> <p>After doing that, simply run <code>sudo update-grub</code> followed by <code>sudo reboot</code> to restart the server and have swap enabled.
|
|
Below is an example of what the line should look like, <em>do not copy this line verbatium, it often has additional
|
|
OS specific parameters.</em></p> <div class="language-text extra-class"><pre class="language-text"><code>GRUB_CMDLINE_LINUX_DEFAULT="swapaccount=1"
|
|
</code></pre></div><h2 id="installing-wings-2"><a href="#installing-wings-2" class="header-anchor">#</a> Installing Wings</h2> <p>The first step for installing Wings is to make sure we have the required directory structure setup. To do so,
|
|
run the commands below which will create the base directory and download the wings executable.</p> <div class="language-bash extra-class"><pre class="language-bash"><code><span class="token function">mkdir</span> -p /etc/pterodactyl
|
|
<span class="token function">curl</span> -L -o /usr/local/bin/wings https://github.com/pterodactyl/wings/releases/latest/download/wings_linux_amd64
|
|
<span class="token function">chmod</span> u+x /usr/local/bin/wings
|
|
</code></pre></div><div class="custom-block warning"><p class="custom-block-title">OVH/SYS Servers</p> <p>If you are using a server provided by OVH or SoYouStart please be aware that your main drive space is probably allocated to
|
|
<code>/home</code>, and not <code>/</code> by default. Please consider using <code>/home/daemon-data</code> for server data. This can be easily
|
|
set when creating the node.</p></div> <h2 id="configure"><a href="#configure" class="header-anchor">#</a> Configure</h2> <p>Once you have installed Wings and required components, the next step is to create a node on your installed Panel
|
|
Once you have done that there will be a tab called Configuration when you view the node.</p> <p>Simply copy and paste the code block and paste it into a file called <code>config.yml</code> in <code>/etc/pterodactyl</code> and save it.</p> <p><img src="/assets/img/wings_configuration_example.9f3fdd0b.png" alt=""></p> <h3 id="starting-wings"><a href="#starting-wings" class="header-anchor">#</a> Starting Wings</h3> <p>To start Wings, simply move into the Wings directory and run the command below which will start it in
|
|
foreground mode. Once you are done, use <code>CTRL+C</code> to terminate the process. Depending on your server's internet connection
|
|
pulling and starting Wings for the first time may take a few minutes.</p> <div class="language-bash extra-class"><pre class="language-bash"><code><span class="token function">sudo</span> wings --debug
|
|
</code></pre></div><p>You may optionally add the <code>--debug</code> flag to run Wings in debug mode.</p> <h3 id="daemonizing-using-systemd"><a href="#daemonizing-using-systemd" class="header-anchor">#</a> Daemonizing (using systemd)</h3> <p>Running Wings in the background is a simple task, just make sure that it runs without errors before doing
|
|
this. Place the contents below in a file called <code>wings.service</code> in the <code>/etc/systemd/system</code> directory.</p> <div class="language-text extra-class"><pre class="language-text"><code>[Unit]
|
|
Description=Pterodactyl Wings Daemon
|
|
After=docker.service
|
|
|
|
[Service]
|
|
User=root
|
|
WorkingDirectory=/etc/pterodactyl
|
|
LimitNOFILE=4096
|
|
PIDFile=/var/run/wings/daemon.pid
|
|
ExecStart=/usr/local/bin/wings
|
|
Restart=on-failure
|
|
StartLimitInterval=600
|
|
|
|
[Install]
|
|
WantedBy=multi-user.target
|
|
</code></pre></div><p>Then, run the commands below to reload systemd and start Wings.</p> <div class="language-bash extra-class"><pre class="language-bash"><code>systemctl <span class="token builtin class-name">enable</span> --now wings
|
|
</code></pre></div></div> <div class="page-edit"><div class="edit-link"><a href="https://github.com/pterodactyl/documentation/edit/master/wings/1.0/installing.md" target="_blank" rel="noopener noreferrer">Help us improve this page.</a> <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" 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></div> <!----></div> <!----> </div></div><div class="global-ui"></div></div>
|
|
<script src="/assets/js/app.6b39bcf0.js" defer></script><script src="/assets/js/4.e413141f.js" defer></script><script src="/assets/js/1.ee4ff4e2.js" defer></script><script src="/assets/js/21.7d0bf491.js" defer></script>
|
|
</body>
|
|
</html>
|