mirror of
https://github.com/pterodactyl/documentation.git
synced 2025-12-10 10:44:43 -06:00
112 lines
32 KiB
HTML
112 lines
32 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en-US">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
<title>Installation | 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.a2a11c9f.js" as="script"><link rel="preload" href="/assets/js/4.17b22ac2.js" as="script"><link rel="preload" href="/assets/js/1.19e16341.js" as="script"><link rel="preload" href="/assets/js/21.40b46144.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.29206997.js"><link rel="prefetch" href="/assets/js/13.bd04c4ec.js"><link rel="prefetch" href="/assets/js/14.d448db4e.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.a335f151.js"><link rel="prefetch" href="/assets/js/2.21e1a937.js"><link rel="prefetch" href="/assets/js/20.0d86a0bd.js"><link rel="prefetch" href="/assets/js/22.f9353e9f.js"><link rel="prefetch" href="/assets/js/23.09b11a78.js"><link rel="prefetch" href="/assets/js/24.3db401dc.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.d561e4f4.js"><link rel="prefetch" href="/assets/js/32.5ec9cc12.js"><link rel="prefetch" href="/assets/js/33.8072b522.js"><link rel="prefetch" href="/assets/js/34.08d0de59.js"><link rel="prefetch" href="/assets/js/35.226da989.js"><link rel="prefetch" href="/assets/js/36.b9c41633.js"><link rel="prefetch" href="/assets/js/37.8e7964de.js"><link rel="prefetch" href="/assets/js/38.ea3ffaf8.js"><link rel="prefetch" href="/assets/js/39.5d85947d.js"><link rel="prefetch" href="/assets/js/40.a78ec0ad.js"><link rel="prefetch" href="/assets/js/41.738df04c.js"><link rel="prefetch" href="/assets/js/42.a8778d05.js"><link rel="prefetch" href="/assets/js/43.25886c53.js"><link rel="prefetch" href="/assets/js/44.1b22667c.js"><link rel="prefetch" href="/assets/js/45.14943dc6.js"><link rel="prefetch" href="/assets/js/46.0fcb43fb.js"><link rel="prefetch" href="/assets/js/47.3af19f15.js"><link rel="prefetch" href="/assets/js/48.b52bf3e1.js"><link rel="prefetch" href="/assets/js/49.8d6a6c8f.js"><link rel="prefetch" href="/assets/js/5.2366f5e0.js"><link rel="prefetch" href="/assets/js/50.e5e4cbbf.js"><link rel="prefetch" href="/assets/js/51.1e3a5853.js"><link rel="prefetch" href="/assets/js/52.5e2e1e53.js"><link rel="prefetch" href="/assets/js/53.aaf29ed5.js"><link rel="prefetch" href="/assets/js/54.5fc704a0.js"><link rel="prefetch" href="/assets/js/55.393a224a.js"><link rel="prefetch" href="/assets/js/56.3a4538a1.js"><link rel="prefetch" href="/assets/js/57.06958522.js"><link rel="prefetch" href="/assets/js/58.ed936067.js"><link rel="prefetch" href="/assets/js/59.7697fd60.js"><link rel="prefetch" href="/assets/js/6.92501184.js"><link rel="prefetch" href="/assets/js/60.401f2243.js"><link rel="prefetch" href="/assets/js/61.ad708944.js"><link rel="prefetch" href="/assets/js/62.037b9f1e.js"><link rel="prefetch" href="/assets/js/63.bbf85631.js"><link rel="prefetch" href="/assets/js/64.58530ff1.js"><link rel="prefetch" href="/assets/js/65.95e6b666.js"><link rel="prefetch" href="/assets/js/66.38ba9f8f.js"><link rel="prefetch" href="/assets/js/67.2d8e0338.js"><link rel="prefetch" href="/assets/js/68.6351c8cd.js"><link rel="prefetch" href="/assets/js/69.96202f0b.js"><link rel="prefetch" href="/assets/js/7.c41300e2.js"><link rel="prefetch" href="/assets/js/70.5cc2ec6f.js"><link rel="prefetch" href="/assets/js/71.d4c67d17.js"><link rel="prefetch" href="/assets/js/72.aeb7ce36.js"><link rel="prefetch" href="/assets/js/73.757eb6a0.js"><link rel="prefetch" href="/assets/js/74.2691a632.js"><link rel="prefetch" href="/assets/js/75.fa43fc98.js"><link rel="prefetch" href="/assets/js/76.60c7de63.js"><link rel="prefetch" href="/assets/js/77.8717480c.js"><link rel="prefetch" href="/assets/js/8.c87d5fba.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" 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.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="installation"><a href="#installation" class="header-anchor">#</a> Installation</h1> <div class="custom-block danger"><p class="custom-block-title">This Software is Abandoned</p> <p>This documentation is for <strong>abandoned software</strong> which does not recieve any security updates or support
|
|
from the community. This documentation has been left accessible for historial reasons.</p> <p>You should be installing and using <a href="/wings/1.0/installing.html">Wings</a> in production environments with
|
|
<a href="/panel/1.0/getting_started.html">Pterodactyl Panel 1.0</a>.</p></div> <div class="custom-block warning"><p class="custom-block-title">WARNING</p> <p>This specific software is for Pterodactyl v0.7 and <strong>must not be used for Pterodactyl v1.0</strong>. If you have installed 1.0 you should use <a href="/wings/1.0/installing.html">Wings</a> instead.</p></div> <p></p><div class="table-of-contents"><ul><li><a href="#supported-systems">Supported Systems</a></li><li><a href="#system-requirements">System Requirements</a></li><li><a href="#dependencies">Dependencies</a><ul><li><a href="#installing-docker">Installing Docker</a></li><li><a href="#installing-nodejs">Installing Nodejs</a></li></ul></li><li><a href="#installing-daemon-software">Installing Daemon Software</a></li><li><a href="#configure-daemon">Configure Daemon</a></li><li><a href="#starting-the-daemon">Starting the Daemon</a><ul><li><a href="#daemonizing-using-systemd">Daemonizing (using systemd)</a></li></ul></li></ul></div><p></p> <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><a href="/community/installation-guides/daemon/ubuntu2004.html">20.04</a></td> <td style="text-align:center;">✅</td> <td></td></tr> <tr><td><strong>CentOS</strong></td> <td><a href="/community/installation-guides/daemon/centos7.html">7</a></td> <td style="text-align:center;">⚠️</td> <td>Extra repos are required</td></tr> <tr><td></td> <td><a href="/community/installation-guides/daemon/centos8.html">8</a></td> <td style="text-align:center;">✅</td> <td></td></tr> <tr><td><strong>Debian</strong></td> <td><a href="/community/installation-guides/daemon/debian9.html">9</a></td> <td style="text-align:center;">✅</td> <td></td></tr> <tr><td></td> <td><a href="/community/installation-guides/daemon/debian10.html">10</a></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 the Daemon 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 the Daemon. 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@daemon:~$ 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@daemon:~$ <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> <p>Pterodactyl's Daemon requires the following dependencies be installed on your system in order for it to operate.</p> <ul><li>Docker</li> <li>Nodejs (<code>v10</code>, <code>v12</code>, higher versions likely work, but are untested)</li> <li><code>node-gyp</code></li> <li><code>tar</code></li> <li><code>unzip</code></li> <li><code>make</code>, <code>gcc</code> (<code>gcc-c++</code> on CentOS), <code>g++</code></li> <li><code>python</code></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<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></li> <li><a href="https://docs.docker.com/install/linux/docker-ce/centos/#install-docker-ce" target="_blank" rel="noopener noreferrer">CentOS<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></li> <li><a href="https://docs.docker.com/install/linux/docker-ce/debian/#install-docker-ce" target="_blank" rel="noopener noreferrer">Debian<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></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="/daemon/0.6/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> 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><h3 id="installing-nodejs"><a href="#installing-nodejs" class="header-anchor">#</a> Installing Nodejs</h3> <p>NodeJS is also super easy to install! Simply run the command below to make the package accessible to your system.</p> <div class="language-bash extra-class"><pre class="language-bash"><code><span class="token function">curl</span> -sL https://deb.nodesource.com/setup_10.x <span class="token operator">|</span> <span class="token function">sudo</span> -E <span class="token function">bash</span> -
|
|
<span class="token function">apt</span> -y <span class="token function">install</span> nodejs <span class="token function">make</span> gcc g++
|
|
</code></pre></div><div class="custom-block tip"><p class="custom-block-title">Other OS Distributions</p> <p>If you are using CentOS, <a href="https://nodejs.org/en/download/package-manager/#enterprise-linux-and-fedora" target="_blank" rel="noopener noreferrer">please follow these instructions<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>. Ubuntu and Debian users may also follow the <a href="https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions" target="_blank" rel="noopener noreferrer">official
|
|
instructions provided by Nodejs<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></div> <h2 id="installing-daemon-software"><a href="#installing-daemon-software" class="header-anchor">#</a> Installing Daemon Software</h2> <div class="custom-block danger"><p class="custom-block-title">This Software is Abandoned</p> <p>This documentation is for <strong>abandoned software</strong> which does not recieve any security updates or support
|
|
from the community. This documentation has been left accessible for historial reasons.</p> <p>You should be installing and using <a href="/wings/1.0/installing.html">Wings</a> in production environments with
|
|
<a href="/panel/1.0/getting_started.html">Pterodactyl Panel 1.0</a>.</p></div> <p>The first step for installing the daemon is to make sure we have the required directory structure setup. To do so,
|
|
run the commands below.</p> <div class="language-bash extra-class"><pre class="language-bash"><code><span class="token function">mkdir</span> -p /srv/daemon /srv/daemon-data
|
|
<span class="token builtin class-name">cd</span> /srv/daemon
|
|
</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> <p>The next step is to download the software and unpack the archive.</p> <div class="language-bash extra-class"><pre class="language-bash"><code><span class="token function">curl</span> -L https://github.com/pterodactyl/daemon/releases/download/v0.6.13/daemon.tar.gz <span class="token operator">|</span> <span class="token function">tar</span> --strip-components<span class="token operator">=</span><span class="token number">1</span> -xzv
|
|
</code></pre></div><p>Finally, we need to install the dependencies that allow the Daemon to run properly. This command will most likely
|
|
take a few minutes to run, please do not interrupt it.</p> <div class="language-bash extra-class"><pre class="language-bash"><code><span class="token function">npm</span> <span class="token function">install</span> --only<span class="token operator">=</span>production --no-audit --unsafe-perm
|
|
</code></pre></div><h2 id="configure-daemon"><a href="#configure-daemon" class="header-anchor">#</a> Configure Daemon</h2> <p>Once you have installed the daemon 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>core.json</code> in <code>/srv/daemon/config</code> and save it.
|
|
You may also use the Auto-Deployment feature rather than manually creating the files.</p> <p><img src="/assets/img/daemon_configuration_example.7d1665c4.png" alt=""></p> <h2 id="starting-the-daemon"><a href="#starting-the-daemon" class="header-anchor">#</a> Starting the Daemon</h2> <p>To start your daemon simply move into the daemon directory and run the command below which will start the daemon 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 the Daemon 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> <span class="token function">npm</span> start
|
|
</code></pre></div><h3 id="daemonizing-using-systemd"><a href="#daemonizing-using-systemd" class="header-anchor">#</a> Daemonizing (using systemd)</h3> <p>Running Pterodactyl Daemon 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
|
|
#Group=some_group
|
|
WorkingDirectory=/srv/daemon
|
|
LimitNOFILE=4096
|
|
PIDFile=/var/run/wings/daemon.pid
|
|
ExecStart=/usr/bin/node /srv/daemon/src/index.js
|
|
Restart=on-failure
|
|
StartLimitInterval=600
|
|
|
|
[Install]
|
|
WantedBy=multi-user.target
|
|
</code></pre></div><p>Then, run the commands below to reload systemd and start the daemon.</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/daemon/0.6/installing.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.a2a11c9f.js" defer></script><script src="/assets/js/4.17b22ac2.js" defer></script><script src="/assets/js/1.19e16341.js" defer></script><script src="/assets/js/21.40b46144.js" defer></script>
|
|
</body>
|
|
</html>
|