mirror of
https://github.com/pterodactyl/documentation.git
synced 2025-12-10 21:05:59 -06:00
53 lines
20 KiB
HTML
53 lines
20 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en-US">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
<title>Creating a New Node | 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/site.webmanifest">
|
|
<link rel="shortcut icon" href="/favicons/favicon.ico">
|
|
<meta name="description" content="Pterodactyl is an open-source game server management panel built with PHP 7, React, and Go. Designed with security in mind, Pterodactyl runs all game servers in isolated Docker containers while exposing a beautiful and intuitive UI to end users.">
|
|
<meta name="msapplication-config" content="/favicons/browserconfig.xml">
|
|
<meta name="theme-color" content="#0e4688">
|
|
<link rel="preload" href="/assets/css/0.styles.26db9e46.css" as="style"><link rel="preload" href="/assets/js/app.5ed11237.js" as="script"><link rel="preload" href="/assets/js/4.cda5f594.js" as="script"><link rel="preload" href="/assets/js/1.d27374d7.js" as="script"><link rel="preload" href="/assets/js/17.403d3937.js" as="script"><link rel="prefetch" href="/assets/js/10.bcaf3754.js"><link rel="prefetch" href="/assets/js/11.e5240661.js"><link rel="prefetch" href="/assets/js/12.bc37074e.js"><link rel="prefetch" href="/assets/js/13.d96e5a31.js"><link rel="prefetch" href="/assets/js/14.2b6a0c7b.js"><link rel="prefetch" href="/assets/js/15.dcb97977.js"><link rel="prefetch" href="/assets/js/16.f2393fa3.js"><link rel="prefetch" href="/assets/js/18.a38a22c6.js"><link rel="prefetch" href="/assets/js/19.2909f3bf.js"><link rel="prefetch" href="/assets/js/2.17b53296.js"><link rel="prefetch" href="/assets/js/20.2b0e82e7.js"><link rel="prefetch" href="/assets/js/21.de639223.js"><link rel="prefetch" href="/assets/js/22.ba247afa.js"><link rel="prefetch" href="/assets/js/23.6388ee5d.js"><link rel="prefetch" href="/assets/js/24.a7d8bd12.js"><link rel="prefetch" href="/assets/js/25.a18e760a.js"><link rel="prefetch" href="/assets/js/26.ce110c77.js"><link rel="prefetch" href="/assets/js/27.1bc51cad.js"><link rel="prefetch" href="/assets/js/28.45d4fe86.js"><link rel="prefetch" href="/assets/js/29.1cc47d12.js"><link rel="prefetch" href="/assets/js/30.831cc1fd.js"><link rel="prefetch" href="/assets/js/31.55c4be08.js"><link rel="prefetch" href="/assets/js/32.86eddebf.js"><link rel="prefetch" href="/assets/js/33.257d9d0e.js"><link rel="prefetch" href="/assets/js/34.fead0e36.js"><link rel="prefetch" href="/assets/js/35.bc9ceac9.js"><link rel="prefetch" href="/assets/js/36.0050a325.js"><link rel="prefetch" href="/assets/js/37.13038a4c.js"><link rel="prefetch" href="/assets/js/38.7687dfa0.js"><link rel="prefetch" href="/assets/js/39.b4cd4648.js"><link rel="prefetch" href="/assets/js/40.04b12ca0.js"><link rel="prefetch" href="/assets/js/41.c2275e99.js"><link rel="prefetch" href="/assets/js/42.b62aa882.js"><link rel="prefetch" href="/assets/js/43.f9c88a30.js"><link rel="prefetch" href="/assets/js/44.d08991a7.js"><link rel="prefetch" href="/assets/js/45.f1a12be4.js"><link rel="prefetch" href="/assets/js/46.ca2282dc.js"><link rel="prefetch" href="/assets/js/47.37177763.js"><link rel="prefetch" href="/assets/js/48.264a4203.js"><link rel="prefetch" href="/assets/js/49.467bb35d.js"><link rel="prefetch" href="/assets/js/5.7eab6273.js"><link rel="prefetch" href="/assets/js/50.56f9cafe.js"><link rel="prefetch" href="/assets/js/51.591e996b.js"><link rel="prefetch" href="/assets/js/52.d8a55dab.js"><link rel="prefetch" href="/assets/js/53.49cf15bb.js"><link rel="prefetch" href="/assets/js/54.9cf0343b.js"><link rel="prefetch" href="/assets/js/55.38afd6c1.js"><link rel="prefetch" href="/assets/js/56.7c20f0d9.js"><link rel="prefetch" href="/assets/js/57.bf8211fd.js"><link rel="prefetch" href="/assets/js/58.4d4d61ab.js"><link rel="prefetch" href="/assets/js/59.8b2e0e29.js"><link rel="prefetch" href="/assets/js/6.f86bc75a.js"><link rel="prefetch" href="/assets/js/60.f1fb5037.js"><link rel="prefetch" href="/assets/js/61.1111872b.js"><link rel="prefetch" href="/assets/js/62.5f8f5d5e.js"><link rel="prefetch" href="/assets/js/63.818b0c85.js"><link rel="prefetch" href="/assets/js/64.c9825ab0.js"><link rel="prefetch" href="/assets/js/65.c8ff65d1.js"><link rel="prefetch" href="/assets/js/66.6eb152b3.js"><link rel="prefetch" href="/assets/js/67.4a6e498c.js"><link rel="prefetch" href="/assets/js/68.da47c92a.js"><link rel="prefetch" href="/assets/js/69.5b1543d7.js"><link rel="prefetch" href="/assets/js/7.4a1def3b.js"><link rel="prefetch" href="/assets/js/70.31ac2858.js"><link rel="prefetch" href="/assets/js/71.21185529.js"><link rel="prefetch" href="/assets/js/72.0f099e82.js"><link rel="prefetch" href="/assets/js/73.afbaa1a8.js"><link rel="prefetch" href="/assets/js/74.80dd8d0e.js"><link rel="prefetch" href="/assets/js/75.bc6f52b4.js"><link rel="prefetch" href="/assets/js/76.f3d105b7.js"><link rel="prefetch" href="/assets/js/77.c8845eb4.js"><link rel="prefetch" href="/assets/js/8.ece8e8ed.js"><link rel="prefetch" href="/assets/js/9.ec68f296.js">
|
|
<link rel="stylesheet" href="/assets/css/0.styles.26db9e46.css">
|
|
</head>
|
|
<body>
|
|
<div id="app" data-server-rendered="true"><div class="theme-container"><header class="nav"><div class="sidebar-button block md:hidden flex-no-shrink"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <div class="logo-container"><a href="/" class="home-link router-link-active"><img src="/logos/pterry.svg" class="logo"> <span class="site-name hidden md:inline can-hide">Pterodactyl</span></a></div> <div class="w-full"><div class="flex"><div class="search-box"><input aria-label="Search" placeholder="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links flex-no-shrink hidden md:flex"><div class="nav-item"><a href="/project/introduction.html" class="nav-link">Documentation
|
|
</a></div><div class="nav-item"><a href="/community/about.html" class="nav-link">Community Guides
|
|
</a></div><div class="nav-item"><a href="https://discord.gg/pterodactyl" target="_blank" rel="noopener noreferrer" class="nav-link external">
|
|
Get Help
|
|
<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://discord.gg/pterodactyl" 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"><span>Community Guides</span> <!----> <!----></p> <ul class="sidebar-group-items"><li><a href="/community/about.html" class="sidebar-link">Community Guides and Tutorials</a></li></ul></div></li><li><div class="sidebar-group"><p class="sidebar-heading"><span>Panel Installation</span> <!----> <!----></p> <ul class="sidebar-group-items"><li><a href="/community/installation-guides/panel/centos7.html" class="sidebar-link">CentOS 7</a></li><li><a href="/community/installation-guides/panel/centos8.html" class="sidebar-link">CentOS 8</a></li><li><a href="/community/installation-guides/panel/debian9.html" class="sidebar-link">Debian 9</a></li><li><a href="/community/installation-guides/panel/debian10.html" class="sidebar-link">Debian 10</a></li><li><a href="/community/installation-guides/panel/ubuntu1804.html" class="sidebar-link">Ubuntu 18.04</a></li><li><a href="/community/installation-guides/panel/ubuntu2004.html" class="sidebar-link">Ubuntu 20.04</a></li></ul></div></li><li><div class="sidebar-group"><p class="sidebar-heading"><span>Wings Installation</span> <!----> <!----></p> <ul class="sidebar-group-items"><li><a href="/community/installation-guides/wings/centos7.html" class="sidebar-link">CentOS 7</a></li><li><a href="/community/installation-guides/wings/centos8.html" class="sidebar-link">CentOS 8</a></li><li><a href="/community/installation-guides/wings/debian9.html" class="sidebar-link">Debian 9</a></li><li><a href="/community/installation-guides/wings/debian10.html" class="sidebar-link">Debian 10</a></li><li><a href="/community/installation-guides/wings/ubuntu1804.html" class="sidebar-link">Ubuntu 18.04</a></li><li><a href="/community/installation-guides/wings/ubuntu2004.html" class="sidebar-link">Ubuntu 20.04</a></li></ul></div></li><li><div class="sidebar-group"><p class="sidebar-heading"><span>Creating Eggs</span> <!----> <!----></p> <ul class="sidebar-group-items"><li><a href="/community/config/eggs/creating_a_custom_egg.html" class="sidebar-link">Creating a Custom Egg</a></li><li><a href="/community/config/eggs/creating_a_custom_image.html" class="sidebar-link">Creating a Custom Docker Image</a></li></ul></div></li><li><div class="sidebar-group"><p class="sidebar-heading"><span>Game Configuration</span> <!----> <!----></p> <ul class="sidebar-group-items"><li><a href="/community/games/minecraft.html" class="sidebar-link">Minecraft</a></li></ul></div></li><li><div class="sidebar-group"><p class="sidebar-heading open"><span>Tutorials</span> <!----> <!----></p> <ul class="sidebar-group-items"><li><a href="/community/config/nodes/add_node.html" class="active sidebar-link">Creating a New Node</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/community/config/nodes/add_node.html#location" class="sidebar-link">Location</a></li><li class="sidebar-sub-header"><a href="/community/config/nodes/add_node.html#information-required" class="sidebar-link">Information Required</a></li><li class="sidebar-sub-header"><a href="/community/config/nodes/add_node.html#install-the-daemon" class="sidebar-link">Install the Daemon</a></li><li class="sidebar-sub-header"><a href="/community/config/nodes/add_node.html#configuring-the-node" class="sidebar-link">Configuring the Node</a></li></ul></li><li><a href="/community/tutorials/artisan.html" class="sidebar-link">Artisan CLI</a></li></ul></div></li><li><div class="sidebar-group"><p class="sidebar-heading"><span>Customization</span> <!----> <!----></p> <ul class="sidebar-group-items"><li><a href="/community/customization/panel.html" class="sidebar-link">Building Panel Assets</a></li><li><a href="/community/customization/wings.html" class="sidebar-link">Building Wings</a></li></ul></div></li></ul> </div> <div class="page"> <div class="content content__default"><h1 id="creating-a-new-node"><a href="#creating-a-new-node" class="header-anchor">#</a> Creating a New Node</h1> <p></p><div class="table-of-contents"><ul><li><a href="#location">Location</a></li><li><a href="#information-required">Information Required</a></li><li><a href="#install-the-daemon">Install the Daemon</a></li><li><a href="#configuring-the-node">Configuring the Node</a><ul><li><a href="#auto-deploy">Auto-Deploy</a></li></ul></li></ul></div><p></p> <h2 id="location"><a href="#location" class="header-anchor">#</a> Location</h2> <p>Head to the admin panel and click the Nodes tab on the left sidebar. After that, click 'Create New' on the
|
|
top right side to open the page to add a node.</p> <p><img src="/assets/img/pterodactyl_add_node_create_button.66eefa0e.png" alt=""></p> <h2 id="information-required"><a href="#information-required" class="header-anchor">#</a> Information Required</h2> <p><img src="/assets/img/pterodactyl_add_node_new_page.e4cc0663.png" alt=""></p> <ul><li><strong>Name</strong>: a quick identifiable name for the daemon</li> <li><strong>Description</strong>: a long description that is used to help you identify the node.</li> <li><strong>Location</strong>: the location you want the node in. These are configured in the 'Locations' section of the panel and one
|
|
must be created before a node can be created. These simply act as categories for nodes and serve no other purpose at
|
|
this time.</li> <li><strong>FQDN</strong>: the fully qualified domain name for the node — for example: <code>node.demon.pterodactyl.io</code></li> <li><strong>Communicate over SSL</strong>: if the panel is using SSL the Daemon is required to use SSL as well.</li> <li><strong>Behind Proxy</strong>: if you have the Daemon behind a proxy that terminates SSL connections before arriving at the Daemon
|
|
then this option should be selected. If none of that sentence made sense, this doesn't affect you.</li> <li><strong>Server File Directory</strong>: the location on the physical server where the daemon is to store the files the servers
|
|
generate. By default this is <code>/srv/daemon-data</code>.</li></ul> <div class="custom-block tip"><p class="custom-block-title">OVH Users</p> <p>Some OVH users regularly have their <code>/home</code> folder be the largest filesystem. You may want to change to use
|
|
<code>/home/daemon-data</code> if you are on a default OVH box.</p></div> <ul><li><strong>Total Memory</strong>: the total amount of RAM the node should be able to allocate automatically.</li> <li><strong>Memory Overallocate</strong>: the percentage of RAM to over-allocate on a node. For example, if you have set a 10GB memory
|
|
limit, with a 20% overallocation, the Panel will allocate up to 12GB of memory on this node in total.</li> <li><strong>Total Disk Space</strong>: the total amount of disk space the node should be able to allocate automatically.</li> <li><strong>Disk Overallocate</strong>: works the same way as memory overallocation.</li></ul> <div class="custom-block danger"><p class="custom-block-title">DANGER</p> <p>Don't forget to account for OS overhead and other software requirements on machines.</p></div> <ul><li><strong>Daemon Port</strong>: the port that the Daemon should listen on.</li> <li><strong>Daemon SFTP Port</strong>: the port the Daemon sftp-server or standalone SFTP server should listen on.</li></ul> <h2 id="install-the-daemon"><a href="#install-the-daemon" class="header-anchor">#</a> Install the Daemon</h2> <p>At this point you'll need to have the Daemon installed on your machine. Check out the <a href="/daemon/installing.html">documentation</a>
|
|
for more information, or try one of the community guides for <a href="/community/installation-guides/daemon/centos7.html">CentOS</a>,
|
|
<a href="/community/installation-guides/daemon/ubuntu1804.html">Ubuntu</a>, or <a href="/community/installation-guides/daemon/debian9.html">Debian</a>.</p> <h2 id="configuring-the-node"><a href="#configuring-the-node" class="header-anchor">#</a> Configuring the Node</h2> <p>Go to the Node Configuration page</p> <p><img src="/assets/img/pterodactyl_add_node_config.91ee33a6.png" alt=""></p> <p>Copy and paste the config into the <code>core.json</code> file. (Default location is <code>/srv/daemon/config/core.json</code>)</p> <h3 id="auto-deploy"><a href="#auto-deploy" class="header-anchor">#</a> Auto-Deploy</h3> <p>This will generate a command to run on the node server to configure the daemon for you. (This needs to be run in the <code>/srv/daemon</code> folder, or <code>/home/daemon</code> if you're using the <code>/home</code> directory to store the Daemon)</p></div> <div class="page-edit"><div class="edit-link"><a href="https://github.com/pterodactyl/documentation/edit/master/community/config/nodes/add_node.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 class="page-nav"><p class="inner"></p> <div class="prev"><span>
|
|
←
|
|
<a href="/community/games/minecraft.html">Minecraft</a></span></div> <div class="next"><span><a href="/community/tutorials/artisan.html">Artisan CLI</a>→
|
|
</span></div></div> </div></div><div class="global-ui"></div></div>
|
|
<script src="/assets/js/app.5ed11237.js" defer></script><script src="/assets/js/4.cda5f594.js" defer></script><script src="/assets/js/1.d27374d7.js" defer></script><script src="/assets/js/17.403d3937.js" defer></script>
|
|
</body>
|
|
</html>
|