mirror of
https://github.com/pterodactyl/documentation.git
synced 2025-12-10 10:44:43 -06:00
57 lines
20 KiB
HTML
57 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>Using Mounts | 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.f2945e27.js" as="script"><link rel="preload" href="/assets/js/4.166b9bf8.js" as="script"><link rel="preload" href="/assets/js/1.19e16341.js" as="script"><link rel="preload" href="/assets/js/22.f9353e9f.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.08b142d8.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.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.69bb49e0.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.d561e4f4.js"><link rel="prefetch" href="/assets/js/32.5ec9cc12.js"><link rel="prefetch" href="/assets/js/33.8f006b9e.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.26c44a85.js"><link rel="prefetch" href="/assets/js/37.bb650e96.js"><link rel="prefetch" href="/assets/js/38.8014c1ae.js"><link rel="prefetch" href="/assets/js/39.d1e0976c.js"><link rel="prefetch" href="/assets/js/40.6726a903.js"><link rel="prefetch" href="/assets/js/41.e352cd67.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.b8b05e62.js"><link rel="prefetch" href="/assets/js/48.bddaa49b.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.b21452cd.js"><link rel="prefetch" href="/assets/js/51.44a25af8.js"><link rel="prefetch" href="/assets/js/52.c69a9cce.js"><link rel="prefetch" href="/assets/js/53.2cf7d527.js"><link rel="prefetch" href="/assets/js/54.a806efe3.js"><link rel="prefetch" href="/assets/js/55.3ff57f8d.js"><link rel="prefetch" href="/assets/js/56.0431282b.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.0bbceca9.js"><link rel="prefetch" href="/assets/js/6.92501184.js"><link rel="prefetch" href="/assets/js/60.02ba8c2d.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/63.30dbbed7.js"><link rel="prefetch" href="/assets/js/64.4ee3782b.js"><link rel="prefetch" href="/assets/js/65.8abdf088.js"><link rel="prefetch" href="/assets/js/66.db520d3d.js"><link rel="prefetch" href="/assets/js/67.45d379df.js"><link rel="prefetch" href="/assets/js/68.ae40e5e7.js"><link rel="prefetch" href="/assets/js/69.03eebd32.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.a824f4b4.js"><link rel="prefetch" href="/assets/js/73.bcb8dfe0.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="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"><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 open"><span>Guides</span> <!----> <!----></p> <ul class="sidebar-group-items"><li><a href="/guides/mounts.html" aria-current="page" class="active sidebar-link">Using Mounts</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/guides/mounts.html#wings-configuration" class="sidebar-link">Wings Configuration</a></li><li class="sidebar-sub-header"><a href="/guides/mounts.html#panel-configuration" class="sidebar-link">Panel Configuration</a></li></ul></li></ul></div></li></ul> </div> <div class="page"> <div class="content content__default"><h1 id="using-mounts"><a href="#using-mounts" class="header-anchor">#</a> Using Mounts</h1> <p>Mounts is a feature that allows administrators to mount other directories from the host file-system into a Server's container.</p> <h2 id="wings-configuration"><a href="#wings-configuration" class="header-anchor">#</a> Wings Configuration</h2> <p>For security reasons it is not possible to mount directories on a node by default. Directories that should be mountable have to be specified explicitly in the Wings configuration.</p> <p>In the Wings configuration file (<code>/etc/pterodactyl/config.yml</code>) the <code>allowed_mounts</code> field is used to list mountable directories. The listed directories and all their subdirectories can be mounted.</p> <div class="language-yml extra-class"><pre class="language-yml"><code><span class="token key atrule">allowed_mounts</span><span class="token punctuation">:</span>
|
|
<span class="token punctuation">-</span> /example
|
|
</code></pre></div><p>You have to restart Wings to apply new changes to your Wings config.</p> <h2 id="panel-configuration"><a href="#panel-configuration" class="header-anchor">#</a> Panel Configuration</h2> <p>You have to configure mounts in admin Panel in order to use them with your servers. They consist of a source pad on the node and a target path where it will be mounted in the container.</p> <div class="custom-block warning"><p class="custom-block-title">Path in the container</p> <p>Mounts cannot be mounted to or inside of <code>/home/container</code> or any subdirectory of it, nor can you cross-mount servers such as Server A's directory into Server B.</p></div> <h3 id="creating-a-mount"><a href="#creating-a-mount" class="header-anchor">#</a> Creating a Mount</h3> <ol><li>In the admin Panel go to <strong>Mounts</strong>.</li> <li>Create a new mount.</li> <li>Fill in the details as required.
|
|
<ul><li><strong>Name</strong>: Name for your mount.</li> <li><strong>Description</strong>: Description for your mount.</li> <li><strong>Source</strong>: The absolute path to the folder or files on the Node machine.</li> <li><strong>Target</strong>: The absolute path where the mount will be placed inside of your server, can <strong>not</strong> include <code>/home/container</code> in the path.</li> <li><strong>Read Only</strong>: Whether the mount will be read-only for the servers using it.</li> <li><strong>User Mountable</strong>: Whether to allow users to self mount this mount.</li></ul></li> <li>After creating the mount, you are required to add both <strong>Eggs</strong> and <strong>Nodes</strong> that this mount may be used on.</li></ol> <div class="custom-block warning"><p class="custom-block-title">Mounts used by multiple servers</p> <p>All servers using the same mounts will <strong>only</strong> share their contents when they are on the same node. Mounts are not synchronized between nodes.</p></div> <h3 id="assigning-a-mount-to-a-server"><a href="#assigning-a-mount-to-a-server" class="header-anchor">#</a> Assigning a Mount to a Server</h3> <ol><li>In the admin Panel navigate to the server you would like to use a mount with</li> <li>Go to the mounts page</li> <li>Click the <strong>+</strong> button</li> <li>Restart the server</li></ol> <p>The files of the mount should become available in the target path in the container. You can temporarily change your server startup command to <code>ls <mount target></code>, which should output the contents of the mount if configured correctly.</p> <div class="custom-block warning"><p class="custom-block-title">Mounts cannot be accessed</p> <p>Mounts do not appear in the Panel's file manager, nor are they accessible via SFTP. However, the server itself will be able to see and use the mounts.</p></div> <h3 id="example-mount"><a href="#example-mount" class="header-anchor">#</a> Example Mount</h3> <p>The example mount below is stored in the path <code>/var/lib/pterodactyl/mounts</code>, which we add to the Wings <code>config.yml</code></p> <div class="language-yml extra-class"><pre class="language-yml"><code><span class="token key atrule">allowed_mounts</span><span class="token punctuation">:</span>
|
|
<span class="token punctuation">-</span> /var/lib/pterodactyl/mounts
|
|
</code></pre></div><p><img src="/assets/img/gmod_mount_example.16b990a7.png" alt=""></p></div> <div class="page-edit"><div class="edit-link"><a href="https://github.com/pterodactyl/documentation/edit/master/guides/mounts.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 class="page-nav"><p class="inner"></p> <div class="prev"><span>
|
|
←
|
|
<a href="/tutorials/creating_ssl_certificates.html">Creating SSL Certificates</a></span></div> <div class="next"><!----></div></div> </div></div></div><div class="global-ui"></div></div>
|
|
<script src="/assets/js/app.f2945e27.js" defer></script><script src="/assets/js/4.166b9bf8.js" defer></script><script src="/assets/js/1.19e16341.js" defer></script><script src="/assets/js/22.f9353e9f.js" defer></script>
|
|
</body>
|
|
</html>
|