From 9ed40aa330fc6f51de8adcfa8f976b879c139ca5 Mon Sep 17 00:00:00 2001 From: rowansc1 Date: Wed, 11 Jun 2025 07:32:37 +0000 Subject: [PATCH] deploy: 2442481f743bd982c16399f0b9e9a7865da87795 --- 404.html | 4 ++-- assets/js/{10.08db94b8.js => 10.08b9c98e.js} | 2 +- assets/js/{12.54d684d5.js => 12.a4261b01.js} | 2 +- assets/js/{14.10dbee7a.js => 14.ed610c4a.js} | 2 +- assets/js/{15.954755fc.js => 15.2fc81408.js} | 2 +- assets/js/{20.5c80f685.js => 20.a720acbc.js} | 2 +- assets/js/{22.c4d3c3e7.js => 22.8f7ee701.js} | 2 +- assets/js/{29.173d87c8.js => 29.26f1f5b0.js} | 2 +- assets/js/{30.1e9b9a83.js => 30.d2985bea.js} | 2 +- assets/js/{31.1a5025b8.js => 31.acd28f7f.js} | 2 +- assets/js/{32.832c5249.js => 32.f259a483.js} | 2 +- assets/js/{33.940dfd44.js => 33.7c770712.js} | 2 +- assets/js/{34.49d78ff7.js => 34.e93e5695.js} | 2 +- assets/js/{35.28ffe57a.js => 35.a04be06d.js} | 2 +- assets/js/{36.d63650be.js => 36.9e445fd9.js} | 2 +- assets/js/{37.25a34a1f.js => 37.c39b55c9.js} | 2 +- assets/js/{38.059a51d4.js => 38.e108ac1d.js} | 2 +- assets/js/{39.9031af87.js => 39.867da03c.js} | 2 +- assets/js/{40.d5244f41.js => 40.34edc760.js} | 2 +- assets/js/{42.03a43dda.js => 42.ea03a576.js} | 2 +- assets/js/{43.9b0bb612.js => 43.74132eec.js} | 2 +- assets/js/{44.a7d15b9f.js => 44.f5ae5bdc.js} | 2 +- assets/js/{45.ec543ccc.js => 45.4bb149c0.js} | 2 +- assets/js/{48.c19ab66e.js => 48.07ebc20a.js} | 2 +- assets/js/{49.f62e3b58.js => 49.342049a1.js} | 2 +- assets/js/{52.958909d9.js => 52.8e320849.js} | 2 +- assets/js/{53.563a7575.js => 53.944dc699.js} | 2 +- assets/js/{54.57d4e764.js => 54.d6bff428.js} | 2 +- assets/js/{55.812633bb.js => 55.a226dbb6.js} | 2 +- assets/js/{57.5d950550.js => 57.3b5f3f55.js} | 2 +- assets/js/{58.6917e3e6.js => 58.8fe9d86f.js} | 2 +- assets/js/{59.74ce363c.js => 59.d3aa2768.js} | 2 +- assets/js/60.6a6972b5.js | 1 + assets/js/60.7c144676.js | 1 - assets/js/{61.d30789b5.js => 61.78ebf38b.js} | 2 +- assets/js/{62.3ad9c42c.js => 62.53e80a9f.js} | 2 +- assets/js/{66.6b9cb27a.js => 66.6040c100.js} | 2 +- assets/js/{67.8bad66f0.js => 67.275f5b02.js} | 2 +- assets/js/{68.66b31eec.js => 68.06aa0e75.js} | 2 +- assets/js/{70.cbd191fe.js => 70.d1a2a03a.js} | 2 +- assets/js/{71.e6dd244d.js => 71.023c6d55.js} | 2 +- assets/js/{9.3e9e31a6.js => 9.90f962cd.js} | 2 +- assets/js/{app.c4b579df.js => app.b423fbf1.js} | 4 ++-- community/about.html | 4 ++-- community/config/eggs/creating_a_custom_egg.html | 4 ++-- community/config/eggs/creating_a_custom_image.html | 4 ++-- community/config/nodes/add_node.html | 4 ++-- community/customization/panel.html | 4 ++-- community/customization/wings.html | 4 ++-- community/games/minecraft.html | 4 ++-- community/installation-guides/panel/centos7.html | 4 ++-- community/installation-guides/panel/centos8.html | 4 ++-- community/installation-guides/panel/debian.html | 4 ++-- community/installation-guides/wings/centos7.html | 4 ++-- community/installation-guides/wings/centos8.html | 4 ++-- community/installation-guides/wings/debian.html | 4 ++-- community/tutorials/artisan.html | 4 ++-- daemon/0.6/configuration.html | 4 ++-- daemon/0.6/debian_8_docker.html | 4 ++-- daemon/0.6/installing.html | 4 ++-- daemon/0.6/kernel_modifications.html | 4 ++-- daemon/0.6/standalone_sftp.html | 4 ++-- daemon/0.6/upgrade/0.4_to_0.5.html | 4 ++-- daemon/0.6/upgrade/0.5.html | 4 ++-- daemon/0.6/upgrade/0.5_to_0.6.html | 4 ++-- daemon/0.6/upgrade/0.6.html | 4 ++-- daemon/0.6/upgrading.html | 4 ++-- guides/mounts.html | 4 ++-- guides/php_upgrade.html | 4 ++-- index.html | 4 ++-- panel/0.7/configuration.html | 4 ++-- panel/0.7/getting_started.html | 4 ++-- panel/0.7/troubleshooting.html | 4 ++-- panel/0.7/upgrade/0.6_to_0.7.html | 4 ++-- panel/0.7/upgrade/0.7.html | 4 ++-- panel/0.7/upgrading.html | 4 ++-- panel/0.7/webserver_configuration.html | 4 ++-- panel/1.0/additional_configuration.html | 4 ++-- panel/1.0/getting_started.html | 11 ++++------- panel/1.0/legacy_upgrade.html | 4 ++-- panel/1.0/troubleshooting.html | 6 ++---- panel/1.0/updating.html | 4 ++-- panel/1.0/webserver_configuration.html | 4 ++-- project/about.html | 4 ++-- project/community.html | 4 ++-- project/introduction.html | 4 ++-- project/terms.html | 4 ++-- tutorials/creating_ssl_certificates.html | 4 ++-- tutorials/mysql_setup.html | 4 ++-- wings/1.0/configuration.html | 4 ++-- wings/1.0/installing.html | 4 ++-- wings/1.0/migrating.html | 4 ++-- wings/1.0/upgrading.html | 4 ++-- 93 files changed, 146 insertions(+), 151 deletions(-) rename assets/js/{10.08db94b8.js => 10.08b9c98e.js} (99%) rename assets/js/{12.54d684d5.js => 12.a4261b01.js} (98%) rename assets/js/{14.10dbee7a.js => 14.ed610c4a.js} (98%) rename assets/js/{15.954755fc.js => 15.2fc81408.js} (99%) rename assets/js/{20.5c80f685.js => 20.a720acbc.js} (99%) rename assets/js/{22.c4d3c3e7.js => 22.8f7ee701.js} (98%) rename assets/js/{29.173d87c8.js => 29.26f1f5b0.js} (68%) rename assets/js/{30.1e9b9a83.js => 30.d2985bea.js} (68%) rename assets/js/{31.1a5025b8.js => 31.acd28f7f.js} (88%) rename assets/js/{32.832c5249.js => 32.f259a483.js} (99%) rename assets/js/{33.940dfd44.js => 33.7c770712.js} (98%) rename assets/js/{34.49d78ff7.js => 34.e93e5695.js} (98%) rename assets/js/{35.28ffe57a.js => 35.a04be06d.js} (99%) rename assets/js/{36.d63650be.js => 36.9e445fd9.js} (99%) rename assets/js/{37.25a34a1f.js => 37.c39b55c9.js} (98%) rename assets/js/{38.059a51d4.js => 38.e108ac1d.js} (96%) rename assets/js/{39.9031af87.js => 39.867da03c.js} (98%) rename assets/js/{40.d5244f41.js => 40.34edc760.js} (90%) rename assets/js/{42.03a43dda.js => 42.ea03a576.js} (99%) rename assets/js/{43.9b0bb612.js => 43.74132eec.js} (98%) rename assets/js/{44.a7d15b9f.js => 44.f5ae5bdc.js} (98%) rename assets/js/{45.ec543ccc.js => 45.4bb149c0.js} (98%) rename assets/js/{48.c19ab66e.js => 48.07ebc20a.js} (98%) rename assets/js/{49.f62e3b58.js => 49.342049a1.js} (97%) rename assets/js/{52.958909d9.js => 52.8e320849.js} (99%) rename assets/js/{53.563a7575.js => 53.944dc699.js} (99%) rename assets/js/{54.57d4e764.js => 54.d6bff428.js} (99%) rename assets/js/{55.812633bb.js => 55.a226dbb6.js} (99%) rename assets/js/{57.5d950550.js => 57.3b5f3f55.js} (96%) rename assets/js/{58.6917e3e6.js => 58.8fe9d86f.js} (99%) rename assets/js/{59.74ce363c.js => 59.d3aa2768.js} (99%) create mode 100644 assets/js/60.6a6972b5.js delete mode 100644 assets/js/60.7c144676.js rename assets/js/{61.d30789b5.js => 61.78ebf38b.js} (99%) rename assets/js/{62.3ad9c42c.js => 62.53e80a9f.js} (78%) rename assets/js/{66.6b9cb27a.js => 66.6040c100.js} (98%) rename assets/js/{67.8bad66f0.js => 67.275f5b02.js} (96%) rename assets/js/{68.66b31eec.js => 68.06aa0e75.js} (99%) rename assets/js/{70.cbd191fe.js => 70.d1a2a03a.js} (99%) rename assets/js/{71.e6dd244d.js => 71.023c6d55.js} (97%) rename assets/js/{9.3e9e31a6.js => 9.90f962cd.js} (99%) rename assets/js/{app.c4b579df.js => app.b423fbf1.js} (83%) diff --git a/404.html b/404.html index dc5ec105..b0f2e527 100644 --- a/404.html +++ b/404.html @@ -15,7 +15,7 @@ - + @@ -44,6 +44,6 @@ current

  • Tutorials

  • Guides

    • Help us improve this page. (opens new window)
    - + diff --git a/assets/js/10.08db94b8.js b/assets/js/10.08b9c98e.js similarity index 99% rename from assets/js/10.08db94b8.js rename to assets/js/10.08b9c98e.js index 9e0b7415..97122020 100644 --- a/assets/js/10.08db94b8.js +++ b/assets/js/10.08b9c98e.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[10],{272:function(A,e){A.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAArMAAAD9CAIAAAAgSGh5AAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA7DAAAOwwHHb6hkAAAfUElEQVR42u2d8W8TR77A73/yr++3W8mKQESFZy5yq/Y4ob57uoprpfQ4kr7nlmLB8cQpPgk1CohixL0CwSlNhNJQkiYR0eVBgb4kV6Bp04a6DjEQiAOmUfTw+2HXu7O7M7vrxHZi7+ejr1ozXs+ux7Mzn52Z3fzq0dPnBEEQBEEQevyKIiAIgiAIAjMgCIIgCAIzIAiCIAgCMyAIgiAIAjMgCIIgCAIzIAiCIAgCMyAIgiAIAjMgCIIgCAIzIAiCIAgCMyAIgiAIAjMgCIIgCAIzIAiCIAgCMyAIgiAIojHM4OGTZwRBEARBNHpUwQwePnn28Mnzh4Ic5JdWCIIgCIJolLDM4Onzh0+e+/rBr3y04OnzB4+W537Kz/6Yu/dD7t4PubtzPxMEQRAE0Sihd9+zP+bmfso/eLSsX+2vxwx0LVh4+HTmu+z7/V//OvXlvxy7ShAEQRBEI8avU1++3//1zHfZhYdPveXAwwyeP3zy7Pv7D97v/5oCJQiCIIgmiPf7v/7+/gN9qUBlZqBPSCw+Xrn7fVb7G6MFBEEQBNEMof3ty7vfZxcfr3gsSPQ2g8Kd734qAQAAQLNw57ufFh8X1mkGDx4V/jl7n0IEAABoGv45e//Bow2Ywcy3mAEAAEDzMPPtes0gv7Sy8HD5n5gBAABAM40ZfHt/4eGy/pwDzAAAAAAzwAwAAAAAMwAAAADMAAAAADADAAAAwAwAAAAAMwAAAADMAAAAABrFDGa7X9NUHBgK9OnXumf9tlvL/6P7rf8arvBT62Zt/IPtmqZt/2B8TXbAxvcSX9fsSOr7xQEAADOoihlsf739PyX891S1zMDeCde6g1wb/2C71traqkXf+aywuWZQ3y8OAACYQXXMoOadVT06YZPCZ+9EtV3H/t61W9P2ns5uITMAAABofDNYmzjUqmnbDwwVbAmt7w0XnJ9eutH9dnxHi6ZpWsuO+Nvd/8ivlUql0tABxwyF+Cm967x8/3Jiz44WTdOi237zdveNJWH/9y8f/n1Mf+v1xOX7lw/4mEwhs0/Tth+aKE137da03V3TAc1gLf+P0/v3lA9/z/7T4lGUSks3VO8u3Ti9f88r26Ka+cWN9zy/uPce/YpFUdQAAIAZ1GHMoDD8XqumtR6aWLO8QP+Hu49v/V2i+8LAwIXu9rZouVv++auBU3/apWl7jw4MDHz1s+xTra0tr+7vvjBwoXv/qy2aMAuwNHSgVdP0N9OH9+6Mtra2eh9v9vReXQzKMyW2xQZKM9B3FG1r774woO9J01oPDC3Z3t2593C6/G70jROzpVJp7fax3eUDHBhId73VFtW06Jtns35f3HuP3sWiLGoAAMAMargC0bqc1t1g97Hbv0wc0l+subxitvs1TXv3stkLL53/Q3Tb73ruSC7PXWagvXb8TvmDa0MHouVt18Y/2K5F3+g239R7Uy8zmO1+TdN2Hbtt/cOmBgoz0JcsCkdR+uXGX6wRB330wfzWpdJSZl/LtvjfbpZK147u2tZqDagYcxnmd1V+cZ89ehaLZ1EDAABmUKsViOICxMLwe61adOfOVntvJnR1hc/eiWrRtvfO37y/sibdi9oM4sfvSEcxJg5t17R9GXEV4Z3jcS8zcMwgZE/v1WzrEBVmINmR/tldx26XSj+ceKOCtRiz3a9ZeSm/uPcevYvFs6gBAAAzqM8KxMLQge2apsVTM2vyT6/dOfvWTn2yPbrtlT37uwf+15z89jED2/6tlLXL7zq6x5I+ea86Xv1CXBxYz57eq4nrEBVmMHTAGmiw7Uk7MFQqDb8X9V5GuLaSn7t5deBC9+E//f4326LCqIbyi3vv0bNYvIsaAAAwg7qYgT6frtkH1d2f/iV3c6A78XtjcZw5EbA+Myhk9lVkBsZjDCSYsrAuM7A6bMk+rU66ZceuXXv+ePjQvl21NgOvogYAAMygDmage8Huv6T/Yp9wV396beV26rXyUsB1moFsyN3jePUZ/t0HzgzYOPZvUWuxQaWzCfHjd6SzCT+ceKNlx58+fayvd9z392+tYf3bx4KYgfceg5iBoqgBAAAzqLkZ6F7Qemhizbg1wXQD69PPP0+8sq1VXOy3dP4PGzUD1wpEY+RCeryFzD7N/QCD8kiCsdigwhWIrYf/p1Ryr0Bcu3PcOMahA5ptMaDxOX8z8NmjV7F4FzUAAGAGNXsGor4G0fCC94b161t9vYHRTYrL4obfa9W0llf/2JU2b98z7uwrlR6cfVPTtr957IL8rkX1xfHSZ++0lG8KvND11s5oNBqVm4FrsaHFdNfusjNs7K5F493Eqy3lAsmefTOqaS2vJtIDAwMXuve/vi3a0tJiHaH6iwe4a1FVLJ5FDQAAmEHN/m6CdmDIuDze/u5l4Sk7mX1R43LX1oGt5Ue6ytPeWsuOPYn+738xPzN++PVtUU3T3jjxQyVmUCqtCU/7eT1xeeS4fIxjumu39A8lWNag7T2dreBJR4nzM4onHdmfOrR0o/ttfdVhdNsrexLn/zc/fmi7pSjKL+69R59i8SpqAADADML0txbvHI/bh+8BAAAwg7CYwYOzb7bs+PePrStna4IfAAAAMwjfmEH27JvR8kOJy88Itmb/AQAAMIOwzSb88n1/ovznilp27Nl/mr8dBAAAmAHrDAAAAAAzAAAAAMwAAAAAMAMAAADADAAAAAAzAAAAAMwAAAAAMAMAAADADAAAAAAzAAAAAMwAAAAAGsUMngEAAECzgBkAAABAVc2AgRcAAABmEzADAAAAzAAzAAAAwAwwAwAAAMwAMwAAAMAMMAMAAADMADMAAAAAzAAAAAAwAwAAaApevny5vLycz+cXITD5fH55efnly5eYAQAANBvLy8tLS0svXrz4BQLz4sWLpaWl5eVlzAAAAJqNfD6PFqxPDvL5/CaYQSQY1GwAAFgfi4uLdPPrY3FxcXPMwPdHxQw2wv/Nnv/xtzvv7WqVx2/fXZxdo5QAADOAcJrBWCISiUQSY9ZrG/obMubTcZ8tjAzj6fnK3qo13/y8t1WpBXrs/aiw5U7k6v5S7ty8fkiwl1vAkvfPqxkLPUjLUFFtr8tvKmmLyl+kWr83ZoAZNI0ZKHtv66zxOFG2phkM39/lZwa7PnjUaGZQ4S+FDVTNDNZXj5v2BwjUMmy93xQzAMzAq78RzhD9PWmzp580iUTCdaaIDYMjQ9Vbeno8kYiL7ax4Xtp2YTthhXdU6c1qBhv6pdRjBra+T8gyaPGGwAzUJS8WkqvszBoe2/evkWYtS2XLUNlp6xAnc6PEWMnddBjNiXdTEbiZUnwlxamwOVc3mAFmsCXNoHxClv/vZdmSjt7zrXh6XnZpVj4M1zvGG6r0kJuB6pdSmcHGize8ZqCeaXDU8FQq3qxm4F3fgtcrsU46Si8e925VpIprq7MebZG/GVRzPgkzwAyaajbBOu3tDYBxxtmbQz0Dj7fcE5NOSRf24vJ3ldf7zSb8xyPpKsO1oflmmk1Q/VKB1hkI6RUUb1hnE+x12u4Mkqn35pxN8G4ZKjhtXXXPs+mw6YRY5B5tiDxDPzPw+pUxA8wgLGYgr/HiSW9rAJytnXCB5fGWu3mQNr/yCzNHVxd8NqHJzKDCX8rHDMT8pXsM92yCx2CWa5hcJVZNaQZ+9S34aSsUTwVNh6vBkf5YXhn6mYHXr9xsZpDL5ZLJZCaTMVMymUwymaxFX5tMJnO5nPeRiC8wg82cTfA8UWTjafUwA/f+/dJDMJtQ8S+lMgPJJxwDQiGfTlCXPGbgObZf4WlbkRnYfQIzqJkZ9PT01KJjnp6ezmQyo6OjvmbAmMEWNgP5il2/YTr/IUH3gi3/rifAOHiIzcDjl1KYga3g7T9Z4OINqxn4zyY0uxl41bdKT9uKZhNkZuDRhjCbUKEZ6FfzuVxOHDPQ39WZnp42+3gzUez43YkiPT09uVyup6fHMYqgI+7IoQiObPVM9IP0PSrMoMr9jfuM877kDLwCUdJuSjZWXdR6XOyG1Qw8fynFmIFqeVUFxRtWM/Bfgaio4c1SkF71reLTtqIViDIz8GhDWIFYiRlMT0/rXezo6KjexTrG/8Xe2nwxOjpqDjZIE8W96E6QyWTMvrynp0d/PT09rXuDezbBHGbQtzHfdST6HgBmUJX+RnIhKVXwSCQST6dVdy3a35LrveruOft5rbqtzuNrNMuTjjb0SynXGZjFHk/P29rdoMUbXjMo+d21aPuYuWmTlKVfy1DZaesYVjBrpeKuRcWvo2xDvJopf+UJyV2LekerDxWYV/bSy263LgRfQzA6Omr25fqO3HuRmoFj8CCXy4nvOrZUHcDIyEjSxcjIyBY1A/5uQk3h6cgADe1m3CZTNzPQr871/zr6bHPcXjrFYHbG0kTH2gUxH/fMgtsMHEeiW4vKDLwPwCEHvlqwaWYAAADSK/+Qj1ltlhnoV/aOC3F9wF86kCAO5nskOiRAn1Co+piB91GJchBECzADAICt5wY81Lu+ZqAvLxC7XncfnMvlxH7XfC1NFKcSzLUF4oSCuc7AzDz4OgP3wXscgCgHAbUAMwAAgLCbgbRjHh0d1a+ze3p6zI7cPb+gSjRnAVSLEhzj//qkg++9CdLXHgfQSCsQAQAANtcMADMAAADMADADAADADAAzAAAAzIA+HjMAAADADDADAAAAzAAzAAAAwAwwAwAAAMwAMwAAAKiQfD7/4sULuvlKefHiRT6fxwwAAKDZWF5eXlpaQg4q1YKlpaXl5WXMAAAAmo2XL18uLy/n8/lFCEw+n19eXn758iVmAAAAAP5gBgAAAIAZAAAAAGYAAAAAmAEAAABgBgAAAIAZAAAAAGYAAAAAW8YMngEAAECzwJgBAAAAMJsAAAAAmAEAAABgBgAAAIAZAAAAAGYATUzh2YoejtcAAIAZQNgVgUIAAMAMADADAADMAJqLqW/mNh6FZytVyadpgnoFYWZ1dbVYLD6vHsVicXV1FTPADKB+ZsCYwRYsUoDG1YLntSHMcoAZAGZAkQI0KtUdLXCMHGAGmAFgBpgBQIPxvJZgBpgBYAaYAQBmgBlgBoAZUKQAmAFmgBkAZkCRAmAGmEG9zeCrYFCz6cYwA8wAADMIixn47h4zoBvDDDADAMwAM8AM6MYwA8wAoH5mUCgUrpV5+vQpZhA2M5hPxyOJMWeKTjw9X+Fny4wlIi7KWwbKX8hA3ErMV77nEHZj11Ox1HXMoNZmoKh7VnW211ZVuqpuq7ff8uQSHYOJmWasKzO3Ih23mqydCdjHZzKZ3t7ea9euXbp06cyZM5hBqMzAaI2c7Zzx77GEVwPl/qxnm2pkFCj/sYSQPpYof8C2vZgRZoAZ1NgM1HVvLCGvhop0Rd1W54MZYAZ1NIOFhYVkMplMJjs7Oz/88EPztf5iamoKM2hyMzA69ngiIV73z6fjjqsbWdct/6xXoyqOF/jl79hGmo/HwYXTDFKpWCwWi5UVIdvXHkuZf3lZfN1nbCjKxHUjrT2Vam/vy9oTbdYhTQyBGajrXmVioKrbDS0GuhkM34t3DEY6BoWu1G4MVi+bS3SMp2fM7cfTi7asjMRhsVcupLv09MFI1z2h/BTpi+XM/TcupLv0fZlHojqGsIwZjIyM9Pb25uz09vaOjIwUCgXMoOnNID1WbqusJsnR2yqmC+SfVRuI7SLJN/+APb66kQ2hGcT0Dj3b16732eYLZ6KxYel6qvxKeGllZCWKOUkTwzFmoKp78+l4PB53TwEo0pV1W5VPw5iB2YPOD48LBqAyA2v7sU/MfjqX6BiMDxeErl3fppDuKqfr+Rvbq9LN/YobFNJdg5FPciXnTgvpLocomB+xHWd4zGBycrK/v398fHxubq6vr29hYeHq1av9/f2Tk5PMJjS/GUg7Z2dv69P7BjAD+8VWkPz1tDFr1lW6h5BMJlQ8m2C8VpqBK9H26WyfMWYgiIO1gTQxhGagnhGbT8etoQRJurpuq/JpnDGDGfc/vcxAkj5zS7zEtwzDOaRfSHcNJmaCp5ujCGKi1B5cnw3lOgPdDE6dOjU5OXn06NG5ublTp05hBphBFc3ALz+VGUQUc7Eh04LAZmB22JWbgSkDTjMQ8UgMmxl41z1JZRXTA9Rtnze2qhmIMwJmX1uZGcwPj5vX9M70jkFHxIcLXum2SYRybq6ZhfhwwfIJ58CD1CcwA8wglGYQcDYhqBm4O/4A+bs+ZN9oPh2PhGAWYZ1jBuUOvwpjBu4hgQYeJ6iOGfjXPdUZYaT71O2KRuNCZQbunr7SdMwAM8AM1m8GjhbJZ8rfr/1yfzxI/s5E4TPed0uE2AyMLtvW3xvX9Nm+9piXGfisM1CuSGjUIYP1moG07qlWJnqkS+t2Y6+urfNsgjvDAOmeswmyg/TcRQjM4OLFi1NTUz09PQsLCxcvXsQMwm0GFdy16G8GsiHRIPm7hjH0f4VjyeE6xwyMexNsEwPlQf++lKcZWNMEqb4+yb0JogJIE0NgBsq6pxpyC5xu/Mtz6K4RzEC2olBc9KffF+C9MlG1+s++SHDmVvkmAlW6lb8wDuG1AlHQGnGz8K5AvHTpkiMRM9hMM9iMv5sQ9ElHssbK+VnHNt73PHrmLz72xdiD40kwIXnaUV0f2NfQtxzUskg9657ioVzKdEnd9ty+IcxAuAvRNmgv3AE4Y161q8yg5Lxj0H7LQERyl6MifdF9C2VJfdei42EM5mYhvWvx8ePHR44cSdo5cuRIPp/HDDbBDAA2wwzMwYXGHgnYorIF68a5MgDqZAb83QTMAOjGKFLYMipgXffbbyYEzAAzAKAbo0hDiHgjIlqAGWAGAHRjFCkAZoAZANCNUaQAmAFmQNUEujGKFAAzwAwwA6Abo0gBMAPMADMAujGKFGDLUCwWa6QFxWIRM8AMgG6MIgVoMFZXV2tkBqurq5gBZgB16saIqgf1CkIuB9UdOSgWi2HWAswAAAAAMAMAAADADAAAAAAzAAAAAMwAAAAAMAMAAADADAAAAAAzAAAAgK1pBs8AAACgWaiCGTwHAACAZgEzAAAAAMwAAAAAMAMAAADADAAAAAAzAAAAAMwAAAAAMAMAAADADKABmfpmjqh6UK8gzKysrBSqzcrKCmaAGUD9zIAnj1YXzADQgloQZjnADAAzwAwAGpVCLcEMMAPADDADAMwAM8AMADPADAAwA8wAMwDMADMAwAwwA8wAMAPMAAAzwAw2zwy+CgY1GzMAzAAAMwiLGfg2apgBZgCYAQBmgBlgBpgBYAYA9TODJ0+ejJV5/PgxZhA2M7h7si3SeUVMudIZMSm/I6Y533PmptN28q7HHv22UR0bZuAi29ceS10P1ileTwXeFDNwIjsvbNXZXqdV6baMbGeAKn3L82Nnx2DnzdptD5tgBhcuXDh37tzY2Fgmk/n4448xg1CZgdF6Ce3clU5n4ybpmm0bOXIzNldsEmgb1bFhBpjBZpmB+ry40imvo4r0K51Cnb/SKZ4M0nTMAOppBtls9uDBgwcPHvzzn//8/vvvm6/1F7dv38YMmtwMjI63rbNTvC53Nkm29sqn2bp7ss1xZeTu9oNsozo2zEBtBqlUTMfo+EVdEF5fT1mbhlYR1mMG6vOiMjFw1H/f9AYyg89n2joGIx2DkY7Rk/MyA7h5I9Jx44pk+xvhPsW33JjBF198ce7cuZ/snDt37osvvnjy5Alm0PRmcPKK74i9pMFSt2GObl6acZBtAh4bZmB1/LH2vqzR8+uv1GYg2QAzWI9W6/X47sm2trY29ySAIl2hwsr0xjEDs4O/cnYw8teZu35mYG5/9/NR5GBLmcHExMSnn3765Zdfzs7O9vb2ZrPZoaGhTz/9dGJigtmEkMwmePe+sskE9TinUxlkChFkm2DHhhnIZhPM1x5jBtfDPrOwYTNQz4jdPdlmDSVI0vX6fsVagWDkokpvyNkEx9iAbzqTC1vSDE6cODExMXH48OHZ2dkTJ05gBpiBWgs8e3LMoBHMwBhcwAyqoQX+sw6OdH2azL2eQJXevGZgzjg8f/48f/Kvg22f5+mzMQPMYGubwd2TbcolhuqOvHqzCZhB7ccMwjudsH4zUJ0XwTzbMAPb533SMQPADDCDrWEGHncMeM+GOnJSrkD02wYz2LgZWCsO9HUIwjoD/SXrDCpFel6oViZ6pEsNQJXObAJskhmcP3/+9u3bH330UTabPX/+PGYQbjPwHBXwG+Os7l2LmMFGzEAXglgsFmvv60tJ7k2wphUwg2BnibSq2quo1cEHTjf+pUpvaDPIn/zrYOTsj+bAgHQForBiEbaKGWQyGUciZrCZZrAZfzfB1iQ5ns7iWA0lvcK3J8qfYlT5NphBYDOA2puB53lR6YOLxMzE2q1Kb1wzMCVgMNIxevLmTJs4m3CzfNciWrDFzCCfzyeTyYN2ksnkwsICZrAJZgCAGfB0ZIDNNQP+bgJmAJgBZgCAGWAGmAFgBpgBAGaAGWAGgBkAZgCYAWaAGQBmAJgBAGaAGQBmAJgBAGaAGQBmAJgBAGaAGQBmAJgBAGaAGQBmAJgBQIWsrKzUSAtWVlYwA8wA6mQGRNWDegXIAVqAGQAAAABmAAAAAJgBAAAAYAYAAACAGQAAAABmAAAAAJgBAAAAYAYAAADQ3GbwDAAAAJqFKpgBj6cFAABoGjADAAAAwAwAAAAAMwAAAADMAAAAADADAAAAwAwAAAAAMwAAAADMABqQqW/miKoH9QrCzOrqarFYrOITAIvF4urqKmaAGUD9zIBCoEgBqqgFNXpCcJjlADMAujGKFKBRqe5ogWPkADPADIBujCIFaDBq+oeFMAPMAOjGKFIAzAAzwAyAbowiBcAMMAPMAOjGKFIAzAAzqLcZfBUMajbdGFCkAJhBWMzAd/eYAd0YUKQAmAFmgBnQjQFFGjrmFwsUwmaZQaFQuFbm6dOnmEHYzGA+HY8kxsSUsUTEpPyOmOZ8z5mbTjw977FHv21Ux0Y3VjOyfe2x1HXxBUVa8jsvbNXZXqdV6baMyqlBz6/wUEh3DcaHdTPIJTrG04v06XU1g0wm09vbe+3atUuXLp05cwYzCJUZGK2X0AaNJZyNm6SBsm3kyM3YXLFJoG1Ux4YZ1MUMKFKFFsjPi7GEvI4q0scSQp0fS1RyfoXWDKB+ZrCwsJBMJpPJZGdn54cffmi+1l9MTU1hBk1uBkbHG08kxOtyZ1Nla8e8m7PSfDruuDJyt25BtlEdG2ag5HoqptPely2Vsn3t7alUeyxm9PTmu0LHn+1rj4mpwja6ImT72tv7stbW+j9kWYXBDNTnRWVi4Kj/gfbVCCzei3cMRjoGI1335q2ufTw9fCvSMRgxrvgL6a7BiHMz4bMdg5GOwcSMfctPcuaYwdgn+j/L5WT9U5EzrGvMYGRkpLe3N2ent7d3ZGSkUChgBk1vBumxclulbIckDZm6bXN089KMg2wT8NgwA/fF/vVUrL0vm+1rF7puPU22nf3TzheCGpRfyrIK5TCMdRLMp+PxeNw9ZaBIV6hwhe6w1cglhB69fKFfSHc5RMEaA5gfHi+/ZX623Nl33Bpzbl+eTZi5VX5XtVMxZ1inGUxOTvb394+Pj8/NzfX19S0sLFy9erW/v39ycpLZhOY3A5/O2bx0d7ynvqBxNmmyJi7INsGODTOQiIEsRZCA0vWUpD8vJ7oUwVQDlxiosgqJGahnxObTcWsoQZKu1/cxawWCTJ0brsrbOmwT+3SAc5tCussSAllW0nUGgkaYWwbMGSo0g1OnTk1OTh49enRubu7UqVOYAWag1gLPnhwz2DQzsIb9pWYgYm0qvCE3g3LO7qkEZ1ZhMgPV2hvvjt1I16fJ1OsMGnHAQHWZbuuh54fHI8KUgR7CMoJcwkr3MANrBsF84ZczYAaYQbXMYD4dVy4xVDdc1ZtNwAyqOmYgHScopypnE8pqcN00jwYeJ6iOGajOi2CebZiB7fP27RtSDAKbgXyQ33ACoy/3GTMwN7AGD5g+wAwwg7qYgcfCaO9ZUkdOyhWIfttgBpV1Y4IImIsHhS7cmgOQLhPI9rWb6xZddy3q6xTFKQRnVuExA+l5oVqZ6JHuYQb+qxC2JOrZBGtUX75NqTRzy9av+5qB7gTD9+JmbqqcYWNmcPHixampqZ6enoWFhYsXL2IG4TYDz6sWvznQ6t61iBkE78Zc9ybYLu7t7wpdfiwWi7WnUoIRxBxiYXqDOqtQmIHyvFB17YHTPW4MahjsV/DC/QLCfL99QeLMrYh7UaFxk4J1I4P0eQbG9IF1k4IiZ9iAGVy6dMmRiBlsphlsxt9NsDVVjqezOFZJSS9p7InypxhVvg1msLELXKhqkXqeF5IHF3mmi5k5R+sa9SkG1p2H5uW7eyWgcG+h0HmPfSKuMLBLhv2uRXFfQXKG9ZnB48ePjxw5krRz5MiRfD6PGWyCGQBgBhQpwOaaAX83ATMAujGKFAAzwAwwA6Abo0gBMAPMADMAujGgSAEzwAwwA6AbA4oUADPADIBuDChSAMwAMwC6MaBIATADzADoxoAiBQhEsViskRYUi0XMADMAujGKFKDBWF1drZEZrK6uYgaYAdSpGyOqHtQrCLkcVHfkoFgshlkLMAMAAADADAAAAAAzAAAAAMwAAAAAMAMAAADADAAAAAAzAAAAAMwAAAAAtqYZPAMAAIBmgTEDAAAAYDYBAAAAMAMAAADYoBn8PxAWo6EG1lk8AAAAJXRFWHRkYXRlOmNyZWF0ZQAyMDIwLTExLTA2VDIzOjE0OjU5KzAwOjAwpDEoZgAAACV0RVh0ZGF0ZTptb2RpZnkAMjAyMC0xMS0wNlQyMzoxNDo1OSswMDowMNVskNoAAAASdEVYdFNvZnR3YXJlAEdyZWVuc2hvdF5VCAUAAAAASUVORK5CYII="},273:function(A,e){A.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQgAAACPCAMAAAAx6rUZAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAB41BMVEXr6+v////r69CWVjMzM3iz6+vrs3gzMzMzVpbQ6+vQllYzeHh4M3gzeLPr0JZWM3iz67OWVlaW0Ov/3b6kD4CTD4Cklun//9S2D4C2uv/ab5TIur6TRb7s//+kD6na/////+nIRYCkD5TI3f94s+vr67NlZWXIRZTIRam2D6nab4CkRb7t7e1vb2/slpSTD5RqamqTb9S2Rb7s/+mkb9T/uqlWltDIlpSzeDO2D5RWM1Z4M1aTD6mklr5WMzMzM1b//7ZmAGa2//9WVpakb6nIb4CPjzkAAABmtv85j9v/2485AABmAAC2ZjmPto8AOY/b//85AGb//9uPOQDa/9QAZrY5OY9mADmP2/+POTmPOWa2ZgAzeJbbjzkAADlmOY/b/9sAAGb/tmY5Zra2utQ5j4////WPOc0AAM3/ttwAOeT/2+Q5AM05j/UAANQAZux4MzOPOdSP2/WPOdy2Zs3//+xmANxmAM05ANzbj9Q5ADmWeDOPZs05OeRWlrM5j+wAANxmANQ5ANT///2vefZYXPZYlvtYXPnL//+W0ND/zPn///uTXPnlsfd2sf3LlvaTzP//5fp2XPaTXPZYXPev5f92XPmvefevefmTXPd2efrl//92sfpYefqWVniz69D09PRNz8JAAAAAAWJLR0QB/wIt3gAAAAlwSFlzAAAOwwAADsMBx2+oZAAAAAd0SU1FB+QLBhcPEJD8JKcAAAlOSURBVHja7Z2NXxRFGMd3edUrMIEDzjcwIPNCigrDREWs7sSXCKMwstIMOdHQgozU3uyUxNfM3szqT+15Zp7Z3dkd7nYP7mT3Zj8cczuzAzfffebZ+e3Ms2cYfjYz+puhQWgQGoQG4RdERWVVtVFTC9uatWUNIvbU09XsTU1dWVtE/bpnOIiK9Q0KEI1N8Xizaba0xuMJ09ywsSm+aXPjljazfWtCzhRHmo3PdoQRREVlZxcHIQziOdwEiPZtrFXtz7eZLdvbzCQ0OJnAzMYXNnszObpwgojVGRwEEOE53Tt27Oi2LKKHn2U42/EXO6C9PLMZf9yZ7Miwdo2KSvSStcCgxnKV3S91O31ET7wXzz97T21uefkVsAZXJj8yzJdPZhGWQSAJ2VlCg1taE1KbN2x8Ff2GnGlyNCHtGgJEjevaSSDQH4L1s27AXAH/A33oJOVMcWSIQegBlQahQWgQGoQGEUx9Mvm5Mx8IHFAvtRcR9dlFrzIGwdVnReVOz5hKBeI11JtIAF5sL2x6M7/67K9VqU8XiFYmOwQI2GvZ1REREKQ+KyrrjH5uEbL69HQNZgpWgrclItE1hPqsX1dt6S6X+swNYltHZJwls4j61xuMrt0NSvXpBQH9ITnAQPQNtEWkawj1GeN3JfJfNfDVE4/vQR8RjyOHyIDQAyoNQoPQIDQIDSKg+qzfW7uvYVkgbA3mUWOD+4eW3FuF6rP+wNpyBsHVJ873uSc/8/2VvjeaNr0JYhTv6ifMZBy2Xn6P3z3cHNz/ViqVZgTgxfYOWoXDh9je4GE8xDxy9FDq7ZHhd4bM0WNpObMk6hO1Rs2+gCAG3m1t7mnGATe2mtsB7rF3EojDY+bweyMCBOwNvj9OZaPH2bvRD1iZOQENnkhjJlSQM0uiPnGI/WFQi+iFFvc094EZ4CQPB4F7yq7BTMFK8HTTdoJZB9pF6qNx0d4TB/HHlVkK9WlpjlKBOD5uF59IMYNh76nNgx9/AtbgyiyJ6DLYTapCQGAfYF1jF5vw29LWvtXrIzgB6A8TJxmIUyedDhO7zeG01OYjRz/FLpUuNQi0jE6jIBBmH0169jBnCb9Pb1eDgFOf+gx9RCplc8A9sH7WDRyu4BQ6SXemHlDpkaUGoUFoEBrE6gDBRlR1y1WfNIQKNgk4eWYKLouZKdjOjpjT5/C3XMYKz1uZcMjn4+5D7DKoDnlTUzMiYfXxj1KSGwQfV3dd6GR6o4QgJi9+cYZakoHP/uWQOXveVTb31RB78W3uUtqc/nrIWx33ePXJi+O8jPOa582fPzviwyI4CJz3jLmGVHmbgoIzYelNSmgdLq3KpeW46lW5k9QS63PPuMomz5w3M1Yr8N28wwqo+vA3ZCVQXQaBdOzER9eAPhHDGb/LnYEtAkbUpDeF7KR1uHxVrli4q16VK0BkCMBs2lM2O2XDgYbOnr2yNAiojn0Ceg8l01evYM+ixIezrKmqjn0LSqM/IAgYW4MNkMwSaosvNhSrcmk5rnpVLrVE8JAsmCwC2y5y578DA5n1gLA40YGZ74comT6XNud+GKfEBwgQGzXQLZxrTv2AIBtQg6BVudZyXNWqXGpJRtWTWRl6BLu5mam01HgZhFWdnAok01dH0E4o8QEC70nsbvCxPsILIjnQRnpTyE6x/FRejqtclctbQu2xTuiUbSbTP47zc8ky8V2GXwTSnq5hYyRPQx4DKlGSB0TXBXb1xMtnVbUR2Fnu4TOhp+2EFufyVbm0HFe5Kpdd48CMuUHMXeJ7vJWibB6StEUHLpHM7KVDOAiqjskM35vhFfBQSvSASo8sNQgNQoNY9SAamxLhACHUJ6SdKwLCJbwkEB5RplBp137KZq/b728slAoEF10V63+uLAqI3GWKg29ed+4t3ioxCMMzwPYBQiU0xRQoL2vfypebYXavVeao4F2Ud/sO/r6bzWbvWSDu/5LNQvbiA55ZtK7B7sgUAEIlNMVJTlKwF99N9jrKqIJylvQ2AMj++hDf3v9tgUBc+51lXPtjYaUtxKs+CwOhEpoCRMJh/HwSTJRRBeXkoLCIm8DjhgABeO6QXRCkIoHwxDsGAyELTSUIai+B4BVygVj88yFnICzgNjjQ+389KvLlM1ZnLAOES2jS2ZdAmMlmS69aFZSzpA4Qd284QCCFxQf3igiC1Ce7ilZVFwJCFppiCtQOBhX+tNcqo3hR1Sypw1n+fWsBvWP28SNMsEtg33j8qIgWoUeWGoQGoUFoECUHsbr1Zl71Wb/X/dChQhechhUEqc9/qo3+nSsCIqRdw7HcNubj8UtJh7QUKpJPgZK0JL3pejDRao12UqlPQ8z45Yj7FCpSkp00XJYFhevBRCEAYalPI0Y+IlfcJ6lIWXbyKVCXspIfTBSSqwZfg7zUU4cUbkCSneK+ggxCfjBRSECgc4g5rhlLxn0KFSnJTpoCdd10kB9MFIKuQeoTEx/qk1SkJDvFFCiXlkJvyg8mComP0CNLDUKD0CA0iNCAGD6UfpIgSH06RtpFCHfMuYnoxycNwhZdy3zm7XJBrCL1GTSmy3fcp2lOpFJjVvwmRXNCHiT4G8pGj7HwJlfAp9VrihQaqlCfMLQMemPGf9ynOTHGEx7USdGcJm+3sAiWugI++Va80FCl+gy8zjJAuCOFu/JPKqI5T6VYkJsEwhXwSVvRQkMNZbyj9bCdosR9OkDwaE6kI8L/7IPkgE/TRlGU0FDV3GfBFuEj7tOcOOj4tBTNSVGglrkQECng03FxLUpoqFp9BvYRvuM+mUcbsz6tiOZkUaB4tqEMj2DeTgr4tGsXJzRUjyw1CA1Cg9AgNIjlqE/x8KEoxn2K/+BTdFlfvBK9uE/TDiTMD8L64pXoxX06/kN+9Wl/8Ur04j6XNghV3GedERxESOI+PUfmUJ//Oh4+FLm4T9PRvfyoz8AWEZa4z6UNQhX3WQCI0MR9Zvw8LUAPqDQIDUKD0CBWAYiwxX1aIlTHfTaskEWEPO6zIBBRjPssaFlANOM+raTc4z6DP/M2onGf/lbnK0BEK+7TFqE67lOPLDUIDUKD0CA0CJ/qk33h55q15QyC1FZM/b3hZQcCA2B11wDZWX/gso+vwo26swTZWb+3M/CC0+iBANnJvpGpv7PMQYDsRFdR3hbheOZt/u/71AMqDUKDKBMQ/+mNbf8DaX7WFybp5ZgAAAAldEVYdGRhdGU6Y3JlYXRlADIwMjAtMTEtMDZUMjM6MTQ6NTkrMDA6MDCkMShmAAAAJXRFWHRkYXRlOm1vZGlmeQAyMDIwLTExLTA2VDIzOjE0OjU5KzAwOjAw1WyQ2gAAABJ0RVh0U29mdHdhcmUAR3JlZW5zaG90XlUIBQAAAABJRU5ErkJggg=="},274:function(A,e){A.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOUAAAA/CAMAAAAosv9tAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAABO1BMVEXr6+v//////9t+hLfB///y9PPr69CWVjMzM3iz6+vr0JZWMzMzMzMzM1aW0Ov//+B2GsK9///QllYzeHh4M3jr67N4MzN4s+tWM3iz67Prs3gzVpbQ6+v/6slZhJUxhJVZwO1+hJV+1f+gwKbBrKag1ckxmMng///BrJUxrNu9dqYaGqYaduC9drSavdBNGqYaTdDf//92GqZ2vf8zeLOzeDOWeDN+hKag6v//1bf//+2gmLdZmMlZhLegmKb/3b6kD4CTD4CTRb7s/////++aTcJWlrNWltAxhKYxhLfgwKb/39AaGrSa3/9NTdB4M1Z2GrQaGsJZwMnfmrRNmtCgmJWaTab/vcKWVlaW0NBNmu+aTbRZrLegrJXB/9uadqbgwLd+rKZ+1duWVnhZhKZNGsJ+mMng/+1ZrNvVQLexAAAAAWJLR0QB/wIt3gAAAAlwSFlzAAAOwwAADsMBx2+oZAAAAAd0SU1FB+QLBhcPEJD8JKcAAAXUSURBVGje7ZuLX9s2EMctIIQwVho2mo4u2EkfOAlbgZQtDt2DjQ0S2m4sZWzZe+se//9fMJ10p4ftmBAnTaDWp8HIOhl9c7J8P5/qOFcqbLgyN7/AZqk4M0iZy+XEZ9YpU5fcdfBlRplRvl7KxfxSwXGW31p5+1YqyqRVKLEtN+zqtXq7ODLl2jvvFpz1OyVn+W7hxlIu332PU27ce99ZWylFKcubrut6bK7iulU+2PtQwRp78HDTfbTFfBdq8NOtqTYs0N1TbbIDIAtsH076bg4OdBKviVeR3bHUG7xsM/bBh48bO7uALD57jUbzMsrFfGmdU649cfbvfRSlnPu4xYIaax+IMcxVaqz8dAtrzAdEQVT+BAdOlvgX25+2TF/KDgTk1wxfqpPCBK+C3T/7/PDw8IsvyZf1nV1WbyLl0VfFkI9j5+sTR1B+nT929gdSCo+etHAoWENCFvBah9iorSvO8YNnUlaZBoJLx1BWmXUVLzpj602q8M/pY+7gZ8+TKRfzK1BKG3y2crdGZ6wvRssdaIwPazRoPlo1CclSl66YxnGU6PFYSnUV6B72pUX5Yne4Jwn4cv2bW+LeDFMSXsUan6wZlD74UviG2nSBS6Df7A6+h5Qt82SV2VcxvrbVb58blLxSPyuu7jWHp4QnyVLBifUlTB2YQnrdkDWasdzku3kxO8Ft2IbrZ0X0pjbs0JUdoBFuTbH60Ek0wb9H3bH0xOojKaHykvsTpuzObrqoIIAB+94Nj33g23RrWYSXFvFNUV7s5vvy2lGWN6tjtxyzJuHhQemKlOEQXIy9fS5iHrs91jLUZtucQqjKjr6XkSu7CD0tRtQkiz/8mE9LGT49mDLO3LKB6LTeZ0c/ydCtNzRisiZxIvEdPi9/3nz0CyqOKgsgtOzosQuFgqGCcqKOZ23LKukVspRyB9tIthghwDZRAnM6StQkAyk7v1a8rke6I6gZXzkoFB6YqRgWm+TvGNxqS0PLaBMuBLANrSlklYEczFgeiZ+++K3R6KehRE0ykBKwOCXqDh6HVWWIhiKkfV6NpQwwRNeWhpaxKecXjGDfcCXO0oszrjuaFMOORkma5BJK5Zrf//CsO4orwERKbWloGWzxzW8g7Et1K5LuqDfTPUmG8CUphqDGnWdSBp0FarMo+fRun3dClEppSBNLzZFsCXlS3Z6pfEmUwqdLhYEzVuqOAL77imcIDjmLoU1EvFJGgCbhJ/8M+9JQGvQm5URPha6x+sBrjgbIKvkgAd3RvJ6xz6TkzmxRTkruZHFsRvmmUk5UVEw2TxJ6hRdDqWLVq1DGhOoQuW3r38+Kk6eUmuSvgrN/fLkvR0g8x3S52L56+mM8mkSEtPF5Ep0gkUNGl4ayJvgURBEj+5E0sZMnrNenvEdTUcKTv8+iaY+xUCpN4oQTCCqDUH7VIuFg646Q0mCGiKF+Mv5FEwxSew310v/07yJSGiIrpW8TNYmzFndfQtRtJHBsSltpSPmBISH2w6BdiRHLlxciiiNf9oS2iqY9xkGpNUkEcmhKKzMSTylNtODoYwpAAJLvenxFiqY9xvUkEb6MQso8ySs58xIo7cwIUmI/lCbh5ImirJ8ZlIAYTXuMk3L9TrwmAfl80tJApu4IZU0sSuxH0sQyMVafl7eF7oCk656cqZG0Rxb7ZJQZZUaZUV4PTQLRQdzeLSPtMVihjJRoeM2UQpNA2YiL1kfekjVblIYmOR5MKUUFJBHghSxJDAsA91lhm7H5qjN9StIkPPiJV9FSa+m9VJF8B81fuc+KLA/UziUtRqZHqTVJ7H4feg9OusODf3a+w96mhW14sBMJU6PUmsQRO5sGUaLumPvn34MFFsp3qAL7rLAND0g5dV+qPEmiL5WoePDwP6MWyTE/3aJdXhXahWikS6ZOCZok7r6knAaJikCsOna+Q78qh1mMlniw0iVZVJBRZpQZZUaZlnLaOZSkPAkd0v9PiwTKUcMgu98lb6X/B99FO0EW076KAAAAJXRFWHRkYXRlOmNyZWF0ZQAyMDIwLTExLTA2VDIzOjE0OjU5KzAwOjAwpDEoZgAAACV0RVh0ZGF0ZTptb2RpZnkAMjAyMC0xMS0wNlQyMzoxNDo1OSswMDowMNVskNoAAAASdEVYdFNvZnR3YXJlAEdyZWVuc2hvdF5VCAUAAAAASUVORK5CYII="},275:function(A,e){A.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAMMAAAAwCAMAAACbpz4vAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAABnlBMVEXr6+vr69CWVjMzMzMzM3iz6+vr0JZWMzN4s+v//////9S2D4CTD4CTD5TI3f/ab4Cklr62D6na////uqm2uv//3b6kD4CTRb7s///slpSTb9Trs3gzVpbQ6+sWFyO4ub3//+nIRYCTD6n///WPOc0AAM1mtv//2+Q5AM0AOeTb//+WVlaW0NAzeLM+PkmPOdSP2/WPOdy2//+2Zs05j/WW0Ouklumkb6nIb4DIlpSkD5Tbj9QAZuzIRZSkD6na/9S2D5TIRamkRb4AANz//+xmAM34+fvw8PPIyc3o6OpDQ07h4eP09PcKCheztLw/P0qlpapWltAqKjX///uTXPnL///r67N4M3hGRlHCwsklJjLW1tgrKzbab5TIur7LlvZYXPZYlvvLlvevzPp2XPZYefrl//+TXPaTzP+zeDMwMDz///2vefnT1NVaWmS+v8L/5fpYXPev5f9WM3h2efpWM1Z4M1aTXPdYXPnQlla2utTlsfd2sfozM1YAANSP2/9WVpY5ANz/ttykb9SPZs0zeJY5j+y2Rb62b6lmANSA+gL5AAAAAWJLR0QJ8dml7AAAAAlwSFlzAAAOwwAADsMBx2+oZAAAAAd0SU1FB+QLBhcPEef7FDEAAATYSURBVGje7ZqJW9MwGMY7KtNslepWkA51XBsiMhVkHvMWL8QDFcVzeIB43/eB9/Ff+yX50iVdB+m8mM/yPCMrbbL8+iX53r6bYbASaTBNc1GjEV1smksMpZCyEotb1tImQmzLWrY8QUjScuC/zS2WtaJVXOOyc+JKPGc7/m5SXi/8KEbfwUvtLMl6EefUQcAnGfMWsuBLnaHOUGf4Pxlgc4U9tQ12WHPlKjhena6Oob3D6kyEalHaLqXS1Z3JQtWzJtO7Vpch0reuAfNCWz/9uzqXrjIOgWMKeX3X+g3dwNC1cYAMbtKfSxFkiPQNMQYiIAIa0QyUZ9kJsltyc8uKLZYTW76V/RPHRFOQlNFsls5oO0fkKmxAO6HnSPO2JiUQWf6msD08Aw8DMAiIgPmyw/u05p2JZOeueN7Nx+KQZXc3IUP7HjmnEjvF7jichpEKBmjQvLfVu6wCw2A2NINAAQaECGjkshtOJQBM/mQKRgEMMJT2DgcZ6B2nUsClV3A2uJ6S2I4Xh4RPPpAAhoL+evAG38ZWNGfgEIHNXIvfdRiAzLBDxIHe4LIpXwWDDoKfQYSBMzCI4HYwSMpgK3FI0i2JjSkWV+SdnRezhc4l3s5j4EEKnEtaCMRQdasIAzJQiPl0q2CI82kDFVWcqvBEicr1p9C0IgZu+ZqGrTWT2TcwvJ9V1eY4ZDiQS/+hLfUv5GlkIAdzh2qegRweOUQWeJmXgRwZqWWGUVjTudxILTOMHj1Gjp+oOd3KhOsYZxg9mj5Jjpw0/sjyLe/i1OnxX2RA3XrmbCN7AQMgGBPnyMSJmmHADB1pGMM0lwMEI32eXLgYNACmOFX9ySVSXghWoVtlwUouXW4R+Y9mdDmrFSehXCHk6rXrk1PTFIi9bkxOzoTWSzfNfmlVTFwgt4LyNBNLqv6kkgEEEQpWoVsVwUps5jGhzvKpC4xDcWqaFGeQ4fadcZ34+OPQb9wUcgPK3fP37gdPBJCoqnZDBhSsWKmCFT0yelRxLhVnxAG8HlyH4Dx8FI4h+rixJPsq+3xcovr0p80mCApWrFTBGp7hyXT49RB9OmSceTakwQASVdWfYtRcsArdqghWZIDnpvaOzrK59PyRxAAHxRfjp27MhNmXULe+NDX91s6EX3/a/KkHBStWqmBFvxXavSpbD+Q1W9OcgR68gVjQyTQ1XW2OC+3NJKnS5re9Zv0l9uCQqntkdYY6w8LSrdHF5tshTYbQ1qo/sUEHdBdg1Zyd9azJvJsNo1uj71fpxiGkgPVfnkzJVeXOhvdnSc+HAc08TY1KNFznzNOKtcptV8i+zOdDwYoSVTFoWTunZIy5PJtgpfq0cv772LuWFDLZEHqp7e28DIq16skH4PjkGa22/DUoGrRC4XIG12KJHSu/TyszFLaTwd7PugxUa3zp09FLJWsVbVc6JS41eUZrSVZwVSLCFpPNsfI4iOZKKXzt3jSXd1zme+NznIZuFbbkbvHV8a5vrZ7Rqn4VjQatBoPi04q5BPPI88G1vn9oGDP0dKvEYNMj+7sjCVYnwKAtPWmwBgEMnk8rz6XhH7NsTejpVlotMTR1q7BWxc8F6KoO/kkAGrQiAC42kBn8Pq2iaWFvnct1rSbHVdgF3XwN5elABvcfida6Xqoz/MbyE+fyp8nqIcaYAAAAJXRFWHRkYXRlOmNyZWF0ZQAyMDIwLTExLTA2VDIzOjE0OjU5KzAwOjAwpDEoZgAAACV0RVh0ZGF0ZTptb2RpZnkAMjAyMC0xMS0wNlQyMzoxNDo1OSswMDowMNVskNoAAAASdEVYdFNvZnR3YXJlAEdyZWVuc2hvdF5VCAUAAAAASUVORK5CYII="},293:function(A,e,t){"use strict";t.r(e);var a=t(15),s=Object(a.a)({},(function(){var A=this,e=A._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":A.$parent.slotKey}},[e("h1",{attrs:{id:"minecraft"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#minecraft"}},[A._v("#")]),A._v(" Minecraft")]),A._v(" "),e("p"),e("div",{staticClass:"table-of-contents"},[e("ul",[e("li",[e("a",{attrs:{href:"#configuring-a-server-network-bungeecord-waterfall-hexacord-etc"}},[A._v("Configuring a Server Network (BungeeCord, Waterfall, HexaCord, etc.)")]),e("ul",[e("li",[e("a",{attrs:{href:"#allocations-in-the-panel"}},[A._v("Allocations in the Panel")])]),e("li",[e("a",{attrs:{href:"#proxy-server-settings"}},[A._v("proxy server settings")])]),e("li",[e("a",{attrs:{href:"#paper-spigot-bukkit-settings"}},[A._v("paper/spigot/bukkit settings")])]),e("li",[e("a",{attrs:{href:"#firewalls"}},[A._v("Firewalls")])])])])])]),e("p"),A._v(" "),e("h2",{attrs:{id:"configuring-a-server-network-bungeecord-waterfall-hexacord-etc"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configuring-a-server-network-bungeecord-waterfall-hexacord-etc"}},[A._v("#")]),A._v(" Configuring a Server Network (BungeeCord, Waterfall, HexaCord, etc.)")]),A._v(" "),e("p",[A._v("If you want to operate Minecraft proxy servers like BungeeCord, Waterfall, HexaCord, etc. securely, you can do so with pterodactyl alone as long as you stay on the same node. It differs from a traditional setup in a few ways and might require additonal firewall rules, which is what this guide is for.")]),A._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[A._v("WARNING")]),A._v(" "),e("p",[A._v("For the setup described below, it is necessary that all servers are on the same node.")])]),A._v(" "),e("div",{staticClass:"custom-block danger"},[e("p",{staticClass:"custom-block-title"},[A._v("DANGER")]),A._v(" "),e("p",[A._v("If you are a hosting provider, you should only allow a single proxy network per node, if you are selling them to customers.")])]),A._v(" "),e("h3",{attrs:{id:"allocations-in-the-panel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#allocations-in-the-panel"}},[A._v("#")]),A._v(" Allocations in the Panel")]),A._v(" "),e("p",[A._v("Create a regular allocation for the proxy server which uses the external IP of the node, so users can reach it.")]),A._v(" "),e("p",[A._v("The actual game servers behind the proxy should use allocations with "),e("code",[A._v("127.0.0.1")]),A._v(" as the address, so they are only reachable on the node, and not from the public.")]),A._v(" "),e("h4",{attrs:{id:"example"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#example"}},[A._v("#")]),A._v(" Example")]),A._v(" "),e("p",[e("img",{attrs:{src:t(272),alt:""}})]),A._v(" "),e("p",[e("code",[A._v("10.1.70.62")]),A._v(" is an example, replace it with your own public IP address.")]),A._v(" "),e("h3",{attrs:{id:"proxy-server-settings"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#proxy-server-settings"}},[A._v("#")]),A._v(" proxy server settings")]),A._v(" "),e("p",[A._v("As the proxy server, like all servers, is running in a docker container with network isolation, "),e("code",[A._v("localhost")]),A._v("/"),e("code",[A._v("127.0.0.1")]),A._v(" doesn't refer to the node, but to the container. The node can be reached from within the container using "),e("code",[A._v("172.18.0.1")]),A._v(" (unless the pterodactyl network is configured differently) instead. You therefore need to use this IP in your proxy server configuration.")]),A._v(" "),e("h4",{attrs:{id:"bungeecord-waterfall-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bungeecord-waterfall-configuration"}},[A._v("#")]),A._v(" bungeecord/waterfall configuration")]),A._v(" "),e("p",[A._v("This will be different for other proxy servers, please refer to their documentation.")]),A._v(" "),e("p",[e("img",{attrs:{src:t(273),alt:""}})]),A._v(" "),e("h3",{attrs:{id:"paper-spigot-bukkit-settings"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#paper-spigot-bukkit-settings"}},[A._v("#")]),A._v(" paper/spigot/bukkit settings")]),A._v(" "),e("p",[A._v("The servers itself require the regular config options required by server proxies, which usually comes down to disabling online mode. This will differ for other server software, please refer to their documentation.")]),A._v(" "),e("h4",{attrs:{id:"server-properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#server-properties"}},[A._v("#")]),A._v(" server.properties")]),A._v(" "),e("p",[A._v("set online-mode "),e("code",[A._v("false")]),A._v(" "),e("img",{attrs:{src:t(274),alt:""}})]),A._v(" "),e("h4",{attrs:{id:"spigot-yml"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#spigot-yml"}},[A._v("#")]),A._v(" spigot.yml")]),A._v(" "),e("p",[A._v("set bungeecord to "),e("code",[A._v("true")]),A._v(" "),e("img",{attrs:{src:t(275),alt:""}})]),A._v(" "),e("h3",{attrs:{id:"firewalls"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#firewalls"}},[A._v("#")]),A._v(" Firewalls")]),A._v(" "),e("p",[A._v("If you are using a firewall, additional rules might be required to allow servers to reach each other on the node. In this case the proxy server needs to reach all of the game servers behind it. Therefore we need to allow traffic from the pterodactyl network to the server ports on localhost.")]),A._v(" "),e("p",[A._v("You can use the following commands as an example. "),e("code",[A._v("172.18.0.1")]),A._v(" is the default address referring to the node within the pterodactyl network. Replace "),e("code",[A._v("")]),A._v(" with the allocated localhost ports of the game servers.")]),A._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[A._v("WARNING")]),A._v(" "),e("p",[A._v("The following commands will allow any server on the node to access the opened ports.")])]),A._v(" "),e("h4",{attrs:{id:"ufw-ubuntu"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ufw-ubuntu"}},[A._v("#")]),A._v(" UFW (Ubuntu)")]),A._v(" "),e("p",[A._v("Allow access to the pterodactyl pterodactyl0 network on a specific port.")]),A._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[A._v("ufw allow "),e("span",{pre:!0,attrs:{class:"token keyword"}},[A._v("in")]),A._v(" on pterodactyl0 to "),e("span",{pre:!0,attrs:{class:"token number"}},[A._v("172.18")]),A._v(".0.1 port "),e("span",{pre:!0,attrs:{class:"token operator"}},[A._v("<")]),A._v("LOCALHOST_PORT"),e("span",{pre:!0,attrs:{class:"token operator"}},[A._v(">")]),A._v(" proto tcp\n")])])]),e("h4",{attrs:{id:"firewalld-centos"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#firewalld-centos"}},[A._v("#")]),A._v(" Firewalld (CentOS)")]),A._v(" "),e("p",[A._v("Allow access to pterodactyl0 from the pterodactyl0 network.")]),A._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[A._v("WARNING")]),A._v(" "),e("p",[A._v("This command will allow any server to access all other servers as well as all ports on the node.")])]),A._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[A._v("firewall-cmd "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[A._v("--permanent")]),A._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[A._v("--zone")]),e("span",{pre:!0,attrs:{class:"token operator"}},[A._v("=")]),A._v("public --add-source"),e("span",{pre:!0,attrs:{class:"token operator"}},[A._v("=")]),e("span",{pre:!0,attrs:{class:"token number"}},[A._v("172.18")]),A._v(".0.1\n")])])])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[10],{272:function(A,e){A.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAArMAAAD9CAIAAAAgSGh5AAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA7DAAAOwwHHb6hkAAAfUElEQVR42u2d8W8TR77A73/yr++3W8mKQESFZy5yq/Y4ob57uoprpfQ4kr7nlmLB8cQpPgk1CohixL0CwSlNhNJQkiYR0eVBgb4kV6Bp04a6DjEQiAOmUfTw+2HXu7O7M7vrxHZi7+ejr1ozXs+ux7Mzn52Z3fzq0dPnBEEQBEEQevyKIiAIgiAIAjMgCIIgCAIzIAiCIAgCMyAIgiAIAjMgCIIgCAIzIAiCIAgCMyAIgiAIAjMgCIIgCAIzIAiCIAgCMyAIgiAIAjMgCIIgCAIzIAiCIAgCMyAIgiAIojHM4OGTZwRBEARBNHpUwQwePnn28Mnzh4Ic5JdWCIIgCIJolLDM4Onzh0+e+/rBr3y04OnzB4+W537Kz/6Yu/dD7t4PubtzPxMEQRAE0Sihd9+zP+bmfso/eLSsX+2vxwx0LVh4+HTmu+z7/V//OvXlvxy7ShAEQRBEI8avU1++3//1zHfZhYdPveXAwwyeP3zy7Pv7D97v/5oCJQiCIIgmiPf7v/7+/gN9qUBlZqBPSCw+Xrn7fVb7G6MFBEEQBNEMof3ty7vfZxcfr3gsSPQ2g8Kd734qAQAAQLNw57ufFh8X1mkGDx4V/jl7n0IEAABoGv45e//Bow2Ywcy3mAEAAEDzMPPtes0gv7Sy8HD5n5gBAABAM40ZfHt/4eGy/pwDzAAAAAAzwAwAAAAAMwAAAADMAAAAADADAAAAwAwAAAAAMwAAAADMAAAAABrFDGa7X9NUHBgK9OnXumf9tlvL/6P7rf8arvBT62Zt/IPtmqZt/2B8TXbAxvcSX9fsSOr7xQEAADOoihlsf739PyX891S1zMDeCde6g1wb/2C71traqkXf+aywuWZQ3y8OAACYQXXMoOadVT06YZPCZ+9EtV3H/t61W9P2ns5uITMAAABofDNYmzjUqmnbDwwVbAmt7w0XnJ9eutH9dnxHi6ZpWsuO+Nvd/8ivlUql0tABxwyF+Cm967x8/3Jiz44WTdOi237zdveNJWH/9y8f/n1Mf+v1xOX7lw/4mEwhs0/Tth+aKE137da03V3TAc1gLf+P0/v3lA9/z/7T4lGUSks3VO8u3Ti9f88r26Ka+cWN9zy/uPce/YpFUdQAAIAZ1GHMoDD8XqumtR6aWLO8QP+Hu49v/V2i+8LAwIXu9rZouVv++auBU3/apWl7jw4MDHz1s+xTra0tr+7vvjBwoXv/qy2aMAuwNHSgVdP0N9OH9+6Mtra2eh9v9vReXQzKMyW2xQZKM9B3FG1r774woO9J01oPDC3Z3t2593C6/G70jROzpVJp7fax3eUDHBhId73VFtW06Jtns35f3HuP3sWiLGoAAMAMargC0bqc1t1g97Hbv0wc0l+subxitvs1TXv3stkLL53/Q3Tb73ruSC7PXWagvXb8TvmDa0MHouVt18Y/2K5F3+g239R7Uy8zmO1+TdN2Hbtt/cOmBgoz0JcsCkdR+uXGX6wRB330wfzWpdJSZl/LtvjfbpZK147u2tZqDagYcxnmd1V+cZ89ehaLZ1EDAABmUKsViOICxMLwe61adOfOVntvJnR1hc/eiWrRtvfO37y/sibdi9oM4sfvSEcxJg5t17R9GXEV4Z3jcS8zcMwgZE/v1WzrEBVmINmR/tldx26XSj+ceKOCtRiz3a9ZeSm/uPcevYvFs6gBAAAzqM8KxMLQge2apsVTM2vyT6/dOfvWTn2yPbrtlT37uwf+15z89jED2/6tlLXL7zq6x5I+ea86Xv1CXBxYz57eq4nrEBVmMHTAGmiw7Uk7MFQqDb8X9V5GuLaSn7t5deBC9+E//f4326LCqIbyi3vv0bNYvIsaAAAwg7qYgT6frtkH1d2f/iV3c6A78XtjcZw5EbA+Myhk9lVkBsZjDCSYsrAuM7A6bMk+rU66ZceuXXv+ePjQvl21NgOvogYAAMygDmage8Huv6T/Yp9wV396beV26rXyUsB1moFsyN3jePUZ/t0HzgzYOPZvUWuxQaWzCfHjd6SzCT+ceKNlx58+fayvd9z392+tYf3bx4KYgfceg5iBoqgBAAAzqLkZ6F7Qemhizbg1wXQD69PPP0+8sq1VXOy3dP4PGzUD1wpEY+RCeryFzD7N/QCD8kiCsdigwhWIrYf/p1Ryr0Bcu3PcOMahA5ptMaDxOX8z8NmjV7F4FzUAAGAGNXsGor4G0fCC94b161t9vYHRTYrL4obfa9W0llf/2JU2b98z7uwrlR6cfVPTtr957IL8rkX1xfHSZ++0lG8KvND11s5oNBqVm4FrsaHFdNfusjNs7K5F493Eqy3lAsmefTOqaS2vJtIDAwMXuve/vi3a0tJiHaH6iwe4a1FVLJ5FDQAAmEHN/m6CdmDIuDze/u5l4Sk7mX1R43LX1oGt5Ue6ytPeWsuOPYn+738xPzN++PVtUU3T3jjxQyVmUCqtCU/7eT1xeeS4fIxjumu39A8lWNag7T2dreBJR4nzM4onHdmfOrR0o/ttfdVhdNsrexLn/zc/fmi7pSjKL+69R59i8SpqAADADML0txbvHI/bh+8BAAAwg7CYwYOzb7bs+PePrStna4IfAAAAMwjfmEH27JvR8kOJy88Itmb/AQAAMIOwzSb88n1/ovznilp27Nl/mr8dBAAAmAHrDAAAAAAzAAAAAMwAAAAAMAMAAADADAAAAAAzAAAAAMwAAAAAMAMAAADADAAAAAAzAAAAAMwAAAAAGsUMngEAAECzgBkAAABAVc2AgRcAAABmEzADAAAAzAAzAAAAwAwwAwAAAMwAMwAAAMAMMAMAAADMADMAAAAAzAAAAAAwAwAAaApevny5vLycz+cXITD5fH55efnly5eYAQAANBvLy8tLS0svXrz4BQLz4sWLpaWl5eVlzAAAAJqNfD6PFqxPDvL5/CaYQSQY1GwAAFgfi4uLdPPrY3FxcXPMwPdHxQw2wv/Nnv/xtzvv7WqVx2/fXZxdo5QAADOAcJrBWCISiUQSY9ZrG/obMubTcZ8tjAzj6fnK3qo13/y8t1WpBXrs/aiw5U7k6v5S7ty8fkiwl1vAkvfPqxkLPUjLUFFtr8tvKmmLyl+kWr83ZoAZNI0ZKHtv66zxOFG2phkM39/lZwa7PnjUaGZQ4S+FDVTNDNZXj5v2BwjUMmy93xQzAMzAq78RzhD9PWmzp580iUTCdaaIDYMjQ9Vbeno8kYiL7ax4Xtp2YTthhXdU6c1qBhv6pdRjBra+T8gyaPGGwAzUJS8WkqvszBoe2/evkWYtS2XLUNlp6xAnc6PEWMnddBjNiXdTEbiZUnwlxamwOVc3mAFmsCXNoHxClv/vZdmSjt7zrXh6XnZpVj4M1zvGG6r0kJuB6pdSmcHGize8ZqCeaXDU8FQq3qxm4F3fgtcrsU46Si8e925VpIprq7MebZG/GVRzPgkzwAyaajbBOu3tDYBxxtmbQz0Dj7fcE5NOSRf24vJ3ldf7zSb8xyPpKsO1oflmmk1Q/VKB1hkI6RUUb1hnE+x12u4Mkqn35pxN8G4ZKjhtXXXPs+mw6YRY5B5tiDxDPzPw+pUxA8wgLGYgr/HiSW9rAJytnXCB5fGWu3mQNr/yCzNHVxd8NqHJzKDCX8rHDMT8pXsM92yCx2CWa5hcJVZNaQZ+9S34aSsUTwVNh6vBkf5YXhn6mYHXr9xsZpDL5ZLJZCaTMVMymUwymaxFX5tMJnO5nPeRiC8wg82cTfA8UWTjafUwA/f+/dJDMJtQ8S+lMgPJJxwDQiGfTlCXPGbgObZf4WlbkRnYfQIzqJkZ9PT01KJjnp6ezmQyo6OjvmbAmMEWNgP5il2/YTr/IUH3gi3/rifAOHiIzcDjl1KYga3g7T9Z4OINqxn4zyY0uxl41bdKT9uKZhNkZuDRhjCbUKEZ6FfzuVxOHDPQ39WZnp42+3gzUez43YkiPT09uVyup6fHMYqgI+7IoQiObPVM9IP0PSrMoMr9jfuM877kDLwCUdJuSjZWXdR6XOyG1Qw8fynFmIFqeVUFxRtWM/Bfgaio4c1SkF71reLTtqIViDIz8GhDWIFYiRlMT0/rXezo6KjexTrG/8Xe2nwxOjpqDjZIE8W96E6QyWTMvrynp0d/PT09rXuDezbBHGbQtzHfdST6HgBmUJX+RnIhKVXwSCQST6dVdy3a35LrveruOft5rbqtzuNrNMuTjjb0SynXGZjFHk/P29rdoMUbXjMo+d21aPuYuWmTlKVfy1DZaesYVjBrpeKuRcWvo2xDvJopf+UJyV2LekerDxWYV/bSy263LgRfQzA6Omr25fqO3HuRmoFj8CCXy4nvOrZUHcDIyEjSxcjIyBY1A/5uQk3h6cgADe1m3CZTNzPQr871/zr6bHPcXjrFYHbG0kTH2gUxH/fMgtsMHEeiW4vKDLwPwCEHvlqwaWYAAADSK/+Qj1ltlhnoV/aOC3F9wF86kCAO5nskOiRAn1Co+piB91GJchBECzADAICt5wY81Lu+ZqAvLxC7XncfnMvlxH7XfC1NFKcSzLUF4oSCuc7AzDz4OgP3wXscgCgHAbUAMwAAgLCbgbRjHh0d1a+ze3p6zI7cPb+gSjRnAVSLEhzj//qkg++9CdLXHgfQSCsQAQAANtcMADMAAADMADADAADADAAzAAAAzIA+HjMAAADADDADAAAAzAAzAAAAwAwwAwAAAMwAMwAAAKiQfD7/4sULuvlKefHiRT6fxwwAAKDZWF5eXlpaQg4q1YKlpaXl5WXMAAAAmo2XL18uLy/n8/lFCEw+n19eXn758iVmAAAAAP5gBgAAAIAZAAAAAGYAAAAAmAEAAABgBgAAAIAZAAAAAGYAAAAAW8YMngEAAECzwJgBAAAAMJsAAAAAmAEAAABgBgAAAIAZAAAAAGYATUzh2YoejtcAAIAZQNgVgUIAAMAMADADAADMAJqLqW/mNh6FZytVyadpgnoFYWZ1dbVYLD6vHsVicXV1FTPADKB+ZsCYwRYsUoDG1YLntSHMcoAZAGZAkQI0KtUdLXCMHGAGmAFgBpgBQIPxvJZgBpgBYAaYAQBmgBlgBoAZUKQAmAFmgBkAZkCRAmAGmEG9zeCrYFCz6cYwA8wAADMIixn47h4zoBvDDDADAMwAM8AM6MYwA8wAoH5mUCgUrpV5+vQpZhA2M5hPxyOJMWeKTjw9X+Fny4wlIi7KWwbKX8hA3ErMV77nEHZj11Ox1HXMoNZmoKh7VnW211ZVuqpuq7ff8uQSHYOJmWasKzO3Ih23mqydCdjHZzKZ3t7ea9euXbp06cyZM5hBqMzAaI2c7Zzx77GEVwPl/qxnm2pkFCj/sYSQPpYof8C2vZgRZoAZ1NgM1HVvLCGvhop0Rd1W54MZYAZ1NIOFhYVkMplMJjs7Oz/88EPztf5iamoKM2hyMzA69ngiIV73z6fjjqsbWdct/6xXoyqOF/jl79hGmo/HwYXTDFKpWCwWi5UVIdvXHkuZf3lZfN1nbCjKxHUjrT2Vam/vy9oTbdYhTQyBGajrXmVioKrbDS0GuhkM34t3DEY6BoWu1G4MVi+bS3SMp2fM7cfTi7asjMRhsVcupLv09MFI1z2h/BTpi+XM/TcupLv0fZlHojqGsIwZjIyM9Pb25uz09vaOjIwUCgXMoOnNID1WbqusJsnR2yqmC+SfVRuI7SLJN/+APb66kQ2hGcT0Dj3b16732eYLZ6KxYel6qvxKeGllZCWKOUkTwzFmoKp78+l4PB53TwEo0pV1W5VPw5iB2YPOD48LBqAyA2v7sU/MfjqX6BiMDxeErl3fppDuKqfr+Rvbq9LN/YobFNJdg5FPciXnTgvpLocomB+xHWd4zGBycrK/v398fHxubq6vr29hYeHq1av9/f2Tk5PMJjS/GUg7Z2dv69P7BjAD+8VWkPz1tDFr1lW6h5BMJlQ8m2C8VpqBK9H26WyfMWYgiIO1gTQxhGagnhGbT8etoQRJurpuq/JpnDGDGfc/vcxAkj5zS7zEtwzDOaRfSHcNJmaCp5ujCGKi1B5cnw3lOgPdDE6dOjU5OXn06NG5ublTp05hBphBFc3ALz+VGUQUc7Eh04LAZmB22JWbgSkDTjMQ8UgMmxl41z1JZRXTA9Rtnze2qhmIMwJmX1uZGcwPj5vX9M70jkFHxIcLXum2SYRybq6ZhfhwwfIJ58CD1CcwA8wglGYQcDYhqBm4O/4A+bs+ZN9oPh2PhGAWYZ1jBuUOvwpjBu4hgQYeJ6iOGfjXPdUZYaT71O2KRuNCZQbunr7SdMwAM8AM1m8GjhbJZ8rfr/1yfzxI/s5E4TPed0uE2AyMLtvW3xvX9Nm+9piXGfisM1CuSGjUIYP1moG07qlWJnqkS+t2Y6+urfNsgjvDAOmeswmyg/TcRQjM4OLFi1NTUz09PQsLCxcvXsQMwm0GFdy16G8GsiHRIPm7hjH0f4VjyeE6xwyMexNsEwPlQf++lKcZWNMEqb4+yb0JogJIE0NgBsq6pxpyC5xu/Mtz6K4RzEC2olBc9KffF+C9MlG1+s++SHDmVvkmAlW6lb8wDuG1AlHQGnGz8K5AvHTpkiMRM9hMM9iMv5sQ9ElHssbK+VnHNt73PHrmLz72xdiD40kwIXnaUV0f2NfQtxzUskg9657ioVzKdEnd9ty+IcxAuAvRNmgv3AE4Y161q8yg5Lxj0H7LQERyl6MifdF9C2VJfdei42EM5mYhvWvx8ePHR44cSdo5cuRIPp/HDDbBDAA2wwzMwYXGHgnYorIF68a5MgDqZAb83QTMAOjGKFLYMipgXffbbyYEzAAzAKAbo0hDiHgjIlqAGWAGAHRjFCkAZoAZANCNUaQAmAFmQNUEujGKFAAzwAwwA6Abo0gBMAPMADMAujGKFGDLUCwWa6QFxWIRM8AMgG6MIgVoMFZXV2tkBqurq5gBZgB16saIqgf1CkIuB9UdOSgWi2HWAswAAAAAMAMAAADADAAAAAAzAAAAAMwAAAAAMAMAAADADAAAAAAzAAAAgK1pBs8AAACgWaiCGTwHAACAZgEzAAAAAMwAAAAAMAMAAADADAAAAAAzAAAAAMwAAAAAMAMAAADADKABmfpmjqh6UK8gzKysrBSqzcrKCmaAGUD9zIAnj1YXzADQgloQZjnADAAzwAwAGpVCLcEMMAPADDADAMwAM8AMADPADAAwA8wAMwDMADMAwAwwA8wAMAPMAAAzwAw2zwy+CgY1GzMAzAAAMwiLGfg2apgBZgCYAQBmgBlgBpgBYAYA9TODJ0+ejJV5/PgxZhA2M7h7si3SeUVMudIZMSm/I6Y533PmptN28q7HHv22UR0bZuAi29ceS10P1ileTwXeFDNwIjsvbNXZXqdV6baMbGeAKn3L82Nnx2DnzdptD5tgBhcuXDh37tzY2Fgmk/n4448xg1CZgdF6Ce3clU5n4ybpmm0bOXIzNldsEmgb1bFhBpjBZpmB+ry40imvo4r0K51Cnb/SKZ4M0nTMAOppBtls9uDBgwcPHvzzn//8/vvvm6/1F7dv38YMmtwMjI63rbNTvC53Nkm29sqn2bp7ss1xZeTu9oNsozo2zEBtBqlUTMfo+EVdEF5fT1mbhlYR1mMG6vOiMjFw1H/f9AYyg89n2joGIx2DkY7Rk/MyA7h5I9Jx44pk+xvhPsW33JjBF198ce7cuZ/snDt37osvvnjy5Alm0PRmcPKK74i9pMFSt2GObl6acZBtAh4bZmB1/LH2vqzR8+uv1GYg2QAzWI9W6/X47sm2trY29ySAIl2hwsr0xjEDs4O/cnYw8teZu35mYG5/9/NR5GBLmcHExMSnn3765Zdfzs7O9vb2ZrPZoaGhTz/9dGJigtmEkMwmePe+sskE9TinUxlkChFkm2DHhhnIZhPM1x5jBtfDPrOwYTNQz4jdPdlmDSVI0vX6fsVagWDkokpvyNkEx9iAbzqTC1vSDE6cODExMXH48OHZ2dkTJ05gBpiBWgs8e3LMoBHMwBhcwAyqoQX+sw6OdH2azL2eQJXevGZgzjg8f/48f/Kvg22f5+mzMQPMYGubwd2TbcolhuqOvHqzCZhB7ccMwjudsH4zUJ0XwTzbMAPb533SMQPADDCDrWEGHncMeM+GOnJSrkD02wYz2LgZWCsO9HUIwjoD/SXrDCpFel6oViZ6pEsNQJXObAJskhmcP3/+9u3bH330UTabPX/+PGYQbjPwHBXwG+Os7l2LmMFGzEAXglgsFmvv60tJ7k2wphUwg2BnibSq2quo1cEHTjf+pUpvaDPIn/zrYOTsj+bAgHQForBiEbaKGWQyGUciZrCZZrAZfzfB1iQ5ns7iWA0lvcK3J8qfYlT5NphBYDOA2puB53lR6YOLxMzE2q1Kb1wzMCVgMNIxevLmTJs4m3CzfNciWrDFzCCfzyeTyYN2ksnkwsICZrAJZgCAGfB0ZIDNNQP+bgJmAJgBZgCAGWAGmAFgBpgBAGaAGWAGgBkAZgCYAWaAGQBmAJgBAGaAGQBmAJgBAGaAGQBmAJgBAGaAGQBmAJgBAGaAGQBmAJgBQIWsrKzUSAtWVlYwA8wA6mQGRNWDegXIAVqAGQAAAABmAAAAAJgBAAAAYAYAAACAGQAAAABmAAAAAJgBAAAAYAYAAADQ3GbwDAAAAJqFKpgBj6cFAABoGjADAAAAwAwAAAAAMwAAAADMAAAAADADAAAAwAwAAAAAMwAAAADMABqQqW/miKoH9QrCzOrqarFYrOITAIvF4urqKmaAGUD9zIBCoEgBqqgFNXpCcJjlADMAujGKFKBRqe5ogWPkADPADIBujCIFaDBq+oeFMAPMAOjGKFIAzAAzwAyAbowiBcAMMAPMAOjGKFIAzAAzqLcZfBUMajbdGFCkAJhBWMzAd/eYAd0YUKQAmAFmgBnQjQFFGjrmFwsUwmaZQaFQuFbm6dOnmEHYzGA+HY8kxsSUsUTEpPyOmOZ8z5mbTjw977FHv21Ux0Y3VjOyfe2x1HXxBUVa8jsvbNXZXqdV6baMyqlBz6/wUEh3DcaHdTPIJTrG04v06XU1g0wm09vbe+3atUuXLp05cwYzCJUZGK2X0AaNJZyNm6SBsm3kyM3YXLFJoG1Ux4YZ1MUMKFKFFsjPi7GEvI4q0scSQp0fS1RyfoXWDKB+ZrCwsJBMJpPJZGdn54cffmi+1l9MTU1hBk1uBkbHG08kxOtyZ1Nla8e8m7PSfDruuDJyt25BtlEdG2ag5HoqptPely2Vsn3t7alUeyxm9PTmu0LHn+1rj4mpwja6ImT72tv7stbW+j9kWYXBDNTnRWVi4Kj/gfbVCCzei3cMRjoGI1335q2ufTw9fCvSMRgxrvgL6a7BiHMz4bMdg5GOwcSMfctPcuaYwdgn+j/L5WT9U5EzrGvMYGRkpLe3N2ent7d3ZGSkUChgBk1vBumxclulbIckDZm6bXN089KMg2wT8NgwA/fF/vVUrL0vm+1rF7puPU22nf3TzheCGpRfyrIK5TCMdRLMp+PxeNw9ZaBIV6hwhe6w1cglhB69fKFfSHc5RMEaA5gfHi+/ZX623Nl33Bpzbl+eTZi5VX5XtVMxZ1inGUxOTvb394+Pj8/NzfX19S0sLFy9erW/v39ycpLZhOY3A5/O2bx0d7ynvqBxNmmyJi7INsGODTOQiIEsRZCA0vWUpD8vJ7oUwVQDlxiosgqJGahnxObTcWsoQZKu1/cxawWCTJ0brsrbOmwT+3SAc5tCussSAllW0nUGgkaYWwbMGSo0g1OnTk1OTh49enRubu7UqVOYAWag1gLPnhwz2DQzsIb9pWYgYm0qvCE3g3LO7qkEZ1ZhMgPV2hvvjt1I16fJ1OsMGnHAQHWZbuuh54fHI8KUgR7CMoJcwkr3MANrBsF84ZczYAaYQbXMYD4dVy4xVDdc1ZtNwAyqOmYgHScopypnE8pqcN00jwYeJ6iOGajOi2CebZiB7fP27RtSDAKbgXyQ33ACoy/3GTMwN7AGD5g+wAwwg7qYgcfCaO9ZUkdOyhWIfttgBpV1Y4IImIsHhS7cmgOQLhPI9rWb6xZddy3q6xTFKQRnVuExA+l5oVqZ6JHuYQb+qxC2JOrZBGtUX75NqTRzy9av+5qB7gTD9+JmbqqcYWNmcPHixampqZ6enoWFhYsXL2IG4TYDz6sWvznQ6t61iBkE78Zc9ybYLu7t7wpdfiwWi7WnUoIRxBxiYXqDOqtQmIHyvFB17YHTPW4MahjsV/DC/QLCfL99QeLMrYh7UaFxk4J1I4P0eQbG9IF1k4IiZ9iAGVy6dMmRiBlsphlsxt9NsDVVjqezOFZJSS9p7InypxhVvg1msLELXKhqkXqeF5IHF3mmi5k5R+sa9SkG1p2H5uW7eyWgcG+h0HmPfSKuMLBLhv2uRXFfQXKG9ZnB48ePjxw5krRz5MiRfD6PGWyCGQBgBhQpwOaaAX83ATMAujGKFAAzwAwwA6Abo0gBMAPMADMAujGgSAEzwAwwA6AbA4oUADPADIBuDChSAMwAMwC6MaBIATADzADoxoAiBQhEsViskRYUi0XMADMAujGKFKDBWF1drZEZrK6uYgaYAdSpGyOqHtQrCLkcVHfkoFgshlkLMAMAAADADAAAAAAzAAAAAMwAAAAAMAMAAADADAAAAAAzAAAAAMwAAAAAtqYZPAMAAIBmgTEDAAAAYDYBAAAAMAMAAADYoBn8PxAWo6EG1lk8AAAAJXRFWHRkYXRlOmNyZWF0ZQAyMDIwLTExLTA2VDIzOjE0OjU5KzAwOjAwpDEoZgAAACV0RVh0ZGF0ZTptb2RpZnkAMjAyMC0xMS0wNlQyMzoxNDo1OSswMDowMNVskNoAAAASdEVYdFNvZnR3YXJlAEdyZWVuc2hvdF5VCAUAAAAASUVORK5CYII="},273:function(A,e){A.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQgAAACPCAMAAAAx6rUZAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAB41BMVEXr6+v////r69CWVjMzM3iz6+vrs3gzMzMzVpbQ6+vQllYzeHh4M3gzeLPr0JZWM3iz67OWVlaW0Ov/3b6kD4CTD4Cklun//9S2D4C2uv/ab5TIur6TRb7s//+kD6na/////+nIRYCkD5TI3f94s+vr67NlZWXIRZTIRam2D6nab4CkRb7t7e1vb2/slpSTD5RqamqTb9S2Rb7s/+mkb9T/uqlWltDIlpSzeDO2D5RWM1Z4M1aTD6mklr5WMzMzM1b//7ZmAGa2//9WVpakb6nIb4CPjzkAAABmtv85j9v/2485AABmAAC2ZjmPto8AOY/b//85AGb//9uPOQDa/9QAZrY5OY9mADmP2/+POTmPOWa2ZgAzeJbbjzkAADlmOY/b/9sAAGb/tmY5Zra2utQ5j4////WPOc0AAM3/ttwAOeT/2+Q5AM05j/UAANQAZux4MzOPOdSP2/WPOdy2Zs3//+xmANxmAM05ANzbj9Q5ADmWeDOPZs05OeRWlrM5j+wAANxmANQ5ANT///2vefZYXPZYlvtYXPnL//+W0ND/zPn///uTXPnlsfd2sf3LlvaTzP//5fp2XPaTXPZYXPev5f92XPmvefevefmTXPd2efrl//92sfpYefqWVniz69D09PRNz8JAAAAAAWJLR0QB/wIt3gAAAAlwSFlzAAAOwwAADsMBx2+oZAAAAAd0SU1FB+QLBhcPEJD8JKcAAAlOSURBVHja7Z2NXxRFGMd3edUrMIEDzjcwIPNCigrDREWs7sSXCKMwstIMOdHQgozU3uyUxNfM3szqT+15Zp7Z3dkd7nYP7mT3Zj8cczuzAzfffebZ+e3Ms2cYfjYz+puhQWgQGoQG4RdERWVVtVFTC9uatWUNIvbU09XsTU1dWVtE/bpnOIiK9Q0KEI1N8Xizaba0xuMJ09ywsSm+aXPjljazfWtCzhRHmo3PdoQRREVlZxcHIQziOdwEiPZtrFXtz7eZLdvbzCQ0OJnAzMYXNnszObpwgojVGRwEEOE53Tt27Oi2LKKHn2U42/EXO6C9PLMZf9yZ7Miwdo2KSvSStcCgxnKV3S91O31ET7wXzz97T21uefkVsAZXJj8yzJdPZhGWQSAJ2VlCg1taE1KbN2x8Ff2GnGlyNCHtGgJEjevaSSDQH4L1s27AXAH/A33oJOVMcWSIQegBlQahQWgQGoQGEUx9Mvm5Mx8IHFAvtRcR9dlFrzIGwdVnReVOz5hKBeI11JtIAF5sL2x6M7/67K9VqU8XiFYmOwQI2GvZ1REREKQ+KyrrjH5uEbL69HQNZgpWgrclItE1hPqsX1dt6S6X+swNYltHZJwls4j61xuMrt0NSvXpBQH9ITnAQPQNtEWkawj1GeN3JfJfNfDVE4/vQR8RjyOHyIDQAyoNQoPQIDQIDSKg+qzfW7uvYVkgbA3mUWOD+4eW3FuF6rP+wNpyBsHVJ873uSc/8/2VvjeaNr0JYhTv6ifMZBy2Xn6P3z3cHNz/ViqVZgTgxfYOWoXDh9je4GE8xDxy9FDq7ZHhd4bM0WNpObMk6hO1Rs2+gCAG3m1t7mnGATe2mtsB7rF3EojDY+bweyMCBOwNvj9OZaPH2bvRD1iZOQENnkhjJlSQM0uiPnGI/WFQi+iFFvc094EZ4CQPB4F7yq7BTMFK8HTTdoJZB9pF6qNx0d4TB/HHlVkK9WlpjlKBOD5uF59IMYNh76nNgx9/AtbgyiyJ6DLYTapCQGAfYF1jF5vw29LWvtXrIzgB6A8TJxmIUyedDhO7zeG01OYjRz/FLpUuNQi0jE6jIBBmH0169jBnCb9Pb1eDgFOf+gx9RCplc8A9sH7WDRyu4BQ6SXemHlDpkaUGoUFoEBrE6gDBRlR1y1WfNIQKNgk4eWYKLouZKdjOjpjT5/C3XMYKz1uZcMjn4+5D7DKoDnlTUzMiYfXxj1KSGwQfV3dd6GR6o4QgJi9+cYZakoHP/uWQOXveVTb31RB78W3uUtqc/nrIWx33ePXJi+O8jPOa582fPzviwyI4CJz3jLmGVHmbgoIzYelNSmgdLq3KpeW46lW5k9QS63PPuMomz5w3M1Yr8N28wwqo+vA3ZCVQXQaBdOzER9eAPhHDGb/LnYEtAkbUpDeF7KR1uHxVrli4q16VK0BkCMBs2lM2O2XDgYbOnr2yNAiojn0Ceg8l01evYM+ixIezrKmqjn0LSqM/IAgYW4MNkMwSaosvNhSrcmk5rnpVLrVE8JAsmCwC2y5y578DA5n1gLA40YGZ74comT6XNud+GKfEBwgQGzXQLZxrTv2AIBtQg6BVudZyXNWqXGpJRtWTWRl6BLu5mam01HgZhFWdnAok01dH0E4o8QEC70nsbvCxPsILIjnQRnpTyE6x/FRejqtclctbQu2xTuiUbSbTP47zc8ky8V2GXwTSnq5hYyRPQx4DKlGSB0TXBXb1xMtnVbUR2Fnu4TOhp+2EFufyVbm0HFe5Kpdd48CMuUHMXeJ7vJWibB6StEUHLpHM7KVDOAiqjskM35vhFfBQSvSASo8sNQgNQoNY9SAamxLhACHUJ6SdKwLCJbwkEB5RplBp137KZq/b728slAoEF10V63+uLAqI3GWKg29ed+4t3ioxCMMzwPYBQiU0xRQoL2vfypebYXavVeao4F2Ud/sO/r6bzWbvWSDu/5LNQvbiA55ZtK7B7sgUAEIlNMVJTlKwF99N9jrKqIJylvQ2AMj++hDf3v9tgUBc+51lXPtjYaUtxKs+CwOhEpoCRMJh/HwSTJRRBeXkoLCIm8DjhgABeO6QXRCkIoHwxDsGAyELTSUIai+B4BVygVj88yFnICzgNjjQ+389KvLlM1ZnLAOES2jS2ZdAmMlmS69aFZSzpA4Qd284QCCFxQf3igiC1Ce7ilZVFwJCFppiCtQOBhX+tNcqo3hR1Sypw1n+fWsBvWP28SNMsEtg33j8qIgWoUeWGoQGoUFoECUHsbr1Zl71Wb/X/dChQhechhUEqc9/qo3+nSsCIqRdw7HcNubj8UtJh7QUKpJPgZK0JL3pejDRao12UqlPQ8z45Yj7FCpSkp00XJYFhevBRCEAYalPI0Y+IlfcJ6lIWXbyKVCXspIfTBSSqwZfg7zUU4cUbkCSneK+ggxCfjBRSECgc4g5rhlLxn0KFSnJTpoCdd10kB9MFIKuQeoTEx/qk1SkJDvFFCiXlkJvyg8mComP0CNLDUKD0CA0iNCAGD6UfpIgSH06RtpFCHfMuYnoxycNwhZdy3zm7XJBrCL1GTSmy3fcp2lOpFJjVvwmRXNCHiT4G8pGj7HwJlfAp9VrihQaqlCfMLQMemPGf9ynOTHGEx7USdGcJm+3sAiWugI++Va80FCl+gy8zjJAuCOFu/JPKqI5T6VYkJsEwhXwSVvRQkMNZbyj9bCdosR9OkDwaE6kI8L/7IPkgE/TRlGU0FDV3GfBFuEj7tOcOOj4tBTNSVGglrkQECng03FxLUpoqFp9BvYRvuM+mUcbsz6tiOZkUaB4tqEMj2DeTgr4tGsXJzRUjyw1CA1Cg9AgNIjlqE/x8KEoxn2K/+BTdFlfvBK9uE/TDiTMD8L64pXoxX06/kN+9Wl/8Ur04j6XNghV3GedERxESOI+PUfmUJ//Oh4+FLm4T9PRvfyoz8AWEZa4z6UNQhX3WQCI0MR9Zvw8LUAPqDQIDUKD0CBWAYiwxX1aIlTHfTaskEWEPO6zIBBRjPssaFlANOM+raTc4z6DP/M2onGf/lbnK0BEK+7TFqE67lOPLDUIDUKD0CA0CJ/qk33h55q15QyC1FZM/b3hZQcCA2B11wDZWX/gso+vwo26swTZWb+3M/CC0+iBANnJvpGpv7PMQYDsRFdR3hbheOZt/u/71AMqDUKDKBMQ/+mNbf8DaX7WFybp5ZgAAAAldEVYdGRhdGU6Y3JlYXRlADIwMjAtMTEtMDZUMjM6MTQ6NTkrMDA6MDCkMShmAAAAJXRFWHRkYXRlOm1vZGlmeQAyMDIwLTExLTA2VDIzOjE0OjU5KzAwOjAw1WyQ2gAAABJ0RVh0U29mdHdhcmUAR3JlZW5zaG90XlUIBQAAAABJRU5ErkJggg=="},274:function(A,e){A.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOUAAAA/CAMAAAAosv9tAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAABO1BMVEXr6+v//////9t+hLfB///y9PPr69CWVjMzM3iz6+vr0JZWMzMzMzMzM1aW0Ov//+B2GsK9///QllYzeHh4M3jr67N4MzN4s+tWM3iz67Prs3gzVpbQ6+v/6slZhJUxhJVZwO1+hJV+1f+gwKbBrKag1ckxmMng///BrJUxrNu9dqYaGqYaduC9drSavdBNGqYaTdDf//92GqZ2vf8zeLOzeDOWeDN+hKag6v//1bf//+2gmLdZmMlZhLegmKb/3b6kD4CTD4CTRb7s/////++aTcJWlrNWltAxhKYxhLfgwKb/39AaGrSa3/9NTdB4M1Z2GrQaGsJZwMnfmrRNmtCgmJWaTab/vcKWVlaW0NBNmu+aTbRZrLegrJXB/9uadqbgwLd+rKZ+1duWVnhZhKZNGsJ+mMng/+1ZrNvVQLexAAAAAWJLR0QB/wIt3gAAAAlwSFlzAAAOwwAADsMBx2+oZAAAAAd0SU1FB+QLBhcPEJD8JKcAAAXUSURBVGje7ZuLX9s2EMctIIQwVho2mo4u2EkfOAlbgZQtDt2DjQ0S2m4sZWzZe+se//9fMJ10p4ftmBAnTaDWp8HIOhl9c7J8P5/qOFcqbLgyN7/AZqk4M0iZy+XEZ9YpU5fcdfBlRplRvl7KxfxSwXGW31p5+1YqyqRVKLEtN+zqtXq7ODLl2jvvFpz1OyVn+W7hxlIu332PU27ce99ZWylFKcubrut6bK7iulU+2PtQwRp78HDTfbTFfBdq8NOtqTYs0N1TbbIDIAtsH076bg4OdBKviVeR3bHUG7xsM/bBh48bO7uALD57jUbzMsrFfGmdU649cfbvfRSlnPu4xYIaax+IMcxVaqz8dAtrzAdEQVT+BAdOlvgX25+2TF/KDgTk1wxfqpPCBK+C3T/7/PDw8IsvyZf1nV1WbyLl0VfFkI9j5+sTR1B+nT929gdSCo+etHAoWENCFvBah9iorSvO8YNnUlaZBoJLx1BWmXUVLzpj602q8M/pY+7gZ8+TKRfzK1BKG3y2crdGZ6wvRssdaIwPazRoPlo1CclSl66YxnGU6PFYSnUV6B72pUX5Yne4Jwn4cv2bW+LeDFMSXsUan6wZlD74UviG2nSBS6Df7A6+h5Qt82SV2VcxvrbVb58blLxSPyuu7jWHp4QnyVLBifUlTB2YQnrdkDWasdzku3kxO8Ft2IbrZ0X0pjbs0JUdoBFuTbH60Ek0wb9H3bH0xOojKaHykvsTpuzObrqoIIAB+94Nj33g23RrWYSXFvFNUV7s5vvy2lGWN6tjtxyzJuHhQemKlOEQXIy9fS5iHrs91jLUZtucQqjKjr6XkSu7CD0tRtQkiz/8mE9LGT49mDLO3LKB6LTeZ0c/ydCtNzRisiZxIvEdPi9/3nz0CyqOKgsgtOzosQuFgqGCcqKOZ23LKukVspRyB9tIthghwDZRAnM6StQkAyk7v1a8rke6I6gZXzkoFB6YqRgWm+TvGNxqS0PLaBMuBLANrSlklYEczFgeiZ+++K3R6KehRE0ykBKwOCXqDh6HVWWIhiKkfV6NpQwwRNeWhpaxKecXjGDfcCXO0oszrjuaFMOORkma5BJK5Zrf//CsO4orwERKbWloGWzxzW8g7Et1K5LuqDfTPUmG8CUphqDGnWdSBp0FarMo+fRun3dClEppSBNLzZFsCXlS3Z6pfEmUwqdLhYEzVuqOAL77imcIDjmLoU1EvFJGgCbhJ/8M+9JQGvQm5URPha6x+sBrjgbIKvkgAd3RvJ6xz6TkzmxRTkruZHFsRvmmUk5UVEw2TxJ6hRdDqWLVq1DGhOoQuW3r38+Kk6eUmuSvgrN/fLkvR0g8x3S52L56+mM8mkSEtPF5Ep0gkUNGl4ayJvgURBEj+5E0sZMnrNenvEdTUcKTv8+iaY+xUCpN4oQTCCqDUH7VIuFg646Q0mCGiKF+Mv5FEwxSew310v/07yJSGiIrpW8TNYmzFndfQtRtJHBsSltpSPmBISH2w6BdiRHLlxciiiNf9oS2iqY9xkGpNUkEcmhKKzMSTylNtODoYwpAAJLvenxFiqY9xvUkEb6MQso8ySs58xIo7cwIUmI/lCbh5ImirJ8ZlIAYTXuMk3L9TrwmAfl80tJApu4IZU0sSuxH0sQyMVafl7eF7oCk656cqZG0Rxb7ZJQZZUaZUV4PTQLRQdzeLSPtMVihjJRoeM2UQpNA2YiL1kfekjVblIYmOR5MKUUFJBHghSxJDAsA91lhm7H5qjN9StIkPPiJV9FSa+m9VJF8B81fuc+KLA/UziUtRqZHqTVJ7H4feg9OusODf3a+w96mhW14sBMJU6PUmsQRO5sGUaLumPvn34MFFsp3qAL7rLAND0g5dV+qPEmiL5WoePDwP6MWyTE/3aJdXhXahWikS6ZOCZok7r6knAaJikCsOna+Q78qh1mMlniw0iVZVJBRZpQZZUaZlnLaOZSkPAkd0v9PiwTKUcMgu98lb6X/B99FO0EW076KAAAAJXRFWHRkYXRlOmNyZWF0ZQAyMDIwLTExLTA2VDIzOjE0OjU5KzAwOjAwpDEoZgAAACV0RVh0ZGF0ZTptb2RpZnkAMjAyMC0xMS0wNlQyMzoxNDo1OSswMDowMNVskNoAAAASdEVYdFNvZnR3YXJlAEdyZWVuc2hvdF5VCAUAAAAASUVORK5CYII="},275:function(A,e){A.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAMMAAAAwCAMAAACbpz4vAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAABnlBMVEXr6+vr69CWVjMzMzMzM3iz6+vr0JZWMzN4s+v//////9S2D4CTD4CTD5TI3f/ab4Cklr62D6na////uqm2uv//3b6kD4CTRb7s///slpSTb9Trs3gzVpbQ6+sWFyO4ub3//+nIRYCTD6n///WPOc0AAM1mtv//2+Q5AM0AOeTb//+WVlaW0NAzeLM+PkmPOdSP2/WPOdy2//+2Zs05j/WW0Ouklumkb6nIb4DIlpSkD5Tbj9QAZuzIRZSkD6na/9S2D5TIRamkRb4AANz//+xmAM34+fvw8PPIyc3o6OpDQ07h4eP09PcKCheztLw/P0qlpapWltAqKjX///uTXPnL///r67N4M3hGRlHCwsklJjLW1tgrKzbab5TIur7LlvZYXPZYlvvLlvevzPp2XPZYefrl//+TXPaTzP+zeDMwMDz///2vefnT1NVaWmS+v8L/5fpYXPev5f9WM3h2efpWM1Z4M1aTXPdYXPnQlla2utTlsfd2sfozM1YAANSP2/9WVpY5ANz/ttykb9SPZs0zeJY5j+y2Rb62b6lmANSA+gL5AAAAAWJLR0QJ8dml7AAAAAlwSFlzAAAOwwAADsMBx2+oZAAAAAd0SU1FB+QLBhcPEef7FDEAAATYSURBVGje7ZqJW9MwGMY7KtNslepWkA51XBsiMhVkHvMWL8QDFcVzeIB43/eB9/Ff+yX50iVdB+m8mM/yPCMrbbL8+iX53r6bYbASaTBNc1GjEV1smksMpZCyEotb1tImQmzLWrY8QUjScuC/zS2WtaJVXOOyc+JKPGc7/m5SXi/8KEbfwUvtLMl6EefUQcAnGfMWsuBLnaHOUGf4Pxlgc4U9tQ12WHPlKjhena6Oob3D6kyEalHaLqXS1Z3JQtWzJtO7Vpch0reuAfNCWz/9uzqXrjIOgWMKeX3X+g3dwNC1cYAMbtKfSxFkiPQNMQYiIAIa0QyUZ9kJsltyc8uKLZYTW76V/RPHRFOQlNFsls5oO0fkKmxAO6HnSPO2JiUQWf6msD08Aw8DMAiIgPmyw/u05p2JZOeueN7Nx+KQZXc3IUP7HjmnEjvF7jichpEKBmjQvLfVu6wCw2A2NINAAQaECGjkshtOJQBM/mQKRgEMMJT2DgcZ6B2nUsClV3A2uJ6S2I4Xh4RPPpAAhoL+evAG38ZWNGfgEIHNXIvfdRiAzLBDxIHe4LIpXwWDDoKfQYSBMzCI4HYwSMpgK3FI0i2JjSkWV+SdnRezhc4l3s5j4EEKnEtaCMRQdasIAzJQiPl0q2CI82kDFVWcqvBEicr1p9C0IgZu+ZqGrTWT2TcwvJ9V1eY4ZDiQS/+hLfUv5GlkIAdzh2qegRweOUQWeJmXgRwZqWWGUVjTudxILTOMHj1Gjp+oOd3KhOsYZxg9mj5Jjpw0/sjyLe/i1OnxX2RA3XrmbCN7AQMgGBPnyMSJmmHADB1pGMM0lwMEI32eXLgYNACmOFX9ySVSXghWoVtlwUouXW4R+Y9mdDmrFSehXCHk6rXrk1PTFIi9bkxOzoTWSzfNfmlVTFwgt4LyNBNLqv6kkgEEEQpWoVsVwUps5jGhzvKpC4xDcWqaFGeQ4fadcZ34+OPQb9wUcgPK3fP37gdPBJCoqnZDBhSsWKmCFT0yelRxLhVnxAG8HlyH4Dx8FI4h+rixJPsq+3xcovr0p80mCApWrFTBGp7hyXT49RB9OmSceTakwQASVdWfYtRcsArdqghWZIDnpvaOzrK59PyRxAAHxRfjp27MhNmXULe+NDX91s6EX3/a/KkHBStWqmBFvxXavSpbD+Q1W9OcgR68gVjQyTQ1XW2OC+3NJKnS5re9Zv0l9uCQqntkdYY6w8LSrdHF5tshTYbQ1qo/sUEHdBdg1Zyd9azJvJsNo1uj71fpxiGkgPVfnkzJVeXOhvdnSc+HAc08TY1KNFznzNOKtcptV8i+zOdDwYoSVTFoWTunZIy5PJtgpfq0cv772LuWFDLZEHqp7e28DIq16skH4PjkGa22/DUoGrRC4XIG12KJHSu/TyszFLaTwd7PugxUa3zp09FLJWsVbVc6JS41eUZrSVZwVSLCFpPNsfI4iOZKKXzt3jSXd1zme+NznIZuFbbkbvHV8a5vrZ7Rqn4VjQatBoPi04q5BPPI88G1vn9oGDP0dKvEYNMj+7sjCVYnwKAtPWmwBgEMnk8rz6XhH7NsTejpVlotMTR1q7BWxc8F6KoO/kkAGrQiAC42kBn8Pq2iaWFvnct1rSbHVdgF3XwN5elABvcfida6Xqoz/MbyE+fyp8nqIcaYAAAAJXRFWHRkYXRlOmNyZWF0ZQAyMDIwLTExLTA2VDIzOjE0OjU5KzAwOjAwpDEoZgAAACV0RVh0ZGF0ZTptb2RpZnkAMjAyMC0xMS0wNlQyMzoxNDo1OSswMDowMNVskNoAAAASdEVYdFNvZnR3YXJlAEdyZWVuc2hvdF5VCAUAAAAASUVORK5CYII="},292:function(A,e,t){"use strict";t.r(e);var a=t(15),s=Object(a.a)({},(function(){var A=this,e=A._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":A.$parent.slotKey}},[e("h1",{attrs:{id:"minecraft"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#minecraft"}},[A._v("#")]),A._v(" Minecraft")]),A._v(" "),e("p"),e("div",{staticClass:"table-of-contents"},[e("ul",[e("li",[e("a",{attrs:{href:"#configuring-a-server-network-bungeecord-waterfall-hexacord-etc"}},[A._v("Configuring a Server Network (BungeeCord, Waterfall, HexaCord, etc.)")]),e("ul",[e("li",[e("a",{attrs:{href:"#allocations-in-the-panel"}},[A._v("Allocations in the Panel")])]),e("li",[e("a",{attrs:{href:"#proxy-server-settings"}},[A._v("proxy server settings")])]),e("li",[e("a",{attrs:{href:"#paper-spigot-bukkit-settings"}},[A._v("paper/spigot/bukkit settings")])]),e("li",[e("a",{attrs:{href:"#firewalls"}},[A._v("Firewalls")])])])])])]),e("p"),A._v(" "),e("h2",{attrs:{id:"configuring-a-server-network-bungeecord-waterfall-hexacord-etc"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configuring-a-server-network-bungeecord-waterfall-hexacord-etc"}},[A._v("#")]),A._v(" Configuring a Server Network (BungeeCord, Waterfall, HexaCord, etc.)")]),A._v(" "),e("p",[A._v("If you want to operate Minecraft proxy servers like BungeeCord, Waterfall, HexaCord, etc. securely, you can do so with pterodactyl alone as long as you stay on the same node. It differs from a traditional setup in a few ways and might require additonal firewall rules, which is what this guide is for.")]),A._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[A._v("WARNING")]),A._v(" "),e("p",[A._v("For the setup described below, it is necessary that all servers are on the same node.")])]),A._v(" "),e("div",{staticClass:"custom-block danger"},[e("p",{staticClass:"custom-block-title"},[A._v("DANGER")]),A._v(" "),e("p",[A._v("If you are a hosting provider, you should only allow a single proxy network per node, if you are selling them to customers.")])]),A._v(" "),e("h3",{attrs:{id:"allocations-in-the-panel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#allocations-in-the-panel"}},[A._v("#")]),A._v(" Allocations in the Panel")]),A._v(" "),e("p",[A._v("Create a regular allocation for the proxy server which uses the external IP of the node, so users can reach it.")]),A._v(" "),e("p",[A._v("The actual game servers behind the proxy should use allocations with "),e("code",[A._v("127.0.0.1")]),A._v(" as the address, so they are only reachable on the node, and not from the public.")]),A._v(" "),e("h4",{attrs:{id:"example"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#example"}},[A._v("#")]),A._v(" Example")]),A._v(" "),e("p",[e("img",{attrs:{src:t(272),alt:""}})]),A._v(" "),e("p",[e("code",[A._v("10.1.70.62")]),A._v(" is an example, replace it with your own public IP address.")]),A._v(" "),e("h3",{attrs:{id:"proxy-server-settings"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#proxy-server-settings"}},[A._v("#")]),A._v(" proxy server settings")]),A._v(" "),e("p",[A._v("As the proxy server, like all servers, is running in a docker container with network isolation, "),e("code",[A._v("localhost")]),A._v("/"),e("code",[A._v("127.0.0.1")]),A._v(" doesn't refer to the node, but to the container. The node can be reached from within the container using "),e("code",[A._v("172.18.0.1")]),A._v(" (unless the pterodactyl network is configured differently) instead. You therefore need to use this IP in your proxy server configuration.")]),A._v(" "),e("h4",{attrs:{id:"bungeecord-waterfall-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bungeecord-waterfall-configuration"}},[A._v("#")]),A._v(" bungeecord/waterfall configuration")]),A._v(" "),e("p",[A._v("This will be different for other proxy servers, please refer to their documentation.")]),A._v(" "),e("p",[e("img",{attrs:{src:t(273),alt:""}})]),A._v(" "),e("h3",{attrs:{id:"paper-spigot-bukkit-settings"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#paper-spigot-bukkit-settings"}},[A._v("#")]),A._v(" paper/spigot/bukkit settings")]),A._v(" "),e("p",[A._v("The servers itself require the regular config options required by server proxies, which usually comes down to disabling online mode. This will differ for other server software, please refer to their documentation.")]),A._v(" "),e("h4",{attrs:{id:"server-properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#server-properties"}},[A._v("#")]),A._v(" server.properties")]),A._v(" "),e("p",[A._v("set online-mode "),e("code",[A._v("false")]),A._v(" "),e("img",{attrs:{src:t(274),alt:""}})]),A._v(" "),e("h4",{attrs:{id:"spigot-yml"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#spigot-yml"}},[A._v("#")]),A._v(" spigot.yml")]),A._v(" "),e("p",[A._v("set bungeecord to "),e("code",[A._v("true")]),A._v(" "),e("img",{attrs:{src:t(275),alt:""}})]),A._v(" "),e("h3",{attrs:{id:"firewalls"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#firewalls"}},[A._v("#")]),A._v(" Firewalls")]),A._v(" "),e("p",[A._v("If you are using a firewall, additional rules might be required to allow servers to reach each other on the node. In this case the proxy server needs to reach all of the game servers behind it. Therefore we need to allow traffic from the pterodactyl network to the server ports on localhost.")]),A._v(" "),e("p",[A._v("You can use the following commands as an example. "),e("code",[A._v("172.18.0.1")]),A._v(" is the default address referring to the node within the pterodactyl network. Replace "),e("code",[A._v("")]),A._v(" with the allocated localhost ports of the game servers.")]),A._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[A._v("WARNING")]),A._v(" "),e("p",[A._v("The following commands will allow any server on the node to access the opened ports.")])]),A._v(" "),e("h4",{attrs:{id:"ufw-ubuntu"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ufw-ubuntu"}},[A._v("#")]),A._v(" UFW (Ubuntu)")]),A._v(" "),e("p",[A._v("Allow access to the pterodactyl pterodactyl0 network on a specific port.")]),A._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[A._v("ufw allow "),e("span",{pre:!0,attrs:{class:"token keyword"}},[A._v("in")]),A._v(" on pterodactyl0 to "),e("span",{pre:!0,attrs:{class:"token number"}},[A._v("172.18")]),A._v(".0.1 port "),e("span",{pre:!0,attrs:{class:"token operator"}},[A._v("<")]),A._v("LOCALHOST_PORT"),e("span",{pre:!0,attrs:{class:"token operator"}},[A._v(">")]),A._v(" proto tcp\n")])])]),e("h4",{attrs:{id:"firewalld-centos"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#firewalld-centos"}},[A._v("#")]),A._v(" Firewalld (CentOS)")]),A._v(" "),e("p",[A._v("Allow access to pterodactyl0 from the pterodactyl0 network.")]),A._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[A._v("WARNING")]),A._v(" "),e("p",[A._v("This command will allow any server to access all other servers as well as all ports on the node.")])]),A._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[A._v("firewall-cmd "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[A._v("--permanent")]),A._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[A._v("--zone")]),e("span",{pre:!0,attrs:{class:"token operator"}},[A._v("=")]),A._v("public --add-source"),e("span",{pre:!0,attrs:{class:"token operator"}},[A._v("=")]),e("span",{pre:!0,attrs:{class:"token number"}},[A._v("172.18")]),A._v(".0.1\n")])])])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/assets/js/12.54d684d5.js b/assets/js/12.a4261b01.js similarity index 98% rename from assets/js/12.54d684d5.js rename to assets/js/12.a4261b01.js index 17183971..f05e7904 100644 --- a/assets/js/12.54d684d5.js +++ b/assets/js/12.a4261b01.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[12],{269:function(t,e,o){t.exports=o.p+"assets/img/pterodactyl_add_node_create_button.05642c32.png"},270:function(t,e,o){t.exports=o.p+"assets/img/pterodactyl_add_node_new_page.17d70664.png"},271:function(t,e,o){t.exports=o.p+"assets/img/pterodactyl_add_node_config.f87f425f.png"},291:function(t,e,o){"use strict";o.r(e);var a=o(15),n=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"creating-a-new-node"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#creating-a-new-node"}},[t._v("#")]),t._v(" Creating a New Node")]),t._v(" "),e("p"),e("div",{staticClass:"table-of-contents"},[e("ul",[e("li",[e("a",{attrs:{href:"#location"}},[t._v("Location")])]),e("li",[e("a",{attrs:{href:"#information-required"}},[t._v("Information Required")])]),e("li",[e("a",{attrs:{href:"#install-the-daemon"}},[t._v("Install the Daemon")])]),e("li",[e("a",{attrs:{href:"#configuring-the-node"}},[t._v("Configuring the Node")]),e("ul",[e("li",[e("a",{attrs:{href:"#auto-deploy"}},[t._v("Auto-Deploy")])])])])])]),e("p"),t._v(" "),e("h2",{attrs:{id:"location"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#location"}},[t._v("#")]),t._v(" Location")]),t._v(" "),e("p",[t._v("Head to the admin panel and click the Nodes tab on the left sidebar. After that, click 'Create New' on the\ntop right side to open the page to add a node.")]),t._v(" "),e("p",[e("img",{attrs:{src:o(269),alt:""}})]),t._v(" "),e("h2",{attrs:{id:"information-required"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#information-required"}},[t._v("#")]),t._v(" Information Required")]),t._v(" "),e("p",[e("img",{attrs:{src:o(270),alt:""}})]),t._v(" "),e("ul",[e("li",[e("strong",[t._v("Name")]),t._v(": a quick identifiable name for the node.")]),t._v(" "),e("li",[e("strong",[t._v("Description")]),t._v(": a long description that is used to help you identify the node.")]),t._v(" "),e("li",[e("strong",[t._v("Location")]),t._v(": the location you want the node in. These are configured in the 'Locations' section of the panel and one\nmust be created before a node can be created. These simply act as categories for nodes and serve no other purpose at\nthis time.")]),t._v(" "),e("li",[e("strong",[t._v("FQDN")]),t._v(": the fully qualified domain name for the node — for example: "),e("code",[t._v("node.pterodactyl.io")])]),t._v(" "),e("li",[e("strong",[t._v("Communicate over SSL")]),t._v(": if the panel is using SSL the Daemon is required to use SSL as well.")]),t._v(" "),e("li",[e("strong",[t._v("Behind Proxy")]),t._v(": if you have the Daemon behind a proxy that terminates SSL connections before arriving at the Daemon\nthen this option should be selected. If none of that sentence made sense, this doesn't affect you.")]),t._v(" "),e("li",[e("strong",[t._v("Server File Directory")]),t._v(": the location on the physical server where the daemon is to store the files the servers\ngenerate. By default this is "),e("code",[t._v("/var/lib/pterodactyl/volumes")]),t._v(".")])]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("OVH Users")]),t._v(" "),e("p",[t._v("Some OVH users regularly have their "),e("code",[t._v("/home")]),t._v(" folder be the largest filesystem. You may want to change to use\n"),e("code",[t._v("/home/pterodactyl/volumes")]),t._v(" if you are on a default OVH box.")])]),t._v(" "),e("ul",[e("li",[e("strong",[t._v("Total Memory")]),t._v(": the total amount of RAM the node should be able to allocate automatically.")]),t._v(" "),e("li",[e("strong",[t._v("Memory Overallocate")]),t._v(": the percentage of RAM to over-allocate on a node. For example, if you have set a 10GB memory\nlimit, with a 20% overallocation, the Panel will allocate up to 12GB of memory on this node in total.")]),t._v(" "),e("li",[e("strong",[t._v("Total Disk Space")]),t._v(": the total amount of disk space the node should be able to allocate automatically.")]),t._v(" "),e("li",[e("strong",[t._v("Disk Overallocate")]),t._v(": works the same way as memory overallocation.")])]),t._v(" "),e("div",{staticClass:"custom-block danger"},[e("p",{staticClass:"custom-block-title"},[t._v("DANGER")]),t._v(" "),e("p",[t._v("Don't forget to account for OS overhead and other software requirements on machines.")])]),t._v(" "),e("ul",[e("li",[e("strong",[t._v("Daemon Port")]),t._v(": the port that the Daemon should listen on.")]),t._v(" "),e("li",[e("strong",[t._v("Daemon SFTP Port")]),t._v(": the port the Daemon sftp-server or standalone SFTP server should listen on.")])]),t._v(" "),e("h2",{attrs:{id:"install-the-daemon"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#install-the-daemon"}},[t._v("#")]),t._v(" Install the Daemon")]),t._v(" "),e("p",[t._v("At this point you'll need to have the Daemon installed on your machine. Check out the "),e("RouterLink",{attrs:{to:"/wings/installing.html"}},[t._v("documentation")]),t._v("\nfor more information, or try one of the community guides for "),e("RouterLink",{attrs:{to:"/community/installation-guides/wings/centos7.html"}},[t._v("CentOS")]),t._v(",\nor "),e("RouterLink",{attrs:{to:"/community/installation-guides/wings/debian.html"}},[t._v("Debian")]),t._v(".")],1),t._v(" "),e("h2",{attrs:{id:"configuring-the-node"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configuring-the-node"}},[t._v("#")]),t._v(" Configuring the Node")]),t._v(" "),e("p",[t._v("Go to the Node Configuration page")]),t._v(" "),e("p",[e("img",{attrs:{src:o(271),alt:""}})]),t._v(" "),e("p",[t._v("Copy and paste the config into the "),e("code",[t._v("config.yml")]),t._v(" file. (Default location is "),e("code",[t._v("/etc/pterodactyl/config.yml")]),t._v(")")]),t._v(" "),e("h3",{attrs:{id:"auto-deploy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#auto-deploy"}},[t._v("#")]),t._v(" Auto-Deploy")]),t._v(" "),e("p",[t._v("This will generate a command to run on the node server to configure the daemon for you.")])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[12],{269:function(t,e,o){t.exports=o.p+"assets/img/pterodactyl_add_node_create_button.05642c32.png"},270:function(t,e,o){t.exports=o.p+"assets/img/pterodactyl_add_node_new_page.17d70664.png"},271:function(t,e,o){t.exports=o.p+"assets/img/pterodactyl_add_node_config.f87f425f.png"},289:function(t,e,o){"use strict";o.r(e);var a=o(15),n=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"creating-a-new-node"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#creating-a-new-node"}},[t._v("#")]),t._v(" Creating a New Node")]),t._v(" "),e("p"),e("div",{staticClass:"table-of-contents"},[e("ul",[e("li",[e("a",{attrs:{href:"#location"}},[t._v("Location")])]),e("li",[e("a",{attrs:{href:"#information-required"}},[t._v("Information Required")])]),e("li",[e("a",{attrs:{href:"#install-the-daemon"}},[t._v("Install the Daemon")])]),e("li",[e("a",{attrs:{href:"#configuring-the-node"}},[t._v("Configuring the Node")]),e("ul",[e("li",[e("a",{attrs:{href:"#auto-deploy"}},[t._v("Auto-Deploy")])])])])])]),e("p"),t._v(" "),e("h2",{attrs:{id:"location"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#location"}},[t._v("#")]),t._v(" Location")]),t._v(" "),e("p",[t._v("Head to the admin panel and click the Nodes tab on the left sidebar. After that, click 'Create New' on the\ntop right side to open the page to add a node.")]),t._v(" "),e("p",[e("img",{attrs:{src:o(269),alt:""}})]),t._v(" "),e("h2",{attrs:{id:"information-required"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#information-required"}},[t._v("#")]),t._v(" Information Required")]),t._v(" "),e("p",[e("img",{attrs:{src:o(270),alt:""}})]),t._v(" "),e("ul",[e("li",[e("strong",[t._v("Name")]),t._v(": a quick identifiable name for the node.")]),t._v(" "),e("li",[e("strong",[t._v("Description")]),t._v(": a long description that is used to help you identify the node.")]),t._v(" "),e("li",[e("strong",[t._v("Location")]),t._v(": the location you want the node in. These are configured in the 'Locations' section of the panel and one\nmust be created before a node can be created. These simply act as categories for nodes and serve no other purpose at\nthis time.")]),t._v(" "),e("li",[e("strong",[t._v("FQDN")]),t._v(": the fully qualified domain name for the node — for example: "),e("code",[t._v("node.pterodactyl.io")])]),t._v(" "),e("li",[e("strong",[t._v("Communicate over SSL")]),t._v(": if the panel is using SSL the Daemon is required to use SSL as well.")]),t._v(" "),e("li",[e("strong",[t._v("Behind Proxy")]),t._v(": if you have the Daemon behind a proxy that terminates SSL connections before arriving at the Daemon\nthen this option should be selected. If none of that sentence made sense, this doesn't affect you.")]),t._v(" "),e("li",[e("strong",[t._v("Server File Directory")]),t._v(": the location on the physical server where the daemon is to store the files the servers\ngenerate. By default this is "),e("code",[t._v("/var/lib/pterodactyl/volumes")]),t._v(".")])]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("OVH Users")]),t._v(" "),e("p",[t._v("Some OVH users regularly have their "),e("code",[t._v("/home")]),t._v(" folder be the largest filesystem. You may want to change to use\n"),e("code",[t._v("/home/pterodactyl/volumes")]),t._v(" if you are on a default OVH box.")])]),t._v(" "),e("ul",[e("li",[e("strong",[t._v("Total Memory")]),t._v(": the total amount of RAM the node should be able to allocate automatically.")]),t._v(" "),e("li",[e("strong",[t._v("Memory Overallocate")]),t._v(": the percentage of RAM to over-allocate on a node. For example, if you have set a 10GB memory\nlimit, with a 20% overallocation, the Panel will allocate up to 12GB of memory on this node in total.")]),t._v(" "),e("li",[e("strong",[t._v("Total Disk Space")]),t._v(": the total amount of disk space the node should be able to allocate automatically.")]),t._v(" "),e("li",[e("strong",[t._v("Disk Overallocate")]),t._v(": works the same way as memory overallocation.")])]),t._v(" "),e("div",{staticClass:"custom-block danger"},[e("p",{staticClass:"custom-block-title"},[t._v("DANGER")]),t._v(" "),e("p",[t._v("Don't forget to account for OS overhead and other software requirements on machines.")])]),t._v(" "),e("ul",[e("li",[e("strong",[t._v("Daemon Port")]),t._v(": the port that the Daemon should listen on.")]),t._v(" "),e("li",[e("strong",[t._v("Daemon SFTP Port")]),t._v(": the port the Daemon sftp-server or standalone SFTP server should listen on.")])]),t._v(" "),e("h2",{attrs:{id:"install-the-daemon"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#install-the-daemon"}},[t._v("#")]),t._v(" Install the Daemon")]),t._v(" "),e("p",[t._v("At this point you'll need to have the Daemon installed on your machine. Check out the "),e("RouterLink",{attrs:{to:"/wings/installing.html"}},[t._v("documentation")]),t._v("\nfor more information, or try one of the community guides for "),e("RouterLink",{attrs:{to:"/community/installation-guides/wings/centos7.html"}},[t._v("CentOS")]),t._v(",\nor "),e("RouterLink",{attrs:{to:"/community/installation-guides/wings/debian.html"}},[t._v("Debian")]),t._v(".")],1),t._v(" "),e("h2",{attrs:{id:"configuring-the-node"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configuring-the-node"}},[t._v("#")]),t._v(" Configuring the Node")]),t._v(" "),e("p",[t._v("Go to the Node Configuration page")]),t._v(" "),e("p",[e("img",{attrs:{src:o(271),alt:""}})]),t._v(" "),e("p",[t._v("Copy and paste the config into the "),e("code",[t._v("config.yml")]),t._v(" file. (Default location is "),e("code",[t._v("/etc/pterodactyl/config.yml")]),t._v(")")]),t._v(" "),e("h3",{attrs:{id:"auto-deploy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#auto-deploy"}},[t._v("#")]),t._v(" Auto-Deploy")]),t._v(" "),e("p",[t._v("This will generate a command to run on the node server to configure the daemon for you.")])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/14.10dbee7a.js b/assets/js/14.ed610c4a.js similarity index 98% rename from assets/js/14.10dbee7a.js rename to assets/js/14.ed610c4a.js index c1ddf0c9..8ed3602d 100644 --- a/assets/js/14.10dbee7a.js +++ b/assets/js/14.ed610c4a.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[14],{278:function(e,A){e.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAloAAAEkCAIAAAB4+QiRAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAW5ElEQVR42u3dv2/b6JbG8TOYIokdWE16/gPspGYBFmxM2IAblWq2IMaCLWAREAlgEEjBTkCmUCUbMqRGlW6jxcKCjfA2bFaNWCxUXLBYsFh1rOhCIJLm3UKOY3tmMrFjySb1/VSDTJLROc+872P9SCwKQIF0Op16vV4ul03TFNyHaZrlcrler5+envI/0hoSVgAUw9nZ2ebmZr1e73Q6YRiykAcIw7DT6ezv729sbJyfn7MQ6hBAzrx7925vb+/z58+s4lHM5/Pd3V3XdVkFdQggT134/v179vDoHMc5OjpiD9QhgBw4Ozvb29tjD0uys7NzcXHBHqhDAM/d5uYmr5Euz3w+L5VK7IE6BPCsLT5Hyh6WyrbtXq/HHqhDAM/X4nOk7GGpTk5ODg4O2AN1COD5KpfL/JmKZZtMJpVKhT1QhwCeL9M0WQJ7BnUIrP0BFo4wewZ1CHCAuabZM6hDAFzT7BnUIQCuafYM6hAA1zR7BnUIgGuaPYM6BMA1zZ5BHQLgmmbPoA4BcE2zZ1CHALim2TOoQwBc0+wZ1CEArmn2DOoQANc0ewZ1CIBrmj2DOgTANc2eQR0CeJbXdOpbckutOcp+7rdMAk/EClL2DOoQQH7q0BCptUZhOB6Px4NWQ0TsfvTTdaiPEvYM6hBAfupQF3G/PZXLmrpozkgpNe66uoiIaIY9ijKl1LhtW7brVHUR0Sw3XPyidNqsGSIimtUaRdd16FOHoA4B5OvZoTOMVJamaRr5LU3EHkRZ2BKRWms4DX3XEjGaqVKBZ4iI5XRHg6Yuoru+UjNPF9FqgyDoOpaItKcZdQjqEED+6vDOe4diOGGqstm42x0lSmXpbODoorkzpQJXF6u1eGfRdzTN8dNxU0TaV88To4aI4QXUIahDALl8dmh3gziaTqfT6TS++hxNEno1/VtH6l6ilO/qmusv/n3g6prjp+PW3TJ1feoQ1CGA/NWhLuIGd7sraBoi1eE0zpSK+jXR3Ks6dK7qcPHPSeCJaP0ozZIkTZNg2PenCXUI6hBAPuvQn935Yd/VRexpptJoVBUR3Y3/rA5VGhgihjtMlYr9pog4oxmfLAV1CCB/dWiIeH94dpiG3euXSmt2VUQ01w9u1OH1P0dD78bbjoPs6pOlBn/uENQhgEJc01kSR3GSLv4xSb/zh/PTJIriWZKxZ1CHALim2TOoQwBc0+wZ1CEArmn2DOoQANc0ewZ1CIBrmj2DOgTANc2eQR0C4Jpmz6AOAXBNs2dQhwC4ptkzqEMAXNPsGdQhAK5p9gzqEADXNHsGdQiAa5o9gzoEwDXNnkEdAuCaZs+gDgFwTbNnUIcAfo5pmiyBPYM6BNZduVwOw5A9LNVkMqlUKuyBOgTwfNXr9U6nwx6W6vj4+PDwkD1QhwCer9PT0/39ffawVLZt93o99kAdAnjWNjY25vM5e1iSy8vLra0t9kAdAnjuzs/Pd3d32cOSbG9v+77PHqhDADnguq7jOOzh0b19+/bDhw/sgToEkBtHR0c7Ozu8avpYLi8vt7e36ULqEED+XFxclEol27ZPTk4mkwkLeYDJZHJ8fGzb9tbWFq+RUocAcqzX6x0cHFQqFdM0BfdhmmalUjk8PORzpNQhACz/0uEvPAN1CADUIahDAKAOQR0CAHUI6hAAqENQhwBAHYI6BADqENQhAFCHoA4BgDoEdQgA1CGoQwCgDkEdAgB1COoQAKhDUIcAQB2COgQA6hDUIQBQh6AOAYA6BHUIANQhqEMAoA5BHQIAdQjqEACoQ1CHAEAdgjoEAOoQ1CEAUIegDgGAOgR1CADUIahDAKAOQR0CAHUI6hAAqENQh8DPMk1TAOSTaZrUIcCzB5Av+eY1X/6/BMcJ5AvypQ7BcQL5gnypQ3CcQL4gX+oQHCeQL8iXOgTHCeQL8qUOwXEC+YJ8qUNwnEC+IF/qEBwnkC/IlzoExwnkC/KlDsFxAvmCfKlDcJxAviBf6hAcJ5AvyJc6BMcJ5AvypQ7BcQL5gnypQ3CcQL4gX+oQHCeQL8iXOgTHCeQL8qUOwXEC+YJ8qUNwnEC+IF/qEBwnkC/IlzrEs+X7fqlU6vV618ep1+uVSqVPnz6xHPIF+VKHWCMvX758/fr1mzdvROTNmzevX79+8eIFayFfkC91iPXy+++/b2xsiMivv/4qIpubmx8/fmQt5AvypQ6xdl69eiVfvXz5koWQL8iXOsRaf4HJUwfyBflSh+ALTJ46kC/IlzrE2n+B+erVK546kC/IlzrEWvvy5ctvv/32+fNnVkG+IF/qEEvU6XTq9Xq5XDZNU3AfpmmWy+V6vX56ekq+5Eu+BcuXOlwjZ2dnm5ub9Xq90+mEYchCHiAMw06ns7+/v7GxcX5+Tr7kS76FyZc6XBfv3r3b29vjRarHMp/Pd3d3XdclX/Il32LkSx2uSxe+f/+ePTw6x3GOjo7Il3zJtwD5UofFd3Z2tre3xx6WZGdn5+LignzJl3zzni91WHybm5u8xrI88/m8VCqRL/mSb97zpQ4LbvE5NPawVLZtL/4uf/IlX/LNb77UYcEtPofGHpbq5OTk4OCAfMmXfHOdL3VYcOVymc9kL9tkMqlUKuRLvuSb63ypw4IzTZMlFHjP5Eu+eKw9U4cFt/jO1CjqnsmXfPFYe2bXHGNwXYJ8yZc65BiD6xLkS77UIccYXJcgX/KlDjnG4LoE+ZIvdcgxBtclyJd8qUOOMbguQb6gDjnG4LoE+YI65BiD6xLkC+qQYwyuS5AvqEOOMbguQb6gDjnG4LoE+YI65BiD6xLkC+qQYwyuS5AvqEOOMbguQb6gDjnGS5T6lohu97OvPzBuWqJ7yd//ysTTxPFnP/QfCVuieUka6GL41791Om7U3GnGdVnAfMd9z9J1XbcazWFCvoU8v9QhinecDBER8b4ejMDTRfuR45T++HEae4bmBonviNHKlFLZLByPmrYuoo+S9djzOuUbdmsiYjf7/bajiYg9yMi3SOeXOkSBj5NhiIg9vXucZn23KiIiUnMHiwOWxSPb0ESk6rhVEdefKaVm435VFxHRq24wu3Vesjjotps1Eal5XlVEq3VHYRJ4cuXJvthcq+tytfn+0xWRxuj6JhXNnZFvgc7vuG1btutUdRHRLDdMqUMU5TjpYviRXxUxPP/mcRq5uojWGoXjYVNEdNdX2bgqIro9GA0dQ2RxnOKBJqI32sF4aOsimhPf/O2jkWsbIlrDtUWk5rqtQXj1rwJPRKcOC5fvf4+HgyBe3JFZ3xbR3IR8C3R+A88QEcvpjgZNffE7U4coynHS/UzFfVtE+jMVNo3F+wSGSGN4dTTCliWa+7+BJ6JdvbyZ+oaI688CzxBpRIsfm7ZFpHvn/cCxJ0Y7S4citZsnLaEOC52vmoVeVRORRn9KvkXKN3B1sa5eNfUdTXOoQxToOI0SpVTiGSLV5qBpieYlia+LNIZXr3KlY0+k+k/fFbn+4vHqvYfAs+Q297ristCpWoYmIlq1qouIXvWuzxp1WOB8g3ZDRESq/fGMfAuWr+/q2tdnhIGrU4co3nFS2bSrXb2jd/XVpRtcHYywbYnm/st3RYzxVZ+Fi/cefFcXzY2zLEnSdDYd9Ifx9ReXWRIGfUPEGQwdXSxvMA6jjGeHRc836tsi4nSDNTpH65Svf6MCfeoQhTxOSinfM66Ok0qbuojhTlOVzfyaiNYYLt5mqLX8VGVBq7Z47yEeNkS0VhArlQ5d/cZ5W5TeUBMrTCNbpBvd+i9ThwXNd+ZqIlZzPA2DIAgC3x9HfLK0SOeXOsRaHCeVhba2OE4qnQ6+vYxiOIvPj4Xdxtcf0kTECxKl0v7ifXkREWn6t94/SnxHrG4Sd6/fn7hdh3yytHD5pv7dV9/4ZGmxzu/NF0h5sRQFPMZ/ddriKIqiWx++zpI4iuI7H65OZ3EUx0nGnsmXfMmXOkQBjxN7Jl/yJV/qEBwn9ky+5Eu+1CE4TuyZfMmXfKlDUIfsmXzJl3ypQ1CH7Jl8yZd8qUNQh+yZfMmXfKlDUIfsmXzJl3ypQ1CH7Jl8yZd8qUNQh+yZfMmXfKlDUIfsmXzJl3ypQ1CH7Jl8yZd8qUNQh+yZfMmXfKlDUIfsmXzJl3ypQ1CH7Jl8yZd8qUNQh+yZfMmXfKlDUIfsmXzJl3ypQzwDpmmyhALvmXzJF4+1Z+qw4MrlchiG7GGpJpNJpVIhX/Il31znSx0WXL1e73Q67GGpjo+PDw8PyZd8yTfX+VKHBXd6erq/v88elsq27V6vR77kS765zpc6LL6NjY35fM4eluTy8nJra4t8yZd8854vdVh85+fnu7u77GFJtre3fd8nX/Il37znSx2uBdd1HcdhD4/u7du3Hz58IF/yJd8C5Esdroujo6OdnR1edXksl5eX29vbz+GuJF/yxaPkSx2ukYuLi1KpZNv2ycnJZDJhIQ8wmUyOj49t297a2nra19DIl3zxuPlSh2un1+sdHBxUKhXTNAX3YZpmpVI5PDx8qs8Zki/5ku/y8qUO8ezwF1MBeIKbhxWAOgQA7h1QhwBAHYI6BADqENQhAFCHoA4BgDoEdQgA1CGoQwCgDkEdAgB1COoQAKhDUIcAQB2COgQA6hDUIQBQh6AOAYA6BHUIANQhqEMAoA5BHQIAdQjqEACoQ1CHAEAdgjoEAOoQ1CEAUIegDgGAOgR1CADUIahDAFh5HZqmKcD9/fLLLw/+taZpcqoBPK86LN7X+EzERACoQy4mJmIiANQhFxMTMREA6pCLiYmYCAB1yMXEREwEgDrkYmIiJgJAHXIxMRETAaAOuZiYiIkAUIdcTEzERACoQy4mJmIiANQhFxMTMREA6pCLiYmYCAB1yMXEREwEgDrkYmIiJgJAHXIxMRETAaAOuZiYiIkAUIcP4ft+qVTq9XrXF1Ov1yuVSp8+fcrpgpiIiQBQhw/x8uXL169fv3nzRkTevHnz+vXrFy9e5HpHTMREAKjDe/v99983NjZE5NdffxWRzc3Njx8/5npHTMREAKjDh3j16pV89fLlywKsiYmYCAB1+PAv1QvzRToTMREA6vDhX6oX6Yt0JmIiANThQ75Uf/XqVZG+SGciJgJAHd7bly9ffvvtt8+fPxdmU0zERADWqw47nU69Xi+Xy6ZpytMxTbNcLtfr9dPT058ckomYaPUTAchxHZ6dnW1ubtbr9U6nE4bhkz+4MAw7nc7+/v7Gxsb5+fkDfgcmYqLVTwQg33X47t27vb295/lC03w+393ddV33Xr+KiZho9RMByHcdvnv37v3798/8sTqOc3R09OP3LBMx0YonApDvOjw7O9vb28vFw93Z2bm4uPjbn8ZETLT6iQDkvg43Nzfz8mG8+XxeKpX+9qcxEROtfiIA+a7DxSf6cvSIbdtefO+Cv8JETLT6iQDkvg4Xn+jL0SM+OTk5ODj4zk9gIiZa/UQAcl+H5XL5OXy6/cdNJpNKpfKdn8BETLT6iQDkvg5N08zdg/7+Y2YiJlr9RAByX4eL7x6euwf94H/LREy0jIkAUIdctUzERACoQ65aJmIiANQhVy0TMREA6pCrlomYCAB1yFXLREwEgDrkqmUiJgKwhnWYzuI4jmdZca5aJmIi6hDAfeowHjX1b98zXPcG07xftUzERNQhgHvWYRoYIlVvECdJMpt2G4aIDOLsCR/0z15bTMRE1CGA+9ZhGngi0o+vfyBsGNVumCqlZuN+VRcR0atuMMuUUuO2XXU8x5J/+/f/MLTaaLb4JUm7ZtRaY6Uyv9XQRES0mjdIlFJZ6FhVt+kZIq4/W81Vy0RM9LgTAViPZ4fZ2BIR0WynORgF0fX7OPFAE9Eb7WA8tHURzYmVCjxDRDSr0f1H3xKptkOllJoNNREvSMJ2VUTc7sgfeCJieIFKfENERGpOa/xj7xA9wjMPJmKiR50IwHrUoVJpNHJr1vXbOFq1+fUOakSLnzBti0h3mgWeLrqXKKWUGtgiRjNVatqtitiRmrma6K6/+D19zxDNnaW+IVLrTu/1oH/+2mIiJnrEiQCsRR1mSRzP0q//OB00bRGptsPA+3ZVLbh+4ru65vg3Xu/S/TRpGaJ7gUpGxp1foHuz1NdF3CBZ5VXLREz0uBMBWIs6DFxNpBHfuKmaumjOyHd10dw4y5IkTWfTQX8YZ+rmxaTU1Bapua4u0o0ylYVVkWp7nGVpkqbxeNQfjrPFxfRj79881lXLREz0uBMBWI9nh2FbRAynG6dZms6CvisijWEcDxsiWiuIlUqHri5ijO9eTMr3DBERY/FCVtatimhOmCiVjG0RqfbVU1y1TMRE1CGAe9ehUipoN26+2lR1B4lSSqV959sLUU0/VkoFty+mbNrVROz+1zdpksDWrt8LaoxTpdLAWvlVy0RMZFGHAB5Qh0oplc6i6XQaRUl654fjKI6Te/x5sGwWR/EsyX7iQT/OtcVETEQdArh3HT6nB12wa4uJ8j4RAOqQq5aJmAgAdchVy0RMBIA65KplIiYCQB3e4ju63hzPRg2x2tcfWJiNvEZ7nNOr9u5EWdx2arquG1at7UdFmCgZezVL142q7Q7DWREmog4BPHUdzhyRdpQMalLrR0qpdBYFo25Vvv39WHm7au9MFHuGiFitwaDZMETE82f5niib2iKi291B17FExPCTvGdEHQJ40jqM/EGr6YiI3fQsEaPRDOL0+i/TMnJYh38y0eQfItKeLp6BpJ4umjPK9USf/qspIsOrCgzu+8fSn2NG/woaluU2XUsTEak1R9mq/q8DQB0qpVQ0atd0EaPhVEXEcj1vOL36Y2J3/nx0bq7aP040+Z/RYHT1zQ/SoCpiNcf5nmj6f3EUp1kaT8O+a4lY+Xp2+CcTBf+5+PP5Xn/Y96oi0hyn1CGA1dWhUmpoa7XBLO5Xtcat8vPzWYffmSgOupaIiDGMCzFRMvr6HedrYZbziVLfELEHkVJKZWNjhc93AVCHKh23q5ali4hmWJqIaDc/O5PHOvzLibKoWdVERK81p2khJrqSzcKBJWLk5/nun0906/tUJJ4mDnUIYGV1mKWx37ZFasNRS0RrjYIwSnJdh38xUdKyRKQ6CJNlxLD6ieJhQ8T5WhdX3y8i3xnd+ou5E5c6BLDKOlRKRd2q1AbJtHXjes1xHf7pRNm0LSK11igMx0EQBL4/nia5nigdN0Wk0R1nWTodNuX6ZcbcTkQdAnjaOsy6VbGHcdg0/vj0Ip8fpfmTiZLAu/tNZB/vE7NPMpFSSd/59q10jUZ3lvOMbn+fisTTxPVX9CULAOrwaR50wa6tJ5woncVRFH39vvNkRB0C1CHlwURMRB0C1CFXLRMxEXUIUIdctUzERNQhQB1y1TIRE1GHAHXIVctETEQdAtQhVy0TMRF1CFCHXLVMxETUIUAdctUyERNRhwB1yFXLRExEHQJrX4emaebuQX//MTMRE61+IgC5r8NyuRyGYY4e8WQyqVQq3/kJTMREq58IQO7rsF6vdzqdHD3i4+Pjw8PD7/wEJmKi1U8EIPd1eHp6ur+/n6NHbNt2r9f7zk9gIiZa/UQAcl+HSqmNjY35fJ6Lh3t5ebm1tfW3P42JmGj1EwHIfR2en5/v7u7m4uFub2/7/t9/l0EmYqLVTwQg93WolHJd13GcZ/5Y3759++HDhx/8yUzERKufCEDu61ApdXR0tLOz8zxfv7q8vNze3r7vrcRETLT6iQDkvg6VUhcXF6VSybbtk5OTyWTy5A9uMpkcHx/btr21tfWwV6uYiIlWPxGA3NfhQq/XOzg4qFQqpmnK0zFNs1KpHB4e/vwn+piIiVY/EYDc1yEAAOvm/wHBD03Xa5BfFAAAACV0RVh0ZGF0ZTpjcmVhdGUAMjAyMC0xMS0wNlQyMzoxNDo1OSswMDowMKQxKGYAAAAldEVYdGRhdGU6bW9kaWZ5ADIwMjAtMTEtMDZUMjM6MTQ6NTkrMDA6MDDVbJDaAAAAAElFTkSuQmCC"},279:function(e,A,a){e.exports=a.p+"assets/img/example_setup.dc8ff2a7.png"},327:function(e,A,a){"use strict";a.r(A);var t=a(15),n=Object(t.a)({},(function(){var e=this,A=e._self._c;return A("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[A("h1",{attrs:{id:"terminology"}},[A("a",{staticClass:"header-anchor",attrs:{href:"#terminology"}},[e._v("#")]),e._v(" Terminology")]),e._v(" "),A("p",[A("strong",[e._v("Panel")]),e._v(" — This refers to Pterodactyl Panel itself, and is what allows you to add additional\nnodes and servers to the system.")]),e._v(" "),A("p",[A("strong",[e._v("Node")]),e._v(" — A node is a physical machine that runs an instance of Wings.")]),e._v(" "),A("p",[A("strong",[e._v("Wings")]),e._v(" — The newer service written in Go that interfaces with Docker and the Panel to provide secure access for\ncontrolling servers via the Panel.")]),e._v(" "),A("p",[A("strong",[e._v("Server")]),e._v(" — In this case, a server refers to a running instance that is created by the panel. These servers are\ncreated on nodes, and you can have multiple servers per node.")]),e._v(" "),A("p",[A("strong",[e._v("Docker")]),e._v(" — Docker is a platform that lets you separate the application from your infrastructure into isolated, secure containers.")]),e._v(" "),A("p",[A("strong",[e._v("Docker Image")]),e._v(" — A Docker image contains everything needed to run a containerized application. (e.g. Java for a Minecraft Server).")]),e._v(" "),A("p",[A("strong",[e._v("Container")]),e._v(" — Each server will be running inside an isolated container to enforce hardware limitations\n(such as CPU and RAM) and avoid any interference between servers on one node. These are created by Docker.")]),e._v(" "),A("p",[A("strong",[e._v("Nest")]),e._v(" — Each nest is usually used as a specific game or service, for example: Minecraft, Teamspeak or Terraria and can contain many eggs.")]),e._v(" "),A("p",[A("strong",[e._v("Egg")]),e._v(" — Each egg is usually used to store the configuration of a specific type of game, for example: Vanilla, Spigot or Bungeecord for Minecraft.")]),e._v(" "),A("p",[A("strong",[e._v("Yolks")]),e._v(" — A curated collection of core docker images that can be used with Pterodactyl's Egg system.")]),e._v(" "),A("h2",{attrs:{id:"simple-setup-diagram"}},[A("a",{staticClass:"header-anchor",attrs:{href:"#simple-setup-diagram"}},[e._v("#")]),e._v(" Simple Setup Diagram")]),e._v(" "),A("p",[A("img",{attrs:{src:a(278),alt:""}})]),e._v(" "),A("h2",{attrs:{id:"advanced-setup-diagram"}},[A("a",{staticClass:"header-anchor",attrs:{href:"#advanced-setup-diagram"}},[e._v("#")]),e._v(" Advanced Setup Diagram")]),e._v(" "),A("div",{staticClass:"custom-block tip"},[A("p",{staticClass:"custom-block-title"},[e._v("Panel and Wings on the same machine")]),e._v(" "),A("p",[e._v("It is also possible to install wings on the panel machine so it acts as panel and node machine at once.")])]),e._v(" "),A("p",[A("img",{attrs:{src:a(279),alt:""}})])])}),[],!1,null,null,null);A.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[14],{278:function(e,A){e.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAloAAAEkCAIAAAB4+QiRAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAW5ElEQVR42u3dv2/b6JbG8TOYIokdWE16/gPspGYBFmxM2IAblWq2IMaCLWAREAlgEEjBTkCmUCUbMqRGlW6jxcKCjfA2bFaNWCxUXLBYsFh1rOhCIJLm3UKOY3tmMrFjySb1/VSDTJLROc+872P9SCwKQIF0Op16vV4ul03TFNyHaZrlcrler5+envI/0hoSVgAUw9nZ2ebmZr1e73Q6YRiykAcIw7DT6ezv729sbJyfn7MQ6hBAzrx7925vb+/z58+s4lHM5/Pd3V3XdVkFdQggT134/v179vDoHMc5OjpiD9QhgBw4Ozvb29tjD0uys7NzcXHBHqhDAM/d5uYmr5Euz3w+L5VK7IE6BPCsLT5Hyh6WyrbtXq/HHqhDAM/X4nOk7GGpTk5ODg4O2AN1COD5KpfL/JmKZZtMJpVKhT1QhwCeL9M0WQJ7BnUIrP0BFo4wewZ1CHCAuabZM6hDAFzT7BnUIQCuafYM6hAA1zR7BnUIgGuaPYM6BMA1zZ5BHQLgmmbPoA4BcE2zZ1CHALim2TOoQwBc0+wZ1CEArmn2DOoQANc0ewZ1CIBrmj2DOgTANc2eQR0CeJbXdOpbckutOcp+7rdMAk/EClL2DOoQQH7q0BCptUZhOB6Px4NWQ0TsfvTTdaiPEvYM6hBAfupQF3G/PZXLmrpozkgpNe66uoiIaIY9ijKl1LhtW7brVHUR0Sw3XPyidNqsGSIimtUaRdd16FOHoA4B5OvZoTOMVJamaRr5LU3EHkRZ2BKRWms4DX3XEjGaqVKBZ4iI5XRHg6Yuoru+UjNPF9FqgyDoOpaItKcZdQjqEED+6vDOe4diOGGqstm42x0lSmXpbODoorkzpQJXF6u1eGfRdzTN8dNxU0TaV88To4aI4QXUIahDALl8dmh3gziaTqfT6TS++hxNEno1/VtH6l6ilO/qmusv/n3g6prjp+PW3TJ1feoQ1CGA/NWhLuIGd7sraBoi1eE0zpSK+jXR3Ks6dK7qcPHPSeCJaP0ozZIkTZNg2PenCXUI6hBAPuvQn935Yd/VRexpptJoVBUR3Y3/rA5VGhgihjtMlYr9pog4oxmfLAV1CCB/dWiIeH94dpiG3euXSmt2VUQ01w9u1OH1P0dD78bbjoPs6pOlBn/uENQhgEJc01kSR3GSLv4xSb/zh/PTJIriWZKxZ1CHALim2TOoQwBc0+wZ1CEArmn2DOoQANc0ewZ1CIBrmj2DOgTANc2eQR0C4Jpmz6AOAXBNs2dQhwC4ptkzqEMAXNPsGdQhAK5p9gzqEADXNHsGdQiAa5o9gzoEwDXNnkEdAuCaZs+gDgFwTbNnUIcAfo5pmiyBPYM6BNZduVwOw5A9LNVkMqlUKuyBOgTwfNXr9U6nwx6W6vj4+PDwkD1QhwCer9PT0/39ffawVLZt93o99kAdAnjWNjY25vM5e1iSy8vLra0t9kAdAnjuzs/Pd3d32cOSbG9v+77PHqhDADnguq7jOOzh0b19+/bDhw/sgToEkBtHR0c7Ozu8avpYLi8vt7e36ULqEED+XFxclEol27ZPTk4mkwkLeYDJZHJ8fGzb9tbWFq+RUocAcqzX6x0cHFQqFdM0BfdhmmalUjk8PORzpNQhACz/0uEvPAN1CADUIahDAKAOQR0CAHUI6hAAqENQhwBAHYI6BADqENQhAFCHoA4BgDoEdQgA1CGoQwCgDkEdAgB1COoQAKhDUIcAQB2COgQA6hDUIQBQh6AOAYA6BHUIANQhqEMAoA5BHQIAdQjqEACoQ1CHAEAdgjoEAOoQ1CEAUIegDgGAOgR1CADUIahDAKAOQR0CAHUI6hAAqENQh8DPMk1TAOSTaZrUIcCzB5Av+eY1X/6/BMcJ5AvypQ7BcQL5gnypQ3CcQL4gX+oQHCeQL8iXOgTHCeQL8qUOwXEC+YJ8qUNwnEC+IF/qEBwnkC/IlzoExwnkC/KlDsFxAvmCfKlDcJxAviBf6hAcJ5AvyJc6BMcJ5AvypQ7BcQL5gnypQ3CcQL4gX+oQHCeQL8iXOgTHCeQL8qUOwXEC+YJ8qUNwnEC+IF/qEBwnkC/IlzrEs+X7fqlU6vV618ep1+uVSqVPnz6xHPIF+VKHWCMvX758/fr1mzdvROTNmzevX79+8eIFayFfkC91iPXy+++/b2xsiMivv/4qIpubmx8/fmQt5AvypQ6xdl69eiVfvXz5koWQL8iXOsRaf4HJUwfyBflSh+ALTJ46kC/IlzrE2n+B+erVK546kC/IlzrEWvvy5ctvv/32+fNnVkG+IF/qEEvU6XTq9Xq5XDZNU3AfpmmWy+V6vX56ekq+5Eu+BcuXOlwjZ2dnm5ub9Xq90+mEYchCHiAMw06ns7+/v7GxcX5+Tr7kS76FyZc6XBfv3r3b29vjRarHMp/Pd3d3XdclX/Il32LkSx2uSxe+f/+ePTw6x3GOjo7Il3zJtwD5UofFd3Z2tre3xx6WZGdn5+LignzJl3zzni91WHybm5u8xrI88/m8VCqRL/mSb97zpQ4LbvE5NPawVLZtL/4uf/IlX/LNb77UYcEtPofGHpbq5OTk4OCAfMmXfHOdL3VYcOVymc9kL9tkMqlUKuRLvuSb63ypw4IzTZMlFHjP5Eu+eKw9U4cFt/jO1CjqnsmXfPFYe2bXHGNwXYJ8yZc65BiD6xLkS77UIccYXJcgX/KlDjnG4LoE+ZIvdcgxBtclyJd8qUOOMbguQb6gDjnG4LoE+YI65BiD6xLkC+qQYwyuS5AvqEOOMbguQb6gDjnG4LoE+YI65BiD6xLkC+qQYwyuS5AvqEOOMbguQb6gDjnGS5T6lohu97OvPzBuWqJ7yd//ysTTxPFnP/QfCVuieUka6GL41791Om7U3GnGdVnAfMd9z9J1XbcazWFCvoU8v9QhinecDBER8b4ejMDTRfuR45T++HEae4bmBonviNHKlFLZLByPmrYuoo+S9djzOuUbdmsiYjf7/bajiYg9yMi3SOeXOkSBj5NhiIg9vXucZn23KiIiUnMHiwOWxSPb0ESk6rhVEdefKaVm435VFxHRq24wu3Vesjjotps1Eal5XlVEq3VHYRJ4cuXJvthcq+tytfn+0xWRxuj6JhXNnZFvgc7vuG1btutUdRHRLDdMqUMU5TjpYviRXxUxPP/mcRq5uojWGoXjYVNEdNdX2bgqIro9GA0dQ2RxnOKBJqI32sF4aOsimhPf/O2jkWsbIlrDtUWk5rqtQXj1rwJPRKcOC5fvf4+HgyBe3JFZ3xbR3IR8C3R+A88QEcvpjgZNffE7U4coynHS/UzFfVtE+jMVNo3F+wSGSGN4dTTCliWa+7+BJ6JdvbyZ+oaI688CzxBpRIsfm7ZFpHvn/cCxJ0Y7S4citZsnLaEOC52vmoVeVRORRn9KvkXKN3B1sa5eNfUdTXOoQxToOI0SpVTiGSLV5qBpieYlia+LNIZXr3KlY0+k+k/fFbn+4vHqvYfAs+Q297ristCpWoYmIlq1qouIXvWuzxp1WOB8g3ZDRESq/fGMfAuWr+/q2tdnhIGrU4co3nFS2bSrXb2jd/XVpRtcHYywbYnm/st3RYzxVZ+Fi/cefFcXzY2zLEnSdDYd9Ifx9ReXWRIGfUPEGQwdXSxvMA6jjGeHRc836tsi4nSDNTpH65Svf6MCfeoQhTxOSinfM66Ok0qbuojhTlOVzfyaiNYYLt5mqLX8VGVBq7Z47yEeNkS0VhArlQ5d/cZ5W5TeUBMrTCNbpBvd+i9ThwXNd+ZqIlZzPA2DIAgC3x9HfLK0SOeXOsRaHCeVhba2OE4qnQ6+vYxiOIvPj4Xdxtcf0kTECxKl0v7ifXkREWn6t94/SnxHrG4Sd6/fn7hdh3yytHD5pv7dV9/4ZGmxzu/NF0h5sRQFPMZ/ddriKIqiWx++zpI4iuI7H65OZ3EUx0nGnsmXfMmXOkQBjxN7Jl/yJV/qEBwn9ky+5Eu+1CE4TuyZfMmXfKlDUIfsmXzJl3ypQ1CH7Jl8yZd8qUNQh+yZfMmXfKlDUIfsmXzJl3ypQ1CH7Jl8yZd8qUNQh+yZfMmXfKlDUIfsmXzJl3ypQ1CH7Jl8yZd8qUNQh+yZfMmXfKlDUIfsmXzJl3ypQ1CH7Jl8yZd8qUNQh+yZfMmXfKlDUIfsmXzJl3ypQzwDpmmyhALvmXzJF4+1Z+qw4MrlchiG7GGpJpNJpVIhX/Il31znSx0WXL1e73Q67GGpjo+PDw8PyZd8yTfX+VKHBXd6erq/v88elsq27V6vR77kS765zpc6LL6NjY35fM4eluTy8nJra4t8yZd8854vdVh85+fnu7u77GFJtre3fd8nX/Il37znSx2uBdd1HcdhD4/u7du3Hz58IF/yJd8C5Esdroujo6OdnR1edXksl5eX29vbz+GuJF/yxaPkSx2ukYuLi1KpZNv2ycnJZDJhIQ8wmUyOj49t297a2nra19DIl3zxuPlSh2un1+sdHBxUKhXTNAX3YZpmpVI5PDx8qs8Zki/5ku/y8qUO8ezwF1MBeIKbhxWAOgQA7h1QhwBAHYI6BADqENQhAFCHoA4BgDoEdQgA1CGoQwCgDkEdAgB1COoQAKhDUIcAQB2COgQA6hDUIQBQh6AOAYA6BHUIANQhqEMAoA5BHQIAdQjqEACoQ1CHAEAdgjoEAOoQ1CEAUIegDgGAOgR1CADUIahDAFh5HZqmKcD9/fLLLw/+taZpcqoBPK86LN7X+EzERACoQy4mJmIiANQhFxMTMREA6pCLiYmYCAB1yMXEREwEgDrkYmIiJgJAHXIxMRETAaAOuZiYiIkAUIdcTEzERACoQy4mJmIiANQhFxMTMREA6pCLiYmYCAB1yMXEREwEgDrkYmIiJgJAHXIxMRETAaAOuZiYiIkAUIcP4ft+qVTq9XrXF1Ov1yuVSp8+fcrpgpiIiQBQhw/x8uXL169fv3nzRkTevHnz+vXrFy9e5HpHTMREAKjDe/v99983NjZE5NdffxWRzc3Njx8/5npHTMREAKjDh3j16pV89fLlywKsiYmYCAB1+PAv1QvzRToTMREA6vDhX6oX6Yt0JmIiANThQ75Uf/XqVZG+SGciJgJAHd7bly9ffvvtt8+fPxdmU0zERADWqw47nU69Xi+Xy6ZpytMxTbNcLtfr9dPT058ckomYaPUTAchxHZ6dnW1ubtbr9U6nE4bhkz+4MAw7nc7+/v7Gxsb5+fkDfgcmYqLVTwQg33X47t27vb295/lC03w+393ddV33Xr+KiZho9RMByHcdvnv37v3798/8sTqOc3R09OP3LBMx0YonApDvOjw7O9vb28vFw93Z2bm4uPjbn8ZETLT6iQDkvg43Nzfz8mG8+XxeKpX+9qcxEROtfiIA+a7DxSf6cvSIbdtefO+Cv8JETLT6iQDkvg4Xn+jL0SM+OTk5ODj4zk9gIiZa/UQAcl+H5XL5OXy6/cdNJpNKpfKdn8BETLT6iQDkvg5N08zdg/7+Y2YiJlr9RAByX4eL7x6euwf94H/LREy0jIkAUIdctUzERACoQ65aJmIiANQhVy0TMREA6pCrlomYCAB1yFXLREwEgDrkqmUiJgKwhnWYzuI4jmdZca5aJmIi6hDAfeowHjX1b98zXPcG07xftUzERNQhgHvWYRoYIlVvECdJMpt2G4aIDOLsCR/0z15bTMRE1CGA+9ZhGngi0o+vfyBsGNVumCqlZuN+VRcR0atuMMuUUuO2XXU8x5J/+/f/MLTaaLb4JUm7ZtRaY6Uyv9XQRES0mjdIlFJZ6FhVt+kZIq4/W81Vy0RM9LgTAViPZ4fZ2BIR0WynORgF0fX7OPFAE9Eb7WA8tHURzYmVCjxDRDSr0f1H3xKptkOllJoNNREvSMJ2VUTc7sgfeCJieIFKfENERGpOa/xj7xA9wjMPJmKiR50IwHrUoVJpNHJr1vXbOFq1+fUOakSLnzBti0h3mgWeLrqXKKWUGtgiRjNVatqtitiRmrma6K6/+D19zxDNnaW+IVLrTu/1oH/+2mIiJnrEiQCsRR1mSRzP0q//OB00bRGptsPA+3ZVLbh+4ru65vg3Xu/S/TRpGaJ7gUpGxp1foHuz1NdF3CBZ5VXLREz0uBMBWIs6DFxNpBHfuKmaumjOyHd10dw4y5IkTWfTQX8YZ+rmxaTU1Bapua4u0o0ylYVVkWp7nGVpkqbxeNQfjrPFxfRj79881lXLREz0uBMBWI9nh2FbRAynG6dZms6CvisijWEcDxsiWiuIlUqHri5ijO9eTMr3DBERY/FCVtatimhOmCiVjG0RqfbVU1y1TMRE1CGAe9ehUipoN26+2lR1B4lSSqV959sLUU0/VkoFty+mbNrVROz+1zdpksDWrt8LaoxTpdLAWvlVy0RMZFGHAB5Qh0oplc6i6XQaRUl654fjKI6Te/x5sGwWR/EsyX7iQT/OtcVETEQdArh3HT6nB12wa4uJ8j4RAOqQq5aJmAgAdchVy0RMBIA65KplIiYCQB3e4ju63hzPRg2x2tcfWJiNvEZ7nNOr9u5EWdx2arquG1at7UdFmCgZezVL142q7Q7DWREmog4BPHUdzhyRdpQMalLrR0qpdBYFo25Vvv39WHm7au9MFHuGiFitwaDZMETE82f5niib2iKi291B17FExPCTvGdEHQJ40jqM/EGr6YiI3fQsEaPRDOL0+i/TMnJYh38y0eQfItKeLp6BpJ4umjPK9USf/qspIsOrCgzu+8fSn2NG/woaluU2XUsTEak1R9mq/q8DQB0qpVQ0atd0EaPhVEXEcj1vOL36Y2J3/nx0bq7aP040+Z/RYHT1zQ/SoCpiNcf5nmj6f3EUp1kaT8O+a4lY+Xp2+CcTBf+5+PP5Xn/Y96oi0hyn1CGA1dWhUmpoa7XBLO5Xtcat8vPzWYffmSgOupaIiDGMCzFRMvr6HedrYZbziVLfELEHkVJKZWNjhc93AVCHKh23q5ali4hmWJqIaDc/O5PHOvzLibKoWdVERK81p2khJrqSzcKBJWLk5/nun0906/tUJJ4mDnUIYGV1mKWx37ZFasNRS0RrjYIwSnJdh38xUdKyRKQ6CJNlxLD6ieJhQ8T5WhdX3y8i3xnd+ou5E5c6BLDKOlRKRd2q1AbJtHXjes1xHf7pRNm0LSK11igMx0EQBL4/nia5nigdN0Wk0R1nWTodNuX6ZcbcTkQdAnjaOsy6VbGHcdg0/vj0Ip8fpfmTiZLAu/tNZB/vE7NPMpFSSd/59q10jUZ3lvOMbn+fisTTxPVX9CULAOrwaR50wa6tJ5woncVRFH39vvNkRB0C1CHlwURMRB0C1CFXLRMxEXUIUIdctUzERNQhQB1y1TIRE1GHAHXIVctETEQdAtQhVy0TMRF1CFCHXLVMxETUIUAdctUyERNRhwB1yFXLRExEHQJrX4emaebuQX//MTMRE61+IgC5r8NyuRyGYY4e8WQyqVQq3/kJTMREq58IQO7rsF6vdzqdHD3i4+Pjw8PD7/wEJmKi1U8EIPd1eHp6ur+/n6NHbNt2r9f7zk9gIiZa/UQAcl+HSqmNjY35fJ6Lh3t5ebm1tfW3P42JmGj1EwHIfR2en5/v7u7m4uFub2/7/t9/l0EmYqLVTwQg93WolHJd13GcZ/5Y3759++HDhx/8yUzERKufCEDu61ApdXR0tLOz8zxfv7q8vNze3r7vrcRETLT6iQDkvg6VUhcXF6VSybbtk5OTyWTy5A9uMpkcHx/btr21tfWwV6uYiIlWPxGA3NfhQq/XOzg4qFQqpmnK0zFNs1KpHB4e/vwn+piIiVY/EYDc1yEAAOvm/wHBD03Xa5BfFAAAACV0RVh0ZGF0ZTpjcmVhdGUAMjAyMC0xMS0wNlQyMzoxNDo1OSswMDowMKQxKGYAAAAldEVYdGRhdGU6bW9kaWZ5ADIwMjAtMTEtMDZUMjM6MTQ6NTkrMDA6MDDVbJDaAAAAAElFTkSuQmCC"},279:function(e,A,a){e.exports=a.p+"assets/img/example_setup.dc8ff2a7.png"},326:function(e,A,a){"use strict";a.r(A);var t=a(15),n=Object(t.a)({},(function(){var e=this,A=e._self._c;return A("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[A("h1",{attrs:{id:"terminology"}},[A("a",{staticClass:"header-anchor",attrs:{href:"#terminology"}},[e._v("#")]),e._v(" Terminology")]),e._v(" "),A("p",[A("strong",[e._v("Panel")]),e._v(" — This refers to Pterodactyl Panel itself, and is what allows you to add additional\nnodes and servers to the system.")]),e._v(" "),A("p",[A("strong",[e._v("Node")]),e._v(" — A node is a physical machine that runs an instance of Wings.")]),e._v(" "),A("p",[A("strong",[e._v("Wings")]),e._v(" — The newer service written in Go that interfaces with Docker and the Panel to provide secure access for\ncontrolling servers via the Panel.")]),e._v(" "),A("p",[A("strong",[e._v("Server")]),e._v(" — In this case, a server refers to a running instance that is created by the panel. These servers are\ncreated on nodes, and you can have multiple servers per node.")]),e._v(" "),A("p",[A("strong",[e._v("Docker")]),e._v(" — Docker is a platform that lets you separate the application from your infrastructure into isolated, secure containers.")]),e._v(" "),A("p",[A("strong",[e._v("Docker Image")]),e._v(" — A Docker image contains everything needed to run a containerized application. (e.g. Java for a Minecraft Server).")]),e._v(" "),A("p",[A("strong",[e._v("Container")]),e._v(" — Each server will be running inside an isolated container to enforce hardware limitations\n(such as CPU and RAM) and avoid any interference between servers on one node. These are created by Docker.")]),e._v(" "),A("p",[A("strong",[e._v("Nest")]),e._v(" — Each nest is usually used as a specific game or service, for example: Minecraft, Teamspeak or Terraria and can contain many eggs.")]),e._v(" "),A("p",[A("strong",[e._v("Egg")]),e._v(" — Each egg is usually used to store the configuration of a specific type of game, for example: Vanilla, Spigot or Bungeecord for Minecraft.")]),e._v(" "),A("p",[A("strong",[e._v("Yolks")]),e._v(" — A curated collection of core docker images that can be used with Pterodactyl's Egg system.")]),e._v(" "),A("h2",{attrs:{id:"simple-setup-diagram"}},[A("a",{staticClass:"header-anchor",attrs:{href:"#simple-setup-diagram"}},[e._v("#")]),e._v(" Simple Setup Diagram")]),e._v(" "),A("p",[A("img",{attrs:{src:a(278),alt:""}})]),e._v(" "),A("h2",{attrs:{id:"advanced-setup-diagram"}},[A("a",{staticClass:"header-anchor",attrs:{href:"#advanced-setup-diagram"}},[e._v("#")]),e._v(" Advanced Setup Diagram")]),e._v(" "),A("div",{staticClass:"custom-block tip"},[A("p",{staticClass:"custom-block-title"},[e._v("Panel and Wings on the same machine")]),e._v(" "),A("p",[e._v("It is also possible to install wings on the panel machine so it acts as panel and node machine at once.")])]),e._v(" "),A("p",[A("img",{attrs:{src:a(279),alt:""}})])])}),[],!1,null,null,null);A.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/15.954755fc.js b/assets/js/15.2fc81408.js similarity index 99% rename from assets/js/15.954755fc.js rename to assets/js/15.2fc81408.js index 6eec649f..972ff4af 100644 --- a/assets/js/15.954755fc.js +++ b/assets/js/15.2fc81408.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[15],{254:function(e,t,a){e.exports=a.p+"assets/img/wings_configuration_example.9f3fdd0b.png"},280:function(e,t,a){e.exports=a.p+"assets/img/node_allocations.323d67f2.png"},332:function(e,t,a){"use strict";a.r(t);var s=a(15),n=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"installing-wings"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installing-wings"}},[e._v("#")]),e._v(" Installing Wings")]),e._v(" "),t("p",[e._v("Wings is the next generation server control plane from Pterodactyl. It has been rebuilt from the\nground up using Go and lessons learned from our first Nodejs Daemon.")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("You should only install Wings if you are running "),t("strong",[e._v("Pterodactyl 1.x")]),e._v(". Do not install this software\nfor previous versions of Pterodactyl.")])]),e._v(" "),t("h2",{attrs:{id:"supported-systems"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#supported-systems"}},[e._v("#")]),e._v(" Supported Systems")]),e._v(" "),t("p",[e._v("The following is a list of supported operating systems. Please be aware that this is not an exhaustive list,\nthere is a high probability that you can run the software on other Linux distributions without much effort.\nYou are responsible for determining which packages may be necessary on those systems. There is also a very\nhigh probability that new releases of the supported OSes below will work just fine, you are not restricted to\nonly the versions listed below.")]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Operating System")]),e._v(" "),t("th",[e._v("Version")]),e._v(" "),t("th",{staticStyle:{"text-align":"center"}},[e._v("Supported")]),e._v(" "),t("th",[e._v("Notes")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("strong",[e._v("Ubuntu")])]),e._v(" "),t("td",[e._v("20.04")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td",[e._v("Documentation written assuming Ubuntu 20.04 as the base OS.")])]),e._v(" "),t("tr",[t("td"),e._v(" "),t("td",[e._v("22.04")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td")]),e._v(" "),t("tr",[t("td"),e._v(" "),t("td",[e._v("24.04")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td")]),e._v(" "),t("tr",[t("td",[t("strong",[e._v("RHEL / Rocky Linux / AlmaLinux")])]),e._v(" "),t("td",[e._v("8")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td")]),e._v(" "),t("tr",[t("td"),e._v(" "),t("td",[e._v("9")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td")]),e._v(" "),t("tr",[t("td",[t("strong",[e._v("Debian")])]),e._v(" "),t("td",[e._v("11")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td")]),e._v(" "),t("tr",[t("td"),e._v(" "),t("td",[e._v("12")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td")]),e._v(" "),t("tr",[t("td",[t("strong",[e._v("Windows")])]),e._v(" "),t("td",[e._v("All")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("❌")]),e._v(" "),t("td",[e._v("This software will not run in Windows environments.")])])])]),e._v(" "),t("h2",{attrs:{id:"system-requirements"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#system-requirements"}},[e._v("#")]),e._v(" System Requirements")]),e._v(" "),t("p",[e._v("To run Wings, you will need a Linux system capable of running Docker containers. Most VPS and almost all\ndedicated servers should be capable of running Docker, but there are edge cases.")]),e._v(" "),t("p",[e._v("When your provider uses "),t("code",[e._v("Virtuozzo")]),e._v(", "),t("code",[e._v("OpenVZ")]),e._v(" (or "),t("code",[e._v("OVZ")]),e._v("), or "),t("code",[e._v("LXC")]),e._v(" virtualization, you will most likely be unable to\nrun Wings. Some providers have made the necessary changes for nested virtualization to support Docker. Ask your provider's support team to make sure. KVM is guaranteed to work.")]),e._v(" "),t("p",[e._v("The easiest way to check is to type "),t("code",[e._v("systemd-detect-virt")]),e._v(".\nIf the result doesn't contain "),t("code",[e._v("OpenVZ")]),e._v(" or"),t("code",[e._v("LXC")]),e._v(", it should be fine. The result of "),t("code",[e._v("none")]),e._v(" will appear when running dedicated hardware without any virtualization.")]),e._v(" "),t("p",[e._v("Should that not work for some reason, or you're still unsure, you can also run the command below.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("dane@pterodactyl:~$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" dmidecode "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-s")]),e._v(" system-manufacturer\nVMware, Inc.\n")])])]),t("h2",{attrs:{id:"dependencies"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dependencies"}},[e._v("#")]),e._v(" Dependencies")]),e._v(" "),t("ul",[t("li",[e._v("curl")]),e._v(" "),t("li",[e._v("Docker")])]),e._v(" "),t("h3",{attrs:{id:"installing-docker"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installing-docker"}},[e._v("#")]),e._v(" Installing Docker")]),e._v(" "),t("p",[e._v("For a quick install of Docker CE, you can execute the command below:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-sSL")]),e._v(" https://get.docker.com/ "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("CHANNEL")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("stable "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("bash")]),e._v("\n")])])]),t("p",[e._v("If you would rather do a manual installation, please reference the "),t("a",{attrs:{href:"https://docs.docker.com/engine/install/",target:"_blank",rel:"noopener noreferrer"}},[e._v("official Docker documentation"),t("OutboundLink")],1),e._v(" for how to install Docker CE on your server.")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("Check your Kernel")]),e._v(" "),t("p",[e._v("Please be aware that some hosts install a modified kernel that does not support important docker features. Please\ncheck your kernel by running "),t("code",[e._v("uname -r")]),e._v(". If your kernel ends in "),t("code",[e._v("-xxxx-grs-ipv6-64")]),e._v(" or "),t("code",[e._v("-xxxx-mod-std-ipv6-64")]),e._v(" you're\nprobably using a non-supported kernel. Check our "),t("RouterLink",{attrs:{to:"/daemon/0.6/kernel_modifications.html"}},[e._v("Kernel Modifications")]),e._v(" guide for details.")],1)]),e._v(" "),t("h4",{attrs:{id:"start-docker-on-boot"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#start-docker-on-boot"}},[e._v("#")]),e._v(" Start Docker on Boot")]),e._v(" "),t("p",[e._v("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.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" systemctl "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("enable")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--now")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v("\n")])])]),t("h4",{attrs:{id:"enabling-swap"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enabling-swap"}},[e._v("#")]),e._v(" Enabling Swap")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("Recent Linux kernel")]),e._v(" "),t("p",[e._v("Since the version 6.1 of the Linux kernel, swap is enabled by default. If you are running a kernel version 6.1 or newer, you can skip this step. To check your kernel version, run "),t("code",[e._v("uname -r")]),e._v(".")])]),e._v(" "),t("p",[e._v("On most systems, Docker will be unable to setup swap space by default. You can confirm this by running "),t("code",[e._v("docker info")]),e._v(" and looking for the output of "),t("code",[e._v("WARNING: No swap limit support")]),e._v(" near the bottom.")]),e._v(" "),t("p",[e._v("Enabling swap is entirely optional, but we recommended doing it if you will be hosting for others and to prevent OOM errors.")]),e._v(" "),t("p",[e._v("To enable swap, open "),t("code",[e._v("/etc/default/grub")]),e._v(" as a root user and find the line starting with "),t("code",[e._v("GRUB_CMDLINE_LINUX_DEFAULT")]),e._v(". Make\nsure the line includes "),t("code",[e._v("swapaccount=1")]),e._v(" somewhere inside the double-quotes.")]),e._v(" "),t("p",[e._v("After that, run "),t("code",[e._v("sudo update-grub")]),e._v(" followed by "),t("code",[e._v("sudo reboot")]),e._v(" to restart the server and have swap enabled.\nBelow is an example of what the line should look like, "),t("em",[e._v("do not copy this line verbatim. It often has additional OS-specific parameters.")])]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('GRUB_CMDLINE_LINUX_DEFAULT="swapaccount=1"\n')])])]),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("GRUB Configuration")]),e._v(" "),t("p",[e._v("Some Linux distros may ignore "),t("code",[e._v("GRUB_CMDLINE_LINUX_DEFAULT")]),e._v(". Therefore you might have to use "),t("code",[e._v("GRUB_CMDLINE_LINUX")]),e._v(" instead should the default one not work for you.")])]),e._v(" "),t("h2",{attrs:{id:"installing-wings-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installing-wings-2"}},[e._v("#")]),e._v(" Installing Wings")]),e._v(" "),t("p",[e._v("The first step for installing Wings is to ensure we have the required directory structure setup. To do so,\nrun the commands below, which will create the base directory and download the wings executable.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("mkdir")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-p")]),e._v(" /etc/pterodactyl\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-L")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-o")]),e._v(" /usr/local/bin/wings "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"https://github.com/pterodactyl/wings/releases/latest/download/wings_linux_$([[ "'),t("span",{pre:!0,attrs:{class:"token variable"}},[t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$(")]),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("uname")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-m")]),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v(")")])]),e._v('"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("==")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"x86_64"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("]")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("]")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("&&")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("echo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"amd64"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("||")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("echo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"arm64"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v('"\n'),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("chmod")]),e._v(" u+x /usr/local/bin/wings\n")])])]),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("OVH/SYS Servers")]),e._v(" "),t("p",[e._v("If you are using a server provided by OVH or SoYouStart please be aware that your main drive space is probably allocated to\n"),t("code",[e._v("/home")]),e._v(", and not "),t("code",[e._v("/")]),e._v(" by default. Please consider using "),t("code",[e._v("/home/daemon-data")]),e._v(" for server data. This can be easily\nset when creating the node.")])]),e._v(" "),t("h2",{attrs:{id:"configure"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#configure"}},[e._v("#")]),e._v(" Configure")]),e._v(" "),t("p",[e._v("Once you have installed Wings and the required components, the next step is to create a node on your installed Panel. Go to your Panel administrative view, select Nodes from the sidebar, and on the right side click Create New button.")]),e._v(" "),t("p",[e._v("After you have created a node, click on it and there will be a tab called Configuration. Copy the code block content, paste it into a new file called "),t("code",[e._v("config.yml")]),e._v(" in "),t("code",[e._v("/etc/pterodactyl")]),e._v(" and save it.")]),e._v(" "),t("p",[e._v("Alternatively, you can click on the Generate Token button, copy the bash command and paste it into your terminal.")]),e._v(" "),t("p",[t("img",{attrs:{src:a(254),alt:"example image of wings configuration"}})]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("When your Panel is using SSL, the Wings must also have one created for its FQDN. See "),t("RouterLink",{attrs:{to:"/tutorials/creating_ssl_certificates.html"}},[e._v("Creating SSL Certificates")]),e._v(" documentation page for how to create these certificates before continuing.")],1)]),e._v(" "),t("h3",{attrs:{id:"starting-wings"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#starting-wings"}},[e._v("#")]),e._v(" Starting Wings")]),e._v(" "),t("p",[e._v("To start Wings, simply run the command below, which will start it in a debug mode. Once you confirmed that it is running without errors, use "),t("code",[e._v("CTRL+C")]),e._v(" to terminate the process and daemonize it by following the instructions below. Depending on your server's internet connection pulling and starting Wings for the first time may take a few minutes.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" wings "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--debug")]),e._v("\n")])])]),t("p",[e._v("You may optionally add the "),t("code",[e._v("--debug")]),e._v(" flag to run Wings in debug mode.")]),e._v(" "),t("h3",{attrs:{id:"daemonizing-using-systemd"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#daemonizing-using-systemd"}},[e._v("#")]),e._v(" Daemonizing (using systemd)")]),e._v(" "),t("p",[e._v("Running Wings in the background is a simple task, just make sure that it runs without errors before doing\nthis. Place the contents below in a file called "),t("code",[e._v("wings.service")]),e._v(" in the "),t("code",[e._v("/etc/systemd/system")]),e._v(" directory.")]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("[Unit]\nDescription=Pterodactyl Wings Daemon\nAfter=docker.service\nRequires=docker.service\nPartOf=docker.service\n\n[Service]\nUser=root\nWorkingDirectory=/etc/pterodactyl\nLimitNOFILE=4096\nPIDFile=/var/run/wings/daemon.pid\nExecStart=/usr/local/bin/wings\nRestart=on-failure\nStartLimitInterval=180\nStartLimitBurst=30\nRestartSec=5s\n\n[Install]\nWantedBy=multi-user.target\n")])])]),t("p",[e._v("Then, run the commands below to reload systemd and start Wings.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" systemctl "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("enable")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--now")]),e._v(" wings\n")])])]),t("h3",{attrs:{id:"node-allocations"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#node-allocations"}},[e._v("#")]),e._v(" Node Allocations")]),e._v(" "),t("p",[e._v("Allocation is a combination of IP and Port that you can assign to a server. Each created server must have at least one allocation. The allocation would be the IP address of your network interface. In some cases, such as when behind NAT, it would be the internal IP. To create new allocations go to Nodes > your node > Allocation.")]),e._v(" "),t("p",[t("img",{attrs:{src:a(280),alt:"example image of node allocations"}})]),e._v(" "),t("p",[e._v("Type "),t("code",[e._v("hostname -I | awk '{print $1}'")]),e._v(" to find the IP to be used for the allocation. Alternatively, you can type "),t("code",[e._v('ip addr | grep "inet "')]),e._v(" to see all your available interfaces and IP addresses. Do not use 127.0.0.1 for allocations.")])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[15],{254:function(e,t,a){e.exports=a.p+"assets/img/wings_configuration_example.9f3fdd0b.png"},280:function(e,t,a){e.exports=a.p+"assets/img/node_allocations.323d67f2.png"},331:function(e,t,a){"use strict";a.r(t);var s=a(15),n=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"installing-wings"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installing-wings"}},[e._v("#")]),e._v(" Installing Wings")]),e._v(" "),t("p",[e._v("Wings is the next generation server control plane from Pterodactyl. It has been rebuilt from the\nground up using Go and lessons learned from our first Nodejs Daemon.")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("You should only install Wings if you are running "),t("strong",[e._v("Pterodactyl 1.x")]),e._v(". Do not install this software\nfor previous versions of Pterodactyl.")])]),e._v(" "),t("h2",{attrs:{id:"supported-systems"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#supported-systems"}},[e._v("#")]),e._v(" Supported Systems")]),e._v(" "),t("p",[e._v("The following is a list of supported operating systems. Please be aware that this is not an exhaustive list,\nthere is a high probability that you can run the software on other Linux distributions without much effort.\nYou are responsible for determining which packages may be necessary on those systems. There is also a very\nhigh probability that new releases of the supported OSes below will work just fine, you are not restricted to\nonly the versions listed below.")]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Operating System")]),e._v(" "),t("th",[e._v("Version")]),e._v(" "),t("th",{staticStyle:{"text-align":"center"}},[e._v("Supported")]),e._v(" "),t("th",[e._v("Notes")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("strong",[e._v("Ubuntu")])]),e._v(" "),t("td",[e._v("20.04")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td",[e._v("Documentation written assuming Ubuntu 20.04 as the base OS.")])]),e._v(" "),t("tr",[t("td"),e._v(" "),t("td",[e._v("22.04")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td")]),e._v(" "),t("tr",[t("td"),e._v(" "),t("td",[e._v("24.04")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td")]),e._v(" "),t("tr",[t("td",[t("strong",[e._v("RHEL / Rocky Linux / AlmaLinux")])]),e._v(" "),t("td",[e._v("8")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td")]),e._v(" "),t("tr",[t("td"),e._v(" "),t("td",[e._v("9")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td")]),e._v(" "),t("tr",[t("td",[t("strong",[e._v("Debian")])]),e._v(" "),t("td",[e._v("11")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td")]),e._v(" "),t("tr",[t("td"),e._v(" "),t("td",[e._v("12")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td")]),e._v(" "),t("tr",[t("td",[t("strong",[e._v("Windows")])]),e._v(" "),t("td",[e._v("All")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("❌")]),e._v(" "),t("td",[e._v("This software will not run in Windows environments.")])])])]),e._v(" "),t("h2",{attrs:{id:"system-requirements"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#system-requirements"}},[e._v("#")]),e._v(" System Requirements")]),e._v(" "),t("p",[e._v("To run Wings, you will need a Linux system capable of running Docker containers. Most VPS and almost all\ndedicated servers should be capable of running Docker, but there are edge cases.")]),e._v(" "),t("p",[e._v("When your provider uses "),t("code",[e._v("Virtuozzo")]),e._v(", "),t("code",[e._v("OpenVZ")]),e._v(" (or "),t("code",[e._v("OVZ")]),e._v("), or "),t("code",[e._v("LXC")]),e._v(" virtualization, you will most likely be unable to\nrun Wings. Some providers have made the necessary changes for nested virtualization to support Docker. Ask your provider's support team to make sure. KVM is guaranteed to work.")]),e._v(" "),t("p",[e._v("The easiest way to check is to type "),t("code",[e._v("systemd-detect-virt")]),e._v(".\nIf the result doesn't contain "),t("code",[e._v("OpenVZ")]),e._v(" or"),t("code",[e._v("LXC")]),e._v(", it should be fine. The result of "),t("code",[e._v("none")]),e._v(" will appear when running dedicated hardware without any virtualization.")]),e._v(" "),t("p",[e._v("Should that not work for some reason, or you're still unsure, you can also run the command below.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("dane@pterodactyl:~$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" dmidecode "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-s")]),e._v(" system-manufacturer\nVMware, Inc.\n")])])]),t("h2",{attrs:{id:"dependencies"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dependencies"}},[e._v("#")]),e._v(" Dependencies")]),e._v(" "),t("ul",[t("li",[e._v("curl")]),e._v(" "),t("li",[e._v("Docker")])]),e._v(" "),t("h3",{attrs:{id:"installing-docker"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installing-docker"}},[e._v("#")]),e._v(" Installing Docker")]),e._v(" "),t("p",[e._v("For a quick install of Docker CE, you can execute the command below:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-sSL")]),e._v(" https://get.docker.com/ "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("CHANNEL")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("stable "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("bash")]),e._v("\n")])])]),t("p",[e._v("If you would rather do a manual installation, please reference the "),t("a",{attrs:{href:"https://docs.docker.com/engine/install/",target:"_blank",rel:"noopener noreferrer"}},[e._v("official Docker documentation"),t("OutboundLink")],1),e._v(" for how to install Docker CE on your server.")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("Check your Kernel")]),e._v(" "),t("p",[e._v("Please be aware that some hosts install a modified kernel that does not support important docker features. Please\ncheck your kernel by running "),t("code",[e._v("uname -r")]),e._v(". If your kernel ends in "),t("code",[e._v("-xxxx-grs-ipv6-64")]),e._v(" or "),t("code",[e._v("-xxxx-mod-std-ipv6-64")]),e._v(" you're\nprobably using a non-supported kernel. Check our "),t("RouterLink",{attrs:{to:"/daemon/0.6/kernel_modifications.html"}},[e._v("Kernel Modifications")]),e._v(" guide for details.")],1)]),e._v(" "),t("h4",{attrs:{id:"start-docker-on-boot"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#start-docker-on-boot"}},[e._v("#")]),e._v(" Start Docker on Boot")]),e._v(" "),t("p",[e._v("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.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" systemctl "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("enable")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--now")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v("\n")])])]),t("h4",{attrs:{id:"enabling-swap"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enabling-swap"}},[e._v("#")]),e._v(" Enabling Swap")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("Recent Linux kernel")]),e._v(" "),t("p",[e._v("Since the version 6.1 of the Linux kernel, swap is enabled by default. If you are running a kernel version 6.1 or newer, you can skip this step. To check your kernel version, run "),t("code",[e._v("uname -r")]),e._v(".")])]),e._v(" "),t("p",[e._v("On most systems, Docker will be unable to setup swap space by default. You can confirm this by running "),t("code",[e._v("docker info")]),e._v(" and looking for the output of "),t("code",[e._v("WARNING: No swap limit support")]),e._v(" near the bottom.")]),e._v(" "),t("p",[e._v("Enabling swap is entirely optional, but we recommended doing it if you will be hosting for others and to prevent OOM errors.")]),e._v(" "),t("p",[e._v("To enable swap, open "),t("code",[e._v("/etc/default/grub")]),e._v(" as a root user and find the line starting with "),t("code",[e._v("GRUB_CMDLINE_LINUX_DEFAULT")]),e._v(". Make\nsure the line includes "),t("code",[e._v("swapaccount=1")]),e._v(" somewhere inside the double-quotes.")]),e._v(" "),t("p",[e._v("After that, run "),t("code",[e._v("sudo update-grub")]),e._v(" followed by "),t("code",[e._v("sudo reboot")]),e._v(" to restart the server and have swap enabled.\nBelow is an example of what the line should look like, "),t("em",[e._v("do not copy this line verbatim. It often has additional OS-specific parameters.")])]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('GRUB_CMDLINE_LINUX_DEFAULT="swapaccount=1"\n')])])]),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("GRUB Configuration")]),e._v(" "),t("p",[e._v("Some Linux distros may ignore "),t("code",[e._v("GRUB_CMDLINE_LINUX_DEFAULT")]),e._v(". Therefore you might have to use "),t("code",[e._v("GRUB_CMDLINE_LINUX")]),e._v(" instead should the default one not work for you.")])]),e._v(" "),t("h2",{attrs:{id:"installing-wings-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installing-wings-2"}},[e._v("#")]),e._v(" Installing Wings")]),e._v(" "),t("p",[e._v("The first step for installing Wings is to ensure we have the required directory structure setup. To do so,\nrun the commands below, which will create the base directory and download the wings executable.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("mkdir")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-p")]),e._v(" /etc/pterodactyl\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-L")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-o")]),e._v(" /usr/local/bin/wings "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"https://github.com/pterodactyl/wings/releases/latest/download/wings_linux_$([[ "'),t("span",{pre:!0,attrs:{class:"token variable"}},[t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$(")]),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("uname")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-m")]),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v(")")])]),e._v('"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("==")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"x86_64"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("]")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("]")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("&&")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("echo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"amd64"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("||")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("echo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"arm64"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v('"\n'),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("chmod")]),e._v(" u+x /usr/local/bin/wings\n")])])]),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("OVH/SYS Servers")]),e._v(" "),t("p",[e._v("If you are using a server provided by OVH or SoYouStart please be aware that your main drive space is probably allocated to\n"),t("code",[e._v("/home")]),e._v(", and not "),t("code",[e._v("/")]),e._v(" by default. Please consider using "),t("code",[e._v("/home/daemon-data")]),e._v(" for server data. This can be easily\nset when creating the node.")])]),e._v(" "),t("h2",{attrs:{id:"configure"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#configure"}},[e._v("#")]),e._v(" Configure")]),e._v(" "),t("p",[e._v("Once you have installed Wings and the required components, the next step is to create a node on your installed Panel. Go to your Panel administrative view, select Nodes from the sidebar, and on the right side click Create New button.")]),e._v(" "),t("p",[e._v("After you have created a node, click on it and there will be a tab called Configuration. Copy the code block content, paste it into a new file called "),t("code",[e._v("config.yml")]),e._v(" in "),t("code",[e._v("/etc/pterodactyl")]),e._v(" and save it.")]),e._v(" "),t("p",[e._v("Alternatively, you can click on the Generate Token button, copy the bash command and paste it into your terminal.")]),e._v(" "),t("p",[t("img",{attrs:{src:a(254),alt:"example image of wings configuration"}})]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("When your Panel is using SSL, the Wings must also have one created for its FQDN. See "),t("RouterLink",{attrs:{to:"/tutorials/creating_ssl_certificates.html"}},[e._v("Creating SSL Certificates")]),e._v(" documentation page for how to create these certificates before continuing.")],1)]),e._v(" "),t("h3",{attrs:{id:"starting-wings"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#starting-wings"}},[e._v("#")]),e._v(" Starting Wings")]),e._v(" "),t("p",[e._v("To start Wings, simply run the command below, which will start it in a debug mode. Once you confirmed that it is running without errors, use "),t("code",[e._v("CTRL+C")]),e._v(" to terminate the process and daemonize it by following the instructions below. Depending on your server's internet connection pulling and starting Wings for the first time may take a few minutes.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" wings "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--debug")]),e._v("\n")])])]),t("p",[e._v("You may optionally add the "),t("code",[e._v("--debug")]),e._v(" flag to run Wings in debug mode.")]),e._v(" "),t("h3",{attrs:{id:"daemonizing-using-systemd"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#daemonizing-using-systemd"}},[e._v("#")]),e._v(" Daemonizing (using systemd)")]),e._v(" "),t("p",[e._v("Running Wings in the background is a simple task, just make sure that it runs without errors before doing\nthis. Place the contents below in a file called "),t("code",[e._v("wings.service")]),e._v(" in the "),t("code",[e._v("/etc/systemd/system")]),e._v(" directory.")]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("[Unit]\nDescription=Pterodactyl Wings Daemon\nAfter=docker.service\nRequires=docker.service\nPartOf=docker.service\n\n[Service]\nUser=root\nWorkingDirectory=/etc/pterodactyl\nLimitNOFILE=4096\nPIDFile=/var/run/wings/daemon.pid\nExecStart=/usr/local/bin/wings\nRestart=on-failure\nStartLimitInterval=180\nStartLimitBurst=30\nRestartSec=5s\n\n[Install]\nWantedBy=multi-user.target\n")])])]),t("p",[e._v("Then, run the commands below to reload systemd and start Wings.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" systemctl "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("enable")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--now")]),e._v(" wings\n")])])]),t("h3",{attrs:{id:"node-allocations"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#node-allocations"}},[e._v("#")]),e._v(" Node Allocations")]),e._v(" "),t("p",[e._v("Allocation is a combination of IP and Port that you can assign to a server. Each created server must have at least one allocation. The allocation would be the IP address of your network interface. In some cases, such as when behind NAT, it would be the internal IP. To create new allocations go to Nodes > your node > Allocation.")]),e._v(" "),t("p",[t("img",{attrs:{src:a(280),alt:"example image of node allocations"}})]),e._v(" "),t("p",[e._v("Type "),t("code",[e._v("hostname -I | awk '{print $1}'")]),e._v(" to find the IP to be used for the allocation. Alternatively, you can type "),t("code",[e._v('ip addr | grep "inet "')]),e._v(" to see all your available interfaces and IP addresses. Do not use 127.0.0.1 for allocations.")])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/20.5c80f685.js b/assets/js/20.a720acbc.js similarity index 99% rename from assets/js/20.5c80f685.js rename to assets/js/20.a720acbc.js index 4a5268e9..b5bf3be8 100644 --- a/assets/js/20.5c80f685.js +++ b/assets/js/20.a720acbc.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[20],{276:function(e,t,a){e.exports=a.p+"assets/img/daemon_configuration_example.7d1665c4.png"},302:function(e,t,a){"use strict";a.r(t);var s=a(15),n=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"installation"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installation"}},[e._v("#")]),e._v(" Installation")]),e._v(" "),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("This Software is Abandoned")]),e._v(" "),t("p",[e._v("This documentation is for "),t("strong",[e._v("abandoned software")]),e._v(" which does not recieve any security updates or support\nfrom the community. This documentation has been left accessible for historial reasons.")]),e._v(" "),t("p",[e._v("You should be installing and using "),t("RouterLink",{attrs:{to:"/wings/1.0/installing.html"}},[e._v("Wings")]),e._v(" in production environments with\n"),t("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html"}},[e._v("Pterodactyl Panel 1.0")]),e._v(".")],1)]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("This specific software is for Pterodactyl v0.7 and "),t("strong",[e._v("must not be used for Pterodactyl v1.0")]),e._v(". If you have installed 1.0 you should use "),t("RouterLink",{attrs:{to:"/wings/1.0/installing.html"}},[e._v("Wings")]),e._v(" instead.")],1)]),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#supported-systems"}},[e._v("Supported Systems")])]),t("li",[t("a",{attrs:{href:"#system-requirements"}},[e._v("System Requirements")])]),t("li",[t("a",{attrs:{href:"#dependencies"}},[e._v("Dependencies")]),t("ul",[t("li",[t("a",{attrs:{href:"#installing-docker"}},[e._v("Installing Docker")])]),t("li",[t("a",{attrs:{href:"#installing-nodejs"}},[e._v("Installing Nodejs")])])])]),t("li",[t("a",{attrs:{href:"#installing-daemon-software"}},[e._v("Installing Daemon Software")])]),t("li",[t("a",{attrs:{href:"#configure-daemon"}},[e._v("Configure Daemon")])]),t("li",[t("a",{attrs:{href:"#starting-the-daemon"}},[e._v("Starting the Daemon")]),t("ul",[t("li",[t("a",{attrs:{href:"#daemonizing-using-systemd"}},[e._v("Daemonizing (using systemd)")])])])])])]),t("p"),e._v(" "),t("h2",{attrs:{id:"supported-systems"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#supported-systems"}},[e._v("#")]),e._v(" Supported Systems")]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Operating System")]),e._v(" "),t("th",[e._v("Version")]),e._v(" "),t("th",{staticStyle:{"text-align":"center"}},[e._v("Supported")]),e._v(" "),t("th",[e._v("Notes")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("strong",[e._v("Ubuntu")])]),e._v(" "),t("td",[e._v("18.04")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td",[e._v("Documentation written assuming Ubuntu 18.04 as the base OS.")])]),e._v(" "),t("tr",[t("td"),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/community/installation-guides/daemon/ubuntu2004.html"}},[e._v("20.04")])],1),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td")]),e._v(" "),t("tr",[t("td",[t("strong",[e._v("CentOS")])]),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/community/installation-guides/daemon/centos7.html"}},[e._v("7")])],1),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("⚠️")]),e._v(" "),t("td",[e._v("Extra repos are required")])]),e._v(" "),t("tr",[t("td"),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/community/installation-guides/daemon/centos8.html"}},[e._v("8")])],1),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td")]),e._v(" "),t("tr",[t("td",[t("strong",[e._v("Debian")])]),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/community/installation-guides/daemon/debian9.html"}},[e._v("9")])],1),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td")]),e._v(" "),t("tr",[t("td"),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/community/installation-guides/daemon/debian10.html"}},[e._v("10")])],1),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td")])])]),e._v(" "),t("h2",{attrs:{id:"system-requirements"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#system-requirements"}},[e._v("#")]),e._v(" System Requirements")]),e._v(" "),t("p",[e._v("In order to run the Daemon you will need a system capable of running Docker containers. Most VPS and almost all\ndedicated servers should be capable of running Docker, but there are edge cases.")]),e._v(" "),t("p",[e._v("If your provider makes use of "),t("code",[e._v("Virtuozzo")]),e._v(", "),t("code",[e._v("OpenVZ")]),e._v(" (or "),t("code",[e._v("OVZ")]),e._v("), or "),t("code",[e._v("LXC")]),e._v(" then you will most likely be unable to\nrun the Daemon. If you are unsure what your host is using there are a couple of options. The easiest is to check\ntheir website, or reach out to their support team.")]),e._v(" "),t("p",[e._v("If you want to take a different approach, try using "),t("code",[e._v("lscpu")]),e._v(" and checking what the virtualization type listed is. An\nexample of this is shown below which shows my hypervisor running with full virtualization — this means it will\nsupport Docker without issues. If you see "),t("code",[e._v("KVM")]),e._v(" for the vendor, chances are you're fine as well.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("dane@daemon:~$ lscpu "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("grep")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'vendor\\|type'")]),e._v("\nHypervisor vendor: VMware\nVirtualization type: full\n")])])]),t("p",[e._v("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\ndoesn't report "),t("code",[e._v("Xen")]),e._v(" or "),t("code",[e._v("LXC")]),e._v(" you're probably okay to continue.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("dane@daemon:~$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" dmidecode "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-s")]),e._v(" system-manufacturer\nVMware, Inc.\n")])])]),t("h2",{attrs:{id:"dependencies"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dependencies"}},[e._v("#")]),e._v(" Dependencies")]),e._v(" "),t("p",[e._v("Pterodactyl's Daemon requires the following dependencies be installed on your system in order for it to operate.")]),e._v(" "),t("ul",[t("li",[e._v("Docker")]),e._v(" "),t("li",[e._v("Nodejs ("),t("code",[e._v("v10")]),e._v(", "),t("code",[e._v("v12")]),e._v(", higher versions likely work, but are untested)")]),e._v(" "),t("li",[t("code",[e._v("node-gyp")])]),e._v(" "),t("li",[t("code",[e._v("tar")])]),e._v(" "),t("li",[t("code",[e._v("unzip")])]),e._v(" "),t("li",[t("code",[e._v("make")]),e._v(", "),t("code",[e._v("gcc")]),e._v(" ("),t("code",[e._v("gcc-c++")]),e._v(" on CentOS), "),t("code",[e._v("g++")])]),e._v(" "),t("li",[t("code",[e._v("python")])])]),e._v(" "),t("h3",{attrs:{id:"installing-docker"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installing-docker"}},[e._v("#")]),e._v(" Installing Docker")]),e._v(" "),t("p",[e._v("For a quick install of Docker CE, you can execute the command below:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-sSL")]),e._v(" https://get.docker.com/ "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("CHANNEL")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("stable "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("bash")]),e._v("\n")])])]),t("p",[e._v("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\nare listed below for commonly supported systems.")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://docs.docker.com/install/linux/docker-ce/ubuntu/#install-docker-ce",target:"_blank",rel:"noopener noreferrer"}},[e._v("Ubuntu"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://docs.docker.com/install/linux/docker-ce/centos/#install-docker-ce",target:"_blank",rel:"noopener noreferrer"}},[e._v("CentOS"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://docs.docker.com/install/linux/docker-ce/debian/#install-docker-ce",target:"_blank",rel:"noopener noreferrer"}},[e._v("Debian"),t("OutboundLink")],1)])]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("Check your Kernel")]),e._v(" "),t("p",[e._v("Please be aware that some hosts install a modified kernel that does not support important docker features. Please\ncheck your kernel by running "),t("code",[e._v("uname -r")]),e._v(". If your kernel ends in "),t("code",[e._v("-xxxx-grs-ipv6-64")]),e._v(" or "),t("code",[e._v("-xxxx-mod-std-ipv6-64")]),e._v(" you're\nprobably using a non-supported kernel. Check our "),t("RouterLink",{attrs:{to:"/daemon/0.6/kernel_modifications.html"}},[e._v("Kernel Modifications")]),e._v(" guide for details.")],1)]),e._v(" "),t("h4",{attrs:{id:"start-docker-on-boot"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#start-docker-on-boot"}},[e._v("#")]),e._v(" Start Docker on Boot")]),e._v(" "),t("p",[e._v("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.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("systemctl "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("enable")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v("\n")])])]),t("h4",{attrs:{id:"enabling-swap"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enabling-swap"}},[e._v("#")]),e._v(" Enabling Swap")]),e._v(" "),t("p",[e._v("On most systems, docker will be unable to setup swap space, you can check if this is the case by running "),t("code",[e._v("docker info")]),e._v(".\nIf it outputs "),t("code",[e._v("WARNING: No swap limit support")]),e._v(" near the bottom, this is the case. Enabling swap is completely optional,\nbut we recommended doing it if you will be hosting for others, and to prevent OOM errors.")]),e._v(" "),t("p",[e._v("To do so, open "),t("code",[e._v("/etc/default/grub")]),e._v(" as a root user, and find the line starting with "),t("code",[e._v("GRUB_CMDLINE_LINUX_DEFAULT")]),e._v(". Make\nsure the line includes "),t("code",[e._v("swapaccount=1")]),e._v(".")]),e._v(" "),t("p",[e._v("After doing that, simply run "),t("code",[e._v("sudo update-grub")]),e._v(" followed by "),t("code",[e._v("sudo reboot")]),e._v(" to restart the server and have swap enabled.\nBelow is an example of what the line should look like, "),t("em",[e._v("do not copy this line verbatium, it often has additional\nOS specific parameters.")])]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('GRUB_CMDLINE_LINUX_DEFAULT="swapaccount=1"\n')])])]),t("h3",{attrs:{id:"installing-nodejs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installing-nodejs"}},[e._v("#")]),e._v(" Installing Nodejs")]),e._v(" "),t("p",[e._v("NodeJS is also super easy to install! Simply run the command below to make the package accessible to your system.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-sL")]),e._v(" https://deb.nodesource.com/setup_10.x "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-E")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("bash")]),e._v(" -\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-y")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" nodejs "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("make")]),e._v(" gcc g++\n")])])]),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("Other OS Distributions")]),e._v(" "),t("p",[e._v("If you are using CentOS, "),t("a",{attrs:{href:"https://nodejs.org/en/download/package-manager/#enterprise-linux-and-fedora",target:"_blank",rel:"noopener noreferrer"}},[e._v("please follow these instructions"),t("OutboundLink")],1),e._v(". Ubuntu and Debian users may also follow the "),t("a",{attrs:{href:"https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions",target:"_blank",rel:"noopener noreferrer"}},[e._v("official\ninstructions provided by Nodejs"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("h2",{attrs:{id:"installing-daemon-software"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installing-daemon-software"}},[e._v("#")]),e._v(" Installing Daemon Software")]),e._v(" "),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("This Software is Abandoned")]),e._v(" "),t("p",[e._v("This documentation is for "),t("strong",[e._v("abandoned software")]),e._v(" which does not recieve any security updates or support\nfrom the community. This documentation has been left accessible for historial reasons.")]),e._v(" "),t("p",[e._v("You should be installing and using "),t("RouterLink",{attrs:{to:"/wings/1.0/installing.html"}},[e._v("Wings")]),e._v(" in production environments with\n"),t("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html"}},[e._v("Pterodactyl Panel 1.0")]),e._v(".")],1)]),e._v(" "),t("p",[e._v("The first step for installing the daemon is to make sure we have the required directory structure setup. To do so,\nrun the commands below.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("mkdir")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-p")]),e._v(" /srv/daemon /srv/daemon-data\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" /srv/daemon\n")])])]),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("OVH/SYS Servers")]),e._v(" "),t("p",[e._v("If you are using a server provided by OVH or SoYouStart please be aware that your main drive space is probably allocated to\n"),t("code",[e._v("/home")]),e._v(", and not "),t("code",[e._v("/")]),e._v(" by default. Please consider using "),t("code",[e._v("/home/daemon-data")]),e._v(" for server data. This can be easily\nset when creating the node.")])]),e._v(" "),t("p",[e._v("The next step is to download the software and unpack the archive.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-L")]),e._v(" https://github.com/pterodactyl/daemon/releases/download/v0.6.13/daemon.tar.gz "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("tar")]),e._v(" --strip-components"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-xzv")]),e._v("\n")])])]),t("p",[e._v("Finally, we need to install the dependencies that allow the Daemon to run properly. This command will most likely\ntake a few minutes to run, please do not interrupt it.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("npm")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--only")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("production --no-audit --unsafe-perm\n")])])]),t("h2",{attrs:{id:"configure-daemon"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#configure-daemon"}},[e._v("#")]),e._v(" Configure Daemon")]),e._v(" "),t("p",[e._v("Once you have installed the daemon and required components, the next step is to create a node on your installed Panel\nOnce you have done that there will be a tab called Configuration when you view the node.")]),e._v(" "),t("p",[e._v("Simply copy and paste the code block and paste it into a file called "),t("code",[e._v("core.json")]),e._v(" in "),t("code",[e._v("/srv/daemon/config")]),e._v(" and save it.\nYou may also use the Auto-Deployment feature rather than manually creating the files.")]),e._v(" "),t("p",[t("img",{attrs:{src:a(276),alt:""}})]),e._v(" "),t("h2",{attrs:{id:"starting-the-daemon"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#starting-the-daemon"}},[e._v("#")]),e._v(" Starting the Daemon")]),e._v(" "),t("p",[e._v("To start your daemon simply move into the daemon directory and run the command below which will start the daemon in\nforeground mode. Once you are done, use "),t("code",[e._v("CTRL+C")]),e._v(" to terminate the process. Depending on your server's internet connection\npulling and starting the Daemon for the first time may take a few minutes.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("npm")]),e._v(" start\n")])])]),t("h3",{attrs:{id:"daemonizing-using-systemd"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#daemonizing-using-systemd"}},[e._v("#")]),e._v(" Daemonizing (using systemd)")]),e._v(" "),t("p",[e._v("Running Pterodactyl Daemon in the background is a simple task, just make sure that it runs without errors before doing\nthis. Place the contents below in a file called "),t("code",[e._v("wings.service")]),e._v(" in the "),t("code",[e._v("/etc/systemd/system")]),e._v(" directory.")]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("[Unit]\nDescription=Pterodactyl Wings Daemon\nAfter=docker.service\n\n[Service]\nUser=root\n#Group=some_group\nWorkingDirectory=/srv/daemon\nLimitNOFILE=4096\nPIDFile=/var/run/wings/daemon.pid\nExecStart=/usr/bin/node /srv/daemon/src/index.js\nRestart=on-failure\nStartLimitInterval=600\n\n[Install]\nWantedBy=multi-user.target\n")])])]),t("p",[e._v("Then, run the commands below to reload systemd and start the daemon.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("systemctl "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("enable")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--now")]),e._v(" wings\n")])])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[20],{276:function(e,t,a){e.exports=a.p+"assets/img/daemon_configuration_example.7d1665c4.png"},303:function(e,t,a){"use strict";a.r(t);var s=a(15),n=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"installation"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installation"}},[e._v("#")]),e._v(" Installation")]),e._v(" "),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("This Software is Abandoned")]),e._v(" "),t("p",[e._v("This documentation is for "),t("strong",[e._v("abandoned software")]),e._v(" which does not recieve any security updates or support\nfrom the community. This documentation has been left accessible for historial reasons.")]),e._v(" "),t("p",[e._v("You should be installing and using "),t("RouterLink",{attrs:{to:"/wings/1.0/installing.html"}},[e._v("Wings")]),e._v(" in production environments with\n"),t("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html"}},[e._v("Pterodactyl Panel 1.0")]),e._v(".")],1)]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("This specific software is for Pterodactyl v0.7 and "),t("strong",[e._v("must not be used for Pterodactyl v1.0")]),e._v(". If you have installed 1.0 you should use "),t("RouterLink",{attrs:{to:"/wings/1.0/installing.html"}},[e._v("Wings")]),e._v(" instead.")],1)]),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#supported-systems"}},[e._v("Supported Systems")])]),t("li",[t("a",{attrs:{href:"#system-requirements"}},[e._v("System Requirements")])]),t("li",[t("a",{attrs:{href:"#dependencies"}},[e._v("Dependencies")]),t("ul",[t("li",[t("a",{attrs:{href:"#installing-docker"}},[e._v("Installing Docker")])]),t("li",[t("a",{attrs:{href:"#installing-nodejs"}},[e._v("Installing Nodejs")])])])]),t("li",[t("a",{attrs:{href:"#installing-daemon-software"}},[e._v("Installing Daemon Software")])]),t("li",[t("a",{attrs:{href:"#configure-daemon"}},[e._v("Configure Daemon")])]),t("li",[t("a",{attrs:{href:"#starting-the-daemon"}},[e._v("Starting the Daemon")]),t("ul",[t("li",[t("a",{attrs:{href:"#daemonizing-using-systemd"}},[e._v("Daemonizing (using systemd)")])])])])])]),t("p"),e._v(" "),t("h2",{attrs:{id:"supported-systems"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#supported-systems"}},[e._v("#")]),e._v(" Supported Systems")]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Operating System")]),e._v(" "),t("th",[e._v("Version")]),e._v(" "),t("th",{staticStyle:{"text-align":"center"}},[e._v("Supported")]),e._v(" "),t("th",[e._v("Notes")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("strong",[e._v("Ubuntu")])]),e._v(" "),t("td",[e._v("18.04")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td",[e._v("Documentation written assuming Ubuntu 18.04 as the base OS.")])]),e._v(" "),t("tr",[t("td"),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/community/installation-guides/daemon/ubuntu2004.html"}},[e._v("20.04")])],1),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td")]),e._v(" "),t("tr",[t("td",[t("strong",[e._v("CentOS")])]),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/community/installation-guides/daemon/centos7.html"}},[e._v("7")])],1),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("⚠️")]),e._v(" "),t("td",[e._v("Extra repos are required")])]),e._v(" "),t("tr",[t("td"),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/community/installation-guides/daemon/centos8.html"}},[e._v("8")])],1),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td")]),e._v(" "),t("tr",[t("td",[t("strong",[e._v("Debian")])]),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/community/installation-guides/daemon/debian9.html"}},[e._v("9")])],1),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td")]),e._v(" "),t("tr",[t("td"),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/community/installation-guides/daemon/debian10.html"}},[e._v("10")])],1),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td")])])]),e._v(" "),t("h2",{attrs:{id:"system-requirements"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#system-requirements"}},[e._v("#")]),e._v(" System Requirements")]),e._v(" "),t("p",[e._v("In order to run the Daemon you will need a system capable of running Docker containers. Most VPS and almost all\ndedicated servers should be capable of running Docker, but there are edge cases.")]),e._v(" "),t("p",[e._v("If your provider makes use of "),t("code",[e._v("Virtuozzo")]),e._v(", "),t("code",[e._v("OpenVZ")]),e._v(" (or "),t("code",[e._v("OVZ")]),e._v("), or "),t("code",[e._v("LXC")]),e._v(" then you will most likely be unable to\nrun the Daemon. If you are unsure what your host is using there are a couple of options. The easiest is to check\ntheir website, or reach out to their support team.")]),e._v(" "),t("p",[e._v("If you want to take a different approach, try using "),t("code",[e._v("lscpu")]),e._v(" and checking what the virtualization type listed is. An\nexample of this is shown below which shows my hypervisor running with full virtualization — this means it will\nsupport Docker without issues. If you see "),t("code",[e._v("KVM")]),e._v(" for the vendor, chances are you're fine as well.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("dane@daemon:~$ lscpu "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("grep")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'vendor\\|type'")]),e._v("\nHypervisor vendor: VMware\nVirtualization type: full\n")])])]),t("p",[e._v("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\ndoesn't report "),t("code",[e._v("Xen")]),e._v(" or "),t("code",[e._v("LXC")]),e._v(" you're probably okay to continue.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("dane@daemon:~$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" dmidecode "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-s")]),e._v(" system-manufacturer\nVMware, Inc.\n")])])]),t("h2",{attrs:{id:"dependencies"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dependencies"}},[e._v("#")]),e._v(" Dependencies")]),e._v(" "),t("p",[e._v("Pterodactyl's Daemon requires the following dependencies be installed on your system in order for it to operate.")]),e._v(" "),t("ul",[t("li",[e._v("Docker")]),e._v(" "),t("li",[e._v("Nodejs ("),t("code",[e._v("v10")]),e._v(", "),t("code",[e._v("v12")]),e._v(", higher versions likely work, but are untested)")]),e._v(" "),t("li",[t("code",[e._v("node-gyp")])]),e._v(" "),t("li",[t("code",[e._v("tar")])]),e._v(" "),t("li",[t("code",[e._v("unzip")])]),e._v(" "),t("li",[t("code",[e._v("make")]),e._v(", "),t("code",[e._v("gcc")]),e._v(" ("),t("code",[e._v("gcc-c++")]),e._v(" on CentOS), "),t("code",[e._v("g++")])]),e._v(" "),t("li",[t("code",[e._v("python")])])]),e._v(" "),t("h3",{attrs:{id:"installing-docker"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installing-docker"}},[e._v("#")]),e._v(" Installing Docker")]),e._v(" "),t("p",[e._v("For a quick install of Docker CE, you can execute the command below:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-sSL")]),e._v(" https://get.docker.com/ "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("CHANNEL")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("stable "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("bash")]),e._v("\n")])])]),t("p",[e._v("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\nare listed below for commonly supported systems.")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://docs.docker.com/install/linux/docker-ce/ubuntu/#install-docker-ce",target:"_blank",rel:"noopener noreferrer"}},[e._v("Ubuntu"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://docs.docker.com/install/linux/docker-ce/centos/#install-docker-ce",target:"_blank",rel:"noopener noreferrer"}},[e._v("CentOS"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://docs.docker.com/install/linux/docker-ce/debian/#install-docker-ce",target:"_blank",rel:"noopener noreferrer"}},[e._v("Debian"),t("OutboundLink")],1)])]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("Check your Kernel")]),e._v(" "),t("p",[e._v("Please be aware that some hosts install a modified kernel that does not support important docker features. Please\ncheck your kernel by running "),t("code",[e._v("uname -r")]),e._v(". If your kernel ends in "),t("code",[e._v("-xxxx-grs-ipv6-64")]),e._v(" or "),t("code",[e._v("-xxxx-mod-std-ipv6-64")]),e._v(" you're\nprobably using a non-supported kernel. Check our "),t("RouterLink",{attrs:{to:"/daemon/0.6/kernel_modifications.html"}},[e._v("Kernel Modifications")]),e._v(" guide for details.")],1)]),e._v(" "),t("h4",{attrs:{id:"start-docker-on-boot"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#start-docker-on-boot"}},[e._v("#")]),e._v(" Start Docker on Boot")]),e._v(" "),t("p",[e._v("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.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("systemctl "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("enable")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v("\n")])])]),t("h4",{attrs:{id:"enabling-swap"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enabling-swap"}},[e._v("#")]),e._v(" Enabling Swap")]),e._v(" "),t("p",[e._v("On most systems, docker will be unable to setup swap space, you can check if this is the case by running "),t("code",[e._v("docker info")]),e._v(".\nIf it outputs "),t("code",[e._v("WARNING: No swap limit support")]),e._v(" near the bottom, this is the case. Enabling swap is completely optional,\nbut we recommended doing it if you will be hosting for others, and to prevent OOM errors.")]),e._v(" "),t("p",[e._v("To do so, open "),t("code",[e._v("/etc/default/grub")]),e._v(" as a root user, and find the line starting with "),t("code",[e._v("GRUB_CMDLINE_LINUX_DEFAULT")]),e._v(". Make\nsure the line includes "),t("code",[e._v("swapaccount=1")]),e._v(".")]),e._v(" "),t("p",[e._v("After doing that, simply run "),t("code",[e._v("sudo update-grub")]),e._v(" followed by "),t("code",[e._v("sudo reboot")]),e._v(" to restart the server and have swap enabled.\nBelow is an example of what the line should look like, "),t("em",[e._v("do not copy this line verbatium, it often has additional\nOS specific parameters.")])]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('GRUB_CMDLINE_LINUX_DEFAULT="swapaccount=1"\n')])])]),t("h3",{attrs:{id:"installing-nodejs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installing-nodejs"}},[e._v("#")]),e._v(" Installing Nodejs")]),e._v(" "),t("p",[e._v("NodeJS is also super easy to install! Simply run the command below to make the package accessible to your system.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-sL")]),e._v(" https://deb.nodesource.com/setup_10.x "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-E")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("bash")]),e._v(" -\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-y")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" nodejs "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("make")]),e._v(" gcc g++\n")])])]),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("Other OS Distributions")]),e._v(" "),t("p",[e._v("If you are using CentOS, "),t("a",{attrs:{href:"https://nodejs.org/en/download/package-manager/#enterprise-linux-and-fedora",target:"_blank",rel:"noopener noreferrer"}},[e._v("please follow these instructions"),t("OutboundLink")],1),e._v(". Ubuntu and Debian users may also follow the "),t("a",{attrs:{href:"https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions",target:"_blank",rel:"noopener noreferrer"}},[e._v("official\ninstructions provided by Nodejs"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("h2",{attrs:{id:"installing-daemon-software"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installing-daemon-software"}},[e._v("#")]),e._v(" Installing Daemon Software")]),e._v(" "),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("This Software is Abandoned")]),e._v(" "),t("p",[e._v("This documentation is for "),t("strong",[e._v("abandoned software")]),e._v(" which does not recieve any security updates or support\nfrom the community. This documentation has been left accessible for historial reasons.")]),e._v(" "),t("p",[e._v("You should be installing and using "),t("RouterLink",{attrs:{to:"/wings/1.0/installing.html"}},[e._v("Wings")]),e._v(" in production environments with\n"),t("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html"}},[e._v("Pterodactyl Panel 1.0")]),e._v(".")],1)]),e._v(" "),t("p",[e._v("The first step for installing the daemon is to make sure we have the required directory structure setup. To do so,\nrun the commands below.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("mkdir")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-p")]),e._v(" /srv/daemon /srv/daemon-data\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" /srv/daemon\n")])])]),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("OVH/SYS Servers")]),e._v(" "),t("p",[e._v("If you are using a server provided by OVH or SoYouStart please be aware that your main drive space is probably allocated to\n"),t("code",[e._v("/home")]),e._v(", and not "),t("code",[e._v("/")]),e._v(" by default. Please consider using "),t("code",[e._v("/home/daemon-data")]),e._v(" for server data. This can be easily\nset when creating the node.")])]),e._v(" "),t("p",[e._v("The next step is to download the software and unpack the archive.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-L")]),e._v(" https://github.com/pterodactyl/daemon/releases/download/v0.6.13/daemon.tar.gz "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("tar")]),e._v(" --strip-components"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-xzv")]),e._v("\n")])])]),t("p",[e._v("Finally, we need to install the dependencies that allow the Daemon to run properly. This command will most likely\ntake a few minutes to run, please do not interrupt it.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("npm")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--only")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("production --no-audit --unsafe-perm\n")])])]),t("h2",{attrs:{id:"configure-daemon"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#configure-daemon"}},[e._v("#")]),e._v(" Configure Daemon")]),e._v(" "),t("p",[e._v("Once you have installed the daemon and required components, the next step is to create a node on your installed Panel\nOnce you have done that there will be a tab called Configuration when you view the node.")]),e._v(" "),t("p",[e._v("Simply copy and paste the code block and paste it into a file called "),t("code",[e._v("core.json")]),e._v(" in "),t("code",[e._v("/srv/daemon/config")]),e._v(" and save it.\nYou may also use the Auto-Deployment feature rather than manually creating the files.")]),e._v(" "),t("p",[t("img",{attrs:{src:a(276),alt:""}})]),e._v(" "),t("h2",{attrs:{id:"starting-the-daemon"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#starting-the-daemon"}},[e._v("#")]),e._v(" Starting the Daemon")]),e._v(" "),t("p",[e._v("To start your daemon simply move into the daemon directory and run the command below which will start the daemon in\nforeground mode. Once you are done, use "),t("code",[e._v("CTRL+C")]),e._v(" to terminate the process. Depending on your server's internet connection\npulling and starting the Daemon for the first time may take a few minutes.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("npm")]),e._v(" start\n")])])]),t("h3",{attrs:{id:"daemonizing-using-systemd"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#daemonizing-using-systemd"}},[e._v("#")]),e._v(" Daemonizing (using systemd)")]),e._v(" "),t("p",[e._v("Running Pterodactyl Daemon in the background is a simple task, just make sure that it runs without errors before doing\nthis. Place the contents below in a file called "),t("code",[e._v("wings.service")]),e._v(" in the "),t("code",[e._v("/etc/systemd/system")]),e._v(" directory.")]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("[Unit]\nDescription=Pterodactyl Wings Daemon\nAfter=docker.service\n\n[Service]\nUser=root\n#Group=some_group\nWorkingDirectory=/srv/daemon\nLimitNOFILE=4096\nPIDFile=/var/run/wings/daemon.pid\nExecStart=/usr/bin/node /srv/daemon/src/index.js\nRestart=on-failure\nStartLimitInterval=600\n\n[Install]\nWantedBy=multi-user.target\n")])])]),t("p",[e._v("Then, run the commands below to reload systemd and start the daemon.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("systemctl "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("enable")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--now")]),e._v(" wings\n")])])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/22.c4d3c3e7.js b/assets/js/22.8f7ee701.js similarity index 98% rename from assets/js/22.c4d3c3e7.js rename to assets/js/22.8f7ee701.js index 4c4e446d..bf7d6e48 100644 --- a/assets/js/22.c4d3c3e7.js +++ b/assets/js/22.8f7ee701.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[22],{254:function(e,t,s){e.exports=s.p+"assets/img/wings_configuration_example.9f3fdd0b.png"},333:function(e,t,s){"use strict";s.r(t);var a=s(15),n=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"migrating-to-wings"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#migrating-to-wings"}},[e._v("#")]),e._v(" Migrating to Wings")]),e._v(" "),t("p",[e._v("This guide is for people looking to migrate from the old Node.JS daemon to Wings. Please see the\n"),t("RouterLink",{attrs:{to:"/wings/1.0/installing.html"}},[e._v("install guide")]),e._v(" if you are trying to install Wings for the first time on\na new node.")],1),e._v(" "),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("Panel Version Requirement")]),e._v(" "),t("p",[e._v("You "),t("strong",[e._v("must")]),e._v(" be running Pterodactyl Panel 1.X in order to use Wings.")])]),e._v(" "),t("p",[e._v("You'll have a brief offline period as you perform this process, however no running game processes\nwill be affected. Plus, chances are your Panel will be offline (or in maintenance mode) during this\nso your users should not notice anything out of the ordinary.")]),e._v(" "),t("h2",{attrs:{id:"install-wings"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#install-wings"}},[e._v("#")]),e._v(" Install Wings")]),e._v(" "),t("p",[e._v("The first step for installing the daemon is to make sure we have the required directory structure setup. To do so,\nrun the commands below which will create the base directory and download the wings executable.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("mkdir")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-p")]),e._v(" /etc/pterodactyl\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-L")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-o")]),e._v(" /usr/local/bin/wings https://github.com/pterodactyl/wings/releases/latest/download/wings_linux_amd64\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("chmod")]),e._v(" u+x /usr/local/bin/wings\n")])])]),t("h2",{attrs:{id:"copy-new-configuration-file"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#copy-new-configuration-file"}},[e._v("#")]),e._v(" Copy New Configuration File")]),e._v(" "),t("p",[e._v("Once you have installed Wings, you'll need to copy over a new configuration file from the Panel. This file\nis in a new format, and should be easier for you to manage and edit in the future.")]),e._v(" "),t("p",[e._v("Simply copy and paste the code block and paste it into a file called "),t("code",[e._v("config.yml")]),e._v(" within the "),t("code",[e._v("/etc/pterodactyl")]),e._v("\ndirectory and save it.")]),e._v(" "),t("p",[t("img",{attrs:{src:s(254),alt:""}})]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("Please note that any modifications you previously made to the configuration will be lost with this. If you have\nmodifications to our default settings, the best option is to start Wings once with the copied configuration which\nwill then populate all of the other configuration settings.")]),e._v(" "),t("p",[e._v("From there you can make any adjustments as necessary.")])]),e._v(" "),t("h2",{attrs:{id:"remove-old-daemon"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#remove-old-daemon"}},[e._v("#")]),e._v(" Remove Old Daemon")]),e._v(" "),t("p",[e._v("Now that Wings is installed, we need to remove all of the old daemon code from the server since it is not being\nused anymore. To do this, simply execute the following commands — assuming your old daemon is in the default\n"),t("code",[e._v("/srv/daemon")]),e._v(" directory.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Stop the old daemon.")]),e._v("\nsystemctl stop wings\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Delete the entire directory. There is nothing stored in here that we actually need for the")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# purposes of this migration. Remember, server data is stored in /srv/daemon-data.")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("rm")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-rf")]),e._v(" /srv/daemon\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Optionally, remove NodeJS from your system if it was not used for anything else.")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-y")]),e._v(" remove nodejs "),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# or: yum remove nodejs")]),e._v("\n")])])]),t("h3",{attrs:{id:"remove-standalone-sftp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#remove-standalone-sftp"}},[e._v("#")]),e._v(" Remove Standalone SFTP")]),e._v(" "),t("p",[e._v("If you've used the "),t("RouterLink",{attrs:{to:"/daemon/0.6/standalone_sftp.html"}},[e._v("standalone SFTP server")]),e._v(" with the old daemon, we need to remove it's systemd service as well, as it's no longer needed.\nYou can do so using the following commands.")],1),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# stop and disable the standalone sftp")]),e._v("\nsystemctl disable "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--now")]),e._v(" pterosftp\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# delete the systemd service")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("rm")]),e._v(" /etc/systemd/system/pterosftp.service\n")])])]),t("h2",{attrs:{id:"daemonize-wings"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#daemonize-wings"}},[e._v("#")]),e._v(" Daemonize Wings")]),e._v(" "),t("p",[e._v("You'll then need to edit your existing "),t("code",[e._v("systemd")]),e._v(" service file for Wings to point to the new control software. To do\nthis, open "),t("code",[e._v("/etc/systemd/system/wings.service")]),e._v(" and replace the entire contents of the file with the following:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("[Unit]\nDescription=Pterodactyl Wings Daemon\nAfter=docker.service\n\n[Service]\nUser=root\nWorkingDirectory=/etc/pterodactyl\nLimitNOFILE=4096\nPIDFile=/var/run/wings/daemon.pid\nExecStart=/usr/local/bin/wings\nRestart=on-failure\nStartLimitInterval=600\n\n[Install]\nWantedBy=multi-user.target\n")])])]),t("p",[e._v("Then, start wings.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("systemctl daemon-reload\nsystemctl enable --now wings\n")])])]),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("What if Wings doesn't start?")]),e._v(" "),t("p",[e._v("If you encounter issues starting Wings at this point, run the following command to start Wings directly and check\nfor any specific error output.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("sudo wings --debug\n")])])])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[22],{254:function(e,t,s){e.exports=s.p+"assets/img/wings_configuration_example.9f3fdd0b.png"},332:function(e,t,s){"use strict";s.r(t);var a=s(15),n=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"migrating-to-wings"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#migrating-to-wings"}},[e._v("#")]),e._v(" Migrating to Wings")]),e._v(" "),t("p",[e._v("This guide is for people looking to migrate from the old Node.JS daemon to Wings. Please see the\n"),t("RouterLink",{attrs:{to:"/wings/1.0/installing.html"}},[e._v("install guide")]),e._v(" if you are trying to install Wings for the first time on\na new node.")],1),e._v(" "),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("Panel Version Requirement")]),e._v(" "),t("p",[e._v("You "),t("strong",[e._v("must")]),e._v(" be running Pterodactyl Panel 1.X in order to use Wings.")])]),e._v(" "),t("p",[e._v("You'll have a brief offline period as you perform this process, however no running game processes\nwill be affected. Plus, chances are your Panel will be offline (or in maintenance mode) during this\nso your users should not notice anything out of the ordinary.")]),e._v(" "),t("h2",{attrs:{id:"install-wings"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#install-wings"}},[e._v("#")]),e._v(" Install Wings")]),e._v(" "),t("p",[e._v("The first step for installing the daemon is to make sure we have the required directory structure setup. To do so,\nrun the commands below which will create the base directory and download the wings executable.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("mkdir")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-p")]),e._v(" /etc/pterodactyl\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-L")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-o")]),e._v(" /usr/local/bin/wings https://github.com/pterodactyl/wings/releases/latest/download/wings_linux_amd64\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("chmod")]),e._v(" u+x /usr/local/bin/wings\n")])])]),t("h2",{attrs:{id:"copy-new-configuration-file"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#copy-new-configuration-file"}},[e._v("#")]),e._v(" Copy New Configuration File")]),e._v(" "),t("p",[e._v("Once you have installed Wings, you'll need to copy over a new configuration file from the Panel. This file\nis in a new format, and should be easier for you to manage and edit in the future.")]),e._v(" "),t("p",[e._v("Simply copy and paste the code block and paste it into a file called "),t("code",[e._v("config.yml")]),e._v(" within the "),t("code",[e._v("/etc/pterodactyl")]),e._v("\ndirectory and save it.")]),e._v(" "),t("p",[t("img",{attrs:{src:s(254),alt:""}})]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("Please note that any modifications you previously made to the configuration will be lost with this. If you have\nmodifications to our default settings, the best option is to start Wings once with the copied configuration which\nwill then populate all of the other configuration settings.")]),e._v(" "),t("p",[e._v("From there you can make any adjustments as necessary.")])]),e._v(" "),t("h2",{attrs:{id:"remove-old-daemon"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#remove-old-daemon"}},[e._v("#")]),e._v(" Remove Old Daemon")]),e._v(" "),t("p",[e._v("Now that Wings is installed, we need to remove all of the old daemon code from the server since it is not being\nused anymore. To do this, simply execute the following commands — assuming your old daemon is in the default\n"),t("code",[e._v("/srv/daemon")]),e._v(" directory.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Stop the old daemon.")]),e._v("\nsystemctl stop wings\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Delete the entire directory. There is nothing stored in here that we actually need for the")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# purposes of this migration. Remember, server data is stored in /srv/daemon-data.")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("rm")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-rf")]),e._v(" /srv/daemon\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Optionally, remove NodeJS from your system if it was not used for anything else.")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-y")]),e._v(" remove nodejs "),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# or: yum remove nodejs")]),e._v("\n")])])]),t("h3",{attrs:{id:"remove-standalone-sftp"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#remove-standalone-sftp"}},[e._v("#")]),e._v(" Remove Standalone SFTP")]),e._v(" "),t("p",[e._v("If you've used the "),t("RouterLink",{attrs:{to:"/daemon/0.6/standalone_sftp.html"}},[e._v("standalone SFTP server")]),e._v(" with the old daemon, we need to remove it's systemd service as well, as it's no longer needed.\nYou can do so using the following commands.")],1),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# stop and disable the standalone sftp")]),e._v("\nsystemctl disable "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--now")]),e._v(" pterosftp\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# delete the systemd service")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("rm")]),e._v(" /etc/systemd/system/pterosftp.service\n")])])]),t("h2",{attrs:{id:"daemonize-wings"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#daemonize-wings"}},[e._v("#")]),e._v(" Daemonize Wings")]),e._v(" "),t("p",[e._v("You'll then need to edit your existing "),t("code",[e._v("systemd")]),e._v(" service file for Wings to point to the new control software. To do\nthis, open "),t("code",[e._v("/etc/systemd/system/wings.service")]),e._v(" and replace the entire contents of the file with the following:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("[Unit]\nDescription=Pterodactyl Wings Daemon\nAfter=docker.service\n\n[Service]\nUser=root\nWorkingDirectory=/etc/pterodactyl\nLimitNOFILE=4096\nPIDFile=/var/run/wings/daemon.pid\nExecStart=/usr/local/bin/wings\nRestart=on-failure\nStartLimitInterval=600\n\n[Install]\nWantedBy=multi-user.target\n")])])]),t("p",[e._v("Then, start wings.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("systemctl daemon-reload\nsystemctl enable --now wings\n")])])]),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("What if Wings doesn't start?")]),e._v(" "),t("p",[e._v("If you encounter issues starting Wings at this point, run the following command to start Wings directly and check\nfor any specific error output.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("sudo wings --debug\n")])])])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/29.173d87c8.js b/assets/js/29.26f1f5b0.js similarity index 68% rename from assets/js/29.173d87c8.js rename to assets/js/29.26f1f5b0.js index 4aad7ef2..af9082e8 100644 --- a/assets/js/29.173d87c8.js +++ b/assets/js/29.26f1f5b0.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[29],{284:function(t,n,s){"use strict";s.r(n);var e=s(15),o=Object(e.a)({},(function(){return(0,this._self._c)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})}),[],!1,null,null,null);n.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[29],{285:function(t,n,s){"use strict";s.r(n);var e=s(15),o=Object(e.a)({},(function(){return(0,this._self._c)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})}),[],!1,null,null,null);n.default=o.exports}}]); \ No newline at end of file diff --git a/assets/js/30.1e9b9a83.js b/assets/js/30.d2985bea.js similarity index 68% rename from assets/js/30.1e9b9a83.js rename to assets/js/30.d2985bea.js index e6da7fa1..f84baa93 100644 --- a/assets/js/30.1e9b9a83.js +++ b/assets/js/30.d2985bea.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[30],{288:function(t,n,s){"use strict";s.r(n);var e=s(15),o=Object(e.a)({},(function(){return(0,this._self._c)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})}),[],!1,null,null,null);n.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[30],{286:function(t,n,s){"use strict";s.r(n);var e=s(15),o=Object(e.a)({},(function(){return(0,this._self._c)("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}})}),[],!1,null,null,null);n.default=o.exports}}]); \ No newline at end of file diff --git a/assets/js/31.1a5025b8.js b/assets/js/31.acd28f7f.js similarity index 88% rename from assets/js/31.1a5025b8.js rename to assets/js/31.acd28f7f.js index 44c07f54..836b6655 100644 --- a/assets/js/31.1a5025b8.js +++ b/assets/js/31.acd28f7f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[31],{285:function(t,e,o){"use strict";o.r(e);var a=o(15),i=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"community-guides-and-tutorials"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#community-guides-and-tutorials"}},[t._v("#")]),t._v(" Community Guides and Tutorials")]),t._v(" "),e("h2",{attrs:{id:"about"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#about"}},[t._v("#")]),t._v(" About")]),t._v(" "),e("p",[t._v("This section of Pterodactyl's site is dedicated to more complex topics, tutorials, and features that we\nfeel are important to share with the community, but do not fit into the theme of our core documentation.")]),t._v(" "),e("p",[t._v("Here you'll find in-depth OS-specific installation guides, advanced network configurations, individual game\nsetup instructions, and so much more.")])])}),[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[31],{284:function(t,e,o){"use strict";o.r(e);var a=o(15),i=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"community-guides-and-tutorials"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#community-guides-and-tutorials"}},[t._v("#")]),t._v(" Community Guides and Tutorials")]),t._v(" "),e("h2",{attrs:{id:"about"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#about"}},[t._v("#")]),t._v(" About")]),t._v(" "),e("p",[t._v("This section of Pterodactyl's site is dedicated to more complex topics, tutorials, and features that we\nfeel are important to share with the community, but do not fit into the theme of our core documentation.")]),t._v(" "),e("p",[t._v("Here you'll find in-depth OS-specific installation guides, advanced network configurations, individual game\nsetup instructions, and so much more.")])])}),[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file diff --git a/assets/js/32.832c5249.js b/assets/js/32.f259a483.js similarity index 99% rename from assets/js/32.832c5249.js rename to assets/js/32.f259a483.js index ba629dd0..710a2027 100644 --- a/assets/js/32.832c5249.js +++ b/assets/js/32.f259a483.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[32],{287:function(e,t,a){"use strict";a.r(t);var s=a(15),n=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"creating-a-custom-docker-image"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#creating-a-custom-docker-image"}},[e._v("#")]),e._v(" Creating a Custom Docker Image")]),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#creating-the-dockerfile"}},[e._v("Creating the Dockerfile")])]),t("li",[t("a",{attrs:{href:"#installing-dependencies"}},[e._v("Installing Dependencies")])]),t("li",[t("a",{attrs:{href:"#creating-a-container-user"}},[e._v("Creating a Container User")])]),t("li",[t("a",{attrs:{href:"#work-directory-entrypoint"}},[e._v("Work Directory & Entrypoint")])]),t("li",[t("a",{attrs:{href:"#entrypoint-script"}},[e._v("Entrypoint Script")])]),t("li",[t("a",{attrs:{href:"#modifying-the-startup-command"}},[e._v("Modifying the Startup Command")])]),t("li",[t("a",{attrs:{href:"#run-the-command"}},[e._v("Run the Command")]),t("ul",[t("li",[t("a",{attrs:{href:"#note"}},[e._v("Note")])])])])])]),t("p"),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("This tutorial uses examples from our "),t("a",{attrs:{href:"https://github.com/pterodactyl/images/tree/java",target:"_blank",rel:"noopener noreferrer"}},[t("code",[e._v("core:java")]),t("OutboundLink")],1),e._v(" docker image,\nwhich can be found on GitHub. This tutorial also assumes some knowledge of "),t("a",{attrs:{href:"https://docker.io/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Docker"),t("OutboundLink")],1),e._v(", we suggest\nreading up if this all looks foreign to you.")])]),e._v(" "),t("h2",{attrs:{id:"creating-the-dockerfile"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#creating-the-dockerfile"}},[e._v("#")]),e._v(" Creating the Dockerfile")]),e._v(" "),t("p",[e._v("The most important part of this process is to create the "),t("a",{attrs:{href:"https://docs.docker.com/engine/reference/builder/",target:"_blank",rel:"noopener noreferrer"}},[t("code",[e._v("Dockerfile")]),t("OutboundLink")],1),e._v("\nthat will be used by the Daemon. Due to heavy restrictions on server containers, you must setup this file in a specific manner.")]),e._v(" "),t("p",[e._v("We try to make use of "),t("a",{attrs:{href:"https://alpinelinux.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("Alpine Linux"),t("OutboundLink")],1),e._v(" as much as possible for our images in order to keep their size down.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# ----------------------------------")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Pterodactyl Core Dockerfile")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Environment: Java")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Minimum Panel Version: 0.6.0")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# ----------------------------------")]),e._v("\nFROM openjdk:8-jdk-alpine\n\nMAINTAINER Pterodactyl Software, "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("support@pterodactyl.io"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v("\n\nRUN apk "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("add")]),e._v(" --no-cache "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--update")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" ca-certificates openssl "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("tar")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("bash")]),e._v(" sqlite fontconfig "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("&&")]),e._v(" adduser --disabled-password "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--home")]),e._v(" /home/container container\n\n"),t("span",{pre:!0,attrs:{class:"token environment constant"}},[e._v("USER")]),e._v(" container\nENV "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t("span",{pre:!0,attrs:{class:"token environment constant"}},[e._v("USER")])]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("container "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t("span",{pre:!0,attrs:{class:"token environment constant"}},[e._v("HOME")])]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("/home/container\n\nWORKDIR /home/container\n\nCOPY ./entrypoint.sh /entrypoint.sh\n\nCMD "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("[")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"/bin/bash"')]),e._v(", "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"/entrypoint.sh"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("]")]),e._v("\n")])])]),t("p",[e._v("Lets walk through the "),t("code",[e._v("Dockerfile")]),e._v(" above. The first thing you'll notice is the "),t("a",{attrs:{href:"https://docs.docker.com/engine/reference/builder/#from",target:"_blank",rel:"noopener noreferrer"}},[t("code",[e._v("FROM")]),t("OutboundLink")],1),e._v(" declaration.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("FROM openjdk:8-jdk-alpine\n")])])]),t("p",[e._v("In this case, we are using "),t("a",{attrs:{href:"https://github.com/docker-library/openjdk",target:"_blank",rel:"noopener noreferrer"}},[t("code",[e._v("openjdk:8-jdk-alpine")]),t("OutboundLink")],1),e._v(" which provides us with Java 8.")]),e._v(" "),t("h2",{attrs:{id:"installing-dependencies"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installing-dependencies"}},[e._v("#")]),e._v(" Installing Dependencies")]),e._v(" "),t("p",[e._v("The next thing we do is install the dependencies we will need using Alpine's package manager: "),t("code",[e._v("apk")]),e._v(". You'll notice some\nspecific flags that keep the container small, including "),t("code",[e._v("--no-cache")]),e._v(", as well as everything being contained in a\nsingle "),t("a",{attrs:{href:"https://docs.docker.com/engine/reference/builder/#run",target:"_blank",rel:"noopener noreferrer"}},[t("code",[e._v("RUN")]),t("OutboundLink")],1),e._v(" block.")]),e._v(" "),t("h2",{attrs:{id:"creating-a-container-user"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#creating-a-container-user"}},[e._v("#")]),e._v(" Creating a Container User")]),e._v(" "),t("p",[e._v("Within this "),t("code",[e._v("RUN")]),e._v(" block, you'll notice the "),t("code",[e._v("useradd")]),e._v(" command.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("adduser "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-D")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-h")]),e._v(" /home/container container\n")])])]),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("All Pterodactyl containers must have a user named "),t("code",[e._v("container")]),e._v(", and the user home "),t("strong",[e._v("must")]),e._v(" be "),t("code",[e._v("/home/container")]),e._v(".")])]),e._v(" "),t("p",[e._v("After we create that user, we then define the default container "),t("a",{attrs:{href:"https://docs.docker.com/engine/reference/builder/#user",target:"_blank",rel:"noopener noreferrer"}},[t("code",[e._v("USER")]),t("OutboundLink")],1),e._v("\nas well as a few "),t("a",{attrs:{href:"https://docs.docker.com/engine/reference/builder/#env",target:"_blank",rel:"noopener noreferrer"}},[t("code",[e._v("ENV")]),t("OutboundLink")],1),e._v(" settings to be applied to things running\nwithin the container.")]),e._v(" "),t("h2",{attrs:{id:"work-directory-entrypoint"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#work-directory-entrypoint"}},[e._v("#")]),e._v(" Work Directory & Entrypoint")]),e._v(" "),t("p",[e._v("One of the last things we do is define a "),t("a",{attrs:{href:"https://docs.docker.com/engine/reference/builder/#workdir",target:"_blank",rel:"noopener noreferrer"}},[t("code",[e._v("WORKDIR")]),t("OutboundLink")],1),e._v(" which\nis where everything else will be executed. The "),t("code",[e._v("WORKDIR")]),e._v(" must be set the "),t("code",[e._v("/home/container")]),e._v(".")]),e._v(" "),t("p",[e._v("Finally, we need to copy our "),t("a",{attrs:{href:"https://docs.docker.com/engine/reference/builder/#entrypoint",target:"_blank",rel:"noopener noreferrer"}},[t("code",[e._v("ENTRYPOINT")]),t("OutboundLink")],1),e._v(" script into\nthe docker image root. This is done using "),t("a",{attrs:{href:"https://docs.docker.com/engine/reference/builder/#copy",target:"_blank",rel:"noopener noreferrer"}},[t("code",[e._v("COPY")]),t("OutboundLink")],1),e._v(", after which\nwe define the command to be used when the container is started using "),t("a",{attrs:{href:"https://docs.docker.com/engine/reference/builder/#cmd",target:"_blank",rel:"noopener noreferrer"}},[t("code",[e._v("CMD")]),t("OutboundLink")],1),e._v(".\nThe "),t("code",[e._v("CMD")]),e._v(" line should always point to the "),t("code",[e._v("entrypoint.sh")]),e._v(" file.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("COPY ./entrypoint.sh /entrypoint.sh\nCMD "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("[")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"/bin/bash"')]),e._v(", "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"/entrypoint.sh"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("]")]),e._v("\n")])])]),t("h2",{attrs:{id:"entrypoint-script"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#entrypoint-script"}},[e._v("#")]),e._v(" Entrypoint Script")]),e._v(" "),t("p",[e._v("In order to complete this "),t("code",[e._v("Dockerfile")]),e._v(", we will need an "),t("code",[e._v("entrypoint.sh")]),e._v(" file which tells Docker how to run this\nspecific server type.")]),e._v(" "),t("p",[e._v("These entrypoint files are actually fairly abstracted, and the Daemon will pass in the start command as an environment\nvariable before processing it and then executing the command.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token shebang important"}},[e._v("#!/bin/bash")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" /home/container\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Output Current Java Version")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("java")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-version")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("## only really needed to show what version is being used. Should be changed for different applications")]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Replace Startup Variables")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("MODIFIED_STARTUP")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token variable"}},[t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("`")]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("eval")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("echo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("$(")]),e._v("echo $"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("STARTUP"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sed")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-e")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'s/{{/${/g'")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-e")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'s/}}/}/g'")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("`")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("echo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('":/home/container$ '),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("${MODIFIED_STARTUP}")]),e._v('"')]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Run the Server")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("${MODIFIED_STARTUP}")]),e._v("\n")])])]),t("p",[e._v("The second command, "),t("code",[e._v("cd /home/container")]),e._v(", simply ensures we are in the correct directory when running the rest of the\ncommands. We then follow that up with "),t("code",[e._v("java -version")]),e._v(" to output this information to end-users, but that is not necessary.")]),e._v(" "),t("h2",{attrs:{id:"modifying-the-startup-command"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#modifying-the-startup-command"}},[e._v("#")]),e._v(" Modifying the Startup Command")]),e._v(" "),t("p",[e._v("The most significant part of this file is the "),t("code",[e._v("MODIFIED_STARTUP")]),e._v(" environment variable. What we are doing in this case\nis parsing the environment "),t("code",[e._v("STARTUP")]),e._v(" that is passed into the container by the Daemon. In most cases, this variable\nlooks something like the example below:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("STARTUP")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"java -Xms128M -Xmx{{SERVER_MEMORY}}M -jar {{SERVER_JARFILE}}"')]),e._v("\n")])])]),t("div",{pre:!0},[t("p",[e._v("You'll notice some placeholders there, specifically "),t("code",[e._v("{{SERVER_MEMORY}}")]),e._v(" and "),t("code",[e._v("{{SERVER_JARFILE}}")]),e._v(". These both refer to\nother environment variables being passed in, and they look something like the example below.")])]),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("SERVER_MEMORY")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1024")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("SERVER_JARFILE")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("server.jar\n")])])]),t("p",[e._v("There are a host of different environment variables, and they change depending on the specific service option\nconfiguration. However, that is not necessarily anything to worry about here.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("MODIFIED_STARTUP")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token variable"}},[t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("`")]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("eval")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("echo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("$(")]),e._v("echo $"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("STARTUP"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sed")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-e")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'s/{{/${/g'")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-e")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'s/}}/}/g'")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("`")])]),e._v("\n")])])]),t("div",{pre:!0},[t("p",[e._v("The command above simply evaluates the "),t("code",[e._v("STARTUP")]),e._v(" environment variable, and then replaces anything surrounded in\ncurly braces "),t("code",[e._v("{{EXAMPLE}}")]),e._v(" with a matching environment variable (such as "),t("code",[e._v("EXAMPLE")]),e._v("). Thus, our "),t("code",[e._v("STARTUP")]),e._v(" command:")])]),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("java")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-Xms128M")]),e._v(" -Xmx"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("SERVER_MEMORY"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("M "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-jar")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("SERVER_JARFILE"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("p",[e._v("Becomes:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("java")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-Xms128M")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-Xmx1024M")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-jar")]),e._v(" server.jar\n")])])]),t("h2",{attrs:{id:"run-the-command"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#run-the-command"}},[e._v("#")]),e._v(" Run the Command")]),e._v(" "),t("p",[e._v("The last step is to run this modified startup command, which is done with the line "),t("code",[e._v("${MODIFIED_STARTUP}")]),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"note"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#note"}},[e._v("#")]),e._v(" Note")]),e._v(" "),t("p",[e._v("Sometimes you may need to change the permissions of the "),t("code",[e._v("entrypoint.sh")]),e._v(" file, on linux you can do this by executing "),t("code",[e._v("chmod +x entrypoint.sh")]),e._v(" in the directory where the file is.")])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[32],{288:function(e,t,a){"use strict";a.r(t);var s=a(15),n=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"creating-a-custom-docker-image"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#creating-a-custom-docker-image"}},[e._v("#")]),e._v(" Creating a Custom Docker Image")]),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#creating-the-dockerfile"}},[e._v("Creating the Dockerfile")])]),t("li",[t("a",{attrs:{href:"#installing-dependencies"}},[e._v("Installing Dependencies")])]),t("li",[t("a",{attrs:{href:"#creating-a-container-user"}},[e._v("Creating a Container User")])]),t("li",[t("a",{attrs:{href:"#work-directory-entrypoint"}},[e._v("Work Directory & Entrypoint")])]),t("li",[t("a",{attrs:{href:"#entrypoint-script"}},[e._v("Entrypoint Script")])]),t("li",[t("a",{attrs:{href:"#modifying-the-startup-command"}},[e._v("Modifying the Startup Command")])]),t("li",[t("a",{attrs:{href:"#run-the-command"}},[e._v("Run the Command")]),t("ul",[t("li",[t("a",{attrs:{href:"#note"}},[e._v("Note")])])])])])]),t("p"),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("This tutorial uses examples from our "),t("a",{attrs:{href:"https://github.com/pterodactyl/images/tree/java",target:"_blank",rel:"noopener noreferrer"}},[t("code",[e._v("core:java")]),t("OutboundLink")],1),e._v(" docker image,\nwhich can be found on GitHub. This tutorial also assumes some knowledge of "),t("a",{attrs:{href:"https://docker.io/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Docker"),t("OutboundLink")],1),e._v(", we suggest\nreading up if this all looks foreign to you.")])]),e._v(" "),t("h2",{attrs:{id:"creating-the-dockerfile"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#creating-the-dockerfile"}},[e._v("#")]),e._v(" Creating the Dockerfile")]),e._v(" "),t("p",[e._v("The most important part of this process is to create the "),t("a",{attrs:{href:"https://docs.docker.com/engine/reference/builder/",target:"_blank",rel:"noopener noreferrer"}},[t("code",[e._v("Dockerfile")]),t("OutboundLink")],1),e._v("\nthat will be used by the Daemon. Due to heavy restrictions on server containers, you must setup this file in a specific manner.")]),e._v(" "),t("p",[e._v("We try to make use of "),t("a",{attrs:{href:"https://alpinelinux.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("Alpine Linux"),t("OutboundLink")],1),e._v(" as much as possible for our images in order to keep their size down.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# ----------------------------------")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Pterodactyl Core Dockerfile")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Environment: Java")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Minimum Panel Version: 0.6.0")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# ----------------------------------")]),e._v("\nFROM openjdk:8-jdk-alpine\n\nMAINTAINER Pterodactyl Software, "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("support@pterodactyl.io"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v("\n\nRUN apk "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("add")]),e._v(" --no-cache "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--update")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" ca-certificates openssl "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("tar")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("bash")]),e._v(" sqlite fontconfig "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("&&")]),e._v(" adduser --disabled-password "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--home")]),e._v(" /home/container container\n\n"),t("span",{pre:!0,attrs:{class:"token environment constant"}},[e._v("USER")]),e._v(" container\nENV "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t("span",{pre:!0,attrs:{class:"token environment constant"}},[e._v("USER")])]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("container "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t("span",{pre:!0,attrs:{class:"token environment constant"}},[e._v("HOME")])]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("/home/container\n\nWORKDIR /home/container\n\nCOPY ./entrypoint.sh /entrypoint.sh\n\nCMD "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("[")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"/bin/bash"')]),e._v(", "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"/entrypoint.sh"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("]")]),e._v("\n")])])]),t("p",[e._v("Lets walk through the "),t("code",[e._v("Dockerfile")]),e._v(" above. The first thing you'll notice is the "),t("a",{attrs:{href:"https://docs.docker.com/engine/reference/builder/#from",target:"_blank",rel:"noopener noreferrer"}},[t("code",[e._v("FROM")]),t("OutboundLink")],1),e._v(" declaration.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("FROM openjdk:8-jdk-alpine\n")])])]),t("p",[e._v("In this case, we are using "),t("a",{attrs:{href:"https://github.com/docker-library/openjdk",target:"_blank",rel:"noopener noreferrer"}},[t("code",[e._v("openjdk:8-jdk-alpine")]),t("OutboundLink")],1),e._v(" which provides us with Java 8.")]),e._v(" "),t("h2",{attrs:{id:"installing-dependencies"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installing-dependencies"}},[e._v("#")]),e._v(" Installing Dependencies")]),e._v(" "),t("p",[e._v("The next thing we do is install the dependencies we will need using Alpine's package manager: "),t("code",[e._v("apk")]),e._v(". You'll notice some\nspecific flags that keep the container small, including "),t("code",[e._v("--no-cache")]),e._v(", as well as everything being contained in a\nsingle "),t("a",{attrs:{href:"https://docs.docker.com/engine/reference/builder/#run",target:"_blank",rel:"noopener noreferrer"}},[t("code",[e._v("RUN")]),t("OutboundLink")],1),e._v(" block.")]),e._v(" "),t("h2",{attrs:{id:"creating-a-container-user"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#creating-a-container-user"}},[e._v("#")]),e._v(" Creating a Container User")]),e._v(" "),t("p",[e._v("Within this "),t("code",[e._v("RUN")]),e._v(" block, you'll notice the "),t("code",[e._v("useradd")]),e._v(" command.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("adduser "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-D")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-h")]),e._v(" /home/container container\n")])])]),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("All Pterodactyl containers must have a user named "),t("code",[e._v("container")]),e._v(", and the user home "),t("strong",[e._v("must")]),e._v(" be "),t("code",[e._v("/home/container")]),e._v(".")])]),e._v(" "),t("p",[e._v("After we create that user, we then define the default container "),t("a",{attrs:{href:"https://docs.docker.com/engine/reference/builder/#user",target:"_blank",rel:"noopener noreferrer"}},[t("code",[e._v("USER")]),t("OutboundLink")],1),e._v("\nas well as a few "),t("a",{attrs:{href:"https://docs.docker.com/engine/reference/builder/#env",target:"_blank",rel:"noopener noreferrer"}},[t("code",[e._v("ENV")]),t("OutboundLink")],1),e._v(" settings to be applied to things running\nwithin the container.")]),e._v(" "),t("h2",{attrs:{id:"work-directory-entrypoint"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#work-directory-entrypoint"}},[e._v("#")]),e._v(" Work Directory & Entrypoint")]),e._v(" "),t("p",[e._v("One of the last things we do is define a "),t("a",{attrs:{href:"https://docs.docker.com/engine/reference/builder/#workdir",target:"_blank",rel:"noopener noreferrer"}},[t("code",[e._v("WORKDIR")]),t("OutboundLink")],1),e._v(" which\nis where everything else will be executed. The "),t("code",[e._v("WORKDIR")]),e._v(" must be set the "),t("code",[e._v("/home/container")]),e._v(".")]),e._v(" "),t("p",[e._v("Finally, we need to copy our "),t("a",{attrs:{href:"https://docs.docker.com/engine/reference/builder/#entrypoint",target:"_blank",rel:"noopener noreferrer"}},[t("code",[e._v("ENTRYPOINT")]),t("OutboundLink")],1),e._v(" script into\nthe docker image root. This is done using "),t("a",{attrs:{href:"https://docs.docker.com/engine/reference/builder/#copy",target:"_blank",rel:"noopener noreferrer"}},[t("code",[e._v("COPY")]),t("OutboundLink")],1),e._v(", after which\nwe define the command to be used when the container is started using "),t("a",{attrs:{href:"https://docs.docker.com/engine/reference/builder/#cmd",target:"_blank",rel:"noopener noreferrer"}},[t("code",[e._v("CMD")]),t("OutboundLink")],1),e._v(".\nThe "),t("code",[e._v("CMD")]),e._v(" line should always point to the "),t("code",[e._v("entrypoint.sh")]),e._v(" file.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("COPY ./entrypoint.sh /entrypoint.sh\nCMD "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("[")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"/bin/bash"')]),e._v(", "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"/entrypoint.sh"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("]")]),e._v("\n")])])]),t("h2",{attrs:{id:"entrypoint-script"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#entrypoint-script"}},[e._v("#")]),e._v(" Entrypoint Script")]),e._v(" "),t("p",[e._v("In order to complete this "),t("code",[e._v("Dockerfile")]),e._v(", we will need an "),t("code",[e._v("entrypoint.sh")]),e._v(" file which tells Docker how to run this\nspecific server type.")]),e._v(" "),t("p",[e._v("These entrypoint files are actually fairly abstracted, and the Daemon will pass in the start command as an environment\nvariable before processing it and then executing the command.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token shebang important"}},[e._v("#!/bin/bash")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" /home/container\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Output Current Java Version")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("java")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-version")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("## only really needed to show what version is being used. Should be changed for different applications")]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Replace Startup Variables")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("MODIFIED_STARTUP")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token variable"}},[t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("`")]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("eval")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("echo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("$(")]),e._v("echo $"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("STARTUP"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sed")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-e")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'s/{{/${/g'")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-e")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'s/}}/}/g'")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("`")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("echo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('":/home/container$ '),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("${MODIFIED_STARTUP}")]),e._v('"')]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Run the Server")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("${MODIFIED_STARTUP}")]),e._v("\n")])])]),t("p",[e._v("The second command, "),t("code",[e._v("cd /home/container")]),e._v(", simply ensures we are in the correct directory when running the rest of the\ncommands. We then follow that up with "),t("code",[e._v("java -version")]),e._v(" to output this information to end-users, but that is not necessary.")]),e._v(" "),t("h2",{attrs:{id:"modifying-the-startup-command"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#modifying-the-startup-command"}},[e._v("#")]),e._v(" Modifying the Startup Command")]),e._v(" "),t("p",[e._v("The most significant part of this file is the "),t("code",[e._v("MODIFIED_STARTUP")]),e._v(" environment variable. What we are doing in this case\nis parsing the environment "),t("code",[e._v("STARTUP")]),e._v(" that is passed into the container by the Daemon. In most cases, this variable\nlooks something like the example below:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("STARTUP")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"java -Xms128M -Xmx{{SERVER_MEMORY}}M -jar {{SERVER_JARFILE}}"')]),e._v("\n")])])]),t("div",{pre:!0},[t("p",[e._v("You'll notice some placeholders there, specifically "),t("code",[e._v("{{SERVER_MEMORY}}")]),e._v(" and "),t("code",[e._v("{{SERVER_JARFILE}}")]),e._v(". These both refer to\nother environment variables being passed in, and they look something like the example below.")])]),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("SERVER_MEMORY")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1024")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("SERVER_JARFILE")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("server.jar\n")])])]),t("p",[e._v("There are a host of different environment variables, and they change depending on the specific service option\nconfiguration. However, that is not necessarily anything to worry about here.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("MODIFIED_STARTUP")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token variable"}},[t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("`")]),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("eval")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("echo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("$(")]),e._v("echo $"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("STARTUP"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sed")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-e")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'s/{{/${/g'")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-e")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'s/}}/}/g'")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("`")])]),e._v("\n")])])]),t("div",{pre:!0},[t("p",[e._v("The command above simply evaluates the "),t("code",[e._v("STARTUP")]),e._v(" environment variable, and then replaces anything surrounded in\ncurly braces "),t("code",[e._v("{{EXAMPLE}}")]),e._v(" with a matching environment variable (such as "),t("code",[e._v("EXAMPLE")]),e._v("). Thus, our "),t("code",[e._v("STARTUP")]),e._v(" command:")])]),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("java")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-Xms128M")]),e._v(" -Xmx"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("SERVER_MEMORY"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("M "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-jar")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("SERVER_JARFILE"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("p",[e._v("Becomes:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("java")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-Xms128M")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-Xmx1024M")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-jar")]),e._v(" server.jar\n")])])]),t("h2",{attrs:{id:"run-the-command"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#run-the-command"}},[e._v("#")]),e._v(" Run the Command")]),e._v(" "),t("p",[e._v("The last step is to run this modified startup command, which is done with the line "),t("code",[e._v("${MODIFIED_STARTUP}")]),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"note"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#note"}},[e._v("#")]),e._v(" Note")]),e._v(" "),t("p",[e._v("Sometimes you may need to change the permissions of the "),t("code",[e._v("entrypoint.sh")]),e._v(" file, on linux you can do this by executing "),t("code",[e._v("chmod +x entrypoint.sh")]),e._v(" in the directory where the file is.")])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/33.940dfd44.js b/assets/js/33.7c770712.js similarity index 98% rename from assets/js/33.940dfd44.js rename to assets/js/33.7c770712.js index 54b92357..0e874f12 100644 --- a/assets/js/33.940dfd44.js +++ b/assets/js/33.7c770712.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[33],{289:function(s,a,e){"use strict";e.r(a);var t=e(15),n=Object(t.a)({},(function(){var s=this,a=s._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":s.$parent.slotKey}},[a("h1",{attrs:{id:"building-panel-assets"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#building-panel-assets"}},[s._v("#")]),s._v(" Building Panel Assets")]),s._v(" "),a("div",{staticClass:"custom-block warning"},[a("p",{staticClass:"custom-block-title"},[s._v("WARNING")]),s._v(" "),a("p",[s._v("Do "),a("strong",[s._v("not")]),s._v(" run the following steps on your production nodes.")])]),s._v(" "),a("p",[s._v("Instructions on how to build the panel are also available in the "),a("a",{attrs:{href:"https://github.com/pterodactyl/panel/blob/1.0-develop/BUILDING.md",target:"_blank",rel:"noopener noreferrer"}},[s._v("BUILDING.md"),a("OutboundLink")],1),s._v(" file.")]),s._v(" "),a("p",[s._v("The frontend of the Panel is built with React. Any changes to the source files require to recompile it.\nThis also applies to style sheets. The following sections explain how to do so.")]),s._v(" "),a("h2",{attrs:{id:"install-dependencies"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#install-dependencies"}},[s._v("#")]),s._v(" Install Dependencies")]),s._v(" "),a("p",[s._v("The following commands will install the necessary dependencies for building the Panel assets.")]),s._v(" "),a("p",[s._v("The build tools require NodeJS, yarn is used as the package manager.")]),s._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("# Ubuntu/Debian")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("curl")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[s._v("-sL")]),s._v(" https://deb.nodesource.com/setup_16.x "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("|")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("sudo")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[s._v("-E")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("bash")]),s._v(" -\n"),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("sudo")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("apt")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("install")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[s._v("-y")]),s._v(" nodejs\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("# CentOS")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("curl")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[s._v("-sL")]),s._v(" https://rpm.nodesource.com/setup_16.x "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("|")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("sudo")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[s._v("-E")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("bash")]),s._v(" -\n"),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("sudo")]),s._v(" yum "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("install")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[s._v("-y")]),s._v(" nodejs "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("yarn")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("# CentOS 7")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("sudo")]),s._v(" dnf "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("install")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[s._v("-y")]),s._v(" nodejs "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("yarn")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("# CentOS 8, Rocky Linux 8, AlmaLinux 8")]),s._v("\n")])])]),a("p",[s._v("Install required javascript packages.")]),s._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[s._v("npm")]),s._v(" i "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[s._v("-g")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("yarn")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("# Install Yarn")]),s._v("\n\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[s._v("cd")]),s._v(" /var/www/pterodactyl\n"),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("yarn")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("# Installs panel build dependencies")]),s._v("\n")])])]),a("h2",{attrs:{id:"build-panel-assets"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#build-panel-assets"}},[s._v("#")]),s._v(" Build Panel Assets")]),s._v(" "),a("p",[s._v("The following command will rebuild the Panel frontend. For NodeJS version 17 and above, you must enable the "),a("code",[s._v("--openssl-legacy-provider")]),s._v(" option before building.")]),s._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[s._v("cd")]),s._v(" /var/www/pterodactyl\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[s._v("export")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("NODE_OPTIONS")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),s._v("--openssl-legacy-provider "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("# for NodeJS v17+")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("yarn")]),s._v(" build:production "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("# Build panel")]),s._v("\n")])])]),a("p",[s._v("You can use command "),a("code",[s._v("yarn run watch")]),s._v(" to view the progress of your changes in almost real-time for easier development. Once you're satisfied with your changes build the panel using the previously mentioned "),a("code",[s._v("yarn build:production")]),s._v(" command.")])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[33],{290:function(s,a,e){"use strict";e.r(a);var t=e(15),n=Object(t.a)({},(function(){var s=this,a=s._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":s.$parent.slotKey}},[a("h1",{attrs:{id:"building-panel-assets"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#building-panel-assets"}},[s._v("#")]),s._v(" Building Panel Assets")]),s._v(" "),a("div",{staticClass:"custom-block warning"},[a("p",{staticClass:"custom-block-title"},[s._v("WARNING")]),s._v(" "),a("p",[s._v("Do "),a("strong",[s._v("not")]),s._v(" run the following steps on your production nodes.")])]),s._v(" "),a("p",[s._v("Instructions on how to build the panel are also available in the "),a("a",{attrs:{href:"https://github.com/pterodactyl/panel/blob/1.0-develop/BUILDING.md",target:"_blank",rel:"noopener noreferrer"}},[s._v("BUILDING.md"),a("OutboundLink")],1),s._v(" file.")]),s._v(" "),a("p",[s._v("The frontend of the Panel is built with React. Any changes to the source files require to recompile it.\nThis also applies to style sheets. The following sections explain how to do so.")]),s._v(" "),a("h2",{attrs:{id:"install-dependencies"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#install-dependencies"}},[s._v("#")]),s._v(" Install Dependencies")]),s._v(" "),a("p",[s._v("The following commands will install the necessary dependencies for building the Panel assets.")]),s._v(" "),a("p",[s._v("The build tools require NodeJS, yarn is used as the package manager.")]),s._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("# Ubuntu/Debian")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("curl")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[s._v("-sL")]),s._v(" https://deb.nodesource.com/setup_16.x "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("|")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("sudo")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[s._v("-E")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("bash")]),s._v(" -\n"),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("sudo")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("apt")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("install")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[s._v("-y")]),s._v(" nodejs\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("# CentOS")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("curl")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[s._v("-sL")]),s._v(" https://rpm.nodesource.com/setup_16.x "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("|")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("sudo")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[s._v("-E")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("bash")]),s._v(" -\n"),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("sudo")]),s._v(" yum "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("install")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[s._v("-y")]),s._v(" nodejs "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("yarn")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("# CentOS 7")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("sudo")]),s._v(" dnf "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("install")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[s._v("-y")]),s._v(" nodejs "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("yarn")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("# CentOS 8, Rocky Linux 8, AlmaLinux 8")]),s._v("\n")])])]),a("p",[s._v("Install required javascript packages.")]),s._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[s._v("npm")]),s._v(" i "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[s._v("-g")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("yarn")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("# Install Yarn")]),s._v("\n\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[s._v("cd")]),s._v(" /var/www/pterodactyl\n"),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("yarn")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("# Installs panel build dependencies")]),s._v("\n")])])]),a("h2",{attrs:{id:"build-panel-assets"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#build-panel-assets"}},[s._v("#")]),s._v(" Build Panel Assets")]),s._v(" "),a("p",[s._v("The following command will rebuild the Panel frontend. For NodeJS version 17 and above, you must enable the "),a("code",[s._v("--openssl-legacy-provider")]),s._v(" option before building.")]),s._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[s._v("cd")]),s._v(" /var/www/pterodactyl\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[s._v("export")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("NODE_OPTIONS")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),s._v("--openssl-legacy-provider "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("# for NodeJS v17+")]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("yarn")]),s._v(" build:production "),a("span",{pre:!0,attrs:{class:"token comment"}},[s._v("# Build panel")]),s._v("\n")])])]),a("p",[s._v("You can use command "),a("code",[s._v("yarn run watch")]),s._v(" to view the progress of your changes in almost real-time for easier development. Once you're satisfied with your changes build the panel using the previously mentioned "),a("code",[s._v("yarn build:production")]),s._v(" command.")])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/34.49d78ff7.js b/assets/js/34.e93e5695.js similarity index 98% rename from assets/js/34.49d78ff7.js rename to assets/js/34.e93e5695.js index 2983d6f6..d55e80bd 100644 --- a/assets/js/34.49d78ff7.js +++ b/assets/js/34.e93e5695.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[34],{290:function(t,s,e){"use strict";e.r(s);var a=e(15),i=Object(a.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"building-wings"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#building-wings"}},[t._v("#")]),t._v(" Building Wings")]),t._v(" "),s("div",{staticClass:"custom-block warning"},[s("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),s("p",[t._v("Do "),s("strong",[t._v("not")]),t._v(" run the following steps on your production nodes.")])]),t._v(" "),s("p",[t._v("Wings is written in Go. This makes it very easy to modify and compile it on your own, and distribute your own binaries.\nThis guide will cover the steps necessary to build it yourself.")]),t._v(" "),s("p",[t._v("It will not, however, explain where to look for certain aspects of Wings and which changes are necessary to achieve specific results. Knowledge of the Go language is required if you want to modify it.")]),t._v(" "),s("p",[t._v("Building Go programs is very easy, and the same also applies to Wings. Go is cross-platform, but Wings only supports Linux at the moment. The easiest way to compile it for Linux is to run the commands on a Linux machine.")]),t._v(" "),s("h2",{attrs:{id:"build-requirements"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#build-requirements"}},[t._v("#")]),t._v(" Build Requirements")]),t._v(" "),s("p",[t._v("An up to date version of Go is required to compile Wings. The minimum version can be found at the top of the "),s("a",{attrs:{href:"https://github.com/pterodactyl/wings/blob/develop/go.mod",target:"_blank",rel:"noopener noreferrer"}},[t._v("go.mod"),s("OutboundLink")],1),t._v(" file. See the "),s("a",{attrs:{href:"https://golang.org/doc/install",target:"_blank",rel:"noopener noreferrer"}},[t._v("official instructions"),s("OutboundLink")],1),t._v(" for help with installing Go.")]),t._v(" "),s("h2",{attrs:{id:"building"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#building"}},[t._v("#")]),t._v(" Building")]),t._v(" "),s("p",[t._v("Execute the following command in your local clone of the repository to compile Wings into a binary.")]),t._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[t._v("go build\n")])])]),s("p",[t._v("You should now have a "),s("code",[t._v("wings")]),t._v(" binary file in your wings directory.")]),t._v(" "),s("h2",{attrs:{id:"install-the-new-binary"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#install-the-new-binary"}},[t._v("#")]),t._v(" Install the new binary")]),t._v(" "),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("Root required")]),t._v(" "),s("p",[t._v("Some the following commands require root permissions. Prepend them with "),s("code",[t._v("sudo")]),t._v(" if you are not logged in as root.")])]),t._v(" "),s("ol",[s("li",[t._v("Backup the current installation of wings")])]),t._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[s("span",{pre:!0,attrs:{class:"token function"}},[t._v("mv")]),t._v(" /usr/local/bin/wings /usr/local/bin/wings-backup\n")])])]),s("ol",{attrs:{start:"2"}},[s("li",[t._v("Place the new binary in "),s("code",[t._v("/usr/local/bin")])])]),t._v(" "),s("div",{staticClass:"language- extra-class"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v("cp ./wings /usr/local/bin\n")])])]),s("ol",{attrs:{start:"3"}},[s("li",[t._v("Restart wings")])]),t._v(" "),s("div",{staticClass:"language- extra-class"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v("systemctl restart wings\n")])])]),s("h2",{attrs:{id:"troubleshooting"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#troubleshooting"}},[t._v("#")]),t._v(" Troubleshooting")]),t._v(" "),s("p",[t._v("If the wings service does not start properly, you can try to start Wings in a console window.")]),t._v(" "),s("div",{staticClass:"language- extra-class"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v("wings --debug\n")])])]),s("p",[t._v("Remember to stop the system service before, and re-enable it afterwards.")]),t._v(" "),s("div",{staticClass:"language- extra-class"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v("systemctl stop wings\n\nsystemctl start wings\n")])])])])}),[],!1,null,null,null);s.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[34],{291:function(t,s,e){"use strict";e.r(s);var a=e(15),i=Object(a.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"building-wings"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#building-wings"}},[t._v("#")]),t._v(" Building Wings")]),t._v(" "),s("div",{staticClass:"custom-block warning"},[s("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),s("p",[t._v("Do "),s("strong",[t._v("not")]),t._v(" run the following steps on your production nodes.")])]),t._v(" "),s("p",[t._v("Wings is written in Go. This makes it very easy to modify and compile it on your own, and distribute your own binaries.\nThis guide will cover the steps necessary to build it yourself.")]),t._v(" "),s("p",[t._v("It will not, however, explain where to look for certain aspects of Wings and which changes are necessary to achieve specific results. Knowledge of the Go language is required if you want to modify it.")]),t._v(" "),s("p",[t._v("Building Go programs is very easy, and the same also applies to Wings. Go is cross-platform, but Wings only supports Linux at the moment. The easiest way to compile it for Linux is to run the commands on a Linux machine.")]),t._v(" "),s("h2",{attrs:{id:"build-requirements"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#build-requirements"}},[t._v("#")]),t._v(" Build Requirements")]),t._v(" "),s("p",[t._v("An up to date version of Go is required to compile Wings. The minimum version can be found at the top of the "),s("a",{attrs:{href:"https://github.com/pterodactyl/wings/blob/develop/go.mod",target:"_blank",rel:"noopener noreferrer"}},[t._v("go.mod"),s("OutboundLink")],1),t._v(" file. See the "),s("a",{attrs:{href:"https://golang.org/doc/install",target:"_blank",rel:"noopener noreferrer"}},[t._v("official instructions"),s("OutboundLink")],1),t._v(" for help with installing Go.")]),t._v(" "),s("h2",{attrs:{id:"building"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#building"}},[t._v("#")]),t._v(" Building")]),t._v(" "),s("p",[t._v("Execute the following command in your local clone of the repository to compile Wings into a binary.")]),t._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[t._v("go build\n")])])]),s("p",[t._v("You should now have a "),s("code",[t._v("wings")]),t._v(" binary file in your wings directory.")]),t._v(" "),s("h2",{attrs:{id:"install-the-new-binary"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#install-the-new-binary"}},[t._v("#")]),t._v(" Install the new binary")]),t._v(" "),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("Root required")]),t._v(" "),s("p",[t._v("Some the following commands require root permissions. Prepend them with "),s("code",[t._v("sudo")]),t._v(" if you are not logged in as root.")])]),t._v(" "),s("ol",[s("li",[t._v("Backup the current installation of wings")])]),t._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[s("span",{pre:!0,attrs:{class:"token function"}},[t._v("mv")]),t._v(" /usr/local/bin/wings /usr/local/bin/wings-backup\n")])])]),s("ol",{attrs:{start:"2"}},[s("li",[t._v("Place the new binary in "),s("code",[t._v("/usr/local/bin")])])]),t._v(" "),s("div",{staticClass:"language- extra-class"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v("cp ./wings /usr/local/bin\n")])])]),s("ol",{attrs:{start:"3"}},[s("li",[t._v("Restart wings")])]),t._v(" "),s("div",{staticClass:"language- extra-class"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v("systemctl restart wings\n")])])]),s("h2",{attrs:{id:"troubleshooting"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#troubleshooting"}},[t._v("#")]),t._v(" Troubleshooting")]),t._v(" "),s("p",[t._v("If the wings service does not start properly, you can try to start Wings in a console window.")]),t._v(" "),s("div",{staticClass:"language- extra-class"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v("wings --debug\n")])])]),s("p",[t._v("Remember to stop the system service before, and re-enable it afterwards.")]),t._v(" "),s("div",{staticClass:"language- extra-class"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v("systemctl stop wings\n\nsystemctl start wings\n")])])])])}),[],!1,null,null,null);s.default=i.exports}}]); \ No newline at end of file diff --git a/assets/js/35.28ffe57a.js b/assets/js/35.a04be06d.js similarity index 99% rename from assets/js/35.28ffe57a.js rename to assets/js/35.a04be06d.js index a52aa73f..255c4708 100644 --- a/assets/js/35.28ffe57a.js +++ b/assets/js/35.a04be06d.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[35],{292:function(a,t,s){"use strict";s.r(t);var e=s(15),n=Object(e.a)({},(function(){var a=this,t=a._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[t("h1",{attrs:{id:"centos-7"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#centos-7"}},[a._v("#")]),a._v(" CentOS 7")]),a._v(" "),t("p",[a._v("This guide provides comprehensive instructions for installing Pterodactyl v1.X on CentOS 7, including all dependencies and SSL configuration.")]),a._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#install-dependencies"}},[a._v("Install Dependencies")]),t("ul",[t("li",[t("a",{attrs:{href:"#selinux-configuration"}},[a._v("SELinux Configuration")])]),t("li",[t("a",{attrs:{href:"#installing-dependencies"}},[a._v("Installing Dependencies")])])])]),t("li",[t("a",{attrs:{href:"#server-configuration"}},[a._v("Server Configuration")]),t("ul",[t("li",[t("a",{attrs:{href:"#php-configuration"}},[a._v("PHP Configuration")])]),t("li",[t("a",{attrs:{href:"#selinux-configuration"}},[a._v("SELinux configuration")])])])]),t("li",[t("a",{attrs:{href:"#installing-the-panel"}},[a._v("Installing the Panel")])])])]),t("p"),a._v(" "),t("h2",{attrs:{id:"install-dependencies"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#install-dependencies"}},[a._v("#")]),a._v(" Install Dependencies")]),a._v(" "),t("h3",{attrs:{id:"selinux-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#selinux-configuration"}},[a._v("#")]),a._v(" SELinux Configuration")]),a._v(" "),t("p",[a._v("If SELinux is enabled (check with "),t("code",[a._v("sestatus")]),a._v("), install the following packages:")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[a._v("yum "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" policycoreutils policycoreutils-python selinux-policy selinux-policy-targeted libselinux-utils setroubleshoot-server setools setools-console mcstrans\n")])])]),t("h3",{attrs:{id:"installing-dependencies"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installing-dependencies"}},[a._v("#")]),a._v(" Installing Dependencies")]),a._v(" "),t("p",[a._v("Run the following commands to install all necessary dependencies:")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Add MariaDB repository")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("tee")]),a._v(" /etc/yum.repos.d/mariadb.repo "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<<")]),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("EOF\n[mariadb]\nname = MariaDB\nbaseurl = http://yum.mariadb.org/10.5/centos7-amd64\ngpgkey = https://yum.mariadb.org/RPM-GPG-KEY-MariaDB\ngpgcheck = 1\nEOF")]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Install EPEL and Remi repositories")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" yum "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" yum "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" https://rpms.remirepo.net/enterprise/remi-release-7.rpm\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Enable PHP 8.3 from Remi")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" yum "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" yum-utils\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" yum-config-manager "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--disable")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'remi-php*'")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" yum-config-manager "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--enable")]),a._v(" remi-php83\n\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" yum update "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Install dependencies")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" yum "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" MariaDB-common MariaDB-server php php-"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("common,fpm,cli,json,mysqlnd,mcrypt,gd,mbstring,pdo,zip,bcmath,dom,opcache"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v(" nginx "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("zip")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("unzip")]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Install Redis")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" yum "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--enablerepo")]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("remi redis\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Start and enable services")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" systemctl "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("enable")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--now")]),a._v(" mariadb nginx redis\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Configure firewall")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" firewall-cmd --add-service"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("http "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--permanent")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" firewall-cmd --add-service"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("https "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--permanent")]),a._v(" \n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" firewall-cmd "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--reload")]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Install Composer")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-sS")]),a._v(" https://getcomposer.org/installer "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" php -- --install-dir"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("/usr/local/bin "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--filename")]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("composer\n")])])]),t("h2",{attrs:{id:"server-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#server-configuration"}},[a._v("#")]),a._v(" Server Configuration")]),a._v(" "),t("h3",{attrs:{id:"php-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#php-configuration"}},[a._v("#")]),a._v(" PHP Configuration")]),a._v(" "),t("p",[a._v("Create a new PHP-FPM configuration file in /etc/php-fpm.d/www-pterodactyl.conf:")]),a._v(" "),t("div",{staticClass:"language-conf extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[a._v("[pterodactyl]\n\nuser = nginx\ngroup = nginx\n\nlisten = /var/run/php-fpm/pterodactyl.sock\nlisten.owner = nginx\nlisten.group = nginx\nlisten.mode = 0750\n\npm = ondemand\npm.max_children = 9\npm.process_idle_timeout = 10s\npm.max_requests = 200\n")])])]),t("p",[a._v("Start and enable PHP-FPM:")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" systemctl "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("enable")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--now")]),a._v(" php-fpm\n")])])]),t("h3",{attrs:{id:"selinux-configuration-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#selinux-configuration-2"}},[a._v("#")]),a._v(" SELinux configuration")]),a._v(" "),t("p",[a._v("The following command will allow nginx to work with redis.")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[a._v("setsebool "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-P")]),a._v(" httpd_can_network_connect "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1")]),a._v("\nsetsebool "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-P")]),a._v(" httpd_execmem "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1")]),a._v("\nsetsebool "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-P")]),a._v(" httpd_unified "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1")]),a._v("\n")])])]),t("h2",{attrs:{id:"installing-the-panel"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installing-the-panel"}},[a._v("#")]),a._v(" Installing the Panel")]),a._v(" "),t("p",[a._v("Excellent, we now have all of the required dependencies installed and configured. From here, follow the "),t("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html#download-files"}},[a._v("official Panel installation documentation")]),a._v(".")],1),a._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[a._v("TIP")]),a._v(" "),t("p",[a._v("You will need to change the fastcgi_pass path in the Nginx configuration to "),t("code",[a._v("/var/run/php-fpm/pterodactyl.sock")])])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[35],{293:function(a,t,s){"use strict";s.r(t);var e=s(15),n=Object(e.a)({},(function(){var a=this,t=a._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[t("h1",{attrs:{id:"centos-7"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#centos-7"}},[a._v("#")]),a._v(" CentOS 7")]),a._v(" "),t("p",[a._v("This guide provides comprehensive instructions for installing Pterodactyl v1.X on CentOS 7, including all dependencies and SSL configuration.")]),a._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#install-dependencies"}},[a._v("Install Dependencies")]),t("ul",[t("li",[t("a",{attrs:{href:"#selinux-configuration"}},[a._v("SELinux Configuration")])]),t("li",[t("a",{attrs:{href:"#installing-dependencies"}},[a._v("Installing Dependencies")])])])]),t("li",[t("a",{attrs:{href:"#server-configuration"}},[a._v("Server Configuration")]),t("ul",[t("li",[t("a",{attrs:{href:"#php-configuration"}},[a._v("PHP Configuration")])]),t("li",[t("a",{attrs:{href:"#selinux-configuration"}},[a._v("SELinux configuration")])])])]),t("li",[t("a",{attrs:{href:"#installing-the-panel"}},[a._v("Installing the Panel")])])])]),t("p"),a._v(" "),t("h2",{attrs:{id:"install-dependencies"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#install-dependencies"}},[a._v("#")]),a._v(" Install Dependencies")]),a._v(" "),t("h3",{attrs:{id:"selinux-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#selinux-configuration"}},[a._v("#")]),a._v(" SELinux Configuration")]),a._v(" "),t("p",[a._v("If SELinux is enabled (check with "),t("code",[a._v("sestatus")]),a._v("), install the following packages:")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[a._v("yum "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" policycoreutils policycoreutils-python selinux-policy selinux-policy-targeted libselinux-utils setroubleshoot-server setools setools-console mcstrans\n")])])]),t("h3",{attrs:{id:"installing-dependencies"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installing-dependencies"}},[a._v("#")]),a._v(" Installing Dependencies")]),a._v(" "),t("p",[a._v("Run the following commands to install all necessary dependencies:")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Add MariaDB repository")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("tee")]),a._v(" /etc/yum.repos.d/mariadb.repo "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<<")]),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("EOF\n[mariadb]\nname = MariaDB\nbaseurl = http://yum.mariadb.org/10.5/centos7-amd64\ngpgkey = https://yum.mariadb.org/RPM-GPG-KEY-MariaDB\ngpgcheck = 1\nEOF")]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Install EPEL and Remi repositories")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" yum "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" yum "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" https://rpms.remirepo.net/enterprise/remi-release-7.rpm\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Enable PHP 8.3 from Remi")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" yum "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" yum-utils\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" yum-config-manager "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--disable")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[a._v("'remi-php*'")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" yum-config-manager "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--enable")]),a._v(" remi-php83\n\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" yum update "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Install dependencies")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" yum "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" MariaDB-common MariaDB-server php php-"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("common,fpm,cli,json,mysqlnd,mcrypt,gd,mbstring,pdo,zip,bcmath,dom,opcache"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v(" nginx "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("zip")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("unzip")]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Install Redis")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" yum "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--enablerepo")]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("remi redis\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Start and enable services")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" systemctl "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("enable")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--now")]),a._v(" mariadb nginx redis\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Configure firewall")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" firewall-cmd --add-service"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("http "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--permanent")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" firewall-cmd --add-service"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("https "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--permanent")]),a._v(" \n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" firewall-cmd "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--reload")]),a._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Install Composer")]),a._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-sS")]),a._v(" https://getcomposer.org/installer "),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" php -- --install-dir"),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("/usr/local/bin "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--filename")]),t("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("composer\n")])])]),t("h2",{attrs:{id:"server-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#server-configuration"}},[a._v("#")]),a._v(" Server Configuration")]),a._v(" "),t("h3",{attrs:{id:"php-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#php-configuration"}},[a._v("#")]),a._v(" PHP Configuration")]),a._v(" "),t("p",[a._v("Create a new PHP-FPM configuration file in /etc/php-fpm.d/www-pterodactyl.conf:")]),a._v(" "),t("div",{staticClass:"language-conf extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[a._v("[pterodactyl]\n\nuser = nginx\ngroup = nginx\n\nlisten = /var/run/php-fpm/pterodactyl.sock\nlisten.owner = nginx\nlisten.group = nginx\nlisten.mode = 0750\n\npm = ondemand\npm.max_children = 9\npm.process_idle_timeout = 10s\npm.max_requests = 200\n")])])]),t("p",[a._v("Start and enable PHP-FPM:")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" systemctl "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("enable")]),a._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--now")]),a._v(" php-fpm\n")])])]),t("h3",{attrs:{id:"selinux-configuration-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#selinux-configuration-2"}},[a._v("#")]),a._v(" SELinux configuration")]),a._v(" "),t("p",[a._v("The following command will allow nginx to work with redis.")]),a._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[a._v("setsebool "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-P")]),a._v(" httpd_can_network_connect "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1")]),a._v("\nsetsebool "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-P")]),a._v(" httpd_execmem "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1")]),a._v("\nsetsebool "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-P")]),a._v(" httpd_unified "),t("span",{pre:!0,attrs:{class:"token number"}},[a._v("1")]),a._v("\n")])])]),t("h2",{attrs:{id:"installing-the-panel"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installing-the-panel"}},[a._v("#")]),a._v(" Installing the Panel")]),a._v(" "),t("p",[a._v("Excellent, we now have all of the required dependencies installed and configured. From here, follow the "),t("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html#download-files"}},[a._v("official Panel installation documentation")]),a._v(".")],1),a._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[a._v("TIP")]),a._v(" "),t("p",[a._v("You will need to change the fastcgi_pass path in the Nginx configuration to "),t("code",[a._v("/var/run/php-fpm/pterodactyl.sock")])])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/36.d63650be.js b/assets/js/36.9e445fd9.js similarity index 99% rename from assets/js/36.d63650be.js rename to assets/js/36.9e445fd9.js index 6b60eb0c..ea34efe7 100644 --- a/assets/js/36.d63650be.js +++ b/assets/js/36.9e445fd9.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[36],{294:function(a,e,s){"use strict";s.r(e);var t=s(15),n=Object(t.a)({},(function(){var a=this,e=a._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[e("h1",{attrs:{id:"enterprise-linux-8-and-fedora-server-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#enterprise-linux-8-and-fedora-server-40"}},[a._v("#")]),a._v(" Enterprise Linux 8 and Fedora Server 40")]),a._v(" "),e("p",[a._v("This guide provides comprehensive instructions for installing Pterodactyl v1.X on CentOS 8, Rocky Linux 8, AlmaLinux 8, and Fedora Server 40, including all dependencies.")]),a._v(" "),e("p"),e("div",{staticClass:"table-of-contents"},[e("ul",[e("li",[e("a",{attrs:{href:"#install-dependencies"}},[a._v("Install Dependencies")]),e("ul",[e("li",[e("a",{attrs:{href:"#selinux-configuration"}},[a._v("SELinux Configuration")])]),e("li",[e("a",{attrs:{href:"#installing-dependencies"}},[a._v("Installing Dependencies")])])])]),e("li",[e("a",{attrs:{href:"#php-configuration"}},[a._v("PHP Configuration")])]),e("li",[e("a",{attrs:{href:"#installing-the-panel"}},[a._v("Installing the Panel")])])])]),e("p"),a._v(" "),e("h2",{attrs:{id:"install-dependencies"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#install-dependencies"}},[a._v("#")]),a._v(" Install Dependencies")]),a._v(" "),e("h3",{attrs:{id:"selinux-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#selinux-configuration"}},[a._v("#")]),a._v(" SELinux Configuration")]),a._v(" "),e("p",[a._v("If SELinux is enabled (check with "),e("code",[a._v("sestatus")]),a._v("), install the following packages:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" dnf "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" policycoreutils selinux-policy selinux-policy-targeted setroubleshoot-server setools setools-console mcstrans\n")])])]),e("h3",{attrs:{id:"installing-dependencies"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#installing-dependencies"}},[a._v("#")]),a._v(" Installing Dependencies")]),a._v(" "),e("p",[a._v("Run the following commands to install all necessary dependencies:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Update system")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" dnf update "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Install EPEL and Remi repository")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" dnf "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" epel-release\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Add additional repositories for PHP (Enterprise Linux 8)")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" dnf "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" https://rpms.remirepo.net/enterprise/remi-release-8.rpm\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Add additional repositories for PHP (Fedora Server 40)")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" dnf "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" https://rpms.remirepo.net/fedora/remi-release-40.rpm\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Enable PHP 8.3 from Remi")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" dnf module reset php\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" dnf module "),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("enable")]),a._v(" php:remi-8.3 "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Install dependencies")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" dnf "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" php php-"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("common,cli,gd,mysql,mbstring,bcmath,xml,fpm,curl,zip"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v(" mariadb mariadb-server nginx redis "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("zip")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("unzip")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("tar")]),a._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Start and enable services")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" systemctl "),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("enable")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--now")]),a._v(" mariadb nginx redis\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Configure firewall")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" firewall-cmd --add-service"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("http "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--permanent")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" firewall-cmd --add-service"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("https "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--permanent")]),a._v(" \n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" firewall-cmd "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--reload")]),a._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Install Composer")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-sS")]),a._v(" https://getcomposer.org/installer "),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" php -- --install-dir"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("/usr/local/bin "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--filename")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("composer\n")])])]),e("h2",{attrs:{id:"php-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#php-configuration"}},[a._v("#")]),a._v(" PHP Configuration")]),a._v(" "),e("p",[a._v("Create a new PHP-FPM configuration file in /etc/php-fpm.d/www-pterodactyl.conf:")]),a._v(" "),e("div",{staticClass:"language-conf extra-class"},[e("pre",{pre:!0,attrs:{class:"language-text"}},[e("code",[a._v("[pterodactyl]\n\nuser = nginx\ngroup = nginx\n\nlisten = /var/run/php-fpm/pterodactyl.sock\nlisten.owner = nginx\nlisten.group = nginx\nlisten.mode = 0750\n\npm = ondemand\npm.max_children = 9\npm.process_idle_timeout = 10s\npm.max_requests = 200\n")])])]),e("p",[a._v("Start and enable PHP-FPM:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" systemctl "),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("enable")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--now")]),a._v(" php-fpm\n")])])]),e("h2",{attrs:{id:"installing-the-panel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#installing-the-panel"}},[a._v("#")]),a._v(" Installing the Panel")]),a._v(" "),e("p",[a._v("Excellent, we now have all of the required dependencies installed and configured. From here, follow the "),e("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html#download-files"}},[a._v("official Panel installation documentation")]),a._v(".")],1),a._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[a._v("TIP")]),a._v(" "),e("p",[a._v("You will need to change the fastcgi_pass path in the Nginx configuration to "),e("code",[a._v("/var/run/php-fpm/pterodactyl.sock")])])])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[36],{297:function(a,e,s){"use strict";s.r(e);var t=s(15),n=Object(t.a)({},(function(){var a=this,e=a._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[e("h1",{attrs:{id:"enterprise-linux-8-and-fedora-server-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#enterprise-linux-8-and-fedora-server-40"}},[a._v("#")]),a._v(" Enterprise Linux 8 and Fedora Server 40")]),a._v(" "),e("p",[a._v("This guide provides comprehensive instructions for installing Pterodactyl v1.X on CentOS 8, Rocky Linux 8, AlmaLinux 8, and Fedora Server 40, including all dependencies.")]),a._v(" "),e("p"),e("div",{staticClass:"table-of-contents"},[e("ul",[e("li",[e("a",{attrs:{href:"#install-dependencies"}},[a._v("Install Dependencies")]),e("ul",[e("li",[e("a",{attrs:{href:"#selinux-configuration"}},[a._v("SELinux Configuration")])]),e("li",[e("a",{attrs:{href:"#installing-dependencies"}},[a._v("Installing Dependencies")])])])]),e("li",[e("a",{attrs:{href:"#php-configuration"}},[a._v("PHP Configuration")])]),e("li",[e("a",{attrs:{href:"#installing-the-panel"}},[a._v("Installing the Panel")])])])]),e("p"),a._v(" "),e("h2",{attrs:{id:"install-dependencies"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#install-dependencies"}},[a._v("#")]),a._v(" Install Dependencies")]),a._v(" "),e("h3",{attrs:{id:"selinux-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#selinux-configuration"}},[a._v("#")]),a._v(" SELinux Configuration")]),a._v(" "),e("p",[a._v("If SELinux is enabled (check with "),e("code",[a._v("sestatus")]),a._v("), install the following packages:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" dnf "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" policycoreutils selinux-policy selinux-policy-targeted setroubleshoot-server setools setools-console mcstrans\n")])])]),e("h3",{attrs:{id:"installing-dependencies"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#installing-dependencies"}},[a._v("#")]),a._v(" Installing Dependencies")]),a._v(" "),e("p",[a._v("Run the following commands to install all necessary dependencies:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Update system")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" dnf update "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Install EPEL and Remi repository")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" dnf "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" epel-release\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Add additional repositories for PHP (Enterprise Linux 8)")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" dnf "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" https://rpms.remirepo.net/enterprise/remi-release-8.rpm\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Add additional repositories for PHP (Fedora Server 40)")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" dnf "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" https://rpms.remirepo.net/fedora/remi-release-40.rpm\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Enable PHP 8.3 from Remi")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" dnf module reset php\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" dnf module "),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("enable")]),a._v(" php:remi-8.3 "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Install dependencies")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" dnf "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" php php-"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("common,cli,gd,mysql,mbstring,bcmath,xml,fpm,curl,zip"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v(" mariadb mariadb-server nginx redis "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("zip")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("unzip")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("tar")]),a._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Start and enable services")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" systemctl "),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("enable")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--now")]),a._v(" mariadb nginx redis\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Configure firewall")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" firewall-cmd --add-service"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("http "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--permanent")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" firewall-cmd --add-service"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("https "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--permanent")]),a._v(" \n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" firewall-cmd "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--reload")]),a._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Install Composer")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-sS")]),a._v(" https://getcomposer.org/installer "),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" php -- --install-dir"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("/usr/local/bin "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--filename")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("composer\n")])])]),e("h2",{attrs:{id:"php-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#php-configuration"}},[a._v("#")]),a._v(" PHP Configuration")]),a._v(" "),e("p",[a._v("Create a new PHP-FPM configuration file in /etc/php-fpm.d/www-pterodactyl.conf:")]),a._v(" "),e("div",{staticClass:"language-conf extra-class"},[e("pre",{pre:!0,attrs:{class:"language-text"}},[e("code",[a._v("[pterodactyl]\n\nuser = nginx\ngroup = nginx\n\nlisten = /var/run/php-fpm/pterodactyl.sock\nlisten.owner = nginx\nlisten.group = nginx\nlisten.mode = 0750\n\npm = ondemand\npm.max_children = 9\npm.process_idle_timeout = 10s\npm.max_requests = 200\n")])])]),e("p",[a._v("Start and enable PHP-FPM:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" systemctl "),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("enable")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--now")]),a._v(" php-fpm\n")])])]),e("h2",{attrs:{id:"installing-the-panel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#installing-the-panel"}},[a._v("#")]),a._v(" Installing the Panel")]),a._v(" "),e("p",[a._v("Excellent, we now have all of the required dependencies installed and configured. From here, follow the "),e("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html#download-files"}},[a._v("official Panel installation documentation")]),a._v(".")],1),a._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[a._v("TIP")]),a._v(" "),e("p",[a._v("You will need to change the fastcgi_pass path in the Nginx configuration to "),e("code",[a._v("/var/run/php-fpm/pterodactyl.sock")])])])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/37.25a34a1f.js b/assets/js/37.c39b55c9.js similarity index 98% rename from assets/js/37.25a34a1f.js rename to assets/js/37.c39b55c9.js index 44f941ad..a9663297 100644 --- a/assets/js/37.25a34a1f.js +++ b/assets/js/37.c39b55c9.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[37],{295:function(a,s,t){"use strict";t.r(s);var e=t(15),n=Object(e.a)({},(function(){var a=this,s=a._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[s("h1",{attrs:{id:"debian-11-12"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#debian-11-12"}},[a._v("#")]),a._v(" Debian 11 & 12")]),a._v(" "),s("p"),s("div",{staticClass:"table-of-contents"},[s("ul",[s("li",[s("a",{attrs:{href:"#dependency-installation"}},[a._v("Dependency Installation")]),s("ul",[s("li",[s("a",{attrs:{href:"#installing-composer"}},[a._v("Installing Composer")])]),s("li",[s("a",{attrs:{href:"#download-files"}},[a._v("Download Files")])])])])])]),s("p"),a._v(" "),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[a._v("TIP")]),a._v(" "),s("p",[a._v("This guide is based off the "),s("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html"}},[a._v("official installation documentation")]),a._v(" but is tailored specifically for Debian 11 and 12.")],1)]),a._v(" "),s("h2",{attrs:{id:"dependency-installation"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#dependency-installation"}},[a._v("#")]),a._v(" Dependency Installation")]),a._v(" "),s("p",[a._v("In this guide, we will install the required dependencies for the Pterodactyl panel. After that, you can follow the official installation documentation.")]),a._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Install necessary packages")]),a._v("\n"),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("apt")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" software-properties-common "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" ca-certificates gnupg2 "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" lsb-release\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Add additional repositories for PHP")]),a._v("\n"),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("echo")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"deb https://packages.sury.org/php/ '),s("span",{pre:!0,attrs:{class:"token variable"}},[s("span",{pre:!0,attrs:{class:"token variable"}},[a._v("$(")]),a._v("lsb_release "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-sc")]),s("span",{pre:!0,attrs:{class:"token variable"}},[a._v(")")])]),a._v(' main"')]),a._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("tee")]),a._v(" /etc/apt/sources.list.d/sury-php.list\n"),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-fsSL")]),a._v(" https://packages.sury.org/php/apt.gpg "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" gpg "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--dearmor")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-o")]),a._v(" /etc/apt/trusted.gpg.d/sury-keyring.gpg\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Add Redis official APT repository")]),a._v("\n"),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-fsSL")]),a._v(" https://packages.redis.io/gpg "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" gpg "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--dearmor")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-o")]),a._v(" /usr/share/keyrings/redis-archive-keyring.gpg\n"),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("echo")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"deb [signed-by=/usr/share/keyrings/redis-archive-keyring.gpg] https://packages.redis.io/deb '),s("span",{pre:!0,attrs:{class:"token variable"}},[s("span",{pre:!0,attrs:{class:"token variable"}},[a._v("$(")]),a._v("lsb_release "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-cs")]),s("span",{pre:!0,attrs:{class:"token variable"}},[a._v(")")])]),a._v(' main"')]),a._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("tee")]),a._v(" /etc/apt/sources.list.d/redis.list\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# MariaDB repo setup script")]),a._v("\n"),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-LsS")]),a._v(" https://r.mariadb.com/downloads/mariadb_repo_setup "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("bash")]),a._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Install Dependencies")]),a._v("\n"),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("apt")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" php8.3 php8.3-"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("common,cli,gd,mysql,mbstring,bcmath,xml,fpm,curl,zip"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v(" mariadb-server nginx "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("tar")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("unzip")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("git")]),a._v(" redis-server\n")])])]),s("h3",{attrs:{id:"installing-composer"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#installing-composer"}},[a._v("#")]),a._v(" Installing Composer")]),a._v(" "),s("p",[a._v("Composer is a dependency manager for PHP that allows us to ship everything you'll need code wise to operate the Panel. You'll need composer installed before continuing in this process.")]),a._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[s("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-sS")]),a._v(" https://getcomposer.org/installer "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" php -- --install-dir"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("/usr/local/bin "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--filename")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("composer\n")])])]),s("h3",{attrs:{id:"download-files"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#download-files"}},[a._v("#")]),a._v(" Download Files")]),a._v(" "),s("p",[a._v("Great, now all of the dependencies have been dealt with. Continue the installation by following the "),s("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html#download-files"}},[a._v("official documentation Download Files section")]),a._v(".")],1)])}),[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[37],{294:function(a,s,t){"use strict";t.r(s);var e=t(15),n=Object(e.a)({},(function(){var a=this,s=a._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[s("h1",{attrs:{id:"debian-11-12"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#debian-11-12"}},[a._v("#")]),a._v(" Debian 11 & 12")]),a._v(" "),s("p"),s("div",{staticClass:"table-of-contents"},[s("ul",[s("li",[s("a",{attrs:{href:"#dependency-installation"}},[a._v("Dependency Installation")]),s("ul",[s("li",[s("a",{attrs:{href:"#installing-composer"}},[a._v("Installing Composer")])]),s("li",[s("a",{attrs:{href:"#download-files"}},[a._v("Download Files")])])])])])]),s("p"),a._v(" "),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[a._v("TIP")]),a._v(" "),s("p",[a._v("This guide is based off the "),s("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html"}},[a._v("official installation documentation")]),a._v(" but is tailored specifically for Debian 11 and 12.")],1)]),a._v(" "),s("h2",{attrs:{id:"dependency-installation"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#dependency-installation"}},[a._v("#")]),a._v(" Dependency Installation")]),a._v(" "),s("p",[a._v("In this guide, we will install the required dependencies for the Pterodactyl panel. After that, you can follow the official installation documentation.")]),a._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Install necessary packages")]),a._v("\n"),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("apt")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" software-properties-common "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" ca-certificates gnupg2 "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" lsb-release\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Add additional repositories for PHP")]),a._v("\n"),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("echo")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"deb https://packages.sury.org/php/ '),s("span",{pre:!0,attrs:{class:"token variable"}},[s("span",{pre:!0,attrs:{class:"token variable"}},[a._v("$(")]),a._v("lsb_release "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-sc")]),s("span",{pre:!0,attrs:{class:"token variable"}},[a._v(")")])]),a._v(' main"')]),a._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("tee")]),a._v(" /etc/apt/sources.list.d/sury-php.list\n"),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-fsSL")]),a._v(" https://packages.sury.org/php/apt.gpg "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" gpg "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--dearmor")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-o")]),a._v(" /etc/apt/trusted.gpg.d/sury-keyring.gpg\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Add Redis official APT repository")]),a._v("\n"),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-fsSL")]),a._v(" https://packages.redis.io/gpg "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" gpg "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--dearmor")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-o")]),a._v(" /usr/share/keyrings/redis-archive-keyring.gpg\n"),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("echo")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"deb [signed-by=/usr/share/keyrings/redis-archive-keyring.gpg] https://packages.redis.io/deb '),s("span",{pre:!0,attrs:{class:"token variable"}},[s("span",{pre:!0,attrs:{class:"token variable"}},[a._v("$(")]),a._v("lsb_release "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-cs")]),s("span",{pre:!0,attrs:{class:"token variable"}},[a._v(")")])]),a._v(' main"')]),a._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("tee")]),a._v(" /etc/apt/sources.list.d/redis.list\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# MariaDB repo setup script")]),a._v("\n"),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-LsS")]),a._v(" https://r.mariadb.com/downloads/mariadb_repo_setup "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("bash")]),a._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Install Dependencies")]),a._v("\n"),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("apt")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" php8.3 php8.3-"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("common,cli,gd,mysql,mbstring,bcmath,xml,fpm,curl,zip"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v(" mariadb-server nginx "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("tar")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("unzip")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("git")]),a._v(" redis-server\n")])])]),s("h3",{attrs:{id:"installing-composer"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#installing-composer"}},[a._v("#")]),a._v(" Installing Composer")]),a._v(" "),s("p",[a._v("Composer is a dependency manager for PHP that allows us to ship everything you'll need code wise to operate the Panel. You'll need composer installed before continuing in this process.")]),a._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[s("span",{pre:!0,attrs:{class:"token function"}},[a._v("curl")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-sS")]),a._v(" https://getcomposer.org/installer "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("sudo")]),a._v(" php -- --install-dir"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("/usr/local/bin "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--filename")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("composer\n")])])]),s("h3",{attrs:{id:"download-files"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#download-files"}},[a._v("#")]),a._v(" Download Files")]),a._v(" "),s("p",[a._v("Great, now all of the dependencies have been dealt with. Continue the installation by following the "),s("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html#download-files"}},[a._v("official documentation Download Files section")]),a._v(".")],1)])}),[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/38.059a51d4.js b/assets/js/38.e108ac1d.js similarity index 96% rename from assets/js/38.059a51d4.js rename to assets/js/38.e108ac1d.js index f3268a8f..2131e2a0 100644 --- a/assets/js/38.059a51d4.js +++ b/assets/js/38.e108ac1d.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[38],{296:function(a,e,t){"use strict";t.r(e);var s=t(15),n=Object(s.a)({},(function(){var a=this,e=a._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[e("h1",{attrs:{id:"centos-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#centos-7"}},[a._v("#")]),a._v(" CentOS 7")]),a._v(" "),e("p",[a._v("This guide provides comprehensive instructions for installing Pterodactyl Wings v1.X on CentOS 7.")]),a._v(" "),e("p"),e("div",{staticClass:"table-of-contents"},[e("ul",[e("li",[e("a",{attrs:{href:"#install-dependencies"}},[a._v("Install Dependencies")])]),e("li",[e("a",{attrs:{href:"#installing-wings"}},[a._v("Installing Wings")])])])]),e("p"),a._v(" "),e("h2",{attrs:{id:"install-dependencies"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#install-dependencies"}},[a._v("#")]),a._v(" Install Dependencies")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("## Install yum tools")]),a._v("\nyum "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" yum-utils device-mapper-persistent-data lvm2\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("## Add the docker repo")]),a._v("\nyum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("## Install docker")]),a._v("\nyum "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" docker-ce docker-ce-cli\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("## Enable docker service")]),a._v("\nsystemctl "),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("enable")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--now")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("docker")]),a._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Configure firewall")]),a._v("\nfirewall-cmd --add-port "),e("span",{pre:!0,attrs:{class:"token number"}},[a._v("8080")]),a._v("/tcp "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--permanent")]),a._v("\nfirewall-cmd --add-port "),e("span",{pre:!0,attrs:{class:"token number"}},[a._v("2022")]),a._v("/tcp "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--permanent")]),a._v("\nfirewall-cmd "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--permanent")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--zone")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("trusted --change-interface"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("docker0\nfirewall-cmd "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--zone")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("trusted --add-masquerade "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--permanent")]),a._v("\nfirewall-cmd "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--reload")]),a._v("\n")])])]),e("h2",{attrs:{id:"installing-wings"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#installing-wings"}},[a._v("#")]),a._v(" Installing Wings")]),a._v(" "),e("p",[a._v("Great, now all of the dependencies and firewall rules have been dealt with. From here follow the "),e("RouterLink",{attrs:{to:"/wings/1.0/installing.html#enabling-swap"}},[a._v("official Wings installation documentation")]),a._v(".")],1)])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[38],{295:function(a,e,t){"use strict";t.r(e);var s=t(15),n=Object(s.a)({},(function(){var a=this,e=a._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[e("h1",{attrs:{id:"centos-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#centos-7"}},[a._v("#")]),a._v(" CentOS 7")]),a._v(" "),e("p",[a._v("This guide provides comprehensive instructions for installing Pterodactyl Wings v1.X on CentOS 7.")]),a._v(" "),e("p"),e("div",{staticClass:"table-of-contents"},[e("ul",[e("li",[e("a",{attrs:{href:"#install-dependencies"}},[a._v("Install Dependencies")])]),e("li",[e("a",{attrs:{href:"#installing-wings"}},[a._v("Installing Wings")])])])]),e("p"),a._v(" "),e("h2",{attrs:{id:"install-dependencies"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#install-dependencies"}},[a._v("#")]),a._v(" Install Dependencies")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("## Install yum tools")]),a._v("\nyum "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" yum-utils device-mapper-persistent-data lvm2\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("## Add the docker repo")]),a._v("\nyum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("## Install docker")]),a._v("\nyum "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("install")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("-y")]),a._v(" docker-ce docker-ce-cli\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("## Enable docker service")]),a._v("\nsystemctl "),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("enable")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--now")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("docker")]),a._v("\n\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[a._v("# Configure firewall")]),a._v("\nfirewall-cmd --add-port "),e("span",{pre:!0,attrs:{class:"token number"}},[a._v("8080")]),a._v("/tcp "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--permanent")]),a._v("\nfirewall-cmd --add-port "),e("span",{pre:!0,attrs:{class:"token number"}},[a._v("2022")]),a._v("/tcp "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--permanent")]),a._v("\nfirewall-cmd "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--permanent")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--zone")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("trusted --change-interface"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("docker0\nfirewall-cmd "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--zone")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("trusted --add-masquerade "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--permanent")]),a._v("\nfirewall-cmd "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[a._v("--reload")]),a._v("\n")])])]),e("h2",{attrs:{id:"installing-wings"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#installing-wings"}},[a._v("#")]),a._v(" Installing Wings")]),a._v(" "),e("p",[a._v("Great, now all of the dependencies and firewall rules have been dealt with. From here follow the "),e("RouterLink",{attrs:{to:"/wings/1.0/installing.html#enabling-swap"}},[a._v("official Wings installation documentation")]),a._v(".")],1)])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/39.9031af87.js b/assets/js/39.867da03c.js similarity index 98% rename from assets/js/39.9031af87.js rename to assets/js/39.867da03c.js index b5b6533c..259e1631 100644 --- a/assets/js/39.9031af87.js +++ b/assets/js/39.867da03c.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[39],{299:function(e,a,t){"use strict";t.r(a);var n=t(15),s=Object(n.a)({},(function(){var e=this,a=e._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"enterprise-linux-8-and-fedora-server-40"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#enterprise-linux-8-and-fedora-server-40"}},[e._v("#")]),e._v(" Enterprise Linux 8 and Fedora Server 40")]),e._v(" "),a("p",[e._v("This guide provides comprehensive instructions for installing Pterodactyl Wings v1.X on CentOS 8, Rocky Linux 8, AlmaLinux 8 and Fedora Server 40.")]),e._v(" "),a("p"),a("div",{staticClass:"table-of-contents"},[a("ul",[a("li",[a("a",{attrs:{href:"#install-dependencies"}},[e._v("Install Dependencies")])]),a("li",[a("a",{attrs:{href:"#installing-wings"}},[e._v("Installing Wings")])])])]),a("p"),e._v(" "),a("h2",{attrs:{id:"install-dependencies"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#install-dependencies"}},[e._v("#")]),e._v(" Install Dependencies")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Install required packages")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" dnf "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-y")]),e._v(" dnf-utils device-mapper-persistent-data lvm2\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Add Docker repository (Enterprise Linux 8)")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" dnf config-manager --add-repo"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("https://download.docker.com/linux/centos/docker-ce.repo\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Add Docker repository (Fedora Server 40)")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" dnf config-manager --add-repo https://download.docker.com/linux/fedora/docker-ce.repo\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("## Install Docker")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" dnf "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-y")]),e._v(" docker-ce docker-ce-cli containerd.io\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("## Enable Docker service")]),e._v("\nsystemctl "),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("enable")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--now")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Configure firewall")]),e._v("\nfirewall-cmd --add-port "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("8080")]),e._v("/tcp "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--permanent")]),e._v("\nfirewall-cmd --add-port "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("2022")]),e._v("/tcp "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--permanent")]),e._v("\nfirewall-cmd "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--permanent")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--zone")]),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("trusted --change-interface"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("pterodactyl0\nfirewall-cmd "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--zone")]),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("trusted --add-masquerade "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--permanent")]),e._v("\nfirewall-cmd "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--reload")]),e._v("\n")])])]),a("h2",{attrs:{id:"installing-wings"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#installing-wings"}},[e._v("#")]),e._v(" Installing Wings")]),e._v(" "),a("p",[e._v("Great, now all of the dependencies and firewall rules have been dealt with. From here follow the "),a("RouterLink",{attrs:{to:"/wings/1.0/installing.html#enabling-swap"}},[e._v("official Wings installation documentation")]),e._v(".")],1),e._v(" "),a("div",{staticClass:"custom-block tip"},[a("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),a("p",[e._v("If you have SELinux enforcement enabled and you are getting AVC denials from your containers, try relocating your Wings data directory from "),a("code",[e._v("/var/lib/pterodactyl")]),e._v(" to "),a("code",[e._v("/var/srv/containers/pterodactyl")]),e._v(". That is where the targeted policy expects Docker to read and write data from.")])])])}),[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[39],{296:function(e,a,t){"use strict";t.r(a);var n=t(15),s=Object(n.a)({},(function(){var e=this,a=e._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"enterprise-linux-8-and-fedora-server-40"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#enterprise-linux-8-and-fedora-server-40"}},[e._v("#")]),e._v(" Enterprise Linux 8 and Fedora Server 40")]),e._v(" "),a("p",[e._v("This guide provides comprehensive instructions for installing Pterodactyl Wings v1.X on CentOS 8, Rocky Linux 8, AlmaLinux 8 and Fedora Server 40.")]),e._v(" "),a("p"),a("div",{staticClass:"table-of-contents"},[a("ul",[a("li",[a("a",{attrs:{href:"#install-dependencies"}},[e._v("Install Dependencies")])]),a("li",[a("a",{attrs:{href:"#installing-wings"}},[e._v("Installing Wings")])])])]),a("p"),e._v(" "),a("h2",{attrs:{id:"install-dependencies"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#install-dependencies"}},[e._v("#")]),e._v(" Install Dependencies")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Install required packages")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" dnf "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-y")]),e._v(" dnf-utils device-mapper-persistent-data lvm2\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Add Docker repository (Enterprise Linux 8)")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" dnf config-manager --add-repo"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("https://download.docker.com/linux/centos/docker-ce.repo\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Add Docker repository (Fedora Server 40)")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" dnf config-manager --add-repo https://download.docker.com/linux/fedora/docker-ce.repo\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("## Install Docker")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" dnf "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-y")]),e._v(" docker-ce docker-ce-cli containerd.io\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("## Enable Docker service")]),e._v("\nsystemctl "),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("enable")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--now")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Configure firewall")]),e._v("\nfirewall-cmd --add-port "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("8080")]),e._v("/tcp "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--permanent")]),e._v("\nfirewall-cmd --add-port "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("2022")]),e._v("/tcp "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--permanent")]),e._v("\nfirewall-cmd "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--permanent")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--zone")]),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("trusted --change-interface"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("pterodactyl0\nfirewall-cmd "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--zone")]),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("trusted --add-masquerade "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--permanent")]),e._v("\nfirewall-cmd "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--reload")]),e._v("\n")])])]),a("h2",{attrs:{id:"installing-wings"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#installing-wings"}},[e._v("#")]),e._v(" Installing Wings")]),e._v(" "),a("p",[e._v("Great, now all of the dependencies and firewall rules have been dealt with. From here follow the "),a("RouterLink",{attrs:{to:"/wings/1.0/installing.html#enabling-swap"}},[e._v("official Wings installation documentation")]),e._v(".")],1),e._v(" "),a("div",{staticClass:"custom-block tip"},[a("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),a("p",[e._v("If you have SELinux enforcement enabled and you are getting AVC denials from your containers, try relocating your Wings data directory from "),a("code",[e._v("/var/lib/pterodactyl")]),e._v(" to "),a("code",[e._v("/var/srv/containers/pterodactyl")]),e._v(". That is where the targeted policy expects Docker to read and write data from.")])])])}),[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file diff --git a/assets/js/40.d5244f41.js b/assets/js/40.34edc760.js similarity index 90% rename from assets/js/40.d5244f41.js rename to assets/js/40.34edc760.js index 3d6d1983..9b2d9a5e 100644 --- a/assets/js/40.d5244f41.js +++ b/assets/js/40.34edc760.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[40],{297:function(t,n,a){"use strict";a.r(n);var i=a(15),s=Object(i.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"debian-11-12"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#debian-11-12"}},[t._v("#")]),t._v(" Debian 11 & 12")]),t._v(" "),n("h2",{attrs:{id:"install"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#install"}},[t._v("#")]),t._v(" Install")]),t._v(" "),n("p",[t._v("There is no additional configuration required for Wings on Debian 11 or 12. You can follow the "),n("RouterLink",{attrs:{to:"/wings/1.0/installing.html"}},[t._v("official Wings install documentation")]),t._v(", which covers Docker installation for Debian.")],1)])}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[40],{299:function(t,n,a){"use strict";a.r(n);var i=a(15),s=Object(i.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"debian-11-12"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#debian-11-12"}},[t._v("#")]),t._v(" Debian 11 & 12")]),t._v(" "),n("h2",{attrs:{id:"install"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#install"}},[t._v("#")]),t._v(" Install")]),t._v(" "),n("p",[t._v("There is no additional configuration required for Wings on Debian 11 or 12. You can follow the "),n("RouterLink",{attrs:{to:"/wings/1.0/installing.html"}},[t._v("official Wings install documentation")]),t._v(", which covers Docker installation for Debian.")],1)])}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file diff --git a/assets/js/42.03a43dda.js b/assets/js/42.ea03a576.js similarity index 99% rename from assets/js/42.03a43dda.js rename to assets/js/42.ea03a576.js index 9ce92b91..51225aaa 100644 --- a/assets/js/42.03a43dda.js +++ b/assets/js/42.ea03a576.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[42],{301:function(t,e,a){"use strict";a.r(e);var s=a(15),o=Object(s.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"additional-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#additional-configuration"}},[t._v("#")]),t._v(" Additional Configuration")]),t._v(" "),e("div",{staticClass:"custom-block danger"},[e("p",{staticClass:"custom-block-title"},[t._v("This Software is Abandoned")]),t._v(" "),e("p",[t._v("This documentation is for "),e("strong",[t._v("abandoned software")]),t._v(" which does not recieve any security updates or support\nfrom the community. This documentation has been left accessible for historial reasons.")]),t._v(" "),e("p",[t._v("You should be installing and using "),e("RouterLink",{attrs:{to:"/wings/1.0/installing.html"}},[t._v("Wings")]),t._v(" in production environments with\n"),e("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html"}},[t._v("Pterodactyl Panel 1.0")]),t._v(".")],1)]),t._v(" "),e("p"),e("div",{staticClass:"table-of-contents"},[e("ul",[e("li",[e("a",{attrs:{href:"#output-throttles"}},[t._v("Output Throttles")])]),e("li",[e("a",{attrs:{href:"#custom-network-interfaces"}},[t._v("Custom Network Interfaces")])]),e("li",[e("a",{attrs:{href:"#private-registries"}},[t._v("Private Registries")])]),e("li",[e("a",{attrs:{href:"#security-policies"}},[t._v("Security Policies")])]),e("li",[e("a",{attrs:{href:"#container-policy"}},[t._v("Container Policy")]),e("ul",[e("li",[e("a",{attrs:{href:"#default-security-opts-array"}},[t._v("Default Security Opts Array")])]),e("li",[e("a",{attrs:{href:"#default-capabilities-drop-array"}},[t._v("Default Capabilities Drop Array")])])])]),e("li",[e("a",{attrs:{href:"#enabling-cloudflare"}},[t._v("Enabling Cloudflare")])])])]),e("p"),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),e("p",[t._v("These are advanced configurations for the daemon. You risk breaking your daemon and making containers un-usable if\nyou modify something incorrectly. Proceed at your own risk, and only if you know what each configuration value does.")])]),t._v(" "),e("p",[t._v("The documentation below uses dot-notated JSON to explain where each setting should live. You will need to manually\nexpand this syntax when adding to the "),e("code",[t._v("core.json")]),t._v(" file for the Daemon. For example, something like "),e("code",[t._v("internals.throttle.enabled")]),t._v("\nwould be expanded to the JSON below.")]),t._v(" "),e("div",{staticClass:"language-json extra-class"},[e("pre",{pre:!0,attrs:{class:"language-json"}},[e("code",[e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token property"}},[t._v('"internals"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token property"}},[t._v('"throttle"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token property"}},[t._v('"enabled"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),e("h2",{attrs:{id:"output-throttles"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#output-throttles"}},[t._v("#")]),t._v(" Output Throttles")]),t._v(" "),e("p",[t._v("There are a few throttle limits built into the Daemon to keep people from causing issues with data volume and CPU usage.\nUnder normal circumstances users should not encounter these limits. You might see the occasional data throttling\nwarning while starting a server or when there is a sudden spike in data output.")]),t._v(" "),e("p",[t._v("If you're seeing more servers than you expected being killed as a result of the Daemon throttler, you can make\nadjustments to the settings below. Please note the configs below are in JSON dot-notation and should be expanded\nout into a normal JSON object.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Setting Path")]),t._v(" "),e("th",[t._v("Default Value")]),t._v(" "),e("th",[t._v("Notes")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("enabled")])]),t._v(" "),e("td",[t._v("true")]),t._v(" "),e("td",[t._v("Determines if the throttle (and associated values below) should be used.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("kill_at_count")])]),t._v(" "),e("td",[t._v("5")]),t._v(" "),e("td",[t._v("The number of warnings that can accumulate for a particular instance before the server process is killed. The decay time below affects how quickly this value is decreased.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("decay")])]),t._v(" "),e("td",[t._v("10")]),t._v(" "),e("td",[t._v("The number of seconds that a server process must go without triggering a data throttle warning before the throttle count begins decreasing. This loop is processed every 5 seconds and will decrement the throttle count by one when the process goes more than this number of seconds without a data throttle occurring.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("bytes")])]),t._v(" "),e("td",[t._v("30720")]),t._v(" "),e("td",[t._v("⚠️ "),e("em",[t._v("(removed in v0.5.5)")]),t._v(" The maximum number of bytes of data that can be output in the defined interval before a warning occurs.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("lines")])]),t._v(" "),e("td",[t._v("1000")]),t._v(" "),e("td",[t._v("⚠️ "),e("em",[t._v("(added in v0.5.6)")]),t._v(" The number of lines that can be output by the server process in the defined check interval time. By default, 5,000 lines in ~500ms results in a server process kill.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("check_interval_ms")])]),t._v(" "),e("td",[t._v("100")]),t._v(" "),e("td",[t._v("The number of milliseconds between the throttle resetting the used bytes or line count.")])])])]),t._v(" "),e("p",[t._v("Please note that all of the settings above are in the "),e("code",[t._v("internals.throttle.X")]),t._v(" path. So, "),e("code",[t._v("enabled")]),t._v(" is actually "),e("code",[t._v("internals.throttle.enabled")]),t._v(".")]),t._v(" "),e("h2",{attrs:{id:"custom-network-interfaces"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#custom-network-interfaces"}},[t._v("#")]),t._v(" Custom Network Interfaces")]),t._v(" "),e("p",[t._v("If for whatever reason you need to modify the network interfaces used for Pterodactyl's local Docker network you\ncan do so by modifying the "),e("code",[t._v("core.json")]),t._v(" file for the daemon. In most cases you'll just be modifying the network\nname to allow your servers to use the host network stack. To do so, just change "),e("code",[t._v("docker.network.name")]),t._v(" to be "),e("code",[t._v("host")]),t._v("\nrather than "),e("code",[t._v("pterodactyl_nw")]),t._v(" as shown below.")]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),e("p",[t._v("While changing to the host network stack does allow servers running on Pterodactyl to have direct access to local\ninterfaces and bind to specific IP addresses (required for some Steam games), it is not recommended on public\ninstallations of Pterodactyl (where you have other users running servers).")]),t._v(" "),e("p",[t._v("Using the "),e("code",[t._v("host")]),t._v(" stack removes many network specific protections afforded by Docker, and will allow server processes\nto access anything on the host, as well as bind to any IP or Port they wish.")])]),t._v(" "),e("div",{staticClass:"custom-block danger"},[e("p",{staticClass:"custom-block-title"},[t._v("DANGER")]),t._v(" "),e("p",[t._v("Any changes to the network after the daemon has been started will require you to remove the docker network and restart the daemon. Any servers on the host need to be stopped before and most likely rebuilt.")]),t._v(" "),e("p",[t._v("The following will stop the daemon, remove the network, and start the daemon again. Run at your own risk."),e("br"),t._v(" "),e("code",[t._v("systemctl stop wings && docker network rm pterodactyl_nw && systemctl start wings")])])]),t._v(" "),e("div",{staticClass:"language-json extra-class"},[e("div",{staticClass:"highlight-lines"},[e("br"),e("br"),e("br"),e("br"),e("div",{staticClass:"highlighted"},[t._v(" ")]),e("br"),e("br"),e("br"),e("br"),e("br"),e("br"),e("br"),e("br"),e("br"),e("br")]),e("pre",{pre:!0,attrs:{class:"language-json"}},[e("code",[e("span",{pre:!0,attrs:{class:"token property"}},[t._v('"docker"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token property"}},[t._v('"socket"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"/var/run/docker.sock"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token property"}},[t._v('"autoupdate_images"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token property"}},[t._v('"network"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"pterodactyl_nw"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token property"}},[t._v('"interfaces"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token property"}},[t._v('"v4"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token property"}},[t._v('"subnet"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"172.18.0.0/16"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token property"}},[t._v('"gateway"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"172.18.0.1"')]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token property"}},[t._v('"interface"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"172.18.0.1"')]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n")])])]),e("h2",{attrs:{id:"private-registries"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#private-registries"}},[t._v("#")]),t._v(" Private Registries")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Setting Path")]),t._v(" "),e("th",[t._v("Default Value")]),t._v(" "),e("th",[t._v("Notes")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("username")])]),t._v(" "),e("td",[e("em",[t._v("none")])]),t._v(" "),e("td",[t._v("The username to use when connecting to the registry.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("password")])]),t._v(" "),e("td",[e("em",[t._v("none")])]),t._v(" "),e("td",[t._v("The password associated with the account.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("images")])]),t._v(" "),e("td",[e("em",[t._v("none")])]),t._v(" "),e("td",[t._v("An array of images that are associated with the private registry.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("auth")])]),t._v(" "),e("td",[e("em",[t._v("none")])]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[e("code",[t._v("email")])]),t._v(" "),e("td",[e("em",[t._v("none")])]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[e("code",[t._v("serveraddress")])]),t._v(" "),e("td",[e("em",[t._v("none")])]),t._v(" "),e("td",[t._v("The address to the server the registry is located on.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("key")])]),t._v(" "),e("td",[e("em",[t._v("none")])]),t._v(" "),e("td",[t._v("A pre-generated base64 encoded authentication string. If provided none of the above options are required.")])])])]),t._v(" "),e("p",[t._v("Please note that all of the settings above are in the "),e("code",[t._v("docker.registry.X")]),t._v(" path. So, "),e("code",[t._v("username")]),t._v(" is actually "),e("code",[t._v("docker.registry.username")]),t._v(".")]),t._v(" "),e("h2",{attrs:{id:"security-policies"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#security-policies"}},[t._v("#")]),t._v(" Security Policies")]),t._v(" "),e("p",[t._v("This daemon ships with a very strict security configuration designed to limit access to the host system, and mitigate\na large range of potential attack vectors. However, some users might need to tweak these settings, or are running on\na private instance and are willing to decrease some of the security measures.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Setting Path")]),t._v(" "),e("th",[t._v("Default Value")]),t._v(" "),e("th",[t._v("Notes")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("ipv6")])]),t._v(" "),e("td",[t._v("true")]),t._v(" "),e("td",[t._v("Set this to false to disable IPv6 networking on the pterodactyl0 interface.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("internal")])]),t._v(" "),e("td",[t._v("false")]),t._v(" "),e("td",[t._v("Set this to true to prevent any external network access to all containers on the pterodactyl0 interface.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("enable_icc")])]),t._v(" "),e("td",[t._v("true")]),t._v(" "),e("td",[t._v("Set this to false to disallow containers to access services running on the host system's non-public IP addresses. Setting this to false does make it impossible to connect (from a container) to MySQL/Redis/etc. running on the host system without using the public IP address.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("enable_ip_masquerade")])]),t._v(" "),e("td",[t._v("true")]),t._v(" "),e("td",[t._v("Set this to false to disable IP Masquerading on the pterodactyl0 interface.")])])])]),t._v(" "),e("p",[t._v("Please note that all of the settings above are in the "),e("code",[t._v("docker.policy.network.X")]),t._v(" path. So, "),e("code",[t._v("ipv6")]),t._v(" is actually "),e("code",[t._v("docker.policy.network.ipv6")]),t._v(".")]),t._v(" "),e("h2",{attrs:{id:"container-policy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#container-policy"}},[t._v("#")]),t._v(" Container Policy")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Setting Path")]),t._v(" "),e("th",[t._v("Default Value")]),t._v(" "),e("th",[t._v("Notes")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("tmpfs")])]),t._v(" "),e("td",[e("code",[t._v("rw,exec,nosuid,size=50M")])]),t._v(" "),e("td",[t._v("These are the arguments used for mounting a "),e("code",[t._v("tmpfs")]),t._v(" directory into containers to allow certain programs to run.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("log_driver")])]),t._v(" "),e("td",[t._v("none")]),t._v(" "),e("td",[t._v("⚠️ This option was "),e("strong",[t._v("removed")]),t._v(" in "),e("code",[t._v("v0.6")]),t._v(" and is forcibly set to "),e("code",[t._v("json-file")]),t._v(". The log driver to use for containers. We default to "),e("code",[t._v("none")]),t._v(" to mitigate a potential DoS attack vector if a server were to spam log output.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("log_opts")])]),t._v(" "),e("td",[t._v("array")]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[e("code",[t._v("log_opts.max_size")])]),t._v(" "),e("td",[e("code",[t._v("5m")])]),t._v(" "),e("td",[t._v("The maximum size of the server output log file created by Docker.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("log_opts.max_files")])]),t._v(" "),e("td",[e("code",[t._v("1")])]),t._v(" "),e("td",[t._v("The maximum number of files that Docker will create with output from the server.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("readonly_root")])]),t._v(" "),e("td",[t._v("true")]),t._v(" "),e("td",[t._v("Determines if the root filesystem of the container should be readonly.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("securityopts")])]),t._v(" "),e("td",[t._v("array")]),t._v(" "),e("td",[t._v("An array of security options to apply to a container. The default array is provided below.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("cap_drop")])]),t._v(" "),e("td",[t._v("array")]),t._v(" "),e("td",[t._v("An array of linux capabilities to drop from the container (in addition to ones "),e("a",{attrs:{href:"https://docs.docker.com/engine/security/security/#linux-kernel-capabilities",target:"_blank",rel:"noopener noreferrer"}},[t._v("dropped by docker already"),e("OutboundLink")],1),t._v(". A listing of the default array is below.")])])])]),t._v(" "),e("p",[t._v("Please note that all of the settings above are in the "),e("code",[t._v("docker.policy.container.X")]),t._v(" path. So, "),e("code",[t._v("tmpfs")]),t._v(" is actually "),e("code",[t._v("docker.policy.container.tmpfs")]),t._v(".")]),t._v(" "),e("h3",{attrs:{id:"default-security-opts-array"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#default-security-opts-array"}},[t._v("#")]),t._v(" Default Security Opts Array")]),t._v(" "),e("div",{staticClass:"language-json extra-class"},[e("pre",{pre:!0,attrs:{class:"language-json"}},[e("code",[e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n 'no-new-privileges'"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n")])])]),e("h3",{attrs:{id:"default-capabilities-drop-array"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#default-capabilities-drop-array"}},[t._v("#")]),t._v(" Default Capabilities Drop Array")]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),e("p",[t._v("Starting with "),e("code",[t._v("v0.6")]),t._v(" of the Daemon, the following previously "),e("em",[t._v("dropped")]),t._v(" capabilities are available in containers: "),e("code",[t._v("chown")]),t._v(", "),e("code",[t._v("kill")]),t._v(", "),e("code",[t._v("setgid")]),t._v(", and "),e("code",[t._v("setuid")]),t._v(".")])]),t._v(" "),e("div",{staticClass:"language-json extra-class"},[e("pre",{pre:!0,attrs:{class:"language-json"}},[e("code",[e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n 'setpcap'"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n 'mknod'"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n 'audit_write'"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n 'net_raw'"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n 'dac_override'"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n 'fowner'"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n 'fsetid'"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n 'net_bind_service'"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n 'sys_chroot'"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n 'setfcap'"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n")])])]),e("h2",{attrs:{id:"enabling-cloudflare"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#enabling-cloudflare"}},[t._v("#")]),t._v(" Enabling Cloudflare")]),t._v(" "),e("p",[t._v("Enabling Cloudflare on the daemon isn't particularly useful since users do not connect directly to the daemon port, and users need an unproxied hostname to access any servers on the node. As a result it's not possible to conceal the IP address of your node machine, but some people want to enable it regardless.")]),t._v(" "),e("p",[t._v("Cloudflare only proxies the default daemon port (8080) when using HTTP. In order to get the daemon to work with Cloudflare when HTTPS is enabled you must change the daemon port to one that Cloudflare will proxy such as 8443. Since Cloudflare only proxies HTTP/HTTPS traffic for non-enterprise plans you cannot proxy the SFTP port.")])])}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[42],{300:function(t,e,a){"use strict";a.r(e);var s=a(15),o=Object(s.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"additional-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#additional-configuration"}},[t._v("#")]),t._v(" Additional Configuration")]),t._v(" "),e("div",{staticClass:"custom-block danger"},[e("p",{staticClass:"custom-block-title"},[t._v("This Software is Abandoned")]),t._v(" "),e("p",[t._v("This documentation is for "),e("strong",[t._v("abandoned software")]),t._v(" which does not recieve any security updates or support\nfrom the community. This documentation has been left accessible for historial reasons.")]),t._v(" "),e("p",[t._v("You should be installing and using "),e("RouterLink",{attrs:{to:"/wings/1.0/installing.html"}},[t._v("Wings")]),t._v(" in production environments with\n"),e("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html"}},[t._v("Pterodactyl Panel 1.0")]),t._v(".")],1)]),t._v(" "),e("p"),e("div",{staticClass:"table-of-contents"},[e("ul",[e("li",[e("a",{attrs:{href:"#output-throttles"}},[t._v("Output Throttles")])]),e("li",[e("a",{attrs:{href:"#custom-network-interfaces"}},[t._v("Custom Network Interfaces")])]),e("li",[e("a",{attrs:{href:"#private-registries"}},[t._v("Private Registries")])]),e("li",[e("a",{attrs:{href:"#security-policies"}},[t._v("Security Policies")])]),e("li",[e("a",{attrs:{href:"#container-policy"}},[t._v("Container Policy")]),e("ul",[e("li",[e("a",{attrs:{href:"#default-security-opts-array"}},[t._v("Default Security Opts Array")])]),e("li",[e("a",{attrs:{href:"#default-capabilities-drop-array"}},[t._v("Default Capabilities Drop Array")])])])]),e("li",[e("a",{attrs:{href:"#enabling-cloudflare"}},[t._v("Enabling Cloudflare")])])])]),e("p"),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),e("p",[t._v("These are advanced configurations for the daemon. You risk breaking your daemon and making containers un-usable if\nyou modify something incorrectly. Proceed at your own risk, and only if you know what each configuration value does.")])]),t._v(" "),e("p",[t._v("The documentation below uses dot-notated JSON to explain where each setting should live. You will need to manually\nexpand this syntax when adding to the "),e("code",[t._v("core.json")]),t._v(" file for the Daemon. For example, something like "),e("code",[t._v("internals.throttle.enabled")]),t._v("\nwould be expanded to the JSON below.")]),t._v(" "),e("div",{staticClass:"language-json extra-class"},[e("pre",{pre:!0,attrs:{class:"language-json"}},[e("code",[e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token property"}},[t._v('"internals"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token property"}},[t._v('"throttle"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token property"}},[t._v('"enabled"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),e("h2",{attrs:{id:"output-throttles"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#output-throttles"}},[t._v("#")]),t._v(" Output Throttles")]),t._v(" "),e("p",[t._v("There are a few throttle limits built into the Daemon to keep people from causing issues with data volume and CPU usage.\nUnder normal circumstances users should not encounter these limits. You might see the occasional data throttling\nwarning while starting a server or when there is a sudden spike in data output.")]),t._v(" "),e("p",[t._v("If you're seeing more servers than you expected being killed as a result of the Daemon throttler, you can make\nadjustments to the settings below. Please note the configs below are in JSON dot-notation and should be expanded\nout into a normal JSON object.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Setting Path")]),t._v(" "),e("th",[t._v("Default Value")]),t._v(" "),e("th",[t._v("Notes")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("enabled")])]),t._v(" "),e("td",[t._v("true")]),t._v(" "),e("td",[t._v("Determines if the throttle (and associated values below) should be used.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("kill_at_count")])]),t._v(" "),e("td",[t._v("5")]),t._v(" "),e("td",[t._v("The number of warnings that can accumulate for a particular instance before the server process is killed. The decay time below affects how quickly this value is decreased.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("decay")])]),t._v(" "),e("td",[t._v("10")]),t._v(" "),e("td",[t._v("The number of seconds that a server process must go without triggering a data throttle warning before the throttle count begins decreasing. This loop is processed every 5 seconds and will decrement the throttle count by one when the process goes more than this number of seconds without a data throttle occurring.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("bytes")])]),t._v(" "),e("td",[t._v("30720")]),t._v(" "),e("td",[t._v("⚠️ "),e("em",[t._v("(removed in v0.5.5)")]),t._v(" The maximum number of bytes of data that can be output in the defined interval before a warning occurs.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("lines")])]),t._v(" "),e("td",[t._v("1000")]),t._v(" "),e("td",[t._v("⚠️ "),e("em",[t._v("(added in v0.5.6)")]),t._v(" The number of lines that can be output by the server process in the defined check interval time. By default, 5,000 lines in ~500ms results in a server process kill.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("check_interval_ms")])]),t._v(" "),e("td",[t._v("100")]),t._v(" "),e("td",[t._v("The number of milliseconds between the throttle resetting the used bytes or line count.")])])])]),t._v(" "),e("p",[t._v("Please note that all of the settings above are in the "),e("code",[t._v("internals.throttle.X")]),t._v(" path. So, "),e("code",[t._v("enabled")]),t._v(" is actually "),e("code",[t._v("internals.throttle.enabled")]),t._v(".")]),t._v(" "),e("h2",{attrs:{id:"custom-network-interfaces"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#custom-network-interfaces"}},[t._v("#")]),t._v(" Custom Network Interfaces")]),t._v(" "),e("p",[t._v("If for whatever reason you need to modify the network interfaces used for Pterodactyl's local Docker network you\ncan do so by modifying the "),e("code",[t._v("core.json")]),t._v(" file for the daemon. In most cases you'll just be modifying the network\nname to allow your servers to use the host network stack. To do so, just change "),e("code",[t._v("docker.network.name")]),t._v(" to be "),e("code",[t._v("host")]),t._v("\nrather than "),e("code",[t._v("pterodactyl_nw")]),t._v(" as shown below.")]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),e("p",[t._v("While changing to the host network stack does allow servers running on Pterodactyl to have direct access to local\ninterfaces and bind to specific IP addresses (required for some Steam games), it is not recommended on public\ninstallations of Pterodactyl (where you have other users running servers).")]),t._v(" "),e("p",[t._v("Using the "),e("code",[t._v("host")]),t._v(" stack removes many network specific protections afforded by Docker, and will allow server processes\nto access anything on the host, as well as bind to any IP or Port they wish.")])]),t._v(" "),e("div",{staticClass:"custom-block danger"},[e("p",{staticClass:"custom-block-title"},[t._v("DANGER")]),t._v(" "),e("p",[t._v("Any changes to the network after the daemon has been started will require you to remove the docker network and restart the daemon. Any servers on the host need to be stopped before and most likely rebuilt.")]),t._v(" "),e("p",[t._v("The following will stop the daemon, remove the network, and start the daemon again. Run at your own risk."),e("br"),t._v(" "),e("code",[t._v("systemctl stop wings && docker network rm pterodactyl_nw && systemctl start wings")])])]),t._v(" "),e("div",{staticClass:"language-json extra-class"},[e("div",{staticClass:"highlight-lines"},[e("br"),e("br"),e("br"),e("br"),e("div",{staticClass:"highlighted"},[t._v(" ")]),e("br"),e("br"),e("br"),e("br"),e("br"),e("br"),e("br"),e("br"),e("br"),e("br")]),e("pre",{pre:!0,attrs:{class:"language-json"}},[e("code",[e("span",{pre:!0,attrs:{class:"token property"}},[t._v('"docker"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token property"}},[t._v('"socket"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"/var/run/docker.sock"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token property"}},[t._v('"autoupdate_images"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token property"}},[t._v('"network"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"pterodactyl_nw"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token property"}},[t._v('"interfaces"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token property"}},[t._v('"v4"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token property"}},[t._v('"subnet"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"172.18.0.0/16"')]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token property"}},[t._v('"gateway"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"172.18.0.1"')]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token property"}},[t._v('"interface"')]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"172.18.0.1"')]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n")])])]),e("h2",{attrs:{id:"private-registries"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#private-registries"}},[t._v("#")]),t._v(" Private Registries")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Setting Path")]),t._v(" "),e("th",[t._v("Default Value")]),t._v(" "),e("th",[t._v("Notes")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("username")])]),t._v(" "),e("td",[e("em",[t._v("none")])]),t._v(" "),e("td",[t._v("The username to use when connecting to the registry.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("password")])]),t._v(" "),e("td",[e("em",[t._v("none")])]),t._v(" "),e("td",[t._v("The password associated with the account.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("images")])]),t._v(" "),e("td",[e("em",[t._v("none")])]),t._v(" "),e("td",[t._v("An array of images that are associated with the private registry.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("auth")])]),t._v(" "),e("td",[e("em",[t._v("none")])]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[e("code",[t._v("email")])]),t._v(" "),e("td",[e("em",[t._v("none")])]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[e("code",[t._v("serveraddress")])]),t._v(" "),e("td",[e("em",[t._v("none")])]),t._v(" "),e("td",[t._v("The address to the server the registry is located on.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("key")])]),t._v(" "),e("td",[e("em",[t._v("none")])]),t._v(" "),e("td",[t._v("A pre-generated base64 encoded authentication string. If provided none of the above options are required.")])])])]),t._v(" "),e("p",[t._v("Please note that all of the settings above are in the "),e("code",[t._v("docker.registry.X")]),t._v(" path. So, "),e("code",[t._v("username")]),t._v(" is actually "),e("code",[t._v("docker.registry.username")]),t._v(".")]),t._v(" "),e("h2",{attrs:{id:"security-policies"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#security-policies"}},[t._v("#")]),t._v(" Security Policies")]),t._v(" "),e("p",[t._v("This daemon ships with a very strict security configuration designed to limit access to the host system, and mitigate\na large range of potential attack vectors. However, some users might need to tweak these settings, or are running on\na private instance and are willing to decrease some of the security measures.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Setting Path")]),t._v(" "),e("th",[t._v("Default Value")]),t._v(" "),e("th",[t._v("Notes")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("ipv6")])]),t._v(" "),e("td",[t._v("true")]),t._v(" "),e("td",[t._v("Set this to false to disable IPv6 networking on the pterodactyl0 interface.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("internal")])]),t._v(" "),e("td",[t._v("false")]),t._v(" "),e("td",[t._v("Set this to true to prevent any external network access to all containers on the pterodactyl0 interface.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("enable_icc")])]),t._v(" "),e("td",[t._v("true")]),t._v(" "),e("td",[t._v("Set this to false to disallow containers to access services running on the host system's non-public IP addresses. Setting this to false does make it impossible to connect (from a container) to MySQL/Redis/etc. running on the host system without using the public IP address.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("enable_ip_masquerade")])]),t._v(" "),e("td",[t._v("true")]),t._v(" "),e("td",[t._v("Set this to false to disable IP Masquerading on the pterodactyl0 interface.")])])])]),t._v(" "),e("p",[t._v("Please note that all of the settings above are in the "),e("code",[t._v("docker.policy.network.X")]),t._v(" path. So, "),e("code",[t._v("ipv6")]),t._v(" is actually "),e("code",[t._v("docker.policy.network.ipv6")]),t._v(".")]),t._v(" "),e("h2",{attrs:{id:"container-policy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#container-policy"}},[t._v("#")]),t._v(" Container Policy")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Setting Path")]),t._v(" "),e("th",[t._v("Default Value")]),t._v(" "),e("th",[t._v("Notes")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("tmpfs")])]),t._v(" "),e("td",[e("code",[t._v("rw,exec,nosuid,size=50M")])]),t._v(" "),e("td",[t._v("These are the arguments used for mounting a "),e("code",[t._v("tmpfs")]),t._v(" directory into containers to allow certain programs to run.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("log_driver")])]),t._v(" "),e("td",[t._v("none")]),t._v(" "),e("td",[t._v("⚠️ This option was "),e("strong",[t._v("removed")]),t._v(" in "),e("code",[t._v("v0.6")]),t._v(" and is forcibly set to "),e("code",[t._v("json-file")]),t._v(". The log driver to use for containers. We default to "),e("code",[t._v("none")]),t._v(" to mitigate a potential DoS attack vector if a server were to spam log output.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("log_opts")])]),t._v(" "),e("td",[t._v("array")]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[e("code",[t._v("log_opts.max_size")])]),t._v(" "),e("td",[e("code",[t._v("5m")])]),t._v(" "),e("td",[t._v("The maximum size of the server output log file created by Docker.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("log_opts.max_files")])]),t._v(" "),e("td",[e("code",[t._v("1")])]),t._v(" "),e("td",[t._v("The maximum number of files that Docker will create with output from the server.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("readonly_root")])]),t._v(" "),e("td",[t._v("true")]),t._v(" "),e("td",[t._v("Determines if the root filesystem of the container should be readonly.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("securityopts")])]),t._v(" "),e("td",[t._v("array")]),t._v(" "),e("td",[t._v("An array of security options to apply to a container. The default array is provided below.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("cap_drop")])]),t._v(" "),e("td",[t._v("array")]),t._v(" "),e("td",[t._v("An array of linux capabilities to drop from the container (in addition to ones "),e("a",{attrs:{href:"https://docs.docker.com/engine/security/security/#linux-kernel-capabilities",target:"_blank",rel:"noopener noreferrer"}},[t._v("dropped by docker already"),e("OutboundLink")],1),t._v(". A listing of the default array is below.")])])])]),t._v(" "),e("p",[t._v("Please note that all of the settings above are in the "),e("code",[t._v("docker.policy.container.X")]),t._v(" path. So, "),e("code",[t._v("tmpfs")]),t._v(" is actually "),e("code",[t._v("docker.policy.container.tmpfs")]),t._v(".")]),t._v(" "),e("h3",{attrs:{id:"default-security-opts-array"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#default-security-opts-array"}},[t._v("#")]),t._v(" Default Security Opts Array")]),t._v(" "),e("div",{staticClass:"language-json extra-class"},[e("pre",{pre:!0,attrs:{class:"language-json"}},[e("code",[e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n 'no-new-privileges'"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n")])])]),e("h3",{attrs:{id:"default-capabilities-drop-array"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#default-capabilities-drop-array"}},[t._v("#")]),t._v(" Default Capabilities Drop Array")]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),e("p",[t._v("Starting with "),e("code",[t._v("v0.6")]),t._v(" of the Daemon, the following previously "),e("em",[t._v("dropped")]),t._v(" capabilities are available in containers: "),e("code",[t._v("chown")]),t._v(", "),e("code",[t._v("kill")]),t._v(", "),e("code",[t._v("setgid")]),t._v(", and "),e("code",[t._v("setuid")]),t._v(".")])]),t._v(" "),e("div",{staticClass:"language-json extra-class"},[e("pre",{pre:!0,attrs:{class:"language-json"}},[e("code",[e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n 'setpcap'"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n 'mknod'"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n 'audit_write'"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n 'net_raw'"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n 'dac_override'"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n 'fowner'"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n 'fsetid'"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n 'net_bind_service'"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n 'sys_chroot'"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n 'setfcap'"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n")])])]),e("h2",{attrs:{id:"enabling-cloudflare"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#enabling-cloudflare"}},[t._v("#")]),t._v(" Enabling Cloudflare")]),t._v(" "),e("p",[t._v("Enabling Cloudflare on the daemon isn't particularly useful since users do not connect directly to the daemon port, and users need an unproxied hostname to access any servers on the node. As a result it's not possible to conceal the IP address of your node machine, but some people want to enable it regardless.")]),t._v(" "),e("p",[t._v("Cloudflare only proxies the default daemon port (8080) when using HTTP. In order to get the daemon to work with Cloudflare when HTTPS is enabled you must change the daemon port to one that Cloudflare will proxy such as 8443. Since Cloudflare only proxies HTTP/HTTPS traffic for non-enterprise plans you cannot proxy the SFTP port.")])])}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/assets/js/43.9b0bb612.js b/assets/js/43.74132eec.js similarity index 98% rename from assets/js/43.9b0bb612.js rename to assets/js/43.74132eec.js index 1dc5e933..d8d7bc79 100644 --- a/assets/js/43.9b0bb612.js +++ b/assets/js/43.74132eec.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[43],{300:function(e,t,a){"use strict";a.r(t);var s=a(15),o=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"docker-on-debian-8"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docker-on-debian-8"}},[e._v("#")]),e._v(" Docker on Debian 8")]),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#install-docker"}},[e._v("Install Docker")])]),t("li",[t("a",{attrs:{href:"#update-grub-startup"}},[e._v("Update GRUB Startup")])]),t("li",[t("a",{attrs:{href:"#add-backports-repo"}},[e._v("Add Backports Repo")])]),t("li",[t("a",{attrs:{href:"#update-software-setup-docker"}},[e._v("Update Software & Setup Docker")])])])]),t("p"),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("There is a potential for broken software after this upgrade as we are moving to a non-stable kernel (in regards\nto mainline Debian). Please take backups and only proceed if you are comfortable with this process.")])]),e._v(" "),t("h2",{attrs:{id:"install-docker"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#install-docker"}},[e._v("#")]),e._v(" Install Docker")]),e._v(" "),t("p",[e._v("To begin with, we're going to install docker just like we would for any other OS by following Docker's\n"),t("a",{attrs:{href:"https://docs.docker.com/install/linux/docker-ce/debian/#install-docker-ce",target:"_blank",rel:"noopener noreferrer"}},[e._v("official documentation for Debian"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("Once you've done that, if you run "),t("code",[e._v("docker info")]),e._v(" you'll notice some missing features at the bottom, something\nlike the output below.")]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("WARNING: No memory limit support\nWARNING: No swap limit support\nWARNING: No kernel memory limit support\nWARNING: No oom kill disable support\nWARNING: No cpu cfs quota support\nWARNING: No cpu cfs period support\n")])])]),t("h2",{attrs:{id:"update-grub-startup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#update-grub-startup"}},[e._v("#")]),e._v(" Update GRUB Startup")]),e._v(" "),t("p",[e._v("To fix the memory limit support issues, we just need to add two arguments to our default grub startup. Start by\nopening "),t("code",[e._v("/etc/default/grub")]),e._v(" and adding the following arguments to "),t("code",[e._v("GRUB_CMDLINE_LINUX_DEFAULT")]),e._v(".")]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("swapaccount=1 cgroup_enable=memory\n")])])]),t("p",[e._v("The line should then look like the one below — assuming nothing else was in the quote to begin with.")]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('GRUB_CMDLINE_LINUX_DEFAULT="swapaccount=1 cgroup_enable=memory"\n')])])]),t("p",[e._v("After doing that, run "),t("code",[e._v("sudo update-grub")]),e._v(" to update our grub configuration.")]),e._v(" "),t("h2",{attrs:{id:"add-backports-repo"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#add-backports-repo"}},[e._v("#")]),e._v(" Add Backports Repo")]),e._v(" "),t("p",[e._v("We then need to enable the "),t("code",[e._v("jessie-backports")]),e._v(" apt repository to install a newer kernel. To do this, run the commands below.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("echo")]),e._v(" deb http://http.debian.net/debian jessie-backports main "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" /etc/apt/sources.list.d/jessie-backports.list\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("echo")]),e._v(" deb http://http.debian.net/debian jessie-backports main contrib non-free "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" /etc/apt/sources.list.d/jessie-backports.list\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" update\n")])])]),t("p",[e._v("To find the most recent kernels, run "),t("code",[e._v("apt-cache search linux-image")]),e._v(" which will list all of the ones available. In this\ncase, we'll install the "),t("code",[e._v("4.9.0")]),e._v(" kernel using the command below. Once we've done that, it is time to reboot the server\nto start using this kernel.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-t")]),e._v(" jessie-backports linux-image-4.9.0-0.bpo.3-amd64\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("reboot")]),e._v("\n")])])]),t("h2",{attrs:{id:"update-software-setup-docker"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#update-software-setup-docker"}},[e._v("#")]),e._v(" Update Software & Setup Docker")]),e._v(" "),t("p",[e._v("Now that we're on the new kernel you probably need to update some software to take advantage of it. To do this,\nsimply run the command below.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" update "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("&&")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" upgrade\n")])])]),t("p",[e._v("Once that is done, we need to make an adjustment to docker to use "),t("code",[e._v("overlay2")]),e._v(" rather than "),t("code",[e._v("aufs")]),e._v(" since "),t("code",[e._v("aufs")]),e._v(" is not\nsupported on this kernel currently. Run the command below to do so.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sed")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-i")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'s,/usr/bin/dockerd,/usr/bin/dockerd --storage-driver=overlay2,g'")]),e._v(" /lib/systemd/system/docker.service\n")])])]),t("p",[e._v("Finally, update "),t("code",[e._v("systemd")]),e._v(" and start docker using the following commands.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("systemctl daemon-reload\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("service")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v(" start\n")])])]),t("p",[e._v("Docker should now be running and reporting no errors if you run "),t("code",[e._v("docker info")]),e._v("!")])])}),[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[43],{301:function(e,t,a){"use strict";a.r(t);var s=a(15),o=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"docker-on-debian-8"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docker-on-debian-8"}},[e._v("#")]),e._v(" Docker on Debian 8")]),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#install-docker"}},[e._v("Install Docker")])]),t("li",[t("a",{attrs:{href:"#update-grub-startup"}},[e._v("Update GRUB Startup")])]),t("li",[t("a",{attrs:{href:"#add-backports-repo"}},[e._v("Add Backports Repo")])]),t("li",[t("a",{attrs:{href:"#update-software-setup-docker"}},[e._v("Update Software & Setup Docker")])])])]),t("p"),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("There is a potential for broken software after this upgrade as we are moving to a non-stable kernel (in regards\nto mainline Debian). Please take backups and only proceed if you are comfortable with this process.")])]),e._v(" "),t("h2",{attrs:{id:"install-docker"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#install-docker"}},[e._v("#")]),e._v(" Install Docker")]),e._v(" "),t("p",[e._v("To begin with, we're going to install docker just like we would for any other OS by following Docker's\n"),t("a",{attrs:{href:"https://docs.docker.com/install/linux/docker-ce/debian/#install-docker-ce",target:"_blank",rel:"noopener noreferrer"}},[e._v("official documentation for Debian"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("Once you've done that, if you run "),t("code",[e._v("docker info")]),e._v(" you'll notice some missing features at the bottom, something\nlike the output below.")]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("WARNING: No memory limit support\nWARNING: No swap limit support\nWARNING: No kernel memory limit support\nWARNING: No oom kill disable support\nWARNING: No cpu cfs quota support\nWARNING: No cpu cfs period support\n")])])]),t("h2",{attrs:{id:"update-grub-startup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#update-grub-startup"}},[e._v("#")]),e._v(" Update GRUB Startup")]),e._v(" "),t("p",[e._v("To fix the memory limit support issues, we just need to add two arguments to our default grub startup. Start by\nopening "),t("code",[e._v("/etc/default/grub")]),e._v(" and adding the following arguments to "),t("code",[e._v("GRUB_CMDLINE_LINUX_DEFAULT")]),e._v(".")]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("swapaccount=1 cgroup_enable=memory\n")])])]),t("p",[e._v("The line should then look like the one below — assuming nothing else was in the quote to begin with.")]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('GRUB_CMDLINE_LINUX_DEFAULT="swapaccount=1 cgroup_enable=memory"\n')])])]),t("p",[e._v("After doing that, run "),t("code",[e._v("sudo update-grub")]),e._v(" to update our grub configuration.")]),e._v(" "),t("h2",{attrs:{id:"add-backports-repo"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#add-backports-repo"}},[e._v("#")]),e._v(" Add Backports Repo")]),e._v(" "),t("p",[e._v("We then need to enable the "),t("code",[e._v("jessie-backports")]),e._v(" apt repository to install a newer kernel. To do this, run the commands below.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("echo")]),e._v(" deb http://http.debian.net/debian jessie-backports main "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" /etc/apt/sources.list.d/jessie-backports.list\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("echo")]),e._v(" deb http://http.debian.net/debian jessie-backports main contrib non-free "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v(" /etc/apt/sources.list.d/jessie-backports.list\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" update\n")])])]),t("p",[e._v("To find the most recent kernels, run "),t("code",[e._v("apt-cache search linux-image")]),e._v(" which will list all of the ones available. In this\ncase, we'll install the "),t("code",[e._v("4.9.0")]),e._v(" kernel using the command below. Once we've done that, it is time to reboot the server\nto start using this kernel.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-t")]),e._v(" jessie-backports linux-image-4.9.0-0.bpo.3-amd64\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("reboot")]),e._v("\n")])])]),t("h2",{attrs:{id:"update-software-setup-docker"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#update-software-setup-docker"}},[e._v("#")]),e._v(" Update Software & Setup Docker")]),e._v(" "),t("p",[e._v("Now that we're on the new kernel you probably need to update some software to take advantage of it. To do this,\nsimply run the command below.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" update "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("&&")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" upgrade\n")])])]),t("p",[e._v("Once that is done, we need to make an adjustment to docker to use "),t("code",[e._v("overlay2")]),e._v(" rather than "),t("code",[e._v("aufs")]),e._v(" since "),t("code",[e._v("aufs")]),e._v(" is not\nsupported on this kernel currently. Run the command below to do so.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sed")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-i")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'s,/usr/bin/dockerd,/usr/bin/dockerd --storage-driver=overlay2,g'")]),e._v(" /lib/systemd/system/docker.service\n")])])]),t("p",[e._v("Finally, update "),t("code",[e._v("systemd")]),e._v(" and start docker using the following commands.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("systemctl daemon-reload\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("service")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v(" start\n")])])]),t("p",[e._v("Docker should now be running and reporting no errors if you run "),t("code",[e._v("docker info")]),e._v("!")])])}),[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/assets/js/44.a7d15b9f.js b/assets/js/44.f5ae5bdc.js similarity index 98% rename from assets/js/44.a7d15b9f.js rename to assets/js/44.f5ae5bdc.js index 71f509da..371ca429 100644 --- a/assets/js/44.a7d15b9f.js +++ b/assets/js/44.f5ae5bdc.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[44],{303:function(e,t,n){"use strict";n.r(t);var s=n(15),a=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"kernel-modifications"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#kernel-modifications"}},[e._v("#")]),e._v(" Kernel Modifications")]),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#update-kernel"}},[e._v("Update Kernel")])]),t("li",[t("a",{attrs:{href:"#confirm-kernel"}},[e._v("Confirm Kernel")])]),t("li",[t("a",{attrs:{href:"#set-default-boot"}},[e._v("Set Default Boot")])]),t("li",[t("a",{attrs:{href:"#boot-from-hard-disk"}},[e._v("Boot from hard disk")])])])]),t("p"),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("In most cases, only users with a server provided by OVH will need to make any modifications to their kernel.")])]),e._v(" "),t("h2",{attrs:{id:"update-kernel"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#update-kernel"}},[e._v("#")]),e._v(" Update Kernel")]),e._v(" "),t("p",[e._v("Install the new kernels using apt-get. In this case we are installing the latest version of the kernel,\nbut feel free to browse using apt-cache search linux-image-extra to find all possible image versions you can\ninstall. You'll want to install the latest.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt-get")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" linux-image-generic linux-image-extra-virtual\n")])])]),t("p",[e._v("After you've installed the new kernel you'll need to update the grub loader using the command below. After that, a\nserver reboot is in order.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("mv")]),e._v(" /etc/grub.d/06_OVHkernel /etc/grub.d/96_OVHkernel\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("update-grub")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("reboot")]),e._v("\n")])])]),t("h2",{attrs:{id:"confirm-kernel"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#confirm-kernel"}},[e._v("#")]),e._v(" Confirm Kernel")]),e._v(" "),t("p",[e._v("Once you've rebooted, check that the latest kernel is installed using "),t("code",[e._v("uname -r")]),e._v(", it should output "),t("code",[e._v("4.4.0-131-generic")]),e._v("\n(in this case) or similar.")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("If it still includes "),t("code",[e._v("-xxxx-grs-ipv6-64")]),e._v(" or similar, it didn't work and you should move on top the steps below.")])]),e._v(" "),t("h2",{attrs:{id:"set-default-boot"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-default-boot"}},[e._v("#")]),e._v(" Set Default Boot")]),e._v(" "),t("p",[e._v("Ok, so unfortunately the easiest way didn't work, but don't worry, we can still fix this. Firstly, lets run a quick\ncommand to list potential kernels, just look at the output and make sure you see your newly installed kernel listed.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("grep")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"menuentry \'"')]),e._v(" /boot/grub/grub.cfg\n")])])]),t("p",[e._v("After running that you should see output similar to the example below.")]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("menuentry 'Ubuntu' --class ubuntu --class gnu-linux --class gnu --class os $menuentry_id_option 'gnulinux-simple-ad1a8550-963c-4a9f-b922-85827cf44fbe' {\n menuentry 'Ubuntu, with Linux 4.4.0-131-generic' --class ubuntu --class gnu-linux --class gnu --class os $menuentry_id_option 'gnulinux-4.4.0-131-generic-advanced-ad1a8550-963c-4a9f-b922-85827cf44fbe' {\n menuentry 'Ubuntu, with Linux 4.4.0-131-generic (recovery mode)' --class ubuntu --class gnu-linux --class gnu --class os $menuentry_id_option 'gnulinux-4.4.0-131-generic-recovery-ad1a8550-963c-4a9f-b922-85827cf44fbe' {\n menuentry 'Ubuntu, with Linux 4.4.0-127-generic' --class ubuntu --class gnu-linux --class gnu --class os $menuentry_id_option 'gnulinux-4.4.0-127-generic-advanced-ad1a8550-963c-4a9f-b922-85827cf44fbe' {\n menuentry 'Ubuntu, with Linux 4.4.0-127-generic (recovery mode)' --class ubuntu --class gnu-linux --class gnu --class os $menuentry_id_option 'gnulinux-4.4.0-127-generic-recovery-ad1a8550-963c-4a9f-b922-85827cf44fbe' {\n menuentry 'Ubuntu, with Linux 4.4.0-116-generic' --class ubuntu --class gnu-linux --class gnu --class os $menuentry_id_option 'gnulinux-4.4.0-116-generic-advanced-ad1a8550-963c-4a9f-b922-85827cf44fbe' {\n menuentry 'Ubuntu, with Linux 4.4.0-116-generic (recovery mode)' --class ubuntu --class gnu-linux --class gnu --class os $menuentry_id_option 'gnulinux-4.4.0-116-generic-recovery-ad1a8550-963c-4a9f-b922-85827cf44fbe' {\n")])])]),t("p",[e._v("As you can see, we have "),t("code",[e._v("Ubuntu, with Linux 4.4.0-131-generic")]),e._v(" listed as the first indented option. To boot using this\nspecific kernel, we will need to modify our grub file.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("nano")]),e._v(" /etc/default/grub\n")])])]),t("p",[e._v("Find "),t("code",[e._v("GRUB_DEFAULT")]),e._v(", it is most likely set to "),t("code",[e._v("GRUB_DEFAULT=0")]),e._v(". We're going to modify it a bit to boot our new kernel.")]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("GRUB_DEFAULT='Advanced options for Ubuntu>Ubuntu, with Linux 4.4.0-131-generic'\n")])])]),t("p",[e._v("The only part of the code above that you might need to change is the "),t("code",[e._v("4.4.0-131-generic")]),e._v(", which you can find based on\nthe kernel version you install. You might also notice that it matches the first indented entry from the grep menuentry\ncommand and also the version of the kernel that we installed above. Once you've done that, run the commands below to\nupdate grub and reboot, and you should be set.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("update-grub")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("reboot")]),e._v("\n")])])]),t("h2",{attrs:{id:"boot-from-hard-disk"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#boot-from-hard-disk"}},[e._v("#")]),e._v(" Boot from hard disk")]),e._v(" "),t("p",[e._v("It's possible that even after you modified the GRUB configuration the server's still booted into a OVH kernel. If this happens to you, go to the OVH control panel and check the server's booting settings and make sure it's booting from hard disk instead of network boot.")])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[44],{305:function(e,t,n){"use strict";n.r(t);var s=n(15),a=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"kernel-modifications"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#kernel-modifications"}},[e._v("#")]),e._v(" Kernel Modifications")]),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#update-kernel"}},[e._v("Update Kernel")])]),t("li",[t("a",{attrs:{href:"#confirm-kernel"}},[e._v("Confirm Kernel")])]),t("li",[t("a",{attrs:{href:"#set-default-boot"}},[e._v("Set Default Boot")])]),t("li",[t("a",{attrs:{href:"#boot-from-hard-disk"}},[e._v("Boot from hard disk")])])])]),t("p"),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("In most cases, only users with a server provided by OVH will need to make any modifications to their kernel.")])]),e._v(" "),t("h2",{attrs:{id:"update-kernel"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#update-kernel"}},[e._v("#")]),e._v(" Update Kernel")]),e._v(" "),t("p",[e._v("Install the new kernels using apt-get. In this case we are installing the latest version of the kernel,\nbut feel free to browse using apt-cache search linux-image-extra to find all possible image versions you can\ninstall. You'll want to install the latest.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt-get")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" linux-image-generic linux-image-extra-virtual\n")])])]),t("p",[e._v("After you've installed the new kernel you'll need to update the grub loader using the command below. After that, a\nserver reboot is in order.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("mv")]),e._v(" /etc/grub.d/06_OVHkernel /etc/grub.d/96_OVHkernel\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("update-grub")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("reboot")]),e._v("\n")])])]),t("h2",{attrs:{id:"confirm-kernel"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#confirm-kernel"}},[e._v("#")]),e._v(" Confirm Kernel")]),e._v(" "),t("p",[e._v("Once you've rebooted, check that the latest kernel is installed using "),t("code",[e._v("uname -r")]),e._v(", it should output "),t("code",[e._v("4.4.0-131-generic")]),e._v("\n(in this case) or similar.")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("If it still includes "),t("code",[e._v("-xxxx-grs-ipv6-64")]),e._v(" or similar, it didn't work and you should move on top the steps below.")])]),e._v(" "),t("h2",{attrs:{id:"set-default-boot"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-default-boot"}},[e._v("#")]),e._v(" Set Default Boot")]),e._v(" "),t("p",[e._v("Ok, so unfortunately the easiest way didn't work, but don't worry, we can still fix this. Firstly, lets run a quick\ncommand to list potential kernels, just look at the output and make sure you see your newly installed kernel listed.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("grep")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"menuentry \'"')]),e._v(" /boot/grub/grub.cfg\n")])])]),t("p",[e._v("After running that you should see output similar to the example below.")]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("menuentry 'Ubuntu' --class ubuntu --class gnu-linux --class gnu --class os $menuentry_id_option 'gnulinux-simple-ad1a8550-963c-4a9f-b922-85827cf44fbe' {\n menuentry 'Ubuntu, with Linux 4.4.0-131-generic' --class ubuntu --class gnu-linux --class gnu --class os $menuentry_id_option 'gnulinux-4.4.0-131-generic-advanced-ad1a8550-963c-4a9f-b922-85827cf44fbe' {\n menuentry 'Ubuntu, with Linux 4.4.0-131-generic (recovery mode)' --class ubuntu --class gnu-linux --class gnu --class os $menuentry_id_option 'gnulinux-4.4.0-131-generic-recovery-ad1a8550-963c-4a9f-b922-85827cf44fbe' {\n menuentry 'Ubuntu, with Linux 4.4.0-127-generic' --class ubuntu --class gnu-linux --class gnu --class os $menuentry_id_option 'gnulinux-4.4.0-127-generic-advanced-ad1a8550-963c-4a9f-b922-85827cf44fbe' {\n menuentry 'Ubuntu, with Linux 4.4.0-127-generic (recovery mode)' --class ubuntu --class gnu-linux --class gnu --class os $menuentry_id_option 'gnulinux-4.4.0-127-generic-recovery-ad1a8550-963c-4a9f-b922-85827cf44fbe' {\n menuentry 'Ubuntu, with Linux 4.4.0-116-generic' --class ubuntu --class gnu-linux --class gnu --class os $menuentry_id_option 'gnulinux-4.4.0-116-generic-advanced-ad1a8550-963c-4a9f-b922-85827cf44fbe' {\n menuentry 'Ubuntu, with Linux 4.4.0-116-generic (recovery mode)' --class ubuntu --class gnu-linux --class gnu --class os $menuentry_id_option 'gnulinux-4.4.0-116-generic-recovery-ad1a8550-963c-4a9f-b922-85827cf44fbe' {\n")])])]),t("p",[e._v("As you can see, we have "),t("code",[e._v("Ubuntu, with Linux 4.4.0-131-generic")]),e._v(" listed as the first indented option. To boot using this\nspecific kernel, we will need to modify our grub file.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("nano")]),e._v(" /etc/default/grub\n")])])]),t("p",[e._v("Find "),t("code",[e._v("GRUB_DEFAULT")]),e._v(", it is most likely set to "),t("code",[e._v("GRUB_DEFAULT=0")]),e._v(". We're going to modify it a bit to boot our new kernel.")]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("GRUB_DEFAULT='Advanced options for Ubuntu>Ubuntu, with Linux 4.4.0-131-generic'\n")])])]),t("p",[e._v("The only part of the code above that you might need to change is the "),t("code",[e._v("4.4.0-131-generic")]),e._v(", which you can find based on\nthe kernel version you install. You might also notice that it matches the first indented entry from the grep menuentry\ncommand and also the version of the kernel that we installed above. Once you've done that, run the commands below to\nupdate grub and reboot, and you should be set.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("update-grub")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("reboot")]),e._v("\n")])])]),t("h2",{attrs:{id:"boot-from-hard-disk"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#boot-from-hard-disk"}},[e._v("#")]),e._v(" Boot from hard disk")]),e._v(" "),t("p",[e._v("It's possible that even after you modified the GRUB configuration the server's still booted into a OVH kernel. If this happens to you, go to the OVH control panel and check the server's booting settings and make sure it's booting from hard disk instead of network boot.")])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/assets/js/45.ec543ccc.js b/assets/js/45.4bb149c0.js similarity index 98% rename from assets/js/45.ec543ccc.js rename to assets/js/45.4bb149c0.js index 6e3cbc14..8d76c2e4 100644 --- a/assets/js/45.ec543ccc.js +++ b/assets/js/45.4bb149c0.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[45],{305:function(e,t,s){"use strict";s.r(t);var a=s(15),r=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"standalone-sftp-server"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#standalone-sftp-server"}},[e._v("#")]),e._v(" Standalone SFTP Server")]),e._v(" "),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("This Software is Abandoned")]),e._v(" "),t("p",[e._v("This documentation is for "),t("strong",[e._v("abandoned software")]),e._v(" which does not recieve any security updates or support\nfrom the community. This documentation has been left accessible for historial reasons.")]),e._v(" "),t("p",[e._v("You should be installing and using "),t("RouterLink",{attrs:{to:"/wings/1.0/installing.html"}},[e._v("Wings")]),e._v(" in production environments with\n"),t("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html"}},[e._v("Pterodactyl Panel 1.0")]),e._v(".")],1)]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("Standalone SFTP support was introduced in "),t("code",[e._v("Panel@v0.7.11")]),e._v(" and "),t("code",[e._v("Daemon@v0.6.8")]),e._v(" and will not work with prior versions.")])]),e._v(" "),t("p",[e._v("Pterodactyl now ships with the option to use a "),t("a",{attrs:{href:"https://github.com/pterodactyl/sftp-server",target:"_blank",rel:"noopener noreferrer"}},[e._v("standalone SFTP server"),t("OutboundLink")],1),e._v("\nrather than using the one that was built into the Daemon. This provides better compatibility with SFTP clients, improved\ntransfer speeds, and a more native approach to file handling and server operation.")]),e._v(" "),t("p",[e._v("Because this functionality is new, we've decided to make it an opt-in process, rather than an opt-out process. This page\nwill cover how to setup your standalone SFTP server.")]),e._v(" "),t("h2",{attrs:{id:"disable-daemon-s-server"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#disable-daemon-s-server"}},[e._v("#")]),e._v(" Disable Daemon's Server")]),e._v(" "),t("p",[e._v("To disable the Daemon SFTP server, you only need to add "),t("code",[e._v("sftp.enabled=false")]),e._v(" to your Daemon's "),t("code",[e._v("core.json")]),e._v(" file.")]),e._v(" "),t("div",{staticClass:"language-json extra-class"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n ...\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"sftp"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n ...\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"ip"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"0.0.0.0"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"enabled"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("false")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"port"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("2022")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n ...\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n ...\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("p",[e._v("Once you've done that, restarting the Daemon will apply the change and not boot the built-in server.")]),e._v(" "),t("h2",{attrs:{id:"run-the-standalone-server"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#run-the-standalone-server"}},[e._v("#")]),e._v(" Run the Standalone Server")]),e._v(" "),t("p",[e._v("To download the standalone server, execute the command below in your Daemon's base directory (generally "),t("code",[e._v("/srv/daemon")]),e._v(").")]),e._v(" "),t("div",{staticClass:"language-sh extra-class"},[t("pre",{pre:!0,attrs:{class:"language-sh"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-Lo")]),e._v(" sftp-server https://github.com/pterodactyl/sftp-server/releases/download/v1.0.5/sftp-server\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("chmod")]),e._v(" +x sftp-server\n")])])]),t("p",[e._v("Excellent, now you've got the server binary. Because we've written this server using "),t("a",{attrs:{href:"https://golang.org",target:"_blank",rel:"noopener noreferrer"}},[t("code",[e._v("go")]),t("OutboundLink")],1),e._v(" there\nare no additional dependencies you need to install.")]),e._v(" "),t("h3",{attrs:{id:"start-the-server"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#start-the-server"}},[e._v("#")]),e._v(" Start the Server")]),e._v(" "),t("p",[e._v("Finally, start the SFTP server so that you can then use it to access your files.")]),e._v(" "),t("div",{staticClass:"language-sh extra-class"},[t("pre",{pre:!0,attrs:{class:"language-sh"}},[t("code",[e._v("./sftp-server\n")])])]),t("p",[e._v("By default, this will start the SFTP server on the old port of "),t("code",[e._v("2022")]),e._v(". If you want to use a different port it can be\nspecified by passing the "),t("code",[e._v("--port")]),e._v(" flag. For more advanced usage, please refer to the "),t("a",{attrs:{href:"https://github.com/pterodactyl/sftp-server/tree/release/v1.0.4#running",target:"_blank",rel:"noopener noreferrer"}},[e._v("GitHub README"),t("OutboundLink")],1),e._v("\nwhich includes all of the flags and their default values.")]),e._v(" "),t("h2",{attrs:{id:"daemonize-server"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#daemonize-server"}},[e._v("#")]),e._v(" Daemonize Server")]),e._v(" "),t("p",[e._v("Chances are you'll want to daemonize the SFTP server using something like "),t("code",[e._v("systemd")]),e._v(" so that it will run in the\nbackground. Place the contents below in a file called "),t("code",[e._v("pterosftp.service")]),e._v(" in the "),t("code",[e._v("/etc/systemd/system")]),e._v(" directory.")]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("[Unit]\nDescription=Pterodactyl Standalone SFTP Server\nAfter=wings.service\n\n[Service]\nUser=root\nWorkingDirectory=/srv/daemon\nLimitNOFILE=4096\nPIDFile=/var/run/wings/sftp.pid\nExecStart=/srv/daemon/sftp-server\nRestart=on-failure\nStartLimitInterval=600\n\n[Install]\nWantedBy=multi-user.target\n")])])]),t("p",[e._v("Then, run the command below to enable it in systemd and start the SFTP server.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("systemctl "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("enable")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--now")]),e._v(" pterosftp\n")])])]),t("h3",{attrs:{id:"customizing-startup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#customizing-startup"}},[e._v("#")]),e._v(" Customizing Startup")]),e._v(" "),t("p",[e._v("If you're trying to pass additional arguments to the server when starting it using SystemD you'll want to modify\nthe "),t("code",[e._v("ExecStart")]),e._v(" line. Something like "),t("code",[e._v("ExecStart=/srv/daemon/sftp-server --port 2022")]),e._v(" for example.")])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[45],{302:function(e,t,s){"use strict";s.r(t);var a=s(15),r=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"standalone-sftp-server"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#standalone-sftp-server"}},[e._v("#")]),e._v(" Standalone SFTP Server")]),e._v(" "),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("This Software is Abandoned")]),e._v(" "),t("p",[e._v("This documentation is for "),t("strong",[e._v("abandoned software")]),e._v(" which does not recieve any security updates or support\nfrom the community. This documentation has been left accessible for historial reasons.")]),e._v(" "),t("p",[e._v("You should be installing and using "),t("RouterLink",{attrs:{to:"/wings/1.0/installing.html"}},[e._v("Wings")]),e._v(" in production environments with\n"),t("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html"}},[e._v("Pterodactyl Panel 1.0")]),e._v(".")],1)]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("Standalone SFTP support was introduced in "),t("code",[e._v("Panel@v0.7.11")]),e._v(" and "),t("code",[e._v("Daemon@v0.6.8")]),e._v(" and will not work with prior versions.")])]),e._v(" "),t("p",[e._v("Pterodactyl now ships with the option to use a "),t("a",{attrs:{href:"https://github.com/pterodactyl/sftp-server",target:"_blank",rel:"noopener noreferrer"}},[e._v("standalone SFTP server"),t("OutboundLink")],1),e._v("\nrather than using the one that was built into the Daemon. This provides better compatibility with SFTP clients, improved\ntransfer speeds, and a more native approach to file handling and server operation.")]),e._v(" "),t("p",[e._v("Because this functionality is new, we've decided to make it an opt-in process, rather than an opt-out process. This page\nwill cover how to setup your standalone SFTP server.")]),e._v(" "),t("h2",{attrs:{id:"disable-daemon-s-server"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#disable-daemon-s-server"}},[e._v("#")]),e._v(" Disable Daemon's Server")]),e._v(" "),t("p",[e._v("To disable the Daemon SFTP server, you only need to add "),t("code",[e._v("sftp.enabled=false")]),e._v(" to your Daemon's "),t("code",[e._v("core.json")]),e._v(" file.")]),e._v(" "),t("div",{staticClass:"language-json extra-class"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n ...\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"sftp"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n ...\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"ip"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"0.0.0.0"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"enabled"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("false")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"port"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("2022")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n ...\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n ...\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("p",[e._v("Once you've done that, restarting the Daemon will apply the change and not boot the built-in server.")]),e._v(" "),t("h2",{attrs:{id:"run-the-standalone-server"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#run-the-standalone-server"}},[e._v("#")]),e._v(" Run the Standalone Server")]),e._v(" "),t("p",[e._v("To download the standalone server, execute the command below in your Daemon's base directory (generally "),t("code",[e._v("/srv/daemon")]),e._v(").")]),e._v(" "),t("div",{staticClass:"language-sh extra-class"},[t("pre",{pre:!0,attrs:{class:"language-sh"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-Lo")]),e._v(" sftp-server https://github.com/pterodactyl/sftp-server/releases/download/v1.0.5/sftp-server\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("chmod")]),e._v(" +x sftp-server\n")])])]),t("p",[e._v("Excellent, now you've got the server binary. Because we've written this server using "),t("a",{attrs:{href:"https://golang.org",target:"_blank",rel:"noopener noreferrer"}},[t("code",[e._v("go")]),t("OutboundLink")],1),e._v(" there\nare no additional dependencies you need to install.")]),e._v(" "),t("h3",{attrs:{id:"start-the-server"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#start-the-server"}},[e._v("#")]),e._v(" Start the Server")]),e._v(" "),t("p",[e._v("Finally, start the SFTP server so that you can then use it to access your files.")]),e._v(" "),t("div",{staticClass:"language-sh extra-class"},[t("pre",{pre:!0,attrs:{class:"language-sh"}},[t("code",[e._v("./sftp-server\n")])])]),t("p",[e._v("By default, this will start the SFTP server on the old port of "),t("code",[e._v("2022")]),e._v(". If you want to use a different port it can be\nspecified by passing the "),t("code",[e._v("--port")]),e._v(" flag. For more advanced usage, please refer to the "),t("a",{attrs:{href:"https://github.com/pterodactyl/sftp-server/tree/release/v1.0.4#running",target:"_blank",rel:"noopener noreferrer"}},[e._v("GitHub README"),t("OutboundLink")],1),e._v("\nwhich includes all of the flags and their default values.")]),e._v(" "),t("h2",{attrs:{id:"daemonize-server"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#daemonize-server"}},[e._v("#")]),e._v(" Daemonize Server")]),e._v(" "),t("p",[e._v("Chances are you'll want to daemonize the SFTP server using something like "),t("code",[e._v("systemd")]),e._v(" so that it will run in the\nbackground. Place the contents below in a file called "),t("code",[e._v("pterosftp.service")]),e._v(" in the "),t("code",[e._v("/etc/systemd/system")]),e._v(" directory.")]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("[Unit]\nDescription=Pterodactyl Standalone SFTP Server\nAfter=wings.service\n\n[Service]\nUser=root\nWorkingDirectory=/srv/daemon\nLimitNOFILE=4096\nPIDFile=/var/run/wings/sftp.pid\nExecStart=/srv/daemon/sftp-server\nRestart=on-failure\nStartLimitInterval=600\n\n[Install]\nWantedBy=multi-user.target\n")])])]),t("p",[e._v("Then, run the command below to enable it in systemd and start the SFTP server.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("systemctl "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("enable")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--now")]),e._v(" pterosftp\n")])])]),t("h3",{attrs:{id:"customizing-startup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#customizing-startup"}},[e._v("#")]),e._v(" Customizing Startup")]),e._v(" "),t("p",[e._v("If you're trying to pass additional arguments to the server when starting it using SystemD you'll want to modify\nthe "),t("code",[e._v("ExecStart")]),e._v(" line. Something like "),t("code",[e._v("ExecStart=/srv/daemon/sftp-server --port 2022")]),e._v(" for example.")])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/48.c19ab66e.js b/assets/js/48.07ebc20a.js similarity index 98% rename from assets/js/48.c19ab66e.js rename to assets/js/48.07ebc20a.js index 61a449e4..236d6421 100644 --- a/assets/js/48.c19ab66e.js +++ b/assets/js/48.07ebc20a.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[48],{307:function(e,t,a){"use strict";a.r(t);var s=a(15),n=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"upgrading-0-5-x-to-0-6-x"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#upgrading-0-5-x-to-0-6-x"}},[e._v("#")]),e._v(" Upgrading 0.5.X to 0.6.X")]),e._v(" "),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("This Software is Abandoned")]),e._v(" "),t("p",[e._v("This documentation is for "),t("strong",[e._v("abandoned software")]),e._v(" which does not recieve any security updates or support\nfrom the community. This documentation has been left accessible for historial reasons.")]),e._v(" "),t("p",[e._v("You should be installing and using "),t("RouterLink",{attrs:{to:"/wings/1.0/installing.html"}},[e._v("Wings")]),e._v(" in production environments with\n"),t("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html"}},[e._v("Pterodactyl Panel 1.0")]),e._v(".")],1)]),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#breaking-changes"}},[e._v("Breaking Changes")])]),t("li",[t("a",{attrs:{href:"#download-files"}},[e._v("Download Files")]),t("ul",[t("li",[t("a",{attrs:{href:"#start-the-daemon"}},[e._v("Start the Daemon")])])])]),t("li",[t("a",{attrs:{href:"#rebuild-containers"}},[e._v("Rebuild Containers")])])])]),t("p"),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("Server Restart Required")]),e._v(" "),t("p",[e._v("Your servers will need to be restarted after upgrading the daemon in order to see the expected log output in the Panel.")])]),e._v(" "),t("h2",{attrs:{id:"breaking-changes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#breaking-changes"}},[e._v("#")]),e._v(" Breaking Changes")]),e._v(" "),t("p",[e._v("This release introduces a few breaking changes to how the Daemon operates, but maintains compatibility with "),t("code",[e._v("v0.7.X")]),e._v(" of\nthe Panel, so you don't need to worry about updating the Panel.")]),e._v(" "),t("p",[e._v("Of notable change in this release is that we've switched from using custom logging functionality to using Docker logging\nfunctionality. This allows us to better output events that happen before we can attach to the container, centralizes logic,\nand allows Docker to manage the logs (which it does very well). Now, when your server refuses to boot, instead of seeing\nan unhelpful \"Server has crashed\" message with nothing before it, you'll see "),t("em",[e._v("everything")]),e._v(" that happened in the container\nleading up to that point, assuming things were output.")]),e._v(" "),t("h2",{attrs:{id:"download-files"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#download-files"}},[e._v("#")]),e._v(" Download Files")]),e._v(" "),t("p",[e._v("To upgrade from v0.5.X first switch the directory where you installed your Daemon. If you followed the installation\nguide your Daemon is most likely located in "),t("code",[e._v("/srv/daemon")]),e._v(". Then, download and unpack the archive using the\ncommand below.")]),e._v(" "),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("DANGER")]),e._v(" "),t("p",[e._v("Stop your Daemon process before continuing in order to avoid any issues and ensure everything updates as expected.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("systemctl stop wings\n")])])])]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-L")]),e._v(" https://github.com/pterodactyl/daemon/releases/download/v0.6.13/daemon.tar.gz "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("tar")]),e._v(" --strip-components"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-xzv")]),e._v("\n")])])]),t("p",[e._v("Then, update the core dependencies for the Daemon with the following command.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("npm")]),e._v(" update "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--only")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("production\n")])])]),t("h3",{attrs:{id:"start-the-daemon"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#start-the-daemon"}},[e._v("#")]),e._v(" Start the Daemon")]),e._v(" "),t("p",[e._v("Finally, start your daemon up, most likely with the command below.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("systemctl start wings\n")])])]),t("h2",{attrs:{id:"rebuild-containers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#rebuild-containers"}},[e._v("#")]),e._v(" Rebuild Containers")]),e._v(" "),t("p",[e._v("Because of some changes we made behind the scenes when it comes to displaying server output you'll need to rebuild and\nrestart all of your servers. The rebuild step is required, the restart step is optional, but highly recommended otherwise\nyou will not be able to see any console output.")]),e._v(" "),t("p",[e._v("Run the following commands "),t("em",[e._v("from the Panel server")]),e._v(" in order to perform a mass rebuild and restart. Replace "),t("code",[e._v("###")]),e._v(" with the\nID of the node you just upgraded, or remove the "),t("code",[e._v("--node")]),e._v(" flag entirely to rebuild on all nodes.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("php artisan p:server:rebuild "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--node")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("###")]),e._v("\n")])])]),t("p",[e._v("Then, restart all of the servers using the following command, or by manually restarting them one at a time in the Panel.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("php artisan p:server:bulk-power restart "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--nodes")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("###")]),e._v("\n")])])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[48],{308:function(e,t,a){"use strict";a.r(t);var s=a(15),n=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"upgrading-0-5-x-to-0-6-x"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#upgrading-0-5-x-to-0-6-x"}},[e._v("#")]),e._v(" Upgrading 0.5.X to 0.6.X")]),e._v(" "),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("This Software is Abandoned")]),e._v(" "),t("p",[e._v("This documentation is for "),t("strong",[e._v("abandoned software")]),e._v(" which does not recieve any security updates or support\nfrom the community. This documentation has been left accessible for historial reasons.")]),e._v(" "),t("p",[e._v("You should be installing and using "),t("RouterLink",{attrs:{to:"/wings/1.0/installing.html"}},[e._v("Wings")]),e._v(" in production environments with\n"),t("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html"}},[e._v("Pterodactyl Panel 1.0")]),e._v(".")],1)]),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#breaking-changes"}},[e._v("Breaking Changes")])]),t("li",[t("a",{attrs:{href:"#download-files"}},[e._v("Download Files")]),t("ul",[t("li",[t("a",{attrs:{href:"#start-the-daemon"}},[e._v("Start the Daemon")])])])]),t("li",[t("a",{attrs:{href:"#rebuild-containers"}},[e._v("Rebuild Containers")])])])]),t("p"),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("Server Restart Required")]),e._v(" "),t("p",[e._v("Your servers will need to be restarted after upgrading the daemon in order to see the expected log output in the Panel.")])]),e._v(" "),t("h2",{attrs:{id:"breaking-changes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#breaking-changes"}},[e._v("#")]),e._v(" Breaking Changes")]),e._v(" "),t("p",[e._v("This release introduces a few breaking changes to how the Daemon operates, but maintains compatibility with "),t("code",[e._v("v0.7.X")]),e._v(" of\nthe Panel, so you don't need to worry about updating the Panel.")]),e._v(" "),t("p",[e._v("Of notable change in this release is that we've switched from using custom logging functionality to using Docker logging\nfunctionality. This allows us to better output events that happen before we can attach to the container, centralizes logic,\nand allows Docker to manage the logs (which it does very well). Now, when your server refuses to boot, instead of seeing\nan unhelpful \"Server has crashed\" message with nothing before it, you'll see "),t("em",[e._v("everything")]),e._v(" that happened in the container\nleading up to that point, assuming things were output.")]),e._v(" "),t("h2",{attrs:{id:"download-files"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#download-files"}},[e._v("#")]),e._v(" Download Files")]),e._v(" "),t("p",[e._v("To upgrade from v0.5.X first switch the directory where you installed your Daemon. If you followed the installation\nguide your Daemon is most likely located in "),t("code",[e._v("/srv/daemon")]),e._v(". Then, download and unpack the archive using the\ncommand below.")]),e._v(" "),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("DANGER")]),e._v(" "),t("p",[e._v("Stop your Daemon process before continuing in order to avoid any issues and ensure everything updates as expected.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("systemctl stop wings\n")])])])]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-L")]),e._v(" https://github.com/pterodactyl/daemon/releases/download/v0.6.13/daemon.tar.gz "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("tar")]),e._v(" --strip-components"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-xzv")]),e._v("\n")])])]),t("p",[e._v("Then, update the core dependencies for the Daemon with the following command.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("npm")]),e._v(" update "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--only")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("production\n")])])]),t("h3",{attrs:{id:"start-the-daemon"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#start-the-daemon"}},[e._v("#")]),e._v(" Start the Daemon")]),e._v(" "),t("p",[e._v("Finally, start your daemon up, most likely with the command below.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("systemctl start wings\n")])])]),t("h2",{attrs:{id:"rebuild-containers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#rebuild-containers"}},[e._v("#")]),e._v(" Rebuild Containers")]),e._v(" "),t("p",[e._v("Because of some changes we made behind the scenes when it comes to displaying server output you'll need to rebuild and\nrestart all of your servers. The rebuild step is required, the restart step is optional, but highly recommended otherwise\nyou will not be able to see any console output.")]),e._v(" "),t("p",[e._v("Run the following commands "),t("em",[e._v("from the Panel server")]),e._v(" in order to perform a mass rebuild and restart. Replace "),t("code",[e._v("###")]),e._v(" with the\nID of the node you just upgraded, or remove the "),t("code",[e._v("--node")]),e._v(" flag entirely to rebuild on all nodes.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("php artisan p:server:rebuild "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--node")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("###")]),e._v("\n")])])]),t("p",[e._v("Then, restart all of the servers using the following command, or by manually restarting them one at a time in the Panel.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("php artisan p:server:bulk-power restart "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--nodes")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("###")]),e._v("\n")])])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/49.f62e3b58.js b/assets/js/49.342049a1.js similarity index 97% rename from assets/js/49.f62e3b58.js rename to assets/js/49.342049a1.js index 9bea321f..3cce5e03 100644 --- a/assets/js/49.f62e3b58.js +++ b/assets/js/49.342049a1.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[49],{308:function(t,e,s){"use strict";s.r(e);var a=s(15),o=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"upgrading-0-6-series"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#upgrading-0-6-series"}},[t._v("#")]),t._v(" Upgrading 0.6 Series")]),t._v(" "),e("div",{staticClass:"custom-block danger"},[e("p",{staticClass:"custom-block-title"},[t._v("This Software is Abandoned")]),t._v(" "),e("p",[t._v("This documentation is for "),e("strong",[t._v("abandoned software")]),t._v(" which does not recieve any security updates or support\nfrom the community. This documentation has been left accessible for historial reasons.")]),t._v(" "),e("p",[t._v("You should be installing and using "),e("RouterLink",{attrs:{to:"/wings/1.0/installing.html"}},[t._v("Wings")]),t._v(" in production environments with\n"),e("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html"}},[t._v("Pterodactyl Panel 1.0")]),t._v(".")],1)]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("Minor Versions Only")]),t._v(" "),e("p",[e("strong",[t._v("DO NOT")]),t._v(" use this guide to upgrade from "),e("code",[t._v("0.5.X")]),t._v(" to "),e("code",[t._v("0.6.X")]),t._v(", it will not work and you will encounter errors afterwards. Please check the "),e("RouterLink",{attrs:{to:"/daemon/upgrade/0.5_to_0.6.html"}},[t._v("0.5 to 0.6")]),t._v(" upgrade documentation to perform that update.")],1)]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),e("p",[t._v("Your servers will not go offline during this process thanks to Docker. Clients will briefly lose connection\nto the Daemon from the Panel, but only during the restart phase.")])]),t._v(" "),e("h2",{attrs:{id:"download-newest-release"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#download-newest-release"}},[t._v("#")]),t._v(" Download Newest Release")]),t._v(" "),e("p",[t._v("First, ensure you're in the Daemon directory, "),e("code",[t._v("/srv/daemon")]),t._v(", before continuing through this process. After you've done\nthat, run the command below to pull down the latest files and unpack them in the daemon directory.")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-L")]),t._v(" https://github.com/pterodactyl/daemon/releases/download/v0.6.13/daemon.tar.gz "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("|")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("tar")]),t._v(" --strip-components"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-xzv")]),t._v("\n")])])]),e("h2",{attrs:{id:"update-components"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#update-components"}},[t._v("#")]),t._v(" Update Components")]),t._v(" "),e("p",[t._v("After you've pulled down the latest files the last thing you need to do is run the commands below to update the\ncomponents and then restart the daemon.")]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("Nodejs 10 Required")]),t._v(" "),e("p",[t._v("Version "),e("code",[t._v("0.6.13")]),t._v(" requires Nodejs v10 or higher in order to compile the "),e("code",[t._v("mmmagic")]),t._v(" dependency. Please ensure\nyou are running at least version 10. You can run "),e("code",[t._v("node -v")]),t._v(" to check, upgrade if it is "),e("code",[t._v("v6")]),t._v(" or "),e("code",[t._v("v8")]),t._v(".")])]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("Audit Results")]),t._v(" "),e("p",[t._v('You may see output along the lines of "found 14 vulnerabilities (6 low, 3 moderate, 5 high) in 927 scanned packages".\nYou can safely ignore this output. Do not run the audit fix command, you '),e("em",[t._v("will")]),t._v(" break your Daemon.")])]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[t._v("npm")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("install")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--only")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v("production --no-audit --unsafe-perm\nsystemctl restart wings\n")])])])])}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[49],{307:function(t,e,s){"use strict";s.r(e);var a=s(15),o=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"upgrading-0-6-series"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#upgrading-0-6-series"}},[t._v("#")]),t._v(" Upgrading 0.6 Series")]),t._v(" "),e("div",{staticClass:"custom-block danger"},[e("p",{staticClass:"custom-block-title"},[t._v("This Software is Abandoned")]),t._v(" "),e("p",[t._v("This documentation is for "),e("strong",[t._v("abandoned software")]),t._v(" which does not recieve any security updates or support\nfrom the community. This documentation has been left accessible for historial reasons.")]),t._v(" "),e("p",[t._v("You should be installing and using "),e("RouterLink",{attrs:{to:"/wings/1.0/installing.html"}},[t._v("Wings")]),t._v(" in production environments with\n"),e("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html"}},[t._v("Pterodactyl Panel 1.0")]),t._v(".")],1)]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("Minor Versions Only")]),t._v(" "),e("p",[e("strong",[t._v("DO NOT")]),t._v(" use this guide to upgrade from "),e("code",[t._v("0.5.X")]),t._v(" to "),e("code",[t._v("0.6.X")]),t._v(", it will not work and you will encounter errors afterwards. Please check the "),e("RouterLink",{attrs:{to:"/daemon/upgrade/0.5_to_0.6.html"}},[t._v("0.5 to 0.6")]),t._v(" upgrade documentation to perform that update.")],1)]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),e("p",[t._v("Your servers will not go offline during this process thanks to Docker. Clients will briefly lose connection\nto the Daemon from the Panel, but only during the restart phase.")])]),t._v(" "),e("h2",{attrs:{id:"download-newest-release"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#download-newest-release"}},[t._v("#")]),t._v(" Download Newest Release")]),t._v(" "),e("p",[t._v("First, ensure you're in the Daemon directory, "),e("code",[t._v("/srv/daemon")]),t._v(", before continuing through this process. After you've done\nthat, run the command below to pull down the latest files and unpack them in the daemon directory.")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-L")]),t._v(" https://github.com/pterodactyl/daemon/releases/download/v0.6.13/daemon.tar.gz "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("|")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("tar")]),t._v(" --strip-components"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-xzv")]),t._v("\n")])])]),e("h2",{attrs:{id:"update-components"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#update-components"}},[t._v("#")]),t._v(" Update Components")]),t._v(" "),e("p",[t._v("After you've pulled down the latest files the last thing you need to do is run the commands below to update the\ncomponents and then restart the daemon.")]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("Nodejs 10 Required")]),t._v(" "),e("p",[t._v("Version "),e("code",[t._v("0.6.13")]),t._v(" requires Nodejs v10 or higher in order to compile the "),e("code",[t._v("mmmagic")]),t._v(" dependency. Please ensure\nyou are running at least version 10. You can run "),e("code",[t._v("node -v")]),t._v(" to check, upgrade if it is "),e("code",[t._v("v6")]),t._v(" or "),e("code",[t._v("v8")]),t._v(".")])]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("Audit Results")]),t._v(" "),e("p",[t._v('You may see output along the lines of "found 14 vulnerabilities (6 low, 3 moderate, 5 high) in 927 scanned packages".\nYou can safely ignore this output. Do not run the audit fix command, you '),e("em",[t._v("will")]),t._v(" break your Daemon.")])]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[t._v("npm")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("install")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("--only")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v("production --no-audit --unsafe-perm\nsystemctl restart wings\n")])])])])}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/assets/js/52.958909d9.js b/assets/js/52.8e320849.js similarity index 99% rename from assets/js/52.958909d9.js rename to assets/js/52.8e320849.js index 0998f95a..1001684e 100644 --- a/assets/js/52.958909d9.js +++ b/assets/js/52.8e320849.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[52],{313:function(e,t,a){"use strict";a.r(t);var o=a(15),n=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"environment-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#environment-configuration"}},[e._v("#")]),e._v(" Environment Configuration")]),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#reporting-all-exceptions"}},[e._v("Reporting All Exceptions")])]),t("li",[t("a",{attrs:{href:"#client-databases"}},[e._v("Client Databases")])]),t("li",[t("a",{attrs:{href:"#reverse-proxy-setup"}},[e._v("Reverse Proxy Setup")]),t("ul",[t("li",[t("a",{attrs:{href:"#nginx-specific-configuration"}},[e._v("NGINX Specific Configuration")])]),t("li",[t("a",{attrs:{href:"#cloudflare-specific-configuration"}},[e._v("Cloudflare Specific Configuration")])])])]),t("li",[t("a",{attrs:{href:"#increasing-the-editable-file-size"}},[e._v("Increasing the Editable File Size")])]),t("li",[t("a",{attrs:{href:"#disable-or-modify-recaptcha"}},[e._v("Disable or Modify ReCaptcha")]),t("ul",[t("li",[t("a",{attrs:{href:"#using-your-own-keys"}},[e._v("Using Your Own Keys")])])])])])]),t("p"),e._v(" "),t("p",[e._v("Pterodactyl's environment settings are configured and stored in an environment file — "),t("code",[e._v(".env")]),e._v(" — located in the\ninstallation root directory — generally "),t("code",[e._v("/var/www/pterodactyl")]),e._v(". Some of these settings are also stored in the database\nand will override settings found in the environment file.")]),e._v(" "),t("p",[e._v("To change this behavior you can edit the "),t("code",[e._v(".env")]),e._v(" file and change the setting "),t("code",[e._v("APP_ENVIRONMENT_ONLY=false")]),e._v(" to\n"),t("code",[e._v("APP_ENVIRONMENT_ONLY=true")]),e._v(" which will take effect the next time you refresh a page on the Panel. Generally you will\nonly need to do this if you severly corrupt a setting in the Panel or are deep in development with the software.")]),e._v(" "),t("h2",{attrs:{id:"reporting-all-exceptions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#reporting-all-exceptions"}},[e._v("#")]),e._v(" Reporting All Exceptions")]),e._v(" "),t("p",[e._v("By default Pterodactyl only logs and reports exceptions that are, well, exceptional by nature. There are some exceptions\nthat we expect to occur such as authentication failures or validation issues. However, in rare instances when developing,\nor even on production servers, you might need to have all exceptions logged to detect inconsistent behavior.")]),e._v(" "),t("p",[e._v("To do this, simply set "),t("code",[e._v("APP_REPORT_ALL_EXCEPTIONS=true")]),e._v(" in your "),t("code",[e._v(".env")]),e._v(" file. You'll want to turn this off once you've\ncompleted whatever it is you're needing the exceptions for, otherwise your logs will become very large, very quickly.")]),e._v(" "),t("h2",{attrs:{id:"client-databases"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#client-databases"}},[e._v("#")]),e._v(" Client Databases")]),e._v(" "),t("p",[e._v("By default Pterodactyl ships with the ability for clients to have their own per-server databases. If you wish to disable\nthis ability, set "),t("code",[e._v("PTERODACTYL_CLIENT_DATABASES_ENABLED")]),e._v(" to be "),t("code",[e._v("false")]),e._v(". Pterodactyl also attempts to create databases\non a database host assigned to the current server's node but will use any host if one can't be found. If you would like\nto force a database to be created only on a host belonging to that server's node, set "),t("code",[e._v("PTERODACTYL_CLIENT_DATABASES_ALLOW_RANDOM")]),e._v("\nto be "),t("code",[e._v("false")]),e._v(".")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("PTERODACTYL_CLIENT_DATABASES_ENABLED=true\nPTERODACTYL_CLIENT_DATABASES_ALLOW_RANDOM=true\n")])])]),t("h2",{attrs:{id:"reverse-proxy-setup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#reverse-proxy-setup"}},[e._v("#")]),e._v(" Reverse Proxy Setup")]),e._v(" "),t("p",[e._v("If you are planning on running Pterodactyl behind a reverse proxy, either using NGINX or because you are using\n"),t("a",{attrs:{href:"https://support.cloudflare.com/hc/en-us/articles/200170416-What-do-the-SSL-options-mean-",target:"_blank",rel:"noopener noreferrer"}},[e._v("Cloudflare's Flexible SSL"),t("OutboundLink")],1),e._v(",\nyou will need to make a quick modification to the Panel to ensure things continue to work as expected. By default when\nyou are using these reverse proxies your Panel will not understand how to properly handle requests and you'll most likely\nbe unable to login, or will see security warnings in your browser console as it attempts to load insecure assets. This\nis because the internal logic the Panel is using to determine how links should be generated thinks it is running over\nHTTP, and not over HTTPS.")]),e._v(" "),t("p",[e._v("You will need to edit the "),t("code",[e._v(".env")]),e._v(" file in the Panel's root directory to contain "),t("code",[e._v("TRUSTED_PROXIES=*")]),e._v(" at minimum. We\nhighly suggest providing a specific IP address (or comma separated list of IPs) rather than allowing "),t("code",[e._v("*")]),e._v(". For example,\nif your proxy is running on the same machine as the server, chances are that something like "),t("code",[e._v("TRUSTED_PROXIES=127.0.0.1")]),e._v("\nwill work for you.")]),e._v(" "),t("h3",{attrs:{id:"nginx-specific-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#nginx-specific-configuration"}},[e._v("#")]),e._v(" NGINX Specific Configuration")]),e._v(" "),t("p",[e._v("For Pterodactyl to properly respond to an NGINX reverse proxy, the NGINX "),t("code",[e._v("location")]),e._v(" config must contain the following lines:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("proxy_set_header X-Real-IP $remote_addr;\nproxy_set_header Host $host;\nproxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\nproxy_set_header X-Forwarded-Proto $scheme;\nproxy_redirect off;\nproxy_buffering off;\nproxy_request_buffering off;\n")])])]),t("h3",{attrs:{id:"cloudflare-specific-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#cloudflare-specific-configuration"}},[e._v("#")]),e._v(" Cloudflare Specific Configuration")]),e._v(" "),t("p",[e._v("If you're using Cloudflare's Flexible SSL you should set "),t("code",[e._v("TRUSTED_PROXIES")]),e._v(" to contain "),t("a",{attrs:{href:"https://www.cloudflare.com/ips/",target:"_blank",rel:"noopener noreferrer"}},[e._v("their IP addresses"),t("OutboundLink")],1),e._v(".\nBelow is an example of how to set this.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("TRUSTED_PROXIES=103.21.244.0/22,103.22.200.0/22,103.31.4.0/22,104.16.0.0/12,108.162.192.0/18,131.0.72.0/22,141.101.64.0/18,162.158.0.0/15,172.64.0.0/13,173.245.48.0/20,188.114.96.0/20,190.93.240.0/20,197.234.240.0/22,198.41.128.0/17\n")])])]),t("h2",{attrs:{id:"increasing-the-editable-file-size"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#increasing-the-editable-file-size"}},[e._v("#")]),e._v(" Increasing the Editable File Size")]),e._v(" "),t("p",[e._v("By default the Panel attempts to set a reasonable limit for editing files through the web based file manager. However,\nsome users find it too restrictive and wish to increase the size. This is controlled by a configuration value that can\nalso be set using the "),t("code",[e._v(".env")]),e._v(" file. The default value is "),t("code",[e._v("50,000")]),e._v(" bytes but this can be increased as you see fit.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("PTERODACTYL_FILES_MAX_EDIT_SIZE=50000\n")])])]),t("h2",{attrs:{id:"disable-or-modify-recaptcha"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#disable-or-modify-recaptcha"}},[e._v("#")]),e._v(" Disable or Modify ReCaptcha")]),e._v(" "),t("p",[e._v("To disable reCAPTCHA on login or password reset, simply set "),t("code",[e._v("RECAPTCHA_ENABLED=false")]),e._v(" in the environment file. This\nchange will take effect immediately.")]),e._v(" "),t("h3",{attrs:{id:"using-your-own-keys"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-your-own-keys"}},[e._v("#")]),e._v(" Using Your Own Keys")]),e._v(" "),t("p",[e._v("Pterodactyl comes preconfigured using a public set of reCAPTCHA keys but you may wish to use your own site\nspecific keys. To do so, follow the instructions below.")]),e._v(" "),t("ol",[t("li",[e._v("Visit "),t("a",{attrs:{href:"https://www.google.com/recaptcha/admin#list",target:"_blank",rel:"noopener noreferrer"}},[e._v("Google's reCAPTCHA Admin Console"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[e._v('Click "Register New Site" and fill in a name for your keys.')]),e._v(" "),t("li",[e._v("Choose "),t("code",[e._v("reCAPTCHA v2")]),e._v(" and ensure that the option for "),t("code",[e._v("Invisible")]),e._v(" is selected.")]),e._v(" "),t("li",[e._v("Include the domain that your panel is located on.")]),e._v(" "),t("li",[e._v('On the next page displayed, locate the "Site Key" and "Secret Key". In Pterodactyl\'s control panel click on "Settings" and then the "Advanced" tab. Enter the keys in the boxes "Site Key" and "Secret Key", respectively.')])]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("Disabling Domain Verification")]),e._v(" "),t("p",[e._v('If you do not want reCAPTCHA to verify the domain making the validation request you can uncheck "Verify the origin of reCaptcha solution" under "Advanced Settings" after generating your key.')])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[52],{312:function(e,t,a){"use strict";a.r(t);var o=a(15),n=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"environment-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#environment-configuration"}},[e._v("#")]),e._v(" Environment Configuration")]),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#reporting-all-exceptions"}},[e._v("Reporting All Exceptions")])]),t("li",[t("a",{attrs:{href:"#client-databases"}},[e._v("Client Databases")])]),t("li",[t("a",{attrs:{href:"#reverse-proxy-setup"}},[e._v("Reverse Proxy Setup")]),t("ul",[t("li",[t("a",{attrs:{href:"#nginx-specific-configuration"}},[e._v("NGINX Specific Configuration")])]),t("li",[t("a",{attrs:{href:"#cloudflare-specific-configuration"}},[e._v("Cloudflare Specific Configuration")])])])]),t("li",[t("a",{attrs:{href:"#increasing-the-editable-file-size"}},[e._v("Increasing the Editable File Size")])]),t("li",[t("a",{attrs:{href:"#disable-or-modify-recaptcha"}},[e._v("Disable or Modify ReCaptcha")]),t("ul",[t("li",[t("a",{attrs:{href:"#using-your-own-keys"}},[e._v("Using Your Own Keys")])])])])])]),t("p"),e._v(" "),t("p",[e._v("Pterodactyl's environment settings are configured and stored in an environment file — "),t("code",[e._v(".env")]),e._v(" — located in the\ninstallation root directory — generally "),t("code",[e._v("/var/www/pterodactyl")]),e._v(". Some of these settings are also stored in the database\nand will override settings found in the environment file.")]),e._v(" "),t("p",[e._v("To change this behavior you can edit the "),t("code",[e._v(".env")]),e._v(" file and change the setting "),t("code",[e._v("APP_ENVIRONMENT_ONLY=false")]),e._v(" to\n"),t("code",[e._v("APP_ENVIRONMENT_ONLY=true")]),e._v(" which will take effect the next time you refresh a page on the Panel. Generally you will\nonly need to do this if you severly corrupt a setting in the Panel or are deep in development with the software.")]),e._v(" "),t("h2",{attrs:{id:"reporting-all-exceptions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#reporting-all-exceptions"}},[e._v("#")]),e._v(" Reporting All Exceptions")]),e._v(" "),t("p",[e._v("By default Pterodactyl only logs and reports exceptions that are, well, exceptional by nature. There are some exceptions\nthat we expect to occur such as authentication failures or validation issues. However, in rare instances when developing,\nor even on production servers, you might need to have all exceptions logged to detect inconsistent behavior.")]),e._v(" "),t("p",[e._v("To do this, simply set "),t("code",[e._v("APP_REPORT_ALL_EXCEPTIONS=true")]),e._v(" in your "),t("code",[e._v(".env")]),e._v(" file. You'll want to turn this off once you've\ncompleted whatever it is you're needing the exceptions for, otherwise your logs will become very large, very quickly.")]),e._v(" "),t("h2",{attrs:{id:"client-databases"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#client-databases"}},[e._v("#")]),e._v(" Client Databases")]),e._v(" "),t("p",[e._v("By default Pterodactyl ships with the ability for clients to have their own per-server databases. If you wish to disable\nthis ability, set "),t("code",[e._v("PTERODACTYL_CLIENT_DATABASES_ENABLED")]),e._v(" to be "),t("code",[e._v("false")]),e._v(". Pterodactyl also attempts to create databases\non a database host assigned to the current server's node but will use any host if one can't be found. If you would like\nto force a database to be created only on a host belonging to that server's node, set "),t("code",[e._v("PTERODACTYL_CLIENT_DATABASES_ALLOW_RANDOM")]),e._v("\nto be "),t("code",[e._v("false")]),e._v(".")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("PTERODACTYL_CLIENT_DATABASES_ENABLED=true\nPTERODACTYL_CLIENT_DATABASES_ALLOW_RANDOM=true\n")])])]),t("h2",{attrs:{id:"reverse-proxy-setup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#reverse-proxy-setup"}},[e._v("#")]),e._v(" Reverse Proxy Setup")]),e._v(" "),t("p",[e._v("If you are planning on running Pterodactyl behind a reverse proxy, either using NGINX or because you are using\n"),t("a",{attrs:{href:"https://support.cloudflare.com/hc/en-us/articles/200170416-What-do-the-SSL-options-mean-",target:"_blank",rel:"noopener noreferrer"}},[e._v("Cloudflare's Flexible SSL"),t("OutboundLink")],1),e._v(",\nyou will need to make a quick modification to the Panel to ensure things continue to work as expected. By default when\nyou are using these reverse proxies your Panel will not understand how to properly handle requests and you'll most likely\nbe unable to login, or will see security warnings in your browser console as it attempts to load insecure assets. This\nis because the internal logic the Panel is using to determine how links should be generated thinks it is running over\nHTTP, and not over HTTPS.")]),e._v(" "),t("p",[e._v("You will need to edit the "),t("code",[e._v(".env")]),e._v(" file in the Panel's root directory to contain "),t("code",[e._v("TRUSTED_PROXIES=*")]),e._v(" at minimum. We\nhighly suggest providing a specific IP address (or comma separated list of IPs) rather than allowing "),t("code",[e._v("*")]),e._v(". For example,\nif your proxy is running on the same machine as the server, chances are that something like "),t("code",[e._v("TRUSTED_PROXIES=127.0.0.1")]),e._v("\nwill work for you.")]),e._v(" "),t("h3",{attrs:{id:"nginx-specific-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#nginx-specific-configuration"}},[e._v("#")]),e._v(" NGINX Specific Configuration")]),e._v(" "),t("p",[e._v("For Pterodactyl to properly respond to an NGINX reverse proxy, the NGINX "),t("code",[e._v("location")]),e._v(" config must contain the following lines:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("proxy_set_header X-Real-IP $remote_addr;\nproxy_set_header Host $host;\nproxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\nproxy_set_header X-Forwarded-Proto $scheme;\nproxy_redirect off;\nproxy_buffering off;\nproxy_request_buffering off;\n")])])]),t("h3",{attrs:{id:"cloudflare-specific-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#cloudflare-specific-configuration"}},[e._v("#")]),e._v(" Cloudflare Specific Configuration")]),e._v(" "),t("p",[e._v("If you're using Cloudflare's Flexible SSL you should set "),t("code",[e._v("TRUSTED_PROXIES")]),e._v(" to contain "),t("a",{attrs:{href:"https://www.cloudflare.com/ips/",target:"_blank",rel:"noopener noreferrer"}},[e._v("their IP addresses"),t("OutboundLink")],1),e._v(".\nBelow is an example of how to set this.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("TRUSTED_PROXIES=103.21.244.0/22,103.22.200.0/22,103.31.4.0/22,104.16.0.0/12,108.162.192.0/18,131.0.72.0/22,141.101.64.0/18,162.158.0.0/15,172.64.0.0/13,173.245.48.0/20,188.114.96.0/20,190.93.240.0/20,197.234.240.0/22,198.41.128.0/17\n")])])]),t("h2",{attrs:{id:"increasing-the-editable-file-size"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#increasing-the-editable-file-size"}},[e._v("#")]),e._v(" Increasing the Editable File Size")]),e._v(" "),t("p",[e._v("By default the Panel attempts to set a reasonable limit for editing files through the web based file manager. However,\nsome users find it too restrictive and wish to increase the size. This is controlled by a configuration value that can\nalso be set using the "),t("code",[e._v(".env")]),e._v(" file. The default value is "),t("code",[e._v("50,000")]),e._v(" bytes but this can be increased as you see fit.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("PTERODACTYL_FILES_MAX_EDIT_SIZE=50000\n")])])]),t("h2",{attrs:{id:"disable-or-modify-recaptcha"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#disable-or-modify-recaptcha"}},[e._v("#")]),e._v(" Disable or Modify ReCaptcha")]),e._v(" "),t("p",[e._v("To disable reCAPTCHA on login or password reset, simply set "),t("code",[e._v("RECAPTCHA_ENABLED=false")]),e._v(" in the environment file. This\nchange will take effect immediately.")]),e._v(" "),t("h3",{attrs:{id:"using-your-own-keys"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-your-own-keys"}},[e._v("#")]),e._v(" Using Your Own Keys")]),e._v(" "),t("p",[e._v("Pterodactyl comes preconfigured using a public set of reCAPTCHA keys but you may wish to use your own site\nspecific keys. To do so, follow the instructions below.")]),e._v(" "),t("ol",[t("li",[e._v("Visit "),t("a",{attrs:{href:"https://www.google.com/recaptcha/admin#list",target:"_blank",rel:"noopener noreferrer"}},[e._v("Google's reCAPTCHA Admin Console"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[e._v('Click "Register New Site" and fill in a name for your keys.')]),e._v(" "),t("li",[e._v("Choose "),t("code",[e._v("reCAPTCHA v2")]),e._v(" and ensure that the option for "),t("code",[e._v("Invisible")]),e._v(" is selected.")]),e._v(" "),t("li",[e._v("Include the domain that your panel is located on.")]),e._v(" "),t("li",[e._v('On the next page displayed, locate the "Site Key" and "Secret Key". In Pterodactyl\'s control panel click on "Settings" and then the "Advanced" tab. Enter the keys in the boxes "Site Key" and "Secret Key", respectively.')])]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("Disabling Domain Verification")]),e._v(" "),t("p",[e._v('If you do not want reCAPTCHA to verify the domain making the validation request you can uncheck "Verify the origin of reCaptcha solution" under "Advanced Settings" after generating your key.')])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/53.563a7575.js b/assets/js/53.944dc699.js similarity index 99% rename from assets/js/53.563a7575.js rename to assets/js/53.944dc699.js index 5c5c92d5..27cf325a 100644 --- a/assets/js/53.563a7575.js +++ b/assets/js/53.944dc699.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[53],{312:function(e,t,a){"use strict";a.r(t);var s=a(15),n=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"getting-started"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getting-started"}},[e._v("#")]),e._v(" Getting Started")]),e._v(" "),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("This Version is End-of-Life")]),e._v(" "),t("p",[e._v("This documentation is for "),t("strong",[e._v("end-of-life software")]),e._v(" which does not recieve any security updates or support\nfrom the community. This documentation has been left accessible for historial reasons.")]),e._v(" "),t("p",[e._v("You should be installing and using "),t("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html"}},[e._v("Pterodactyl Panel 1.0")]),e._v(" in production environments.")],1)]),e._v(" "),t("p",[e._v("Pterodactyl Panel is designed to run on your own web server. You will need to have root access to your server in order\nto run and use this panel.")]),e._v(" "),t("p",[e._v("This panel does not exist as a drag-and-drop service to run your servers. It is a highly complex system\nrequiring multiple dependencies and administrators willing to spend some time learning how to use it. If you expect\nto be able to install this with no understanding of basic Linux system administration you should stop and turn\naround now.")]),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#picking-a-server-os"}},[e._v("Picking a Server OS")])]),t("li",[t("a",{attrs:{href:"#dependencies"}},[e._v("Dependencies")]),t("ul",[t("li",[t("a",{attrs:{href:"#example-dependency-installation"}},[e._v("Example Dependency Installation")])]),t("li",[t("a",{attrs:{href:"#installing-composer"}},[e._v("Installing Composer")])])])]),t("li",[t("a",{attrs:{href:"#download-files"}},[e._v("Download Files")])]),t("li",[t("a",{attrs:{href:"#installation"}},[e._v("Installation")]),t("ul",[t("li",[t("a",{attrs:{href:"#environment-configuration"}},[e._v("Environment Configuration")])]),t("li",[t("a",{attrs:{href:"#database-setup"}},[e._v("Database Setup")])]),t("li",[t("a",{attrs:{href:"#add-the-first-user"}},[e._v("Add The First User")])]),t("li",[t("a",{attrs:{href:"#set-permissions"}},[e._v("Set Permissions")])])])]),t("li",[t("a",{attrs:{href:"#queue-listeners"}},[e._v("Queue Listeners")]),t("ul",[t("li",[t("a",{attrs:{href:"#crontab-configuration"}},[e._v("Crontab Configuration")])]),t("li",[t("a",{attrs:{href:"#create-queue-worker"}},[e._v("Create Queue Worker")])])])])])]),t("p"),e._v(" "),t("h2",{attrs:{id:"picking-a-server-os"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#picking-a-server-os"}},[e._v("#")]),e._v(" Picking a Server OS")]),e._v(" "),t("p",[e._v("Pterodactyl runs on a wide range of operating systems, so pick whichever you are most comfortable using.")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("Pterodactyl does not support most OpenVZ systems due to incompatabilities with Docker. If you are planning on running\nthis software on an OpenVZ based system you will — most likely — not be successful.")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Operating System")]),e._v(" "),t("th",[e._v("Version")]),e._v(" "),t("th",{staticStyle:{"text-align":"center"}},[e._v("Supported")]),e._v(" "),t("th",[e._v("Notes")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("strong",[e._v("Ubuntu")])]),e._v(" "),t("td",[e._v("18.04")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td",[e._v("Documentation written assuming Ubuntu 18.04 as the base OS.")])]),e._v(" "),t("tr",[t("td"),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/community/installation-guides/panel/ubuntu2004.html"}},[e._v("20.04")])],1),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td")]),e._v(" "),t("tr",[t("td",[t("strong",[e._v("CentOS")])]),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/community/installation-guides/panel/centos7.html"}},[e._v("7")])],1),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td",[e._v("Extra repos are required.")])]),e._v(" "),t("tr",[t("td"),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/community/installation-guides/panel/centos8.html"}},[e._v("8")])],1),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td",[e._v("All required packages are part of the base repos.")])]),e._v(" "),t("tr",[t("td",[t("strong",[e._v("Debian")])]),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/community/installation-guides/panel/debian9.html"}},[e._v("9")])],1),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td",[e._v("Extra repos are required.")])]),e._v(" "),t("tr",[t("td"),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/community/installation-guides/panel/debian10.html"}},[e._v("10")])],1),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td",[e._v("All required packages are part of the base repos.")])])])]),e._v(" "),t("h2",{attrs:{id:"dependencies"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dependencies"}},[e._v("#")]),e._v(" Dependencies")]),e._v(" "),t("ul",[t("li",[e._v("PHP "),t("code",[e._v("7.2")]),e._v(" with the following extensions: "),t("code",[e._v("cli")]),e._v(", "),t("code",[e._v("openssl")]),e._v(", "),t("code",[e._v("gd")]),e._v(", "),t("code",[e._v("mysql")]),e._v(", "),t("code",[e._v("PDO")]),e._v(", "),t("code",[e._v("mbstring")]),e._v(", "),t("code",[e._v("tokenizer")]),e._v(", "),t("code",[e._v("bcmath")]),e._v(", "),t("code",[e._v("xml")]),e._v(" or "),t("code",[e._v("dom")]),e._v(", "),t("code",[e._v("curl")]),e._v(", "),t("code",[e._v("zip")]),e._v(", and "),t("code",[e._v("fpm")]),e._v(" if you are planning to use nginx")]),e._v(" "),t("li",[e._v("MySQL "),t("code",[e._v("5.7")]),e._v(" "),t("strong",[e._v("or")]),e._v(" MariaDB "),t("code",[e._v("10.1.3")]),e._v(" or higher")]),e._v(" "),t("li",[e._v("Redis ("),t("code",[e._v("redis-server")]),e._v(")")]),e._v(" "),t("li",[e._v("A webserver (Apache, NGINX, Caddy, etc.)")]),e._v(" "),t("li",[t("code",[e._v("curl")])]),e._v(" "),t("li",[t("code",[e._v("tar")])]),e._v(" "),t("li",[t("code",[e._v("unzip")])]),e._v(" "),t("li",[t("code",[e._v("git")])]),e._v(" "),t("li",[t("code",[e._v("composer")])])]),e._v(" "),t("h3",{attrs:{id:"example-dependency-installation"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#example-dependency-installation"}},[e._v("#")]),e._v(" Example Dependency Installation")]),e._v(" "),t("p",[e._v("The commands below are simply an example of how you might install these dependencies. Please consult with your\noperating system's package manager to determine the correct packages to install.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v('# Add "add-apt-repository" command')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-y")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" software-properties-common "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Add additional repositories for PHP, Redis, and MariaDB")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t("span",{pre:!0,attrs:{class:"token environment constant"}},[e._v("LC_ALL")])]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("C.UTF-8 add-apt-repository "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-y")]),e._v(" ppa:ondrej/php\nadd-apt-repository "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-y")]),e._v(" ppa:chris-lea/redis-server\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-LsS")]),e._v(" https://r.mariadb.com/downloads/mariadb_repo_setup "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("bash")]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Update repositories list")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" update\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Add universe repository if you are on Ubuntu 18.04")]),e._v("\napt-add-repository universe\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Install Dependencies")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-y")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" php7.2 php7.2-cli php7.2-gd php7.2-mysql php7.2-pdo php7.2-mbstring php7.2-tokenizer php7.2-bcmath php7.2-xml php7.2-fpm php7.2-curl php7.2-zip mariadb-server nginx "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("tar")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("unzip")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" redis-server\n")])])]),t("h3",{attrs:{id:"installing-composer"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installing-composer"}},[e._v("#")]),e._v(" Installing Composer")]),e._v(" "),t("p",[e._v("Composer is a dependency manager for PHP that allows us to ship everything you'll need code wise to operate the Panel. You'll\nneed composer installed before continuing in this process.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-sS")]),e._v(" https://getcomposer.org/installer "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" php -- --install-dir"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("/usr/local/bin "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--filename")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("composer "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--1")]),e._v("\n")])])]),t("h2",{attrs:{id:"download-files"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#download-files"}},[e._v("#")]),e._v(" Download Files")]),e._v(" "),t("p",[e._v("The first step in this process is to create the folder where the panel will live and then move ourselves into that\nnewly created folder. Below is an example of how to perform this operation.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("mkdir")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-p")]),e._v(" /var/www/pterodactyl\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" /var/www/pterodactyl\n")])])]),t("p",[e._v("Once you have created a new directory for the Panel and moved into it you'll need to download the Panel files. This\nis as simple as using "),t("code",[e._v("curl")]),e._v(" to download our pre-packaged content. Once it is downloaded you'll need to unpack the archive\nand then set the correct permissions on the "),t("code",[e._v("storage/")]),e._v(" and "),t("code",[e._v("bootstrap/cache/")]),e._v(" directories. These directories\nallow us to store files as well as keep a speedy cache available to reduce load times.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-Lo")]),e._v(" panel.tar.gz https://github.com/pterodactyl/panel/releases/download/v0.7.19/panel.tar.gz\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("tar")]),e._v(" --strip-components"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-xzvf")]),e._v(" panel.tar.gz\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("chmod")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("755")]),e._v(" storage/* bootstrap/cache/\n")])])]),t("h2",{attrs:{id:"installation"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installation"}},[e._v("#")]),e._v(" Installation")]),e._v(" "),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("This Version is End-of-Life")]),e._v(" "),t("p",[e._v("This documentation is for "),t("strong",[e._v("end-of-life software")]),e._v(" which does not recieve any security updates or support\nfrom the community. This documentation has been left accessible for historial reasons.")]),e._v(" "),t("p",[e._v("You should be installing and using "),t("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html"}},[e._v("Pterodactyl Panel 1.0")]),e._v(" in production environments.")],1)]),e._v(" "),t("p",[e._v("Now that all of the files have been downloaded we need to configure some core aspects of the Panel.")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("Database Configuration")]),e._v(" "),t("p",[e._v("You will need a database setup and a user with the correct permissions created for that database before\ncontinuing any further. See below to quickly create a user and database for your Pterodactyl panel, if you are unsure how to do this or want more information, please have a look at "),t("RouterLink",{attrs:{to:"/tutorials/mysql_setup.html"}},[e._v("Setting up MySQL")]),e._v(".")],1),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("$ mysql -u root -p\n\nmysql> CREATE USER 'pterodactyl'@'localhost' IDENTIFIED WITH mysql_native_password BY 'A secure password';\nmysql> CREATE DATABASE panel;\nmysql> GRANT ALL ON panel.* TO 'pterodactyl'@'localhost' WITH GRANT OPTION;\n\n")])])])]),e._v(" "),t("p",[e._v("First we will copy over our default environment settings file, install core dependencies, and then generate a\nnew application encryption key.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("cp")]),e._v(" .env.example .env\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("composer")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" --no-dev --optimize-autoloader\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Only run the command below if you are installing this Panel for")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# the first time and do not have any Pterodactyl Panel data in the database.")]),e._v("\nphp artisan key:generate "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--force")]),e._v("\n")])])]),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("DANGER")]),e._v(" "),t("p",[e._v("Back up your encryption key (APP_KEY in the "),t("code",[e._v(".env")]),e._v(" file). It is used as an encryption key for all data that needs to be stored securely (e.g. api keys).\nStore it somewhere safe - not just on your server. If you lose it, all encrypted data is useless and can't be restored, even if you have database backups.")])]),e._v(" "),t("h3",{attrs:{id:"environment-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#environment-configuration"}},[e._v("#")]),e._v(" Environment Configuration")]),e._v(" "),t("p",[e._v("Pterodactyl's core environment is easily configured using a few different CLI commands built into the app. This step\nwill cover setting up things such as sessions, caching, database credentials, and email sending.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("php artisan p:environment:setup\nphp artisan p:environment:database\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v('# To use PHP\'s internal mail sending (not recommended), select "mail". To use a')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v('# custom SMTP server, select "smtp".')]),e._v("\nphp artisan p:environment:mail\n")])])]),t("h3",{attrs:{id:"database-setup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#database-setup"}},[e._v("#")]),e._v(" Database Setup")]),e._v(" "),t("p",[e._v("Now we need to setup all of the base data for the Panel in the database you created earlier. "),t("strong",[e._v("The command below\nmay take some time to run depending on your machine. Please "),t("em",[e._v("DO NOT")]),e._v(" exit the process until it is completed!")]),e._v(" This\ncommand will setup the database tables and then add all of the Nests & Eggs that power Pterodactyl.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("php artisan migrate "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--seed")]),e._v("\n")])])]),t("h3",{attrs:{id:"add-the-first-user"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#add-the-first-user"}},[e._v("#")]),e._v(" Add The First User")]),e._v(" "),t("p",[e._v("You'll then need to create an administrative user so that you can log into the panel. To do so, run the command below.\nAt this time passwords "),t("strong",[e._v("must")]),e._v(" meet the following requirements: 8 characters, mixed case, at least one number.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("php artisan p:user:make\n")])])]),t("h3",{attrs:{id:"set-permissions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-permissions"}},[e._v("#")]),e._v(" Set Permissions")]),e._v(" "),t("p",[e._v("The last step in the installation process is to set the correct permissions on the Panel files so that the webserver can\nuse them correctly.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using NGINX or Apache (not on CentOS):")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("chown")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" www-data:www-data * \n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using NGINX on CentOS:")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("chown")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" nginx:nginx *\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using Apache on CentOS")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("chown")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" apache:apache *\n")])])]),t("h2",{attrs:{id:"queue-listeners"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#queue-listeners"}},[e._v("#")]),e._v(" Queue Listeners")]),e._v(" "),t("p",[e._v("We make use of queues to make the application faster and handle sending emails and other actions in the background.\nYou will need to setup the queue worker for these actions to be processed.")]),e._v(" "),t("h3",{attrs:{id:"crontab-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#crontab-configuration"}},[e._v("#")]),e._v(" Crontab Configuration")]),e._v(" "),t("p",[e._v("The first thing we need to do is create a new cronjob that runs every minute to process specific Pterodactyl tasks, such\nas session cleanup and sending scheduled tasks to daemons. You'll want to open your crontab using "),t("code",[e._v("sudo crontab -e")]),e._v(" and\nthen paste the line below.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("* * * * * php /var/www/pterodactyl/artisan schedule:run "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">>")]),e._v(" /dev/null "),t("span",{pre:!0,attrs:{class:"token operator"}},[t("span",{pre:!0,attrs:{class:"token file-descriptor important"}},[e._v("2")]),e._v(">")]),t("span",{pre:!0,attrs:{class:"token file-descriptor important"}},[e._v("&1")]),e._v("\n")])])]),t("h3",{attrs:{id:"create-queue-worker"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#create-queue-worker"}},[e._v("#")]),e._v(" Create Queue Worker")]),e._v(" "),t("p",[e._v("Next you need to create a new systemd worker to keep our queue process running in the background. This queue is responsible\nfor sending emails and handling many other background tasks for Pterodactyl.")]),e._v(" "),t("p",[e._v("Create a file called "),t("code",[e._v("pteroq.service")]),e._v(" in "),t("code",[e._v("/etc/systemd/system")]),e._v(" with the contents below.")]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("# Pterodactyl Queue Worker File\n# ----------------------------------\n\n[Unit]\nDescription=Pterodactyl Queue Worker\nAfter=redis-server.service\n\n[Service]\n# On some systems the user and group might be different.\n# Some systems use `apache` or `nginx` as the user and group.\nUser=www-data\nGroup=www-data\nRestart=always\nExecStart=/usr/bin/php /var/www/pterodactyl/artisan queue:work --queue=high,standard,low --sleep=3 --tries=3\n\n[Install]\nWantedBy=multi-user.target\n")])])]),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("Redis on CentOS")]),e._v(" "),t("p",[e._v("If you are using CentOS, you will need to replace "),t("code",[e._v("redis-server.service")]),e._v(" with "),t("code",[e._v("redis.service")]),e._v(" at the "),t("code",[e._v("After=")]),e._v(" line in order to ensure "),t("code",[e._v("redis")]),e._v(" starts before the queue worker.")])]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("If you are not using "),t("code",[e._v("redis")]),e._v(" for anything you should remove the "),t("code",[e._v("After=")]),e._v(" line, otherwise you will encounter errors\nwhen the service starts.")])]),e._v(" "),t("p",[e._v("If you are are using redis for your system, you will want to make sure to enable that it will start on boot. You can do that by running the following command:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" systemctl "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("enable")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--now")]),e._v(" redis-server\n")])])]),t("p",[e._v("Finally, enable the service and set it to boot on machine start.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" systemctl "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("enable")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--now")]),e._v(" pteroq.service\n")])])]),t("h4",{attrs:{id:"next-step-webserver-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#next-step-webserver-configuration"}},[e._v("#")]),e._v(" Next Step: "),t("a",{attrs:{href:"./webserver_configuration"}},[e._v("Webserver Configuration")])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[53],{313:function(e,t,a){"use strict";a.r(t);var s=a(15),n=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"getting-started"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getting-started"}},[e._v("#")]),e._v(" Getting Started")]),e._v(" "),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("This Version is End-of-Life")]),e._v(" "),t("p",[e._v("This documentation is for "),t("strong",[e._v("end-of-life software")]),e._v(" which does not recieve any security updates or support\nfrom the community. This documentation has been left accessible for historial reasons.")]),e._v(" "),t("p",[e._v("You should be installing and using "),t("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html"}},[e._v("Pterodactyl Panel 1.0")]),e._v(" in production environments.")],1)]),e._v(" "),t("p",[e._v("Pterodactyl Panel is designed to run on your own web server. You will need to have root access to your server in order\nto run and use this panel.")]),e._v(" "),t("p",[e._v("This panel does not exist as a drag-and-drop service to run your servers. It is a highly complex system\nrequiring multiple dependencies and administrators willing to spend some time learning how to use it. If you expect\nto be able to install this with no understanding of basic Linux system administration you should stop and turn\naround now.")]),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#picking-a-server-os"}},[e._v("Picking a Server OS")])]),t("li",[t("a",{attrs:{href:"#dependencies"}},[e._v("Dependencies")]),t("ul",[t("li",[t("a",{attrs:{href:"#example-dependency-installation"}},[e._v("Example Dependency Installation")])]),t("li",[t("a",{attrs:{href:"#installing-composer"}},[e._v("Installing Composer")])])])]),t("li",[t("a",{attrs:{href:"#download-files"}},[e._v("Download Files")])]),t("li",[t("a",{attrs:{href:"#installation"}},[e._v("Installation")]),t("ul",[t("li",[t("a",{attrs:{href:"#environment-configuration"}},[e._v("Environment Configuration")])]),t("li",[t("a",{attrs:{href:"#database-setup"}},[e._v("Database Setup")])]),t("li",[t("a",{attrs:{href:"#add-the-first-user"}},[e._v("Add The First User")])]),t("li",[t("a",{attrs:{href:"#set-permissions"}},[e._v("Set Permissions")])])])]),t("li",[t("a",{attrs:{href:"#queue-listeners"}},[e._v("Queue Listeners")]),t("ul",[t("li",[t("a",{attrs:{href:"#crontab-configuration"}},[e._v("Crontab Configuration")])]),t("li",[t("a",{attrs:{href:"#create-queue-worker"}},[e._v("Create Queue Worker")])])])])])]),t("p"),e._v(" "),t("h2",{attrs:{id:"picking-a-server-os"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#picking-a-server-os"}},[e._v("#")]),e._v(" Picking a Server OS")]),e._v(" "),t("p",[e._v("Pterodactyl runs on a wide range of operating systems, so pick whichever you are most comfortable using.")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("Pterodactyl does not support most OpenVZ systems due to incompatabilities with Docker. If you are planning on running\nthis software on an OpenVZ based system you will — most likely — not be successful.")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Operating System")]),e._v(" "),t("th",[e._v("Version")]),e._v(" "),t("th",{staticStyle:{"text-align":"center"}},[e._v("Supported")]),e._v(" "),t("th",[e._v("Notes")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("strong",[e._v("Ubuntu")])]),e._v(" "),t("td",[e._v("18.04")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td",[e._v("Documentation written assuming Ubuntu 18.04 as the base OS.")])]),e._v(" "),t("tr",[t("td"),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/community/installation-guides/panel/ubuntu2004.html"}},[e._v("20.04")])],1),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td")]),e._v(" "),t("tr",[t("td",[t("strong",[e._v("CentOS")])]),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/community/installation-guides/panel/centos7.html"}},[e._v("7")])],1),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td",[e._v("Extra repos are required.")])]),e._v(" "),t("tr",[t("td"),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/community/installation-guides/panel/centos8.html"}},[e._v("8")])],1),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td",[e._v("All required packages are part of the base repos.")])]),e._v(" "),t("tr",[t("td",[t("strong",[e._v("Debian")])]),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/community/installation-guides/panel/debian9.html"}},[e._v("9")])],1),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td",[e._v("Extra repos are required.")])]),e._v(" "),t("tr",[t("td"),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/community/installation-guides/panel/debian10.html"}},[e._v("10")])],1),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td",[e._v("All required packages are part of the base repos.")])])])]),e._v(" "),t("h2",{attrs:{id:"dependencies"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dependencies"}},[e._v("#")]),e._v(" Dependencies")]),e._v(" "),t("ul",[t("li",[e._v("PHP "),t("code",[e._v("7.2")]),e._v(" with the following extensions: "),t("code",[e._v("cli")]),e._v(", "),t("code",[e._v("openssl")]),e._v(", "),t("code",[e._v("gd")]),e._v(", "),t("code",[e._v("mysql")]),e._v(", "),t("code",[e._v("PDO")]),e._v(", "),t("code",[e._v("mbstring")]),e._v(", "),t("code",[e._v("tokenizer")]),e._v(", "),t("code",[e._v("bcmath")]),e._v(", "),t("code",[e._v("xml")]),e._v(" or "),t("code",[e._v("dom")]),e._v(", "),t("code",[e._v("curl")]),e._v(", "),t("code",[e._v("zip")]),e._v(", and "),t("code",[e._v("fpm")]),e._v(" if you are planning to use nginx")]),e._v(" "),t("li",[e._v("MySQL "),t("code",[e._v("5.7")]),e._v(" "),t("strong",[e._v("or")]),e._v(" MariaDB "),t("code",[e._v("10.1.3")]),e._v(" or higher")]),e._v(" "),t("li",[e._v("Redis ("),t("code",[e._v("redis-server")]),e._v(")")]),e._v(" "),t("li",[e._v("A webserver (Apache, NGINX, Caddy, etc.)")]),e._v(" "),t("li",[t("code",[e._v("curl")])]),e._v(" "),t("li",[t("code",[e._v("tar")])]),e._v(" "),t("li",[t("code",[e._v("unzip")])]),e._v(" "),t("li",[t("code",[e._v("git")])]),e._v(" "),t("li",[t("code",[e._v("composer")])])]),e._v(" "),t("h3",{attrs:{id:"example-dependency-installation"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#example-dependency-installation"}},[e._v("#")]),e._v(" Example Dependency Installation")]),e._v(" "),t("p",[e._v("The commands below are simply an example of how you might install these dependencies. Please consult with your\noperating system's package manager to determine the correct packages to install.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v('# Add "add-apt-repository" command')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-y")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" software-properties-common "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Add additional repositories for PHP, Redis, and MariaDB")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t("span",{pre:!0,attrs:{class:"token environment constant"}},[e._v("LC_ALL")])]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("C.UTF-8 add-apt-repository "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-y")]),e._v(" ppa:ondrej/php\nadd-apt-repository "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-y")]),e._v(" ppa:chris-lea/redis-server\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-LsS")]),e._v(" https://r.mariadb.com/downloads/mariadb_repo_setup "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("bash")]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Update repositories list")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" update\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Add universe repository if you are on Ubuntu 18.04")]),e._v("\napt-add-repository universe\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Install Dependencies")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-y")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" php7.2 php7.2-cli php7.2-gd php7.2-mysql php7.2-pdo php7.2-mbstring php7.2-tokenizer php7.2-bcmath php7.2-xml php7.2-fpm php7.2-curl php7.2-zip mariadb-server nginx "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("tar")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("unzip")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" redis-server\n")])])]),t("h3",{attrs:{id:"installing-composer"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installing-composer"}},[e._v("#")]),e._v(" Installing Composer")]),e._v(" "),t("p",[e._v("Composer is a dependency manager for PHP that allows us to ship everything you'll need code wise to operate the Panel. You'll\nneed composer installed before continuing in this process.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-sS")]),e._v(" https://getcomposer.org/installer "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" php -- --install-dir"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("/usr/local/bin "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--filename")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("composer "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--1")]),e._v("\n")])])]),t("h2",{attrs:{id:"download-files"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#download-files"}},[e._v("#")]),e._v(" Download Files")]),e._v(" "),t("p",[e._v("The first step in this process is to create the folder where the panel will live and then move ourselves into that\nnewly created folder. Below is an example of how to perform this operation.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("mkdir")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-p")]),e._v(" /var/www/pterodactyl\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" /var/www/pterodactyl\n")])])]),t("p",[e._v("Once you have created a new directory for the Panel and moved into it you'll need to download the Panel files. This\nis as simple as using "),t("code",[e._v("curl")]),e._v(" to download our pre-packaged content. Once it is downloaded you'll need to unpack the archive\nand then set the correct permissions on the "),t("code",[e._v("storage/")]),e._v(" and "),t("code",[e._v("bootstrap/cache/")]),e._v(" directories. These directories\nallow us to store files as well as keep a speedy cache available to reduce load times.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-Lo")]),e._v(" panel.tar.gz https://github.com/pterodactyl/panel/releases/download/v0.7.19/panel.tar.gz\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("tar")]),e._v(" --strip-components"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-xzvf")]),e._v(" panel.tar.gz\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("chmod")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("755")]),e._v(" storage/* bootstrap/cache/\n")])])]),t("h2",{attrs:{id:"installation"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installation"}},[e._v("#")]),e._v(" Installation")]),e._v(" "),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("This Version is End-of-Life")]),e._v(" "),t("p",[e._v("This documentation is for "),t("strong",[e._v("end-of-life software")]),e._v(" which does not recieve any security updates or support\nfrom the community. This documentation has been left accessible for historial reasons.")]),e._v(" "),t("p",[e._v("You should be installing and using "),t("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html"}},[e._v("Pterodactyl Panel 1.0")]),e._v(" in production environments.")],1)]),e._v(" "),t("p",[e._v("Now that all of the files have been downloaded we need to configure some core aspects of the Panel.")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("Database Configuration")]),e._v(" "),t("p",[e._v("You will need a database setup and a user with the correct permissions created for that database before\ncontinuing any further. See below to quickly create a user and database for your Pterodactyl panel, if you are unsure how to do this or want more information, please have a look at "),t("RouterLink",{attrs:{to:"/tutorials/mysql_setup.html"}},[e._v("Setting up MySQL")]),e._v(".")],1),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("$ mysql -u root -p\n\nmysql> CREATE USER 'pterodactyl'@'localhost' IDENTIFIED WITH mysql_native_password BY 'A secure password';\nmysql> CREATE DATABASE panel;\nmysql> GRANT ALL ON panel.* TO 'pterodactyl'@'localhost' WITH GRANT OPTION;\n\n")])])])]),e._v(" "),t("p",[e._v("First we will copy over our default environment settings file, install core dependencies, and then generate a\nnew application encryption key.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("cp")]),e._v(" .env.example .env\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("composer")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" --no-dev --optimize-autoloader\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Only run the command below if you are installing this Panel for")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# the first time and do not have any Pterodactyl Panel data in the database.")]),e._v("\nphp artisan key:generate "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--force")]),e._v("\n")])])]),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("DANGER")]),e._v(" "),t("p",[e._v("Back up your encryption key (APP_KEY in the "),t("code",[e._v(".env")]),e._v(" file). It is used as an encryption key for all data that needs to be stored securely (e.g. api keys).\nStore it somewhere safe - not just on your server. If you lose it, all encrypted data is useless and can't be restored, even if you have database backups.")])]),e._v(" "),t("h3",{attrs:{id:"environment-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#environment-configuration"}},[e._v("#")]),e._v(" Environment Configuration")]),e._v(" "),t("p",[e._v("Pterodactyl's core environment is easily configured using a few different CLI commands built into the app. This step\nwill cover setting up things such as sessions, caching, database credentials, and email sending.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("php artisan p:environment:setup\nphp artisan p:environment:database\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v('# To use PHP\'s internal mail sending (not recommended), select "mail". To use a')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v('# custom SMTP server, select "smtp".')]),e._v("\nphp artisan p:environment:mail\n")])])]),t("h3",{attrs:{id:"database-setup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#database-setup"}},[e._v("#")]),e._v(" Database Setup")]),e._v(" "),t("p",[e._v("Now we need to setup all of the base data for the Panel in the database you created earlier. "),t("strong",[e._v("The command below\nmay take some time to run depending on your machine. Please "),t("em",[e._v("DO NOT")]),e._v(" exit the process until it is completed!")]),e._v(" This\ncommand will setup the database tables and then add all of the Nests & Eggs that power Pterodactyl.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("php artisan migrate "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--seed")]),e._v("\n")])])]),t("h3",{attrs:{id:"add-the-first-user"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#add-the-first-user"}},[e._v("#")]),e._v(" Add The First User")]),e._v(" "),t("p",[e._v("You'll then need to create an administrative user so that you can log into the panel. To do so, run the command below.\nAt this time passwords "),t("strong",[e._v("must")]),e._v(" meet the following requirements: 8 characters, mixed case, at least one number.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("php artisan p:user:make\n")])])]),t("h3",{attrs:{id:"set-permissions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-permissions"}},[e._v("#")]),e._v(" Set Permissions")]),e._v(" "),t("p",[e._v("The last step in the installation process is to set the correct permissions on the Panel files so that the webserver can\nuse them correctly.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using NGINX or Apache (not on CentOS):")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("chown")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" www-data:www-data * \n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using NGINX on CentOS:")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("chown")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" nginx:nginx *\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using Apache on CentOS")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("chown")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" apache:apache *\n")])])]),t("h2",{attrs:{id:"queue-listeners"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#queue-listeners"}},[e._v("#")]),e._v(" Queue Listeners")]),e._v(" "),t("p",[e._v("We make use of queues to make the application faster and handle sending emails and other actions in the background.\nYou will need to setup the queue worker for these actions to be processed.")]),e._v(" "),t("h3",{attrs:{id:"crontab-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#crontab-configuration"}},[e._v("#")]),e._v(" Crontab Configuration")]),e._v(" "),t("p",[e._v("The first thing we need to do is create a new cronjob that runs every minute to process specific Pterodactyl tasks, such\nas session cleanup and sending scheduled tasks to daemons. You'll want to open your crontab using "),t("code",[e._v("sudo crontab -e")]),e._v(" and\nthen paste the line below.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("* * * * * php /var/www/pterodactyl/artisan schedule:run "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">>")]),e._v(" /dev/null "),t("span",{pre:!0,attrs:{class:"token operator"}},[t("span",{pre:!0,attrs:{class:"token file-descriptor important"}},[e._v("2")]),e._v(">")]),t("span",{pre:!0,attrs:{class:"token file-descriptor important"}},[e._v("&1")]),e._v("\n")])])]),t("h3",{attrs:{id:"create-queue-worker"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#create-queue-worker"}},[e._v("#")]),e._v(" Create Queue Worker")]),e._v(" "),t("p",[e._v("Next you need to create a new systemd worker to keep our queue process running in the background. This queue is responsible\nfor sending emails and handling many other background tasks for Pterodactyl.")]),e._v(" "),t("p",[e._v("Create a file called "),t("code",[e._v("pteroq.service")]),e._v(" in "),t("code",[e._v("/etc/systemd/system")]),e._v(" with the contents below.")]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("# Pterodactyl Queue Worker File\n# ----------------------------------\n\n[Unit]\nDescription=Pterodactyl Queue Worker\nAfter=redis-server.service\n\n[Service]\n# On some systems the user and group might be different.\n# Some systems use `apache` or `nginx` as the user and group.\nUser=www-data\nGroup=www-data\nRestart=always\nExecStart=/usr/bin/php /var/www/pterodactyl/artisan queue:work --queue=high,standard,low --sleep=3 --tries=3\n\n[Install]\nWantedBy=multi-user.target\n")])])]),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("Redis on CentOS")]),e._v(" "),t("p",[e._v("If you are using CentOS, you will need to replace "),t("code",[e._v("redis-server.service")]),e._v(" with "),t("code",[e._v("redis.service")]),e._v(" at the "),t("code",[e._v("After=")]),e._v(" line in order to ensure "),t("code",[e._v("redis")]),e._v(" starts before the queue worker.")])]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("If you are not using "),t("code",[e._v("redis")]),e._v(" for anything you should remove the "),t("code",[e._v("After=")]),e._v(" line, otherwise you will encounter errors\nwhen the service starts.")])]),e._v(" "),t("p",[e._v("If you are are using redis for your system, you will want to make sure to enable that it will start on boot. You can do that by running the following command:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" systemctl "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("enable")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--now")]),e._v(" redis-server\n")])])]),t("p",[e._v("Finally, enable the service and set it to boot on machine start.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" systemctl "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("enable")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--now")]),e._v(" pteroq.service\n")])])]),t("h4",{attrs:{id:"next-step-webserver-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#next-step-webserver-configuration"}},[e._v("#")]),e._v(" Next Step: "),t("a",{attrs:{href:"./webserver_configuration"}},[e._v("Webserver Configuration")])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/54.57d4e764.js b/assets/js/54.d6bff428.js similarity index 99% rename from assets/js/54.57d4e764.js rename to assets/js/54.d6bff428.js index 205501b2..288445f2 100644 --- a/assets/js/54.57d4e764.js +++ b/assets/js/54.d6bff428.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[54],{315:function(e,t,a){"use strict";a.r(t);var r=a(15),s=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"troubleshooting"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#troubleshooting"}},[e._v("#")]),e._v(" Troubleshooting")]),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#reading-error-logs"}},[e._v("Reading Error Logs")]),t("ul",[t("li",[t("a",{attrs:{href:"#parsing-the-error"}},[e._v("Parsing the Error")])]),t("li",[t("a",{attrs:{href:"#understanding-the-error"}},[e._v("Understanding the Error")])]),t("li",[t("a",{attrs:{href:"#utilizing-grep"}},[e._v("Utilizing GREP")])])])]),t("li",[t("a",{attrs:{href:"#transfer-exceptions-xhr-poll-error"}},[e._v("Transfer Exceptions / XHR Poll Error")]),t("ul",[t("li",[t("a",{attrs:{href:"#example-errors"}},[e._v("Example Errors")])]),t("li",[t("a",{attrs:{href:"#basic-debugging-steps"}},[e._v("Basic Debugging Steps")])]),t("li",[t("a",{attrs:{href:"#more-advanced-debugging-steps"}},[e._v("More Advanced Debugging Steps")])])])]),t("li",[t("a",{attrs:{href:"#invalid-mac-exception"}},[e._v("Invalid MAC Exception")])]),t("li",[t("a",{attrs:{href:"#selinux-issues"}},[e._v("SELinux Issues")]),t("ul",[t("li",[t("a",{attrs:{href:"#redis-permissions-errors"}},[e._v("Redis Permissions Errors")])]),t("li",[t("a",{attrs:{href:"#in-case-there-is-any-weirdness-with-parts-of-the-panel"}},[e._v("In case there is any weirdness with parts of the panel")])]),t("li",[t("a",{attrs:{href:"#daemon-connection-errors"}},[e._v("Daemon Connection Errors")])])])]),t("li",[t("a",{attrs:{href:"#firewalld-issues"}},[e._v("FirewallD issues")])]),t("li",[t("a",{attrs:{href:"#database-errors"}},[e._v("Database Errors")]),t("ul",[t("li",[t("a",{attrs:{href:"#databasecontroller-php-142"}},[e._v("DatabaseController.php:142")])])])])])]),t("p"),e._v(" "),t("h2",{attrs:{id:"reading-error-logs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#reading-error-logs"}},[e._v("#")]),e._v(" Reading Error Logs")]),e._v(" "),t("p",[e._v("If you ever encounter an unexpected error with the Panel the first thing you will likely be asked for is the logs.\nTo retrieve these, simply execute the command below which will output the last 100 lines of the Panel's log file.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("tail")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-n")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("100")]),e._v(" /var/www/pterodactyl/storage/logs/laravel-"),t("span",{pre:!0,attrs:{class:"token variable"}},[t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$(")]),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("date")]),e._v(" +%F"),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v(")")])]),e._v(".log\n")])])]),t("h3",{attrs:{id:"parsing-the-error"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#parsing-the-error"}},[e._v("#")]),e._v(" Parsing the Error")]),e._v(" "),t("p",[e._v("When you run the command above, you'll probably be hit with a huge wall of text that might scare you. Fear not,\nthis is simply a stacktrace leading to the cause of the error, and you can actually ignore almost all of it when\nlooking for the cause of the error. Lets take a look at some example output below, which has been truncated to\nmake this easier to follow with.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("#70 /srv/www/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php(116): Illuminate\\Foundation\\Http\\Kernel->sendRequestThroughRouter(Object(Illuminate\\Http\\Request))\n#71 /srv/www/public/index.php(53): Illuminate\\Foundation\\Http\\Kernel->handle(Object(Illuminate\\Http\\Request))\n#72 {main}\n[2018-07-19 00:50:24] local.ERROR: ErrorException: file_put_contents(/srv/www/storage/framework/views/c9c05d1357df1ce4ec8fc5df78c16c493b0d4f48.php): failed to open stream: Permission denied in /srv/www/vendor/laravel/framework/src/Illuminate/Filesystem/Filesystem.php:122\nStack trace:\n#0 [internal function]: Illuminate\\Foundation\\Bootstrap\\HandleExceptions->handleError(2, 'file_put_conten...', '/srv/www/vendor...', 122, Array)\n#1 /srv/www/vendor/laravel/framework/src/Illuminate/Filesystem/Filesystem.php(122): file_put_contents('/srv/www/storag...', 's...', 0)\n#2 /srv/www/vendor/laravel/framework/src/Illuminate/View/Compilers/BladeCompiler.php(122): Illuminate\\Filesystem\\Filesystem->put('/srv/www/storag...', 's...')\n#3 /srv/www/vendor/laravel/framework/src/Illuminate/View/Engines/CompilerEngine.php(51): Illuminate\\View\\Compilers\\BladeCompiler->compile('/srv/www/resour...')\n#4 /srv/www/vendor/laravel/framework/src/Illuminate/View/View.php(142): Illuminate\\View\\Engines\\CompilerEngine->get('/srv/www/resour...', Array)\n#5 /srv/www/vendor/laravel/framework/src/Illuminate/View/View.php(125): Illuminate\\View\\View->getContents()\n")])])]),t("p",[e._v("The first thing you'll want to do is follow the chain of numbers "),t("em",[e._v("up")]),e._v(" until you find "),t("code",[e._v("#0")]),e._v(", this will be the function that\ntriggered the exception. Right above line 0 you will see a line that has the date and time in brackets, "),t("code",[e._v("[2018-07-19 00:50:24]")]),e._v("\nabove for example. This line will be the human readable exception that you can use to understand what went wrong.")]),e._v(" "),t("h3",{attrs:{id:"understanding-the-error"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#understanding-the-error"}},[e._v("#")]),e._v(" Understanding the Error")]),e._v(" "),t("p",[e._v("In the example above we can see that the actual error was:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("local.ERROR: ErrorException: file_put_contents(...): failed to open stream: Permission denied in /srv/www/vendor/laravel/framework/src/Illuminate/Filesystem/Filesystem.php:122\n")])])]),t("p",[e._v("From this error we can determine that there was an error performing a "),t("a",{attrs:{href:"http://php.net/manual/en/function.file-put-contents.php",target:"_blank",rel:"noopener noreferrer"}},[e._v("file_put_contents()"),t("OutboundLink")],1),e._v(" call, and the error was\nthat we couldn't open the file because permissions were denied. Its okay if you don't understand the error at all, but\nit does help you get faster support if you're able to provide these logs, and at least find the source of the error.\nSometimes the errors are pretty straightforward and will tell you exactly what went wrong, such as a "),t("code",[e._v("ConnectionException")]),e._v("\nbeing thrown when the Panel can't connect to the Daemon.")]),e._v(" "),t("h3",{attrs:{id:"utilizing-grep"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#utilizing-grep"}},[e._v("#")]),e._v(" Utilizing GREP")]),e._v(" "),t("p",[e._v("If you're trying to go through a bunch of errors quickly, you can use the command below which will limit the results returned to only\nbe the actual error lines, without all of the stack traces.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("tail")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-n")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1000")]),e._v(" /var/www/pterodactyl/storage/logs/laravel-"),t("span",{pre:!0,attrs:{class:"token variable"}},[t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$(")]),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("date")]),e._v(" +%F"),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v(")")])]),e._v(".log "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("grep")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"\\['),t("span",{pre:!0,attrs:{class:"token variable"}},[t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$(")]),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("date")]),e._v(" +%Y"),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v(")")])]),e._v('"')]),e._v("\n")])])]),t("h2",{attrs:{id:"transfer-exceptions-xhr-poll-error"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#transfer-exceptions-xhr-poll-error"}},[e._v("#")]),e._v(" Transfer Exceptions / XHR Poll Error")]),e._v(" "),t("p",[e._v("If you are seeing errors similar to the examples below, chances are there is some networking related issue, or you\njust don't have a required service running.")]),e._v(" "),t("h3",{attrs:{id:"example-errors"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#example-errors"}},[e._v("#")]),e._v(" Example Errors")]),e._v(" "),t("ul",[t("li",[t("p",[e._v('"We were unable to connect to the main Socket.IO server, there may be network issues currently. The panel may not work as expected."')])]),e._v(" "),t("li",[t("p",[e._v('"A TransferException was encountered while trying to contact the daemon, please ensure it\'s online and accessible. This error has been logged."')])])]),e._v(" "),t("h3",{attrs:{id:"basic-debugging-steps"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#basic-debugging-steps"}},[e._v("#")]),e._v(" Basic Debugging Steps")]),e._v(" "),t("ul",[t("li",[t("p",[e._v("Ensure you have AdBlock disabled or whitelisted for your Panel and Daemon domains.")])]),e._v(" "),t("li",[t("p",[e._v("Check your browser's console by pressing "),t("code",[e._v("Ctrl + Shift + J")]),e._v(" (in Chrome) or "),t("code",[e._v("Cmd + Alt + I")]),e._v(" (in Safari). If there is\na red error in it, chances are that it will narrow down the potential problem.")])]),e._v(" "),t("li",[t("p",[e._v("Make sure if the daemon is properly installed and the active configuration matches the configuration shown under\n"),t("code",[e._v("Admin -> Node -> Configuration")]),e._v(" in the Panel.")])]),e._v(" "),t("li",[t("p",[e._v("Check that the Daemon is running, and not reporting errors. Use "),t("code",[e._v("service wings status")]),e._v(" to check the current status of the process.")])]),e._v(" "),t("li",[t("p",[e._v("Check that the Daemon ports are open on your firewall. The Daemon uses ports "),t("code",[e._v("8080")]),e._v(" or "),t("code",[e._v("8443")]),e._v(" for HTTP traffic,\nand "),t("code",[e._v("2022")]),e._v(" for SFTP traffic.")])]),e._v(" "),t("li",[t("p",[e._v("Check that the Panel can reach the Daemon using the domain that is configured on the Panel. Run "),t("code",[e._v("curl https://domain.com:8080")]),e._v(" on the Panel server and ensure that it can connect to the Daemon.")])]),e._v(" "),t("li",[t("p",[e._v("Ensure that you are using the correct HTTP scheme for your Panel and Daemon. If the Panel is running over HTTPS\nthe Daemon will also need to be running on HTTPS.")])])]),e._v(" "),t("h3",{attrs:{id:"more-advanced-debugging-steps"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#more-advanced-debugging-steps"}},[e._v("#")]),e._v(" More Advanced Debugging Steps")]),e._v(" "),t("ul",[t("li",[t("p",[e._v("Stop the Daemon and run "),t("code",[e._v("cd /srv/daemon; sudo npm start")]),e._v(" to see if there are any errors being output by the Daemon.\nIf so, try resolving them manually, or contact us on Discord for more assistance.")])]),e._v(" "),t("li",[t("p",[e._v("Check your DNS and ensure that the response you receive is the one you expect using a tool such as "),t("code",[e._v("nslookup")]),e._v(" or "),t("code",[e._v("dig")]),e._v(".")])]),e._v(" "),t("li",[t("p",[e._v("If you use CloudFlare make sure that the yellow cloud is disabled for your Daemon or Panel "),t("code",[e._v("A")]),e._v(" records.")])]),e._v(" "),t("li",[t("p",[e._v("Make sure when using the daemon behind a firewall — pfSense, OpenSwitch, etc — that the correct NAT settings to access\nthe Daemon's ports from the outside network are setup.")])]),e._v(" "),t("li",[t("p",[e._v("If nothing is working so far, check your own DNS settings and consider switching DNS servers.")])]),e._v(" "),t("li",[t("p",[e._v("When running the Panel and Daemon on one server it can sometimes help if to add an entry in "),t("code",[e._v("/etc/hosts")]),e._v(" that directs\nthe public IP back to the server. Sometimes the reverse path is also needed, so you may need to add an entry to your\nservers "),t("code",[e._v("/etc/hosts")]),e._v(" file that points the Panel's domain to the correct IP.")])]),e._v(" "),t("li",[t("p",[e._v("When running the Daemon and Panel on separate VM's using the same adapter make sure the VM's can connect to each\nother. Promiscuous mode might be needed.")])])]),e._v(" "),t("h2",{attrs:{id:"invalid-mac-exception"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#invalid-mac-exception"}},[e._v("#")]),e._v(" Invalid MAC Exception")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("This error should never happen if you correctly follow our installation and upgrade guides. The only time we have\never seen this error occur is when you blindly restore the Panel database from a backup and try to use a fresh\ninstallation of the Panel.")]),e._v(" "),t("p",[e._v("When restoring backups you should "),t("em",[e._v("always")]),e._v(" restore the "),t("code",[e._v(".env")]),e._v(" file!")])]),e._v(" "),t("p",[e._v("Sometimes when using the Panel you'll unexpectedly encounter a broken page, and upon checking the logs you'll see\nan exception mentioning an invalid MAC when decrypting. This error is caused by mismatched "),t("code",[e._v("APP_KEY")]),e._v("s in your "),t("code",[e._v(".env")]),e._v(" file\nwhen the data was encrypted versus decrypted.")]),e._v(" "),t("p",[e._v("If you are seeing this error the only solution is to restore the "),t("code",[e._v("APP_KEY")]),e._v(" from your "),t("code",[e._v(".env")]),e._v(" file. If you have lost that\noriginal key there is no way to recover the lost data.")]),e._v(" "),t("h2",{attrs:{id:"selinux-issues"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#selinux-issues"}},[e._v("#")]),e._v(" SELinux Issues")]),e._v(" "),t("p",[e._v("On systems with SELinux installed you might encounter unexpected errors when running redis or attempting to connect\nto the daemon to perform actions. These issues can generally be resolved by executing the commands below to allow\nthese programs to work with SELinux.")]),e._v(" "),t("h3",{attrs:{id:"redis-permissions-errors"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#redis-permissions-errors"}},[e._v("#")]),e._v(" Redis Permissions Errors")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("audit2allow "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-a")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-M")]),e._v(" redis_t\nsemodule "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-i")]),e._v(" redis_t.pp\n")])])]),t("h3",{attrs:{id:"in-case-there-is-any-weirdness-with-parts-of-the-panel"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#in-case-there-is-any-weirdness-with-parts-of-the-panel"}},[e._v("#")]),e._v(" In case there is any weirdness with parts of the panel")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("restorecon "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" /var/www/pterodactyl/\n")])])]),t("h3",{attrs:{id:"daemon-connection-errors"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#daemon-connection-errors"}},[e._v("#")]),e._v(" Daemon Connection Errors")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("audit2allow "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-a")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-M")]),e._v(" http_port_t\nsemodule "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-i")]),e._v(" http_port_t.pp\n")])])]),t("h2",{attrs:{id:"firewalld-issues"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#firewalld-issues"}},[e._v("#")]),e._v(" FirewallD issues")]),e._v(" "),t("p",[e._v("If you are on a RHEL/CentOS server with firewalld installed you may have broken DNS.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("firewall-cmd --permanent --zone=trusted --change-interface=pterodactyl0\nfirewall-cmd --reload\n")])])]),t("p",[e._v("restart docker and wings after running these to be sure the rules are applied.")]),e._v(" "),t("h2",{attrs:{id:"database-errors"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#database-errors"}},[e._v("#")]),e._v(" Database Errors")]),e._v(" "),t("h3",{attrs:{id:"databasecontroller-php-142"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#databasecontroller-php-142"}},[e._v("#")]),e._v(" DatabaseController.php:142")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("production.ERROR: ErrorException: Undefined variable: host in /var/www/pterodactyl/app/Http/Controllers/Admin/DatabaseController.php:142\n")])])]),t("p",[e._v("The database user you are trying to use doesn't have appropriate grants/has used incorrect password.")])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[54],{314:function(e,t,a){"use strict";a.r(t);var r=a(15),s=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"troubleshooting"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#troubleshooting"}},[e._v("#")]),e._v(" Troubleshooting")]),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#reading-error-logs"}},[e._v("Reading Error Logs")]),t("ul",[t("li",[t("a",{attrs:{href:"#parsing-the-error"}},[e._v("Parsing the Error")])]),t("li",[t("a",{attrs:{href:"#understanding-the-error"}},[e._v("Understanding the Error")])]),t("li",[t("a",{attrs:{href:"#utilizing-grep"}},[e._v("Utilizing GREP")])])])]),t("li",[t("a",{attrs:{href:"#transfer-exceptions-xhr-poll-error"}},[e._v("Transfer Exceptions / XHR Poll Error")]),t("ul",[t("li",[t("a",{attrs:{href:"#example-errors"}},[e._v("Example Errors")])]),t("li",[t("a",{attrs:{href:"#basic-debugging-steps"}},[e._v("Basic Debugging Steps")])]),t("li",[t("a",{attrs:{href:"#more-advanced-debugging-steps"}},[e._v("More Advanced Debugging Steps")])])])]),t("li",[t("a",{attrs:{href:"#invalid-mac-exception"}},[e._v("Invalid MAC Exception")])]),t("li",[t("a",{attrs:{href:"#selinux-issues"}},[e._v("SELinux Issues")]),t("ul",[t("li",[t("a",{attrs:{href:"#redis-permissions-errors"}},[e._v("Redis Permissions Errors")])]),t("li",[t("a",{attrs:{href:"#in-case-there-is-any-weirdness-with-parts-of-the-panel"}},[e._v("In case there is any weirdness with parts of the panel")])]),t("li",[t("a",{attrs:{href:"#daemon-connection-errors"}},[e._v("Daemon Connection Errors")])])])]),t("li",[t("a",{attrs:{href:"#firewalld-issues"}},[e._v("FirewallD issues")])]),t("li",[t("a",{attrs:{href:"#database-errors"}},[e._v("Database Errors")]),t("ul",[t("li",[t("a",{attrs:{href:"#databasecontroller-php-142"}},[e._v("DatabaseController.php:142")])])])])])]),t("p"),e._v(" "),t("h2",{attrs:{id:"reading-error-logs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#reading-error-logs"}},[e._v("#")]),e._v(" Reading Error Logs")]),e._v(" "),t("p",[e._v("If you ever encounter an unexpected error with the Panel the first thing you will likely be asked for is the logs.\nTo retrieve these, simply execute the command below which will output the last 100 lines of the Panel's log file.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("tail")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-n")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("100")]),e._v(" /var/www/pterodactyl/storage/logs/laravel-"),t("span",{pre:!0,attrs:{class:"token variable"}},[t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$(")]),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("date")]),e._v(" +%F"),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v(")")])]),e._v(".log\n")])])]),t("h3",{attrs:{id:"parsing-the-error"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#parsing-the-error"}},[e._v("#")]),e._v(" Parsing the Error")]),e._v(" "),t("p",[e._v("When you run the command above, you'll probably be hit with a huge wall of text that might scare you. Fear not,\nthis is simply a stacktrace leading to the cause of the error, and you can actually ignore almost all of it when\nlooking for the cause of the error. Lets take a look at some example output below, which has been truncated to\nmake this easier to follow with.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("#70 /srv/www/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php(116): Illuminate\\Foundation\\Http\\Kernel->sendRequestThroughRouter(Object(Illuminate\\Http\\Request))\n#71 /srv/www/public/index.php(53): Illuminate\\Foundation\\Http\\Kernel->handle(Object(Illuminate\\Http\\Request))\n#72 {main}\n[2018-07-19 00:50:24] local.ERROR: ErrorException: file_put_contents(/srv/www/storage/framework/views/c9c05d1357df1ce4ec8fc5df78c16c493b0d4f48.php): failed to open stream: Permission denied in /srv/www/vendor/laravel/framework/src/Illuminate/Filesystem/Filesystem.php:122\nStack trace:\n#0 [internal function]: Illuminate\\Foundation\\Bootstrap\\HandleExceptions->handleError(2, 'file_put_conten...', '/srv/www/vendor...', 122, Array)\n#1 /srv/www/vendor/laravel/framework/src/Illuminate/Filesystem/Filesystem.php(122): file_put_contents('/srv/www/storag...', 's...', 0)\n#2 /srv/www/vendor/laravel/framework/src/Illuminate/View/Compilers/BladeCompiler.php(122): Illuminate\\Filesystem\\Filesystem->put('/srv/www/storag...', 's...')\n#3 /srv/www/vendor/laravel/framework/src/Illuminate/View/Engines/CompilerEngine.php(51): Illuminate\\View\\Compilers\\BladeCompiler->compile('/srv/www/resour...')\n#4 /srv/www/vendor/laravel/framework/src/Illuminate/View/View.php(142): Illuminate\\View\\Engines\\CompilerEngine->get('/srv/www/resour...', Array)\n#5 /srv/www/vendor/laravel/framework/src/Illuminate/View/View.php(125): Illuminate\\View\\View->getContents()\n")])])]),t("p",[e._v("The first thing you'll want to do is follow the chain of numbers "),t("em",[e._v("up")]),e._v(" until you find "),t("code",[e._v("#0")]),e._v(", this will be the function that\ntriggered the exception. Right above line 0 you will see a line that has the date and time in brackets, "),t("code",[e._v("[2018-07-19 00:50:24]")]),e._v("\nabove for example. This line will be the human readable exception that you can use to understand what went wrong.")]),e._v(" "),t("h3",{attrs:{id:"understanding-the-error"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#understanding-the-error"}},[e._v("#")]),e._v(" Understanding the Error")]),e._v(" "),t("p",[e._v("In the example above we can see that the actual error was:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("local.ERROR: ErrorException: file_put_contents(...): failed to open stream: Permission denied in /srv/www/vendor/laravel/framework/src/Illuminate/Filesystem/Filesystem.php:122\n")])])]),t("p",[e._v("From this error we can determine that there was an error performing a "),t("a",{attrs:{href:"http://php.net/manual/en/function.file-put-contents.php",target:"_blank",rel:"noopener noreferrer"}},[e._v("file_put_contents()"),t("OutboundLink")],1),e._v(" call, and the error was\nthat we couldn't open the file because permissions were denied. Its okay if you don't understand the error at all, but\nit does help you get faster support if you're able to provide these logs, and at least find the source of the error.\nSometimes the errors are pretty straightforward and will tell you exactly what went wrong, such as a "),t("code",[e._v("ConnectionException")]),e._v("\nbeing thrown when the Panel can't connect to the Daemon.")]),e._v(" "),t("h3",{attrs:{id:"utilizing-grep"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#utilizing-grep"}},[e._v("#")]),e._v(" Utilizing GREP")]),e._v(" "),t("p",[e._v("If you're trying to go through a bunch of errors quickly, you can use the command below which will limit the results returned to only\nbe the actual error lines, without all of the stack traces.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("tail")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-n")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1000")]),e._v(" /var/www/pterodactyl/storage/logs/laravel-"),t("span",{pre:!0,attrs:{class:"token variable"}},[t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$(")]),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("date")]),e._v(" +%F"),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v(")")])]),e._v(".log "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("grep")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"\\['),t("span",{pre:!0,attrs:{class:"token variable"}},[t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$(")]),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("date")]),e._v(" +%Y"),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v(")")])]),e._v('"')]),e._v("\n")])])]),t("h2",{attrs:{id:"transfer-exceptions-xhr-poll-error"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#transfer-exceptions-xhr-poll-error"}},[e._v("#")]),e._v(" Transfer Exceptions / XHR Poll Error")]),e._v(" "),t("p",[e._v("If you are seeing errors similar to the examples below, chances are there is some networking related issue, or you\njust don't have a required service running.")]),e._v(" "),t("h3",{attrs:{id:"example-errors"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#example-errors"}},[e._v("#")]),e._v(" Example Errors")]),e._v(" "),t("ul",[t("li",[t("p",[e._v('"We were unable to connect to the main Socket.IO server, there may be network issues currently. The panel may not work as expected."')])]),e._v(" "),t("li",[t("p",[e._v('"A TransferException was encountered while trying to contact the daemon, please ensure it\'s online and accessible. This error has been logged."')])])]),e._v(" "),t("h3",{attrs:{id:"basic-debugging-steps"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#basic-debugging-steps"}},[e._v("#")]),e._v(" Basic Debugging Steps")]),e._v(" "),t("ul",[t("li",[t("p",[e._v("Ensure you have AdBlock disabled or whitelisted for your Panel and Daemon domains.")])]),e._v(" "),t("li",[t("p",[e._v("Check your browser's console by pressing "),t("code",[e._v("Ctrl + Shift + J")]),e._v(" (in Chrome) or "),t("code",[e._v("Cmd + Alt + I")]),e._v(" (in Safari). If there is\na red error in it, chances are that it will narrow down the potential problem.")])]),e._v(" "),t("li",[t("p",[e._v("Make sure if the daemon is properly installed and the active configuration matches the configuration shown under\n"),t("code",[e._v("Admin -> Node -> Configuration")]),e._v(" in the Panel.")])]),e._v(" "),t("li",[t("p",[e._v("Check that the Daemon is running, and not reporting errors. Use "),t("code",[e._v("service wings status")]),e._v(" to check the current status of the process.")])]),e._v(" "),t("li",[t("p",[e._v("Check that the Daemon ports are open on your firewall. The Daemon uses ports "),t("code",[e._v("8080")]),e._v(" or "),t("code",[e._v("8443")]),e._v(" for HTTP traffic,\nand "),t("code",[e._v("2022")]),e._v(" for SFTP traffic.")])]),e._v(" "),t("li",[t("p",[e._v("Check that the Panel can reach the Daemon using the domain that is configured on the Panel. Run "),t("code",[e._v("curl https://domain.com:8080")]),e._v(" on the Panel server and ensure that it can connect to the Daemon.")])]),e._v(" "),t("li",[t("p",[e._v("Ensure that you are using the correct HTTP scheme for your Panel and Daemon. If the Panel is running over HTTPS\nthe Daemon will also need to be running on HTTPS.")])])]),e._v(" "),t("h3",{attrs:{id:"more-advanced-debugging-steps"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#more-advanced-debugging-steps"}},[e._v("#")]),e._v(" More Advanced Debugging Steps")]),e._v(" "),t("ul",[t("li",[t("p",[e._v("Stop the Daemon and run "),t("code",[e._v("cd /srv/daemon; sudo npm start")]),e._v(" to see if there are any errors being output by the Daemon.\nIf so, try resolving them manually, or contact us on Discord for more assistance.")])]),e._v(" "),t("li",[t("p",[e._v("Check your DNS and ensure that the response you receive is the one you expect using a tool such as "),t("code",[e._v("nslookup")]),e._v(" or "),t("code",[e._v("dig")]),e._v(".")])]),e._v(" "),t("li",[t("p",[e._v("If you use CloudFlare make sure that the yellow cloud is disabled for your Daemon or Panel "),t("code",[e._v("A")]),e._v(" records.")])]),e._v(" "),t("li",[t("p",[e._v("Make sure when using the daemon behind a firewall — pfSense, OpenSwitch, etc — that the correct NAT settings to access\nthe Daemon's ports from the outside network are setup.")])]),e._v(" "),t("li",[t("p",[e._v("If nothing is working so far, check your own DNS settings and consider switching DNS servers.")])]),e._v(" "),t("li",[t("p",[e._v("When running the Panel and Daemon on one server it can sometimes help if to add an entry in "),t("code",[e._v("/etc/hosts")]),e._v(" that directs\nthe public IP back to the server. Sometimes the reverse path is also needed, so you may need to add an entry to your\nservers "),t("code",[e._v("/etc/hosts")]),e._v(" file that points the Panel's domain to the correct IP.")])]),e._v(" "),t("li",[t("p",[e._v("When running the Daemon and Panel on separate VM's using the same adapter make sure the VM's can connect to each\nother. Promiscuous mode might be needed.")])])]),e._v(" "),t("h2",{attrs:{id:"invalid-mac-exception"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#invalid-mac-exception"}},[e._v("#")]),e._v(" Invalid MAC Exception")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("This error should never happen if you correctly follow our installation and upgrade guides. The only time we have\never seen this error occur is when you blindly restore the Panel database from a backup and try to use a fresh\ninstallation of the Panel.")]),e._v(" "),t("p",[e._v("When restoring backups you should "),t("em",[e._v("always")]),e._v(" restore the "),t("code",[e._v(".env")]),e._v(" file!")])]),e._v(" "),t("p",[e._v("Sometimes when using the Panel you'll unexpectedly encounter a broken page, and upon checking the logs you'll see\nan exception mentioning an invalid MAC when decrypting. This error is caused by mismatched "),t("code",[e._v("APP_KEY")]),e._v("s in your "),t("code",[e._v(".env")]),e._v(" file\nwhen the data was encrypted versus decrypted.")]),e._v(" "),t("p",[e._v("If you are seeing this error the only solution is to restore the "),t("code",[e._v("APP_KEY")]),e._v(" from your "),t("code",[e._v(".env")]),e._v(" file. If you have lost that\noriginal key there is no way to recover the lost data.")]),e._v(" "),t("h2",{attrs:{id:"selinux-issues"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#selinux-issues"}},[e._v("#")]),e._v(" SELinux Issues")]),e._v(" "),t("p",[e._v("On systems with SELinux installed you might encounter unexpected errors when running redis or attempting to connect\nto the daemon to perform actions. These issues can generally be resolved by executing the commands below to allow\nthese programs to work with SELinux.")]),e._v(" "),t("h3",{attrs:{id:"redis-permissions-errors"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#redis-permissions-errors"}},[e._v("#")]),e._v(" Redis Permissions Errors")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("audit2allow "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-a")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-M")]),e._v(" redis_t\nsemodule "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-i")]),e._v(" redis_t.pp\n")])])]),t("h3",{attrs:{id:"in-case-there-is-any-weirdness-with-parts-of-the-panel"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#in-case-there-is-any-weirdness-with-parts-of-the-panel"}},[e._v("#")]),e._v(" In case there is any weirdness with parts of the panel")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("restorecon "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" /var/www/pterodactyl/\n")])])]),t("h3",{attrs:{id:"daemon-connection-errors"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#daemon-connection-errors"}},[e._v("#")]),e._v(" Daemon Connection Errors")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("audit2allow "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-a")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-M")]),e._v(" http_port_t\nsemodule "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-i")]),e._v(" http_port_t.pp\n")])])]),t("h2",{attrs:{id:"firewalld-issues"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#firewalld-issues"}},[e._v("#")]),e._v(" FirewallD issues")]),e._v(" "),t("p",[e._v("If you are on a RHEL/CentOS server with firewalld installed you may have broken DNS.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("firewall-cmd --permanent --zone=trusted --change-interface=pterodactyl0\nfirewall-cmd --reload\n")])])]),t("p",[e._v("restart docker and wings after running these to be sure the rules are applied.")]),e._v(" "),t("h2",{attrs:{id:"database-errors"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#database-errors"}},[e._v("#")]),e._v(" Database Errors")]),e._v(" "),t("h3",{attrs:{id:"databasecontroller-php-142"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#databasecontroller-php-142"}},[e._v("#")]),e._v(" DatabaseController.php:142")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("production.ERROR: ErrorException: Undefined variable: host in /var/www/pterodactyl/app/Http/Controllers/Admin/DatabaseController.php:142\n")])])]),t("p",[e._v("The database user you are trying to use doesn't have appropriate grants/has used incorrect password.")])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/assets/js/55.812633bb.js b/assets/js/55.a226dbb6.js similarity index 99% rename from assets/js/55.812633bb.js rename to assets/js/55.a226dbb6.js index 06de45f5..36db1fa6 100644 --- a/assets/js/55.812633bb.js +++ b/assets/js/55.a226dbb6.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[55],{314:function(e,a,t){"use strict";t.r(a);var s=t(15),n=Object(s.a)({},(function(){var e=this,a=e._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"upgrading-0-6-to-0-7"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#upgrading-0-6-to-0-7"}},[e._v("#")]),e._v(" Upgrading 0.6 to 0.7")]),e._v(" "),a("div",{staticClass:"custom-block danger"},[a("p",{staticClass:"custom-block-title"},[e._v("This Version is End-of-Life")]),e._v(" "),a("p",[e._v("This documentation is for "),a("strong",[e._v("end-of-life software")]),e._v(" which does not recieve any security updates or support\nfrom the community. This documentation has been left accessible for historial reasons.")]),e._v(" "),a("p",[e._v("You should be installing and using "),a("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html"}},[e._v("Pterodactyl Panel 1.0")]),e._v(" in production environments.")],1)]),e._v(" "),a("h2",{attrs:{id:"fetch-updated-files"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#fetch-updated-files"}},[e._v("#")]),e._v(" Fetch Updated Files")]),e._v(" "),a("p",[e._v("The first step in the update process is to download the new panel files from GitHub. The command below will download\nthe release archive for the most recent version of Pterodactyl and save it in the current directory. Now is a good time\nto ensure that you're in the "),a("code",[e._v("/var/www/pterodactyl")]),e._v(" directory as the command below will automatically unpack in whatever\ndirectory you are currently in.")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-L")]),e._v(" https://github.com/pterodactyl/panel/releases/download/v0.7.19/panel.tar.gz "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("tar")]),e._v(" --strip-components"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("1")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-xzv")]),e._v("\n")])])]),a("p",[e._v("Once all of the files are downloaded we need to set the correct permissions on the cache and storage directories to avoid\nany webserver related errors.")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("chmod")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("755")]),e._v(" storage/* bootstrap/cache\n")])])]),a("h2",{attrs:{id:"clear-compiled-assets"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#clear-compiled-assets"}},[e._v("#")]),e._v(" Clear Compiled Assets")]),e._v(" "),a("p",[e._v("Previous versions of Pterodactyl attempted to cache your configuration file for speed and performance enhancements. This\nended up just causing more headaches with minimal improvements in performance, so we decided to stop doing that. Running\nthe command below will clear the cached files for you so we can continue with upgrading.")]),e._v(" "),a("div",{staticClass:"custom-block tip"},[a("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),a("p",[e._v("You probably only need to run this command once when upgrading from "),a("code",[e._v("0.6.X")]),e._v(". Once you're upgraded we don't cache the configuration\nfile so there is no reason to remove anything.")])]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("rm")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-rf")]),e._v(" bootstrap/cache/*\n")])])]),a("p",[e._v("Once the configuration cache is removed, you'll need to clear the template cache to ensure users get the most recent\ntemplates.")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("php artisan view:clear\n")])])]),a("h2",{attrs:{id:"update-dependencies"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#update-dependencies"}},[e._v("#")]),e._v(" Update Dependencies")]),e._v(" "),a("p",[e._v("After you've downloaded all of the new files you will need to upgrade the core components of the panel. To do this,\nsimply run the commands below and follow any prompts.")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("composer")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" --no-dev --optimize-autoloader\n")])])]),a("h2",{attrs:{id:"update-environment"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#update-environment"}},[e._v("#")]),e._v(" Update Environment")]),e._v(" "),a("p",[e._v("These scripts will display your current values in brackets. To keep the current values simply press enter and it will\ncontinue without making any modifications.")]),e._v(" "),a("div",{staticClass:"custom-block tip"},[a("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),a("p",[e._v("We've changed our recommended cache driver to be Redis, rather than Memcached. If you're using Memcached you can\ncontinue doing so with no problems, however moving forward our installation documentation will only mention Redis.")])]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("php artisan p:environment:setup\nphp artisan p:environment:mail\nphp artisan p:environment:database\n")])])]),a("h2",{attrs:{id:"database-updates"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#database-updates"}},[e._v("#")]),e._v(" Database Updates")]),e._v(" "),a("div",{staticClass:"custom-block warning"},[a("p",{staticClass:"custom-block-title"},[e._v("Backup your databases")]),e._v(" "),a("p",[e._v("The upgrade from "),a("code",[e._v("0.6")]),e._v(" to "),a("code",[e._v("v0.7")]),e._v(" includes some rather significant database changes. While the migration utility is\nable to handle everything for you, we still suggest taking a backup of your database before proceeding — just incase.")])]),e._v(" "),a("div",{staticClass:"custom-block warning"},[a("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),a("p",[e._v("Running "),a("code",[e._v("db:seed")]),e._v(" below will overwrite any changes you made to core Pterodactyl Nests, Eggs, or Egg Variables! This is\nunavoidable, and this seeder must be run. To avoid this in the future, please create custom nests, or create custom\neggs for game variations.")])]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("php artisan migrate "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--force")]),e._v("\nphp artisan db:seed "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--force")]),e._v("\n")])])]),a("h2",{attrs:{id:"cleanup-api-keys"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#cleanup-api-keys"}},[e._v("#")]),e._v(" Cleanup API Keys")]),e._v(" "),a("p",[e._v("A significant change is introduced in 0.7.0 that changes how API keys are used, stored, and validated. Due to this\nchange, all previously created keys will no longer function. In order to keep things cleaned up you'll want to remove\nthese orphaned keys. To do so, run the command below.")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("php artisan p:migration:clean-orphaned-keys\n")])])]),a("p",[e._v("Don't forget to create new keys for yourself, as well as let all of your users know they'll need to do so as well.")]),e._v(" "),a("h2",{attrs:{id:"set-permissions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#set-permissions"}},[e._v("#")]),e._v(" Set Permissions")]),e._v(" "),a("p",[e._v("The last step is to set the proper owner of the files to be the user that runs your webserver. In most cases this\nis "),a("code",[e._v("www-data")]),e._v(" but can vary from system to system — sometimes being "),a("code",[e._v("nginx")]),e._v(", "),a("code",[e._v("apache")]),e._v(", or even "),a("code",[e._v("nobody")]),e._v(".")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using NGINX or Apache (not on CentOS):")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("chown")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" www-data:www-data * \n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using NGINX on CentOS:")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("chown")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" nginx:nginx *\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using Apache on CentOS")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("chown")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" apache:apache *\n")])])])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[55],{315:function(e,a,t){"use strict";t.r(a);var s=t(15),n=Object(s.a)({},(function(){var e=this,a=e._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"upgrading-0-6-to-0-7"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#upgrading-0-6-to-0-7"}},[e._v("#")]),e._v(" Upgrading 0.6 to 0.7")]),e._v(" "),a("div",{staticClass:"custom-block danger"},[a("p",{staticClass:"custom-block-title"},[e._v("This Version is End-of-Life")]),e._v(" "),a("p",[e._v("This documentation is for "),a("strong",[e._v("end-of-life software")]),e._v(" which does not recieve any security updates or support\nfrom the community. This documentation has been left accessible for historial reasons.")]),e._v(" "),a("p",[e._v("You should be installing and using "),a("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html"}},[e._v("Pterodactyl Panel 1.0")]),e._v(" in production environments.")],1)]),e._v(" "),a("h2",{attrs:{id:"fetch-updated-files"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#fetch-updated-files"}},[e._v("#")]),e._v(" Fetch Updated Files")]),e._v(" "),a("p",[e._v("The first step in the update process is to download the new panel files from GitHub. The command below will download\nthe release archive for the most recent version of Pterodactyl and save it in the current directory. Now is a good time\nto ensure that you're in the "),a("code",[e._v("/var/www/pterodactyl")]),e._v(" directory as the command below will automatically unpack in whatever\ndirectory you are currently in.")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-L")]),e._v(" https://github.com/pterodactyl/panel/releases/download/v0.7.19/panel.tar.gz "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("tar")]),e._v(" --strip-components"),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("1")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-xzv")]),e._v("\n")])])]),a("p",[e._v("Once all of the files are downloaded we need to set the correct permissions on the cache and storage directories to avoid\nany webserver related errors.")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("chmod")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("755")]),e._v(" storage/* bootstrap/cache\n")])])]),a("h2",{attrs:{id:"clear-compiled-assets"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#clear-compiled-assets"}},[e._v("#")]),e._v(" Clear Compiled Assets")]),e._v(" "),a("p",[e._v("Previous versions of Pterodactyl attempted to cache your configuration file for speed and performance enhancements. This\nended up just causing more headaches with minimal improvements in performance, so we decided to stop doing that. Running\nthe command below will clear the cached files for you so we can continue with upgrading.")]),e._v(" "),a("div",{staticClass:"custom-block tip"},[a("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),a("p",[e._v("You probably only need to run this command once when upgrading from "),a("code",[e._v("0.6.X")]),e._v(". Once you're upgraded we don't cache the configuration\nfile so there is no reason to remove anything.")])]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("rm")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-rf")]),e._v(" bootstrap/cache/*\n")])])]),a("p",[e._v("Once the configuration cache is removed, you'll need to clear the template cache to ensure users get the most recent\ntemplates.")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("php artisan view:clear\n")])])]),a("h2",{attrs:{id:"update-dependencies"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#update-dependencies"}},[e._v("#")]),e._v(" Update Dependencies")]),e._v(" "),a("p",[e._v("After you've downloaded all of the new files you will need to upgrade the core components of the panel. To do this,\nsimply run the commands below and follow any prompts.")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("composer")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" --no-dev --optimize-autoloader\n")])])]),a("h2",{attrs:{id:"update-environment"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#update-environment"}},[e._v("#")]),e._v(" Update Environment")]),e._v(" "),a("p",[e._v("These scripts will display your current values in brackets. To keep the current values simply press enter and it will\ncontinue without making any modifications.")]),e._v(" "),a("div",{staticClass:"custom-block tip"},[a("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),a("p",[e._v("We've changed our recommended cache driver to be Redis, rather than Memcached. If you're using Memcached you can\ncontinue doing so with no problems, however moving forward our installation documentation will only mention Redis.")])]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("php artisan p:environment:setup\nphp artisan p:environment:mail\nphp artisan p:environment:database\n")])])]),a("h2",{attrs:{id:"database-updates"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#database-updates"}},[e._v("#")]),e._v(" Database Updates")]),e._v(" "),a("div",{staticClass:"custom-block warning"},[a("p",{staticClass:"custom-block-title"},[e._v("Backup your databases")]),e._v(" "),a("p",[e._v("The upgrade from "),a("code",[e._v("0.6")]),e._v(" to "),a("code",[e._v("v0.7")]),e._v(" includes some rather significant database changes. While the migration utility is\nable to handle everything for you, we still suggest taking a backup of your database before proceeding — just incase.")])]),e._v(" "),a("div",{staticClass:"custom-block warning"},[a("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),a("p",[e._v("Running "),a("code",[e._v("db:seed")]),e._v(" below will overwrite any changes you made to core Pterodactyl Nests, Eggs, or Egg Variables! This is\nunavoidable, and this seeder must be run. To avoid this in the future, please create custom nests, or create custom\neggs for game variations.")])]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("php artisan migrate "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--force")]),e._v("\nphp artisan db:seed "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--force")]),e._v("\n")])])]),a("h2",{attrs:{id:"cleanup-api-keys"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#cleanup-api-keys"}},[e._v("#")]),e._v(" Cleanup API Keys")]),e._v(" "),a("p",[e._v("A significant change is introduced in 0.7.0 that changes how API keys are used, stored, and validated. Due to this\nchange, all previously created keys will no longer function. In order to keep things cleaned up you'll want to remove\nthese orphaned keys. To do so, run the command below.")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("php artisan p:migration:clean-orphaned-keys\n")])])]),a("p",[e._v("Don't forget to create new keys for yourself, as well as let all of your users know they'll need to do so as well.")]),e._v(" "),a("h2",{attrs:{id:"set-permissions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#set-permissions"}},[e._v("#")]),e._v(" Set Permissions")]),e._v(" "),a("p",[e._v("The last step is to set the proper owner of the files to be the user that runs your webserver. In most cases this\nis "),a("code",[e._v("www-data")]),e._v(" but can vary from system to system — sometimes being "),a("code",[e._v("nginx")]),e._v(", "),a("code",[e._v("apache")]),e._v(", or even "),a("code",[e._v("nobody")]),e._v(".")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using NGINX or Apache (not on CentOS):")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("chown")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" www-data:www-data * \n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using NGINX on CentOS:")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("chown")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" nginx:nginx *\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using Apache on CentOS")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("chown")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" apache:apache *\n")])])])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/57.5d950550.js b/assets/js/57.3b5f3f55.js similarity index 96% rename from assets/js/57.5d950550.js rename to assets/js/57.3b5f3f55.js index 3788ea33..6aee11a5 100644 --- a/assets/js/57.5d950550.js +++ b/assets/js/57.3b5f3f55.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[57],{317:function(e,t,a){"use strict";a.r(t);var s=a(15),r=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"upgrading"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#upgrading"}},[e._v("#")]),e._v(" Upgrading")]),e._v(" "),t("p",[e._v("Upgrading the Panel is a relatively simple process. Below you will find a list of articles that will walk you through\nthe upgrade process for each version of the software.")]),e._v(" "),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("This Version is End-of-Life")]),e._v(" "),t("p",[e._v("This documentation is for "),t("strong",[e._v("end-of-life software")]),e._v(" which does not recieve any security updates or support\nfrom the community. This documentation has been left accessible for historial reasons.")]),e._v(" "),t("p",[e._v("You should be installing and using "),t("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html"}},[e._v("Pterodactyl Panel 1.0")]),e._v(" in production environments.")],1)]),e._v(" "),t("h2",{attrs:{id:"maintenance-mode"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#maintenance-mode"}},[e._v("#")]),e._v(" Maintenance Mode")]),e._v(" "),t("p",[e._v('Whenever you are performing an upgrade, you should be sure to place your Panel into "maintenance mode". This will prevent\nusers from encountering unexpected errors, and ensure everything can be upgraded before users encounter potentially new features.')]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Put the Panel into maintenance mode and deny user access")]),e._v("\nphp artisan down\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Bring the Panel back up to receive connections.")]),e._v("\nphp artisan up\n")])])]),t("h2",{attrs:{id:"restarting-queue-workers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#restarting-queue-workers"}},[e._v("#")]),e._v(" Restarting Queue Workers")]),e._v(" "),t("p",[e._v("After "),t("em",[e._v("every")]),e._v(" update, you should restart the queue worker to ensure that the new code is being loaded in and used.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("php artisan queue:restart\n")])])]),t("h2",{attrs:{id:"version-specific-guides"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#version-specific-guides"}},[e._v("#")]),e._v(" Version Specific Guides")]),e._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/panel/0.7/upgrade/0.6_to_0.7.html"}},[e._v("0.6.X to 0.7.19")])],1),e._v(" "),t("li",[t("RouterLink",{attrs:{to:"/panel/0.7/upgrade/0.7.html"}},[e._v("0.7.X series")])],1),e._v(" "),t("li",[t("a",{attrs:{href:"/panel/1.0/upgrade/0.7_to_1.0"}},[e._v("0.7.19 to 1.X.X")]),e._v(" "),t("Badge",{attrs:{text:"current",vertical:"middle"}})],1)])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[57],{319:function(e,t,a){"use strict";a.r(t);var s=a(15),r=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"upgrading"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#upgrading"}},[e._v("#")]),e._v(" Upgrading")]),e._v(" "),t("p",[e._v("Upgrading the Panel is a relatively simple process. Below you will find a list of articles that will walk you through\nthe upgrade process for each version of the software.")]),e._v(" "),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("This Version is End-of-Life")]),e._v(" "),t("p",[e._v("This documentation is for "),t("strong",[e._v("end-of-life software")]),e._v(" which does not recieve any security updates or support\nfrom the community. This documentation has been left accessible for historial reasons.")]),e._v(" "),t("p",[e._v("You should be installing and using "),t("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html"}},[e._v("Pterodactyl Panel 1.0")]),e._v(" in production environments.")],1)]),e._v(" "),t("h2",{attrs:{id:"maintenance-mode"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#maintenance-mode"}},[e._v("#")]),e._v(" Maintenance Mode")]),e._v(" "),t("p",[e._v('Whenever you are performing an upgrade, you should be sure to place your Panel into "maintenance mode". This will prevent\nusers from encountering unexpected errors, and ensure everything can be upgraded before users encounter potentially new features.')]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Put the Panel into maintenance mode and deny user access")]),e._v("\nphp artisan down\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Bring the Panel back up to receive connections.")]),e._v("\nphp artisan up\n")])])]),t("h2",{attrs:{id:"restarting-queue-workers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#restarting-queue-workers"}},[e._v("#")]),e._v(" Restarting Queue Workers")]),e._v(" "),t("p",[e._v("After "),t("em",[e._v("every")]),e._v(" update, you should restart the queue worker to ensure that the new code is being loaded in and used.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("php artisan queue:restart\n")])])]),t("h2",{attrs:{id:"version-specific-guides"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#version-specific-guides"}},[e._v("#")]),e._v(" Version Specific Guides")]),e._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/panel/0.7/upgrade/0.6_to_0.7.html"}},[e._v("0.6.X to 0.7.19")])],1),e._v(" "),t("li",[t("RouterLink",{attrs:{to:"/panel/0.7/upgrade/0.7.html"}},[e._v("0.7.X series")])],1),e._v(" "),t("li",[t("a",{attrs:{href:"/panel/1.0/upgrade/0.7_to_1.0"}},[e._v("0.7.19 to 1.X.X")]),e._v(" "),t("Badge",{attrs:{text:"current",vertical:"middle"}})],1)])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/58.6917e3e6.js b/assets/js/58.8fe9d86f.js similarity index 99% rename from assets/js/58.6917e3e6.js rename to assets/js/58.8fe9d86f.js index b7cda8d6..da8c3806 100644 --- a/assets/js/58.6917e3e6.js +++ b/assets/js/58.8fe9d86f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[58],{318:function(e,t,a){"use strict";a.r(t);var n=a(15),r=Object(n.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"webserver-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#webserver-configuration"}},[e._v("#")]),e._v(" Webserver Configuration")]),e._v(" "),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("This Version is End-of-Life")]),e._v(" "),t("p",[e._v("This documentation is for "),t("strong",[e._v("end-of-life software")]),e._v(" which does not recieve any security updates or support\nfrom the community. This documentation has been left accessible for historial reasons.")]),e._v(" "),t("p",[e._v("You should be installing and using "),t("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html"}},[e._v("Pterodactyl Panel 1.0")]),e._v(" in production environments.")],1)]),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#nginx"}},[e._v("NGINX")]),t("ul",[t("li",[t("a",{attrs:{href:"#nginx-with-ssl"}},[e._v("NGINX With SSL")])]),t("li",[t("a",{attrs:{href:"#nginx-without-ssl"}},[e._v("NGINX Without SSL")])]),t("li",[t("a",{attrs:{href:"#enabling-configuration"}},[e._v("Enabling Configuration")])])])]),t("li",[t("a",{attrs:{href:"#apache"}},[e._v("Apache")]),t("ul",[t("li",[t("a",{attrs:{href:"#apache-with-ssl"}},[e._v("Apache With SSL")])]),t("li",[t("a",{attrs:{href:"#apache-without-ssl"}},[e._v("Apache Without SSL")])]),t("li",[t("a",{attrs:{href:"#enabling-configuration"}},[e._v("Enabling Configuration")])])])])])]),t("p"),e._v(" "),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("DANGER")]),e._v(" "),t("p",[e._v("You should remove the default Apache or NGINX configuration as it will expose application secrets to malicious\nusers by default.")])]),e._v(" "),t("h2",{attrs:{id:"nginx"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#nginx"}},[e._v("#")]),e._v(" NGINX")]),e._v(" "),t("p",[e._v("You should paste the contents of the file below, replacing "),t("code",[e._v("")]),e._v(" with your domain name being used in a file called\n"),t("code",[e._v("pterodactyl.conf")]),e._v(" and place it in "),t("code",[e._v("/etc/nginx/sites-available/")]),e._v(", or — if on CentOS, "),t("code",[e._v("/etc/nginx/conf.d/")]),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"nginx-with-ssl"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#nginx-with-ssl"}},[e._v("#")]),e._v(" NGINX With SSL")]),e._v(" "),t("p",[e._v("This configuration assumes that you will be using SSL on both the Panel and Daemons for significantly improved communication\nsecurity between users and the Panel. You will need to get a valid SSL certificate which can be done for free by using\nLet's Encrypt.")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("When using the SSL configuration you MUST create SSL certificates, otherwise your NGINX will fail to start. See "),t("RouterLink",{attrs:{to:"/tutorials/creating_ssl_certificates.html"}},[e._v("Creating SSL Certificates")]),e._v(" documentation page for how to create these certificates before continuing.")],1)]),e._v(" "),t("div",{staticClass:"language-conf extra-class"},[t("div",{staticClass:"highlight-lines"},[t("br"),t("br"),t("br"),t("br"),t("div",{staticClass:"highlighted"},[e._v(" ")]),t("br"),t("br"),t("br"),t("br"),t("br"),t("div",{staticClass:"highlighted"},[e._v(" ")]),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("div",{staticClass:"highlighted"},[e._v(" ")]),t("div",{staticClass:"highlighted"},[e._v(" ")]),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br")]),t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('server_tokens off;\n\nserver {\n listen 80;\n server_name ;\n return 301 https://$server_name$request_uri;\n}\n\nserver {\n listen 443 ssl http2;\n server_name ;\n\n root /var/www/pterodactyl/public;\n index index.php;\n\n access_log /var/log/nginx/pterodactyl.app-access.log;\n error_log /var/log/nginx/pterodactyl.app-error.log error;\n\n # allow larger file uploads and longer script runtimes\n client_max_body_size 100m;\n client_body_timeout 120s;\n\n sendfile off;\n\n # SSL Configuration\n ssl_certificate /etc/letsencrypt/live//fullchain.pem;\n ssl_certificate_key /etc/letsencrypt/live//privkey.pem;\n ssl_session_cache shared:SSL:10m;\n ssl_protocols TLSv1.2 TLSv1.3;\n ssl_ciphers "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384";\n ssl_prefer_server_ciphers on;\n\n # See https://hstspreload.org/ before uncommenting the line below.\n # add_header Strict-Transport-Security "max-age=15768000; preload;";\n add_header X-Content-Type-Options nosniff;\n add_header X-XSS-Protection "1; mode=block";\n add_header X-Robots-Tag none;\n add_header Content-Security-Policy "frame-ancestors \'self\'";\n add_header X-Frame-Options DENY;\n add_header Referrer-Policy same-origin;\n\n location / {\n try_files $uri $uri/ /index.php?$query_string;\n }\n\n location ~ \\.php$ {\n fastcgi_split_path_info ^(.+\\.php)(/.+)$;\n fastcgi_pass unix:/run/php/php7.2-fpm.sock;\n fastcgi_index index.php;\n include fastcgi_params;\n fastcgi_param PHP_VALUE "upload_max_filesize = 100M \\n post_max_size=100M";\n fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;\n fastcgi_param HTTP_PROXY "";\n fastcgi_intercept_errors off;\n fastcgi_buffer_size 16k;\n fastcgi_buffers 4 16k;\n fastcgi_connect_timeout 300;\n fastcgi_send_timeout 300;\n fastcgi_read_timeout 300;\n include /etc/nginx/fastcgi_params;\n }\n\n location ~ /\\.ht {\n deny all;\n }\n}\n')])])]),t("p",[e._v("Continue reading to the bottom of this section for the final steps with NGINX!")]),e._v(" "),t("h3",{attrs:{id:"nginx-without-ssl"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#nginx-without-ssl"}},[e._v("#")]),e._v(" NGINX Without SSL")]),e._v(" "),t("div",{staticClass:"language-conf extra-class"},[t("div",{staticClass:"highlight-lines"},[t("br"),t("br"),t("div",{staticClass:"highlighted"},[e._v(" ")]),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br")]),t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('server {\n listen 80;\n server_name ;\n\n root /var/www/pterodactyl/public;\n index index.html index.htm index.php;\n charset utf-8;\n\n location / {\n try_files $uri $uri/ /index.php?$query_string;\n }\n\n location = /favicon.ico { access_log off; log_not_found off; }\n location = /robots.txt { access_log off; log_not_found off; }\n\n access_log off;\n error_log /var/log/nginx/pterodactyl.app-error.log error;\n\n # allow larger file uploads and longer script runtimes\n client_max_body_size 100m;\n client_body_timeout 120s;\n\n sendfile off;\n\n location ~ \\.php$ {\n fastcgi_split_path_info ^(.+\\.php)(/.+)$;\n fastcgi_pass unix:/run/php/php7.2-fpm.sock;\n fastcgi_index index.php;\n include fastcgi_params;\n fastcgi_param PHP_VALUE "upload_max_filesize = 100M \\n post_max_size=100M";\n fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;\n fastcgi_param HTTP_PROXY "";\n fastcgi_intercept_errors off;\n fastcgi_buffer_size 16k;\n fastcgi_buffers 4 16k;\n fastcgi_connect_timeout 300;\n fastcgi_send_timeout 300;\n fastcgi_read_timeout 300;\n }\n\n location ~ /\\.ht {\n deny all;\n }\n}\n')])])]),t("h3",{attrs:{id:"enabling-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enabling-configuration"}},[e._v("#")]),e._v(" Enabling Configuration")]),e._v(" "),t("p",[e._v("The final step is to enable your NGINX configuration and restart it.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# You do not need to symlink this file if you are using CentOS.")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("ln")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-s")]),e._v(" /etc/nginx/sites-available/pterodactyl.conf /etc/nginx/sites-enabled/pterodactyl.conf\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# You need to restart nginx regardless of OS.")]),e._v("\nsystemctl restart nginx\n")])])]),t("h2",{attrs:{id:"apache"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#apache"}},[e._v("#")]),e._v(" Apache")]),e._v(" "),t("p",[e._v("You should paste the contents of the file below, replacing "),t("code",[e._v("")]),e._v(" with your domain name being used in a file called\n"),t("code",[e._v("pterodactyl.conf")]),e._v(" and place it in "),t("code",[e._v("/etc/apache2/sites-available")]),e._v(", or — if on CentOS, "),t("code",[e._v("/etc/httpd/conf.d/")]),e._v(".")]),e._v(" "),t("p",[e._v("Note: When using Apache, make sure you have the "),t("code",[e._v("libapache2-mod-php")]),e._v(" package installed or else PHP will not display on your webserver.")]),e._v(" "),t("h3",{attrs:{id:"apache-with-ssl"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#apache-with-ssl"}},[e._v("#")]),e._v(" Apache With SSL")]),e._v(" "),t("p",[e._v("Like the nginx configuration, this assumes you will be using SSL on both the Panel and Daemons for improved security.")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("When using the SSL configuration you MUST create SSL certificates, otherwise your Apache will fail to start. See "),t("RouterLink",{attrs:{to:"/tutorials/creating_ssl_certificates.html"}},[e._v("Creating SSL Certificates")]),e._v(" documentation page for how to create these certificates before continuing.")],1)]),e._v(" "),t("div",{staticClass:"language-conf extra-class"},[t("div",{staticClass:"highlight-lines"},[t("br"),t("div",{staticClass:"highlighted"},[e._v(" ")]),t("br"),t("br"),t("br"),t("br"),t("br"),t("div",{staticClass:"highlighted"},[e._v(" ")]),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("div",{staticClass:"highlighted"},[e._v(" ")]),t("div",{staticClass:"highlighted"},[e._v(" ")]),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br")]),t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('\n # Replace the example with your domain name or IP address\n ServerName \n\n RewriteEngine On\n RewriteCond %{HTTPS} !=on\n RewriteRule ^/?(.*) https://%{SERVER_NAME}/$1 [R,L] \n\n\n\n # Replace the example with your domain name or IP address\n ServerName \n DocumentRoot "/var/www/pterodactyl/public"\n\n AllowEncodedSlashes On\n\n php_value upload_max_filesize 100M\n php_value post_max_size 100M\n\n \n Require all granted\n AllowOverride all\n \n\n SSLEngine on\n SSLCertificateFile /etc/letsencrypt/live//fullchain.pem\n SSLCertificateKeyFile /etc/letsencrypt/live//privkey.pem\n \n')])])]),t("h3",{attrs:{id:"apache-without-ssl"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#apache-without-ssl"}},[e._v("#")]),e._v(" Apache Without SSL")]),e._v(" "),t("div",{staticClass:"language-conf extra-class"},[t("div",{staticClass:"highlight-lines"},[t("br"),t("div",{staticClass:"highlighted"},[e._v(" ")]),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br")]),t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('\n # Replace the example with your domain name or IP address\n ServerName \n DocumentRoot "/var/www/pterodactyl/public"\n \n AllowEncodedSlashes On\n \n php_value upload_max_filesize 100M\n php_value post_max_size 100M\n \n \n AllowOverride all\n Require all granted\n \n\n')])])]),t("h3",{attrs:{id:"enabling-configuration-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enabling-configuration-2"}},[e._v("#")]),e._v(" Enabling Configuration")]),e._v(" "),t("p",[e._v("Once you've created the file above, simply run the commands below. If you are on CentOS "),t("em",[e._v("you do not need to run the commands\nbelow!")]),e._v(" You only need to run "),t("code",[e._v("systemctl restart httpd")]),e._v(".")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# You do not need to run any of these commands on CentOS")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("ln")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-s")]),e._v(" /etc/apache2/sites-available/pterodactyl.conf /etc/apache2/sites-enabled/pterodactyl.conf\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" a2enmod rewrite\nsystemctl restart apache2\n")])])])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[58],{321:function(e,t,a){"use strict";a.r(t);var n=a(15),r=Object(n.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"webserver-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#webserver-configuration"}},[e._v("#")]),e._v(" Webserver Configuration")]),e._v(" "),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("This Version is End-of-Life")]),e._v(" "),t("p",[e._v("This documentation is for "),t("strong",[e._v("end-of-life software")]),e._v(" which does not recieve any security updates or support\nfrom the community. This documentation has been left accessible for historial reasons.")]),e._v(" "),t("p",[e._v("You should be installing and using "),t("RouterLink",{attrs:{to:"/panel/1.0/getting_started.html"}},[e._v("Pterodactyl Panel 1.0")]),e._v(" in production environments.")],1)]),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#nginx"}},[e._v("NGINX")]),t("ul",[t("li",[t("a",{attrs:{href:"#nginx-with-ssl"}},[e._v("NGINX With SSL")])]),t("li",[t("a",{attrs:{href:"#nginx-without-ssl"}},[e._v("NGINX Without SSL")])]),t("li",[t("a",{attrs:{href:"#enabling-configuration"}},[e._v("Enabling Configuration")])])])]),t("li",[t("a",{attrs:{href:"#apache"}},[e._v("Apache")]),t("ul",[t("li",[t("a",{attrs:{href:"#apache-with-ssl"}},[e._v("Apache With SSL")])]),t("li",[t("a",{attrs:{href:"#apache-without-ssl"}},[e._v("Apache Without SSL")])]),t("li",[t("a",{attrs:{href:"#enabling-configuration"}},[e._v("Enabling Configuration")])])])])])]),t("p"),e._v(" "),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("DANGER")]),e._v(" "),t("p",[e._v("You should remove the default Apache or NGINX configuration as it will expose application secrets to malicious\nusers by default.")])]),e._v(" "),t("h2",{attrs:{id:"nginx"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#nginx"}},[e._v("#")]),e._v(" NGINX")]),e._v(" "),t("p",[e._v("You should paste the contents of the file below, replacing "),t("code",[e._v("")]),e._v(" with your domain name being used in a file called\n"),t("code",[e._v("pterodactyl.conf")]),e._v(" and place it in "),t("code",[e._v("/etc/nginx/sites-available/")]),e._v(", or — if on CentOS, "),t("code",[e._v("/etc/nginx/conf.d/")]),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"nginx-with-ssl"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#nginx-with-ssl"}},[e._v("#")]),e._v(" NGINX With SSL")]),e._v(" "),t("p",[e._v("This configuration assumes that you will be using SSL on both the Panel and Daemons for significantly improved communication\nsecurity between users and the Panel. You will need to get a valid SSL certificate which can be done for free by using\nLet's Encrypt.")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("When using the SSL configuration you MUST create SSL certificates, otherwise your NGINX will fail to start. See "),t("RouterLink",{attrs:{to:"/tutorials/creating_ssl_certificates.html"}},[e._v("Creating SSL Certificates")]),e._v(" documentation page for how to create these certificates before continuing.")],1)]),e._v(" "),t("div",{staticClass:"language-conf extra-class"},[t("div",{staticClass:"highlight-lines"},[t("br"),t("br"),t("br"),t("br"),t("div",{staticClass:"highlighted"},[e._v(" ")]),t("br"),t("br"),t("br"),t("br"),t("br"),t("div",{staticClass:"highlighted"},[e._v(" ")]),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("div",{staticClass:"highlighted"},[e._v(" ")]),t("div",{staticClass:"highlighted"},[e._v(" ")]),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br")]),t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('server_tokens off;\n\nserver {\n listen 80;\n server_name ;\n return 301 https://$server_name$request_uri;\n}\n\nserver {\n listen 443 ssl http2;\n server_name ;\n\n root /var/www/pterodactyl/public;\n index index.php;\n\n access_log /var/log/nginx/pterodactyl.app-access.log;\n error_log /var/log/nginx/pterodactyl.app-error.log error;\n\n # allow larger file uploads and longer script runtimes\n client_max_body_size 100m;\n client_body_timeout 120s;\n\n sendfile off;\n\n # SSL Configuration\n ssl_certificate /etc/letsencrypt/live//fullchain.pem;\n ssl_certificate_key /etc/letsencrypt/live//privkey.pem;\n ssl_session_cache shared:SSL:10m;\n ssl_protocols TLSv1.2 TLSv1.3;\n ssl_ciphers "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384";\n ssl_prefer_server_ciphers on;\n\n # See https://hstspreload.org/ before uncommenting the line below.\n # add_header Strict-Transport-Security "max-age=15768000; preload;";\n add_header X-Content-Type-Options nosniff;\n add_header X-XSS-Protection "1; mode=block";\n add_header X-Robots-Tag none;\n add_header Content-Security-Policy "frame-ancestors \'self\'";\n add_header X-Frame-Options DENY;\n add_header Referrer-Policy same-origin;\n\n location / {\n try_files $uri $uri/ /index.php?$query_string;\n }\n\n location ~ \\.php$ {\n fastcgi_split_path_info ^(.+\\.php)(/.+)$;\n fastcgi_pass unix:/run/php/php7.2-fpm.sock;\n fastcgi_index index.php;\n include fastcgi_params;\n fastcgi_param PHP_VALUE "upload_max_filesize = 100M \\n post_max_size=100M";\n fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;\n fastcgi_param HTTP_PROXY "";\n fastcgi_intercept_errors off;\n fastcgi_buffer_size 16k;\n fastcgi_buffers 4 16k;\n fastcgi_connect_timeout 300;\n fastcgi_send_timeout 300;\n fastcgi_read_timeout 300;\n include /etc/nginx/fastcgi_params;\n }\n\n location ~ /\\.ht {\n deny all;\n }\n}\n')])])]),t("p",[e._v("Continue reading to the bottom of this section for the final steps with NGINX!")]),e._v(" "),t("h3",{attrs:{id:"nginx-without-ssl"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#nginx-without-ssl"}},[e._v("#")]),e._v(" NGINX Without SSL")]),e._v(" "),t("div",{staticClass:"language-conf extra-class"},[t("div",{staticClass:"highlight-lines"},[t("br"),t("br"),t("div",{staticClass:"highlighted"},[e._v(" ")]),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br")]),t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('server {\n listen 80;\n server_name ;\n\n root /var/www/pterodactyl/public;\n index index.html index.htm index.php;\n charset utf-8;\n\n location / {\n try_files $uri $uri/ /index.php?$query_string;\n }\n\n location = /favicon.ico { access_log off; log_not_found off; }\n location = /robots.txt { access_log off; log_not_found off; }\n\n access_log off;\n error_log /var/log/nginx/pterodactyl.app-error.log error;\n\n # allow larger file uploads and longer script runtimes\n client_max_body_size 100m;\n client_body_timeout 120s;\n\n sendfile off;\n\n location ~ \\.php$ {\n fastcgi_split_path_info ^(.+\\.php)(/.+)$;\n fastcgi_pass unix:/run/php/php7.2-fpm.sock;\n fastcgi_index index.php;\n include fastcgi_params;\n fastcgi_param PHP_VALUE "upload_max_filesize = 100M \\n post_max_size=100M";\n fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;\n fastcgi_param HTTP_PROXY "";\n fastcgi_intercept_errors off;\n fastcgi_buffer_size 16k;\n fastcgi_buffers 4 16k;\n fastcgi_connect_timeout 300;\n fastcgi_send_timeout 300;\n fastcgi_read_timeout 300;\n }\n\n location ~ /\\.ht {\n deny all;\n }\n}\n')])])]),t("h3",{attrs:{id:"enabling-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enabling-configuration"}},[e._v("#")]),e._v(" Enabling Configuration")]),e._v(" "),t("p",[e._v("The final step is to enable your NGINX configuration and restart it.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# You do not need to symlink this file if you are using CentOS.")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("ln")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-s")]),e._v(" /etc/nginx/sites-available/pterodactyl.conf /etc/nginx/sites-enabled/pterodactyl.conf\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# You need to restart nginx regardless of OS.")]),e._v("\nsystemctl restart nginx\n")])])]),t("h2",{attrs:{id:"apache"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#apache"}},[e._v("#")]),e._v(" Apache")]),e._v(" "),t("p",[e._v("You should paste the contents of the file below, replacing "),t("code",[e._v("")]),e._v(" with your domain name being used in a file called\n"),t("code",[e._v("pterodactyl.conf")]),e._v(" and place it in "),t("code",[e._v("/etc/apache2/sites-available")]),e._v(", or — if on CentOS, "),t("code",[e._v("/etc/httpd/conf.d/")]),e._v(".")]),e._v(" "),t("p",[e._v("Note: When using Apache, make sure you have the "),t("code",[e._v("libapache2-mod-php")]),e._v(" package installed or else PHP will not display on your webserver.")]),e._v(" "),t("h3",{attrs:{id:"apache-with-ssl"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#apache-with-ssl"}},[e._v("#")]),e._v(" Apache With SSL")]),e._v(" "),t("p",[e._v("Like the nginx configuration, this assumes you will be using SSL on both the Panel and Daemons for improved security.")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("When using the SSL configuration you MUST create SSL certificates, otherwise your Apache will fail to start. See "),t("RouterLink",{attrs:{to:"/tutorials/creating_ssl_certificates.html"}},[e._v("Creating SSL Certificates")]),e._v(" documentation page for how to create these certificates before continuing.")],1)]),e._v(" "),t("div",{staticClass:"language-conf extra-class"},[t("div",{staticClass:"highlight-lines"},[t("br"),t("div",{staticClass:"highlighted"},[e._v(" ")]),t("br"),t("br"),t("br"),t("br"),t("br"),t("div",{staticClass:"highlighted"},[e._v(" ")]),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("div",{staticClass:"highlighted"},[e._v(" ")]),t("div",{staticClass:"highlighted"},[e._v(" ")]),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br")]),t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('\n # Replace the example with your domain name or IP address\n ServerName \n\n RewriteEngine On\n RewriteCond %{HTTPS} !=on\n RewriteRule ^/?(.*) https://%{SERVER_NAME}/$1 [R,L] \n\n\n\n # Replace the example with your domain name or IP address\n ServerName \n DocumentRoot "/var/www/pterodactyl/public"\n\n AllowEncodedSlashes On\n\n php_value upload_max_filesize 100M\n php_value post_max_size 100M\n\n \n Require all granted\n AllowOverride all\n \n\n SSLEngine on\n SSLCertificateFile /etc/letsencrypt/live//fullchain.pem\n SSLCertificateKeyFile /etc/letsencrypt/live//privkey.pem\n \n')])])]),t("h3",{attrs:{id:"apache-without-ssl"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#apache-without-ssl"}},[e._v("#")]),e._v(" Apache Without SSL")]),e._v(" "),t("div",{staticClass:"language-conf extra-class"},[t("div",{staticClass:"highlight-lines"},[t("br"),t("div",{staticClass:"highlighted"},[e._v(" ")]),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br")]),t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('\n # Replace the example with your domain name or IP address\n ServerName \n DocumentRoot "/var/www/pterodactyl/public"\n \n AllowEncodedSlashes On\n \n php_value upload_max_filesize 100M\n php_value post_max_size 100M\n \n \n AllowOverride all\n Require all granted\n \n\n')])])]),t("h3",{attrs:{id:"enabling-configuration-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enabling-configuration-2"}},[e._v("#")]),e._v(" Enabling Configuration")]),e._v(" "),t("p",[e._v("Once you've created the file above, simply run the commands below. If you are on CentOS "),t("em",[e._v("you do not need to run the commands\nbelow!")]),e._v(" You only need to run "),t("code",[e._v("systemctl restart httpd")]),e._v(".")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# You do not need to run any of these commands on CentOS")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("ln")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-s")]),e._v(" /etc/apache2/sites-available/pterodactyl.conf /etc/apache2/sites-enabled/pterodactyl.conf\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" a2enmod rewrite\nsystemctl restart apache2\n")])])])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/59.74ce363c.js b/assets/js/59.d3aa2768.js similarity index 99% rename from assets/js/59.74ce363c.js rename to assets/js/59.d3aa2768.js index cbf49a30..85a93779 100644 --- a/assets/js/59.74ce363c.js +++ b/assets/js/59.d3aa2768.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[59],{319:function(e,t,a){"use strict";a.r(t);var s=a(15),r=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"additional-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#additional-configuration"}},[e._v("#")]),e._v(" Additional Configuration")]),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#backups"}},[e._v("Backups")]),t("ul",[t("li",[t("a",{attrs:{href:"#using-local-backups"}},[e._v("Using Local Backups")])]),t("li",[t("a",{attrs:{href:"#using-s3-backups"}},[e._v("Using S3 Backups")])])])]),t("li",[t("a",{attrs:{href:"#reverse-proxy-setup"}},[e._v("Reverse Proxy Setup")]),t("ul",[t("li",[t("a",{attrs:{href:"#nginx-specific-configuration"}},[e._v("NGINX Specific Configuration")])]),t("li",[t("a",{attrs:{href:"#cloudflare-specific-configuration"}},[e._v("Cloudflare Specific Configuration")])])])]),t("li",[t("a",{attrs:{href:"#recaptcha"}},[e._v("reCAPTCHA")]),t("ul",[t("li",[t("a",{attrs:{href:"#configuring-recaptcha"}},[e._v("Configuring reCAPTCHA")])]),t("li",[t("a",{attrs:{href:"#disabling-recaptcha"}},[e._v("Disabling reCAPTCHA")])])])]),t("li",[t("a",{attrs:{href:"#_2fa"}},[e._v("2FA")]),t("ul",[t("li",[t("a",{attrs:{href:"#disable-2fa-requirement"}},[e._v("Disable 2FA requirement")])]),t("li",[t("a",{attrs:{href:"#disable-2fa-for-a-specific-user"}},[e._v("Disable 2FA for a specific user")])])])]),t("li",[t("a",{attrs:{href:"#telemetry"}},[e._v("Telemetry")]),t("ul",[t("li",[t("a",{attrs:{href:"#how-does-it-work"}},[e._v("How does it work?")])]),t("li",[t("a",{attrs:{href:"#what-data-is-collected"}},[e._v("What data is collected?")])]),t("li",[t("a",{attrs:{href:"#how-is-the-data-stored"}},[e._v("How is the data stored?")])]),t("li",[t("a",{attrs:{href:"#why"}},[e._v("Why?")])]),t("li",[t("a",{attrs:{href:"#enabling-telemetry"}},[e._v("Enabling Telemetry")])]),t("li",[t("a",{attrs:{href:"#disabling-telemetry"}},[e._v("Disabling Telemetry")])])])])])]),t("p"),e._v(" "),t("h2",{attrs:{id:"backups"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#backups"}},[e._v("#")]),e._v(" Backups")]),e._v(" "),t("p",[e._v("Pterodactyl Panel allows users to create backups of their servers. In order to create backups, a backup storage method has to be configured.")]),e._v(" "),t("p",[e._v("When changing Pterodactyl Panel's backup storage method, users may still download or delete existing backups from the prior storage driver. In the instance of migrating from S3 to local backups, S3 credentials must remain configured after switching to the local backup storage method.")]),e._v(" "),t("h3",{attrs:{id:"using-local-backups"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-local-backups"}},[e._v("#")]),e._v(" Using Local Backups")]),e._v(" "),t("p",[e._v("By default, Pterodactyl Panel uses local storage via Wings for backups. That said, this method of backup storage can be explicitly set with the following configuration in the "),t("code",[e._v(".env")]),e._v(" file:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Sets your panel to use local storage via Wings for backups")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("APP_BACKUP_DRIVER")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("wings\n")])])]),t("p",[e._v("Do note that, when using local storage via Wings, the destination for backups is set in Wings' "),t("code",[e._v("config.yml")]),e._v(" with the following setting key:")]),e._v(" "),t("div",{staticClass:"language-yml extra-class"},[t("pre",{pre:!0,attrs:{class:"language-yml"}},[t("code",[t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("system")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("backup_directory")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" /path/to/backup/storage\n")])])]),t("h3",{attrs:{id:"using-s3-backups"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-s3-backups"}},[e._v("#")]),e._v(" Using S3 Backups")]),e._v(" "),t("p",[e._v("AWS S3 (or compatible storage) can be used to store remote or cloud-based backups. The following configuration options have to be set in the "),t("code",[e._v(".env")]),e._v(" file or as environment variables in order to enable it:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Sets your panel to use s3 for backups")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("APP_BACKUP_DRIVER")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("s3\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Info to actually use s3")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("AWS_DEFAULT_REGION")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("AWS_ACCESS_KEY_ID")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("AWS_SECRET_ACCESS_KEY")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("AWS_BACKUPS_BUCKET")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("AWS_ENDPOINT")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("\n")])])]),t("p",[e._v("For some configurations, you might have to change your S3 URL from "),t("code",[e._v("bucket.domain.com")]),e._v(" to "),t("code",[e._v("domain.com/bucket")]),e._v(". To accomplish this, add "),t("code",[e._v("AWS_USE_PATH_STYLE_ENDPOINT=true")]),e._v(" to your "),t("code",[e._v(".env")]),e._v(" file.")]),e._v(" "),t("h4",{attrs:{id:"multipart-upload"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#multipart-upload"}},[e._v("#")]),e._v(" Multipart Upload")]),e._v(" "),t("p",[e._v("The S3 backup is using the S3 multipart upload capabilities. In rare situations, you might want to adjust the size of a single part or the lifespan of the generated pre-signed URLs. The default part size is 5GB, and the default pre-signed URL lifespan is 60 minutes.")]),e._v(" "),t("p",[e._v("You can configure the maximal part size using the "),t("code",[e._v("BACKUP_MAX_PART_SIZE")]),e._v(" environment variable. You must specify the size in bytes. To define the pre-signed URL lifespan, use the "),t("code",[e._v("BACKUP_PRESIGNED_URL_LIFESPAN")]),e._v(" variable. The expected unit is minutes.")]),e._v(" "),t("p",[e._v("The following "),t("code",[e._v(".env")]),e._v(" snippet configures 1GB parts and uses 120 minutes as the pre-signed URL lifespan:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BACKUP_MAX_PART_SIZE")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1073741824")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BACKUP_PRESIGNED_URL_LIFESPAN")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("120")]),e._v("\n")])])]),t("h4",{attrs:{id:"storage-class"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#storage-class"}},[e._v("#")]),e._v(" Storage Class")]),e._v(" "),t("p",[e._v("Should you need to specify a storage class, use the "),t("code",[e._v("AWS_BACKUPS_STORAGE_CLASS")]),e._v(" environment variable. Default option is "),t("code",[e._v("STANDARD")]),e._v(" (S3 Standard).")]),e._v(" "),t("p",[e._v("The following "),t("code",[e._v(".env")]),e._v(" snippet sets the class to "),t("code",[e._v("STANDARD_IA")]),e._v(" (this is an example).")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# STANDARD_IA is an example.")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("AWS_BACKUPS_STORAGE_CLASS")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("STANDARD_IA\n")])])]),t("h2",{attrs:{id:"reverse-proxy-setup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#reverse-proxy-setup"}},[e._v("#")]),e._v(" Reverse Proxy Setup")]),e._v(" "),t("p",[e._v("When running Pterodactyl behind a reverse proxy, such as "),t("a",{attrs:{href:"https://support.cloudflare.com/hc/en-us/articles/200170416-What-do-the-SSL-options-mean-",target:"_blank",rel:"noopener noreferrer"}},[e._v("Cloudflare's Flexible SSL"),t("OutboundLink")],1),e._v("\nor Nginx/Apache/Caddy, etc., you will need to make a quick modification to the Panel to ensure things continue to work as expected. By default, when using these reverse proxies,\nyour Panel will not correctly handle requests. You'll most likely be unable to login or see security warnings in your browser console as it attempts to load insecure assets.\nThis is because the internal logic the Panel uses to determine how links should be generated thinks it is running over HTTP and not over HTTPS.")]),e._v(" "),t("p",[e._v("You will need to edit the "),t("code",[e._v(".env")]),e._v(" file in the Panel's root directory to contain "),t("code",[e._v("TRUSTED_PROXIES=*")]),e._v(" at minimum. We highly suggest providing a specific IP address\n(or comma-separated list of IPs) rather than allowing "),t("code",[e._v("*")]),e._v(". For example, if your proxy is running on the same machine as the server,\nthe chances are that something like "),t("code",[e._v("TRUSTED_PROXIES=127.0.0.1")]),e._v(" will work for you.")]),e._v(" "),t("h3",{attrs:{id:"nginx-specific-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#nginx-specific-configuration"}},[e._v("#")]),e._v(" NGINX Specific Configuration")]),e._v(" "),t("p",[e._v("For Pterodactyl to properly respond to an NGINX reverse proxy, the NGINX "),t("code",[e._v("location")]),e._v(" config must contain the following lines:")]),e._v(" "),t("div",{staticClass:"language-Nginx extra-class"},[t("pre",{pre:!0,attrs:{class:"language-nginx"}},[t("code",[t("span",{pre:!0,attrs:{class:"token directive"}},[t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("proxy_set_header")]),e._v(" X-Real-IP "),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$remote_addr")])]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token directive"}},[t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("proxy_set_header")]),e._v(" Host "),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$host")])]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token directive"}},[t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("proxy_set_header")]),e._v(" X-Forwarded-For "),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$proxy_add_x_forwarded_for")])]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token directive"}},[t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("proxy_set_header")]),e._v(" X-Forwarded-Proto "),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$scheme")])]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token directive"}},[t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("proxy_redirect")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("off")])]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token directive"}},[t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("proxy_buffering")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("off")])]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token directive"}},[t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("proxy_request_buffering")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("off")])]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n")])])]),t("h3",{attrs:{id:"cloudflare-specific-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#cloudflare-specific-configuration"}},[e._v("#")]),e._v(" Cloudflare Specific Configuration")]),e._v(" "),t("p",[e._v("If you're using Cloudflare's Flexible SSL you should set "),t("code",[e._v("TRUSTED_PROXIES")]),e._v(" to contain "),t("a",{attrs:{href:"https://www.cloudflare.com/ips/",target:"_blank",rel:"noopener noreferrer"}},[e._v("their IP addresses"),t("OutboundLink")],1),e._v(".\nBelow is an example of how to set this.")]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("TRUSTED_PROXIES=173.245.48.0/20,103.21.244.0/22,103.22.200.0/22,103.31.4.0/22,141.101.64.0/18,108.162.192.0/18,190.93.240.0/20,188.114.96.0/20,197.234.240.0/22,198.41.128.0/17,162.158.0.0/15,104.16.0.0/13,104.24.0.0/14,172.64.0.0/13,131.0.72.0/22\n")])])]),t("h2",{attrs:{id:"recaptcha"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#recaptcha"}},[e._v("#")]),e._v(" reCAPTCHA")]),e._v(" "),t("p",[e._v("The Panel uses invisible reCAPTCHA to secure the login page from brute-force attacks. If the login attempt is considered suspicious, users may be required to perform a reCAPTCHA challenge.")]),e._v(" "),t("h3",{attrs:{id:"configuring-recaptcha"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#configuring-recaptcha"}},[e._v("#")]),e._v(" Configuring reCAPTCHA")]),e._v(" "),t("p",[e._v("While we provide a global Site Key and Secret Key by default, we highly recommend changing it for your own setup.")]),e._v(" "),t("p",[e._v("You can generate your own keys in the "),t("a",{attrs:{href:"https://www.google.com/recaptcha/admin",target:"_blank",rel:"noopener noreferrer"}},[e._v("reCAPTCHA Admin Console"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("The keys can then be applied using the Settings in the admin panel. The reCAPTCHA settings can be found on the "),t("strong",[e._v("Advanced")]),e._v(" tab.")]),e._v(" "),t("h3",{attrs:{id:"disabling-recaptcha"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#disabling-recaptcha"}},[e._v("#")]),e._v(" Disabling reCAPTCHA")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("SECURITY WARNING")]),e._v(" "),t("p",[e._v("We do not recommend disabling reCAPTCHA. It is a security mechanism that makes it harder to perform brute-force attacks on user accounts.")])]),e._v(" "),t("p",[e._v("If users have trouble logging in, or your Panel isn't exposed to the internet, it can make sense to disable reCAPTCHA.")]),e._v(" "),t("p",[e._v("reCAPTCHA can easily be disabled using the admin panel. In the Settings, select the "),t("strong",[e._v("Advanced")]),e._v(" tab and set the "),t("strong",[e._v("Status")]),e._v(" of reCAPTCHA to "),t("strong",[e._v("disabled")]),e._v(".")]),e._v(" "),t("h4",{attrs:{id:"editing-your-database"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#editing-your-database"}},[e._v("#")]),e._v(" Editing your database")]),e._v(" "),t("p",[e._v("If you cannot access your panel, you can modify the database directly using the following commands.")]),e._v(" "),t("div",{staticClass:"language-sql extra-class"},[t("pre",{pre:!0,attrs:{class:"language-sql"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using MariaDB (v11.0.0+)")]),e._v("\nmariadb "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("-")]),e._v("u root "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("-")]),e._v("p\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using MySQL")]),e._v("\nmysql "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("-")]),e._v("u root "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("-")]),e._v("p\n")])])]),t("div",{staticClass:"language-sql extra-class"},[t("pre",{pre:!0,attrs:{class:"language-sql"}},[t("code",[t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("UPDATE")]),e._v(" panel"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("settings "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("SET")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("value")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'false'")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("WHERE")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token identifier"}},[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("`")]),e._v("key"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("`")])]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'settings::recaptcha:enabled'")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n")])])]),t("h2",{attrs:{id:"_2fa"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_2fa"}},[e._v("#")]),e._v(" 2FA")]),e._v(" "),t("p",[e._v("If possible you should use the panel to update your 2FA settings. If you can't access your panel for what ever reason you can use the following steps.")]),e._v(" "),t("h3",{attrs:{id:"disable-2fa-requirement"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#disable-2fa-requirement"}},[e._v("#")]),e._v(" Disable 2FA requirement")]),e._v(" "),t("div",{staticClass:"language-sql extra-class"},[t("pre",{pre:!0,attrs:{class:"language-sql"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using MariaDB (v11.0.0+)")]),e._v("\nmariadb "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("-")]),e._v("u root "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("-")]),e._v("p\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using MySQL")]),e._v("\nmysql "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("-")]),e._v("u root "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("-")]),e._v("p\n")])])]),t("div",{staticClass:"language-sql extra-class"},[t("pre",{pre:!0,attrs:{class:"language-sql"}},[t("code",[t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("UPDATE")]),e._v(" panel"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("settings "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("SET")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("value")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("0")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("WHERE")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token identifier"}},[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("`")]),e._v("key"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("`")])]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'settings::pterodactyl:auth:2fa_required'")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n")])])]),t("h3",{attrs:{id:"disable-2fa-for-a-specific-user"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#disable-2fa-for-a-specific-user"}},[e._v("#")]),e._v(" Disable 2FA for a specific user")]),e._v(" "),t("p",[e._v("Run the following command in your "),t("code",[e._v("/var/www/pterodactyl")]),e._v(" directory.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("php artisan p:user:disable2fa\n")])])]),t("h2",{attrs:{id:"telemetry"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#telemetry"}},[e._v("#")]),e._v(" Telemetry")]),e._v(" "),t("p",[e._v("Since 1.11, the Panel collects anonymous metrics about the Panel and all connected nodes.\nThis feature is enabled by default, but can be disabled.")]),e._v(" "),t("p",[e._v("The data collected by this feature is not sold or used for advertising purposes. Aggregate statistics\nmay be made public or shared with third-parties for the purposes of improving the software.")]),e._v(" "),t("h3",{attrs:{id:"how-does-it-work"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-does-it-work"}},[e._v("#")]),e._v(" How does it work?")]),e._v(" "),t("p",[e._v("The Telemetry system works by first generating a random UUIDv4 identifier for the Panel installation.\nThis identifier is stored in the database so people load-balancing multiple Panel instances can still\nhave a unique identifier. This identifier is then sent to a remote server, along the associated\ntelemetry data. The telemetry data is collected every 24 hours, there is no ongoing collection\nor local storage of the telemetry data, we collect the data right before we send it to the remote\nserver.")]),e._v(" "),t("p",[e._v("Currently, all telemetry collection logic is handled by the "),t("a",{attrs:{href:"https://github.com/pterodactyl/panel/blob/1.0-develop/app/Services/Telemetry/TelemetryCollectionService.php#L53",target:"_blank",rel:"noopener noreferrer"}},[e._v("TelemetryCollectionService"),t("OutboundLink")],1),e._v("\non the panel. This service is responsible for collecting all the data that is sent to the remote\nserver.")]),e._v(" "),t("h3",{attrs:{id:"what-data-is-collected"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#what-data-is-collected"}},[e._v("#")]),e._v(" What data is collected?")]),e._v(" "),t("p",[e._v("If you wish to see the full data that is collected, please look at the TelemetryCollectionService\n(as linked above), or use the "),t("code",[e._v("php artisan p:telemetry")]),e._v(" command to view the exact data that will\nbe sent to the remote server.")]),e._v(" "),t("p",[e._v("As of 2022-12-12, the data collected consists of:")]),e._v(" "),t("ul",[t("li",[e._v("Unique identifier for the Panel")]),e._v(" "),t("li",[e._v("Version of the Panel")]),e._v(" "),t("li",[e._v("PHP version")]),e._v(" "),t("li",[e._v("Backup storage driver (S3, Local, etc.)")]),e._v(" "),t("li",[e._v("Cache driver (Redis, Memcached, etc.)")]),e._v(" "),t("li",[e._v("Database driver and version (MySQL, MariaDB, PostgreSQL, etc.)")]),e._v(" "),t("li",[e._v("Resources\n"),t("ul",[t("li",[e._v("Allocations\n"),t("ul",[t("li",[e._v("Total number")]),e._v(" "),t("li",[e._v("Total number of used allocations (assigned to a server)")])])]),e._v(" "),t("li",[e._v("Backups\n"),t("ul",[t("li",[e._v("Total number")]),e._v(" "),t("li",[e._v("Sum of the total amount of bytes stored by backups")])])]),e._v(" "),t("li",[e._v("Eggs\n"),t("ul",[t("li",[e._v("Total number")]),e._v(" "),t("li",[t("s",[e._v("Map of egg UUIDs to the number of servers using that egg")]),e._v(" (removed in 1.11.2)")])])]),e._v(" "),t("li",[e._v("Locations\n"),t("ul",[t("li",[e._v("Total number")])])]),e._v(" "),t("li",[e._v("Mounts\n"),t("ul",[t("li",[e._v("Total number")])])]),e._v(" "),t("li",[e._v("Nests\n"),t("ul",[t("li",[e._v("Total number")]),e._v(" "),t("li",[t("s",[e._v("Map of nest UUIDs to the number of servers using eggs in that nest")]),e._v(" (removed in 1.11.2)")])])]),e._v(" "),t("li",[e._v("Nodes\n"),t("ul",[t("li",[e._v("Total number")])])]),e._v(" "),t("li",[e._v("Servers\n"),t("ul",[t("li",[e._v("Total number")]),e._v(" "),t("li",[e._v("Number of servers that are suspended")])])]),e._v(" "),t("li",[e._v("Users\n"),t("ul",[t("li",[e._v("Total number")]),e._v(" "),t("li",[e._v("Number of users that are admins")])])])])]),e._v(" "),t("li",[e._v("Nodes\n"),t("ul",[t("li",[e._v("Node UUID")]),e._v(" "),t("li",[e._v("Version of Wings on the node")]),e._v(" "),t("li",[e._v("Docker\n"),t("ul",[t("li",[e._v("Version")]),e._v(" "),t("li",[e._v("Cgroups\n"),t("ul",[t("li",[e._v("Driver")]),e._v(" "),t("li",[e._v("Version")])])]),e._v(" "),t("li",[e._v("Containers\n"),t("ul",[t("li",[e._v("Total")]),e._v(" "),t("li",[e._v("Running")]),e._v(" "),t("li",[e._v("Paused")]),e._v(" "),t("li",[e._v("Stopped")])])]),e._v(" "),t("li",[e._v("Storage\n"),t("ul",[t("li",[e._v("Driver")]),e._v(" "),t("li",[e._v("Filesystem")])])]),e._v(" "),t("li",[e._v("runc\n"),t("ul",[t("li",[e._v("Version")])])])])]),e._v(" "),t("li",[e._v("System\n"),t("ul",[t("li",[e._v("Architecture ("),t("code",[e._v("amd64")]),e._v(", "),t("code",[e._v("arm64")]),e._v(", etc.)")]),e._v(" "),t("li",[e._v("CPU Threads")]),e._v(" "),t("li",[e._v("Memory Bytes")]),e._v(" "),t("li",[e._v("Kernel Version")]),e._v(" "),t("li",[e._v("Operating System (Debian, Fedora, RHEL, Ubuntu, etc.)")]),e._v(" "),t("li",[e._v("Operating System Type (bsd, linux, windows, etc.)")])])])])])]),e._v(" "),t("h3",{attrs:{id:"how-is-the-data-stored"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-is-the-data-stored"}},[e._v("#")]),e._v(" How is the data stored?")]),e._v(" "),t("p",[e._v("Currently, the data is stored with Cloudflare, we ingest all telemetry data with a Worker which does\nbasic processing such as validation and then inserts it into Cloudflare D1. Right now, there is not\nan API or visualization for any of the data collected, and it can only be manually queried. Only\nMatthew is able to query the data at this time, but we are working on alternatives to make this data\nmore accessible.")]),e._v(" "),t("h3",{attrs:{id:"why"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#why"}},[e._v("#")]),e._v(" Why?")]),e._v(" "),t("p",[e._v("The primary reason for collecting this data is to help us make better decisions about the future of\nthis software. With the release of 1.11, the minimum PHP version requirement jumped from 7.4 to 8.0,\nhowever, we wanted to add a feature that required PHP 8.1 which would've made the version requirement\njump larger and potentially cause issues for some users. By collecting this data, we can hopefully\nhave more insight to how changes like this will affect the community and make better decisions in the\nfuture. This is especially important for information like the architecture, kernel version, and\noperating system nodes are using. For example, we want to utilize a feature that is only present in\nsome filesystems, but we have no idea how many people are using those filesystems, so we cannot\ndetermine if it's worth the effort to implement.")]),e._v(" "),t("p",[e._v("Some of the data is not as useful for making decisions, but is still useful for us to know.\nFor example, have you ever wondered how many Panel instances there are? How many servers are being\nran across all of those instances? How many users are using the Panel? How many of those users are\nadmins? How many servers are using a specific egg? How many servers are using a specific nest?\nAll of these questions can be answered by the data we collect, and can help us and the community\nbetter understand how the software is being used.")]),e._v(" "),t("p",[e._v("If you have any questions about the data we collect, please feel free to reach out to us on Discord.\nOur goal is to be as transparent as possible, and we want to make sure that the community understands\nwhat we are doing and why.")]),e._v(" "),t("h3",{attrs:{id:"enabling-telemetry"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enabling-telemetry"}},[e._v("#")]),e._v(" Enabling Telemetry")]),e._v(" "),t("p",[e._v("Telemetry is enabled by default, if you want to enable it after disabling it, edit your "),t("code",[e._v(".env")]),e._v(" file\nand either remove the "),t("code",[e._v("PTERODACTYL_TELEMETRY_ENABLED")]),e._v(" line, or set it to "),t("code",[e._v("true")]),e._v(".")]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("PTERODACTYL_TELEMETRY_ENABLED=true\n")])])]),t("p",[e._v("You may also use the "),t("code",[e._v("php artisan p:environment:setup")]),e._v(" command to enable telemetry, optionally with\nthe "),t("code",[e._v("--telemetry")]),e._v(" flag for a non-interactive setup.")]),e._v(" "),t("h3",{attrs:{id:"disabling-telemetry"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#disabling-telemetry"}},[e._v("#")]),e._v(" Disabling Telemetry")]),e._v(" "),t("p",[e._v("To disable telemetry, edit your "),t("code",[e._v(".env")]),e._v(" file and set "),t("code",[e._v("PTERODACTYL_TELEMETRY_ENABLED")]),e._v(" to "),t("code",[e._v("false")]),e._v(".")]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("PTERODACTYL_TELEMETRY_ENABLED=false\n")])])]),t("p",[e._v("You may also use the "),t("code",[e._v("php artisan p:environment:setup")]),e._v(" command to disable telemetry, optionally with\nthe "),t("code",[e._v("--telemetry=false")]),e._v(" flag for a non-interactive setup.")])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[59],{317:function(e,t,a){"use strict";a.r(t);var s=a(15),r=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"additional-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#additional-configuration"}},[e._v("#")]),e._v(" Additional Configuration")]),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#backups"}},[e._v("Backups")]),t("ul",[t("li",[t("a",{attrs:{href:"#using-local-backups"}},[e._v("Using Local Backups")])]),t("li",[t("a",{attrs:{href:"#using-s3-backups"}},[e._v("Using S3 Backups")])])])]),t("li",[t("a",{attrs:{href:"#reverse-proxy-setup"}},[e._v("Reverse Proxy Setup")]),t("ul",[t("li",[t("a",{attrs:{href:"#nginx-specific-configuration"}},[e._v("NGINX Specific Configuration")])]),t("li",[t("a",{attrs:{href:"#cloudflare-specific-configuration"}},[e._v("Cloudflare Specific Configuration")])])])]),t("li",[t("a",{attrs:{href:"#recaptcha"}},[e._v("reCAPTCHA")]),t("ul",[t("li",[t("a",{attrs:{href:"#configuring-recaptcha"}},[e._v("Configuring reCAPTCHA")])]),t("li",[t("a",{attrs:{href:"#disabling-recaptcha"}},[e._v("Disabling reCAPTCHA")])])])]),t("li",[t("a",{attrs:{href:"#_2fa"}},[e._v("2FA")]),t("ul",[t("li",[t("a",{attrs:{href:"#disable-2fa-requirement"}},[e._v("Disable 2FA requirement")])]),t("li",[t("a",{attrs:{href:"#disable-2fa-for-a-specific-user"}},[e._v("Disable 2FA for a specific user")])])])]),t("li",[t("a",{attrs:{href:"#telemetry"}},[e._v("Telemetry")]),t("ul",[t("li",[t("a",{attrs:{href:"#how-does-it-work"}},[e._v("How does it work?")])]),t("li",[t("a",{attrs:{href:"#what-data-is-collected"}},[e._v("What data is collected?")])]),t("li",[t("a",{attrs:{href:"#how-is-the-data-stored"}},[e._v("How is the data stored?")])]),t("li",[t("a",{attrs:{href:"#why"}},[e._v("Why?")])]),t("li",[t("a",{attrs:{href:"#enabling-telemetry"}},[e._v("Enabling Telemetry")])]),t("li",[t("a",{attrs:{href:"#disabling-telemetry"}},[e._v("Disabling Telemetry")])])])])])]),t("p"),e._v(" "),t("h2",{attrs:{id:"backups"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#backups"}},[e._v("#")]),e._v(" Backups")]),e._v(" "),t("p",[e._v("Pterodactyl Panel allows users to create backups of their servers. In order to create backups, a backup storage method has to be configured.")]),e._v(" "),t("p",[e._v("When changing Pterodactyl Panel's backup storage method, users may still download or delete existing backups from the prior storage driver. In the instance of migrating from S3 to local backups, S3 credentials must remain configured after switching to the local backup storage method.")]),e._v(" "),t("h3",{attrs:{id:"using-local-backups"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-local-backups"}},[e._v("#")]),e._v(" Using Local Backups")]),e._v(" "),t("p",[e._v("By default, Pterodactyl Panel uses local storage via Wings for backups. That said, this method of backup storage can be explicitly set with the following configuration in the "),t("code",[e._v(".env")]),e._v(" file:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Sets your panel to use local storage via Wings for backups")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("APP_BACKUP_DRIVER")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("wings\n")])])]),t("p",[e._v("Do note that, when using local storage via Wings, the destination for backups is set in Wings' "),t("code",[e._v("config.yml")]),e._v(" with the following setting key:")]),e._v(" "),t("div",{staticClass:"language-yml extra-class"},[t("pre",{pre:!0,attrs:{class:"language-yml"}},[t("code",[t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("system")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("backup_directory")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" /path/to/backup/storage\n")])])]),t("h3",{attrs:{id:"using-s3-backups"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-s3-backups"}},[e._v("#")]),e._v(" Using S3 Backups")]),e._v(" "),t("p",[e._v("AWS S3 (or compatible storage) can be used to store remote or cloud-based backups. The following configuration options have to be set in the "),t("code",[e._v(".env")]),e._v(" file or as environment variables in order to enable it:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Sets your panel to use s3 for backups")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("APP_BACKUP_DRIVER")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("s3\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Info to actually use s3")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("AWS_DEFAULT_REGION")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("AWS_ACCESS_KEY_ID")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("AWS_SECRET_ACCESS_KEY")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("AWS_BACKUPS_BUCKET")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("AWS_ENDPOINT")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("\n")])])]),t("p",[e._v("For some configurations, you might have to change your S3 URL from "),t("code",[e._v("bucket.domain.com")]),e._v(" to "),t("code",[e._v("domain.com/bucket")]),e._v(". To accomplish this, add "),t("code",[e._v("AWS_USE_PATH_STYLE_ENDPOINT=true")]),e._v(" to your "),t("code",[e._v(".env")]),e._v(" file.")]),e._v(" "),t("h4",{attrs:{id:"multipart-upload"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#multipart-upload"}},[e._v("#")]),e._v(" Multipart Upload")]),e._v(" "),t("p",[e._v("The S3 backup is using the S3 multipart upload capabilities. In rare situations, you might want to adjust the size of a single part or the lifespan of the generated pre-signed URLs. The default part size is 5GB, and the default pre-signed URL lifespan is 60 minutes.")]),e._v(" "),t("p",[e._v("You can configure the maximal part size using the "),t("code",[e._v("BACKUP_MAX_PART_SIZE")]),e._v(" environment variable. You must specify the size in bytes. To define the pre-signed URL lifespan, use the "),t("code",[e._v("BACKUP_PRESIGNED_URL_LIFESPAN")]),e._v(" variable. The expected unit is minutes.")]),e._v(" "),t("p",[e._v("The following "),t("code",[e._v(".env")]),e._v(" snippet configures 1GB parts and uses 120 minutes as the pre-signed URL lifespan:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BACKUP_MAX_PART_SIZE")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1073741824")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BACKUP_PRESIGNED_URL_LIFESPAN")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("120")]),e._v("\n")])])]),t("h4",{attrs:{id:"storage-class"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#storage-class"}},[e._v("#")]),e._v(" Storage Class")]),e._v(" "),t("p",[e._v("Should you need to specify a storage class, use the "),t("code",[e._v("AWS_BACKUPS_STORAGE_CLASS")]),e._v(" environment variable. Default option is "),t("code",[e._v("STANDARD")]),e._v(" (S3 Standard).")]),e._v(" "),t("p",[e._v("The following "),t("code",[e._v(".env")]),e._v(" snippet sets the class to "),t("code",[e._v("STANDARD_IA")]),e._v(" (this is an example).")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# STANDARD_IA is an example.")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("AWS_BACKUPS_STORAGE_CLASS")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("STANDARD_IA\n")])])]),t("h2",{attrs:{id:"reverse-proxy-setup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#reverse-proxy-setup"}},[e._v("#")]),e._v(" Reverse Proxy Setup")]),e._v(" "),t("p",[e._v("When running Pterodactyl behind a reverse proxy, such as "),t("a",{attrs:{href:"https://support.cloudflare.com/hc/en-us/articles/200170416-What-do-the-SSL-options-mean-",target:"_blank",rel:"noopener noreferrer"}},[e._v("Cloudflare's Flexible SSL"),t("OutboundLink")],1),e._v("\nor Nginx/Apache/Caddy, etc., you will need to make a quick modification to the Panel to ensure things continue to work as expected. By default, when using these reverse proxies,\nyour Panel will not correctly handle requests. You'll most likely be unable to login or see security warnings in your browser console as it attempts to load insecure assets.\nThis is because the internal logic the Panel uses to determine how links should be generated thinks it is running over HTTP and not over HTTPS.")]),e._v(" "),t("p",[e._v("You will need to edit the "),t("code",[e._v(".env")]),e._v(" file in the Panel's root directory to contain "),t("code",[e._v("TRUSTED_PROXIES=*")]),e._v(" at minimum. We highly suggest providing a specific IP address\n(or comma-separated list of IPs) rather than allowing "),t("code",[e._v("*")]),e._v(". For example, if your proxy is running on the same machine as the server,\nthe chances are that something like "),t("code",[e._v("TRUSTED_PROXIES=127.0.0.1")]),e._v(" will work for you.")]),e._v(" "),t("h3",{attrs:{id:"nginx-specific-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#nginx-specific-configuration"}},[e._v("#")]),e._v(" NGINX Specific Configuration")]),e._v(" "),t("p",[e._v("For Pterodactyl to properly respond to an NGINX reverse proxy, the NGINX "),t("code",[e._v("location")]),e._v(" config must contain the following lines:")]),e._v(" "),t("div",{staticClass:"language-Nginx extra-class"},[t("pre",{pre:!0,attrs:{class:"language-nginx"}},[t("code",[t("span",{pre:!0,attrs:{class:"token directive"}},[t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("proxy_set_header")]),e._v(" X-Real-IP "),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$remote_addr")])]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token directive"}},[t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("proxy_set_header")]),e._v(" Host "),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$host")])]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token directive"}},[t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("proxy_set_header")]),e._v(" X-Forwarded-For "),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$proxy_add_x_forwarded_for")])]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token directive"}},[t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("proxy_set_header")]),e._v(" X-Forwarded-Proto "),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$scheme")])]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token directive"}},[t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("proxy_redirect")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("off")])]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token directive"}},[t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("proxy_buffering")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("off")])]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token directive"}},[t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("proxy_request_buffering")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("off")])]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n")])])]),t("h3",{attrs:{id:"cloudflare-specific-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#cloudflare-specific-configuration"}},[e._v("#")]),e._v(" Cloudflare Specific Configuration")]),e._v(" "),t("p",[e._v("If you're using Cloudflare's Flexible SSL you should set "),t("code",[e._v("TRUSTED_PROXIES")]),e._v(" to contain "),t("a",{attrs:{href:"https://www.cloudflare.com/ips/",target:"_blank",rel:"noopener noreferrer"}},[e._v("their IP addresses"),t("OutboundLink")],1),e._v(".\nBelow is an example of how to set this.")]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("TRUSTED_PROXIES=173.245.48.0/20,103.21.244.0/22,103.22.200.0/22,103.31.4.0/22,141.101.64.0/18,108.162.192.0/18,190.93.240.0/20,188.114.96.0/20,197.234.240.0/22,198.41.128.0/17,162.158.0.0/15,104.16.0.0/13,104.24.0.0/14,172.64.0.0/13,131.0.72.0/22\n")])])]),t("h2",{attrs:{id:"recaptcha"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#recaptcha"}},[e._v("#")]),e._v(" reCAPTCHA")]),e._v(" "),t("p",[e._v("The Panel uses invisible reCAPTCHA to secure the login page from brute-force attacks. If the login attempt is considered suspicious, users may be required to perform a reCAPTCHA challenge.")]),e._v(" "),t("h3",{attrs:{id:"configuring-recaptcha"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#configuring-recaptcha"}},[e._v("#")]),e._v(" Configuring reCAPTCHA")]),e._v(" "),t("p",[e._v("While we provide a global Site Key and Secret Key by default, we highly recommend changing it for your own setup.")]),e._v(" "),t("p",[e._v("You can generate your own keys in the "),t("a",{attrs:{href:"https://www.google.com/recaptcha/admin",target:"_blank",rel:"noopener noreferrer"}},[e._v("reCAPTCHA Admin Console"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("The keys can then be applied using the Settings in the admin panel. The reCAPTCHA settings can be found on the "),t("strong",[e._v("Advanced")]),e._v(" tab.")]),e._v(" "),t("h3",{attrs:{id:"disabling-recaptcha"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#disabling-recaptcha"}},[e._v("#")]),e._v(" Disabling reCAPTCHA")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("SECURITY WARNING")]),e._v(" "),t("p",[e._v("We do not recommend disabling reCAPTCHA. It is a security mechanism that makes it harder to perform brute-force attacks on user accounts.")])]),e._v(" "),t("p",[e._v("If users have trouble logging in, or your Panel isn't exposed to the internet, it can make sense to disable reCAPTCHA.")]),e._v(" "),t("p",[e._v("reCAPTCHA can easily be disabled using the admin panel. In the Settings, select the "),t("strong",[e._v("Advanced")]),e._v(" tab and set the "),t("strong",[e._v("Status")]),e._v(" of reCAPTCHA to "),t("strong",[e._v("disabled")]),e._v(".")]),e._v(" "),t("h4",{attrs:{id:"editing-your-database"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#editing-your-database"}},[e._v("#")]),e._v(" Editing your database")]),e._v(" "),t("p",[e._v("If you cannot access your panel, you can modify the database directly using the following commands.")]),e._v(" "),t("div",{staticClass:"language-sql extra-class"},[t("pre",{pre:!0,attrs:{class:"language-sql"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using MariaDB (v11.0.0+)")]),e._v("\nmariadb "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("-")]),e._v("u root "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("-")]),e._v("p\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using MySQL")]),e._v("\nmysql "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("-")]),e._v("u root "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("-")]),e._v("p\n")])])]),t("div",{staticClass:"language-sql extra-class"},[t("pre",{pre:!0,attrs:{class:"language-sql"}},[t("code",[t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("UPDATE")]),e._v(" panel"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("settings "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("SET")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("value")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'false'")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("WHERE")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token identifier"}},[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("`")]),e._v("key"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("`")])]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'settings::recaptcha:enabled'")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n")])])]),t("h2",{attrs:{id:"_2fa"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_2fa"}},[e._v("#")]),e._v(" 2FA")]),e._v(" "),t("p",[e._v("If possible you should use the panel to update your 2FA settings. If you can't access your panel for what ever reason you can use the following steps.")]),e._v(" "),t("h3",{attrs:{id:"disable-2fa-requirement"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#disable-2fa-requirement"}},[e._v("#")]),e._v(" Disable 2FA requirement")]),e._v(" "),t("div",{staticClass:"language-sql extra-class"},[t("pre",{pre:!0,attrs:{class:"language-sql"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using MariaDB (v11.0.0+)")]),e._v("\nmariadb "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("-")]),e._v("u root "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("-")]),e._v("p\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using MySQL")]),e._v("\nmysql "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("-")]),e._v("u root "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("-")]),e._v("p\n")])])]),t("div",{staticClass:"language-sql extra-class"},[t("pre",{pre:!0,attrs:{class:"language-sql"}},[t("code",[t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("UPDATE")]),e._v(" panel"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("settings "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("SET")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("value")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("0")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("WHERE")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token identifier"}},[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("`")]),e._v("key"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("`")])]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'settings::pterodactyl:auth:2fa_required'")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n")])])]),t("h3",{attrs:{id:"disable-2fa-for-a-specific-user"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#disable-2fa-for-a-specific-user"}},[e._v("#")]),e._v(" Disable 2FA for a specific user")]),e._v(" "),t("p",[e._v("Run the following command in your "),t("code",[e._v("/var/www/pterodactyl")]),e._v(" directory.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("php artisan p:user:disable2fa\n")])])]),t("h2",{attrs:{id:"telemetry"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#telemetry"}},[e._v("#")]),e._v(" Telemetry")]),e._v(" "),t("p",[e._v("Since 1.11, the Panel collects anonymous metrics about the Panel and all connected nodes.\nThis feature is enabled by default, but can be disabled.")]),e._v(" "),t("p",[e._v("The data collected by this feature is not sold or used for advertising purposes. Aggregate statistics\nmay be made public or shared with third-parties for the purposes of improving the software.")]),e._v(" "),t("h3",{attrs:{id:"how-does-it-work"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-does-it-work"}},[e._v("#")]),e._v(" How does it work?")]),e._v(" "),t("p",[e._v("The Telemetry system works by first generating a random UUIDv4 identifier for the Panel installation.\nThis identifier is stored in the database so people load-balancing multiple Panel instances can still\nhave a unique identifier. This identifier is then sent to a remote server, along the associated\ntelemetry data. The telemetry data is collected every 24 hours, there is no ongoing collection\nor local storage of the telemetry data, we collect the data right before we send it to the remote\nserver.")]),e._v(" "),t("p",[e._v("Currently, all telemetry collection logic is handled by the "),t("a",{attrs:{href:"https://github.com/pterodactyl/panel/blob/1.0-develop/app/Services/Telemetry/TelemetryCollectionService.php#L53",target:"_blank",rel:"noopener noreferrer"}},[e._v("TelemetryCollectionService"),t("OutboundLink")],1),e._v("\non the panel. This service is responsible for collecting all the data that is sent to the remote\nserver.")]),e._v(" "),t("h3",{attrs:{id:"what-data-is-collected"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#what-data-is-collected"}},[e._v("#")]),e._v(" What data is collected?")]),e._v(" "),t("p",[e._v("If you wish to see the full data that is collected, please look at the TelemetryCollectionService\n(as linked above), or use the "),t("code",[e._v("php artisan p:telemetry")]),e._v(" command to view the exact data that will\nbe sent to the remote server.")]),e._v(" "),t("p",[e._v("As of 2022-12-12, the data collected consists of:")]),e._v(" "),t("ul",[t("li",[e._v("Unique identifier for the Panel")]),e._v(" "),t("li",[e._v("Version of the Panel")]),e._v(" "),t("li",[e._v("PHP version")]),e._v(" "),t("li",[e._v("Backup storage driver (S3, Local, etc.)")]),e._v(" "),t("li",[e._v("Cache driver (Redis, Memcached, etc.)")]),e._v(" "),t("li",[e._v("Database driver and version (MySQL, MariaDB, PostgreSQL, etc.)")]),e._v(" "),t("li",[e._v("Resources\n"),t("ul",[t("li",[e._v("Allocations\n"),t("ul",[t("li",[e._v("Total number")]),e._v(" "),t("li",[e._v("Total number of used allocations (assigned to a server)")])])]),e._v(" "),t("li",[e._v("Backups\n"),t("ul",[t("li",[e._v("Total number")]),e._v(" "),t("li",[e._v("Sum of the total amount of bytes stored by backups")])])]),e._v(" "),t("li",[e._v("Eggs\n"),t("ul",[t("li",[e._v("Total number")]),e._v(" "),t("li",[t("s",[e._v("Map of egg UUIDs to the number of servers using that egg")]),e._v(" (removed in 1.11.2)")])])]),e._v(" "),t("li",[e._v("Locations\n"),t("ul",[t("li",[e._v("Total number")])])]),e._v(" "),t("li",[e._v("Mounts\n"),t("ul",[t("li",[e._v("Total number")])])]),e._v(" "),t("li",[e._v("Nests\n"),t("ul",[t("li",[e._v("Total number")]),e._v(" "),t("li",[t("s",[e._v("Map of nest UUIDs to the number of servers using eggs in that nest")]),e._v(" (removed in 1.11.2)")])])]),e._v(" "),t("li",[e._v("Nodes\n"),t("ul",[t("li",[e._v("Total number")])])]),e._v(" "),t("li",[e._v("Servers\n"),t("ul",[t("li",[e._v("Total number")]),e._v(" "),t("li",[e._v("Number of servers that are suspended")])])]),e._v(" "),t("li",[e._v("Users\n"),t("ul",[t("li",[e._v("Total number")]),e._v(" "),t("li",[e._v("Number of users that are admins")])])])])]),e._v(" "),t("li",[e._v("Nodes\n"),t("ul",[t("li",[e._v("Node UUID")]),e._v(" "),t("li",[e._v("Version of Wings on the node")]),e._v(" "),t("li",[e._v("Docker\n"),t("ul",[t("li",[e._v("Version")]),e._v(" "),t("li",[e._v("Cgroups\n"),t("ul",[t("li",[e._v("Driver")]),e._v(" "),t("li",[e._v("Version")])])]),e._v(" "),t("li",[e._v("Containers\n"),t("ul",[t("li",[e._v("Total")]),e._v(" "),t("li",[e._v("Running")]),e._v(" "),t("li",[e._v("Paused")]),e._v(" "),t("li",[e._v("Stopped")])])]),e._v(" "),t("li",[e._v("Storage\n"),t("ul",[t("li",[e._v("Driver")]),e._v(" "),t("li",[e._v("Filesystem")])])]),e._v(" "),t("li",[e._v("runc\n"),t("ul",[t("li",[e._v("Version")])])])])]),e._v(" "),t("li",[e._v("System\n"),t("ul",[t("li",[e._v("Architecture ("),t("code",[e._v("amd64")]),e._v(", "),t("code",[e._v("arm64")]),e._v(", etc.)")]),e._v(" "),t("li",[e._v("CPU Threads")]),e._v(" "),t("li",[e._v("Memory Bytes")]),e._v(" "),t("li",[e._v("Kernel Version")]),e._v(" "),t("li",[e._v("Operating System (Debian, Fedora, RHEL, Ubuntu, etc.)")]),e._v(" "),t("li",[e._v("Operating System Type (bsd, linux, windows, etc.)")])])])])])]),e._v(" "),t("h3",{attrs:{id:"how-is-the-data-stored"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-is-the-data-stored"}},[e._v("#")]),e._v(" How is the data stored?")]),e._v(" "),t("p",[e._v("Currently, the data is stored with Cloudflare, we ingest all telemetry data with a Worker which does\nbasic processing such as validation and then inserts it into Cloudflare D1. Right now, there is not\nan API or visualization for any of the data collected, and it can only be manually queried. Only\nMatthew is able to query the data at this time, but we are working on alternatives to make this data\nmore accessible.")]),e._v(" "),t("h3",{attrs:{id:"why"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#why"}},[e._v("#")]),e._v(" Why?")]),e._v(" "),t("p",[e._v("The primary reason for collecting this data is to help us make better decisions about the future of\nthis software. With the release of 1.11, the minimum PHP version requirement jumped from 7.4 to 8.0,\nhowever, we wanted to add a feature that required PHP 8.1 which would've made the version requirement\njump larger and potentially cause issues for some users. By collecting this data, we can hopefully\nhave more insight to how changes like this will affect the community and make better decisions in the\nfuture. This is especially important for information like the architecture, kernel version, and\noperating system nodes are using. For example, we want to utilize a feature that is only present in\nsome filesystems, but we have no idea how many people are using those filesystems, so we cannot\ndetermine if it's worth the effort to implement.")]),e._v(" "),t("p",[e._v("Some of the data is not as useful for making decisions, but is still useful for us to know.\nFor example, have you ever wondered how many Panel instances there are? How many servers are being\nran across all of those instances? How many users are using the Panel? How many of those users are\nadmins? How many servers are using a specific egg? How many servers are using a specific nest?\nAll of these questions can be answered by the data we collect, and can help us and the community\nbetter understand how the software is being used.")]),e._v(" "),t("p",[e._v("If you have any questions about the data we collect, please feel free to reach out to us on Discord.\nOur goal is to be as transparent as possible, and we want to make sure that the community understands\nwhat we are doing and why.")]),e._v(" "),t("h3",{attrs:{id:"enabling-telemetry"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enabling-telemetry"}},[e._v("#")]),e._v(" Enabling Telemetry")]),e._v(" "),t("p",[e._v("Telemetry is enabled by default, if you want to enable it after disabling it, edit your "),t("code",[e._v(".env")]),e._v(" file\nand either remove the "),t("code",[e._v("PTERODACTYL_TELEMETRY_ENABLED")]),e._v(" line, or set it to "),t("code",[e._v("true")]),e._v(".")]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("PTERODACTYL_TELEMETRY_ENABLED=true\n")])])]),t("p",[e._v("You may also use the "),t("code",[e._v("php artisan p:environment:setup")]),e._v(" command to enable telemetry, optionally with\nthe "),t("code",[e._v("--telemetry")]),e._v(" flag for a non-interactive setup.")]),e._v(" "),t("h3",{attrs:{id:"disabling-telemetry"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#disabling-telemetry"}},[e._v("#")]),e._v(" Disabling Telemetry")]),e._v(" "),t("p",[e._v("To disable telemetry, edit your "),t("code",[e._v(".env")]),e._v(" file and set "),t("code",[e._v("PTERODACTYL_TELEMETRY_ENABLED")]),e._v(" to "),t("code",[e._v("false")]),e._v(".")]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("PTERODACTYL_TELEMETRY_ENABLED=false\n")])])]),t("p",[e._v("You may also use the "),t("code",[e._v("php artisan p:environment:setup")]),e._v(" command to disable telemetry, optionally with\nthe "),t("code",[e._v("--telemetry=false")]),e._v(" flag for a non-interactive setup.")])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/60.6a6972b5.js b/assets/js/60.6a6972b5.js new file mode 100644 index 00000000..293fe605 --- /dev/null +++ b/assets/js/60.6a6972b5.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[60],{318:function(e,t,a){"use strict";a.r(t);var s=a(15),r=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"getting-started"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getting-started"}},[e._v("#")]),e._v(" Getting Started")]),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#picking-a-server-os"}},[e._v("Picking a Server OS")])]),t("li",[t("a",{attrs:{href:"#dependencies"}},[e._v("Dependencies")]),t("ul",[t("li",[t("a",{attrs:{href:"#example-dependency-installation"}},[e._v("Example Dependency Installation")])]),t("li",[t("a",{attrs:{href:"#installing-composer"}},[e._v("Installing Composer")])])])]),t("li",[t("a",{attrs:{href:"#download-files"}},[e._v("Download Files")])]),t("li",[t("a",{attrs:{href:"#installation"}},[e._v("Installation")]),t("ul",[t("li",[t("a",{attrs:{href:"#environment-configuration"}},[e._v("Environment Configuration")])]),t("li",[t("a",{attrs:{href:"#database-setup"}},[e._v("Database Setup")])]),t("li",[t("a",{attrs:{href:"#add-the-first-user"}},[e._v("Add The First User")])]),t("li",[t("a",{attrs:{href:"#set-permissions"}},[e._v("Set Permissions")])])])]),t("li",[t("a",{attrs:{href:"#queue-listeners"}},[e._v("Queue Listeners")]),t("ul",[t("li",[t("a",{attrs:{href:"#crontab-configuration"}},[e._v("Crontab Configuration")])]),t("li",[t("a",{attrs:{href:"#create-queue-worker"}},[e._v("Create Queue Worker")])]),t("li",[t("a",{attrs:{href:"#telemetry"}},[e._v("Telemetry")])])])])])]),t("p"),e._v(" "),t("p",[e._v("Pterodactyl Panel is designed to run on your own web server. You will need to have root access to your server in order to run and use this panel.")]),e._v(" "),t("p",[e._v("You are expected to understand how to read documentation to use this Panel. We have spent many hours detailing how to install or upgrade our\nsoftware; take some time and read rather than copy and pasting and then complaining when things do not work. This panel does\nnot exist as a drag-and-drop service to run your servers. It is a highly complex system requiring multiple dependencies and\nadministrators willing to spend some time learning how to use it. "),t("strong",[e._v("If you expect to be able to install this with no understanding\nof basic linux system administration you should stop and turn around now.")])]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("Looking for something simple to setup?")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://wisp.gg",target:"_blank",rel:"noopener noreferrer"}},[e._v("WISP"),t("OutboundLink")],1),e._v(" is a Pterodactyl powered SaaS suitable for enterprise and personal use. Offering all the features without the setup hassle, and fully compatible with Pterodactyl eggs. Comparable to MultiCraft or TCAdmin while offering new and unique features. Click here to "),t("a",{attrs:{href:"https://wisp.gg/features",target:"_blank",rel:"noopener noreferrer"}},[e._v("learn more"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("h2",{attrs:{id:"picking-a-server-os"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#picking-a-server-os"}},[e._v("#")]),e._v(" Picking a Server OS")]),e._v(" "),t("p",[e._v("Pterodactyl runs on a wide range of operating systems, so pick whichever you are most comfortable using.")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("Pterodactyl does not support most OpenVZ systems due to incompatibilities with Docker. If you are planning on running\nthis software on an OpenVZ based system you will — most likely — not be successful.")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Operating System")]),e._v(" "),t("th",[e._v("Version")]),e._v(" "),t("th",{staticStyle:{"text-align":"center"}},[e._v("Supported")]),e._v(" "),t("th",[e._v("Notes")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("strong",[e._v("Ubuntu")])]),e._v(" "),t("td",[e._v("22.04")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td",[e._v("Requires additional repositories for PHP")])]),e._v(" "),t("tr",[t("td"),e._v(" "),t("td",[e._v("24.04")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td",[e._v("MariaDB can be installed without the repo setup script.")])]),e._v(" "),t("tr",[t("td",[t("strong",[e._v("RHEL / Rocky Linux / AlmaLinux")])]),e._v(" "),t("td",[e._v("8")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td",[e._v("Extra repos are required.")])]),e._v(" "),t("tr",[t("td"),e._v(" "),t("td",[e._v("9")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td")]),e._v(" "),t("tr",[t("td",[t("strong",[e._v("Debian")])]),e._v(" "),t("td",[e._v("11")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td")]),e._v(" "),t("tr",[t("td"),e._v(" "),t("td",[e._v("12")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td")])])]),e._v(" "),t("h2",{attrs:{id:"dependencies"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dependencies"}},[e._v("#")]),e._v(" Dependencies")]),e._v(" "),t("ul",[t("li",[e._v("PHP "),t("code",[e._v("8.2")]),e._v(" or "),t("code",[e._v("8.3")]),e._v(" (recommended) with the following extensions: "),t("code",[e._v("cli")]),e._v(", "),t("code",[e._v("openssl")]),e._v(", "),t("code",[e._v("gd")]),e._v(", "),t("code",[e._v("mysql")]),e._v(", "),t("code",[e._v("PDO")]),e._v(", "),t("code",[e._v("mbstring")]),e._v(", "),t("code",[e._v("tokenizer")]),e._v(", "),t("code",[e._v("bcmath")]),e._v(", "),t("code",[e._v("xml")]),e._v(" or "),t("code",[e._v("dom")]),e._v(", "),t("code",[e._v("curl")]),e._v(", "),t("code",[e._v("zip")]),e._v(", and "),t("code",[e._v("fpm")]),e._v(" if you are planning to use NGINX.")]),e._v(" "),t("li",[e._v("MySQL "),t("code",[e._v("5.7.22")]),e._v(" and higher (MySQL "),t("code",[e._v("8")]),e._v(" recommended) "),t("strong",[e._v("or")]),e._v(" MariaDB "),t("code",[e._v("10.2")]),e._v(" and higher.")]),e._v(" "),t("li",[e._v("Redis ("),t("code",[e._v("redis-server")]),e._v(")")]),e._v(" "),t("li",[e._v("A webserver (Apache, NGINX, Caddy, etc.)")]),e._v(" "),t("li",[t("code",[e._v("curl")])]),e._v(" "),t("li",[t("code",[e._v("tar")])]),e._v(" "),t("li",[t("code",[e._v("unzip")])]),e._v(" "),t("li",[t("code",[e._v("git")])]),e._v(" "),t("li",[t("code",[e._v("composer")]),e._v(" v2")])]),e._v(" "),t("h3",{attrs:{id:"example-dependency-installation"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#example-dependency-installation"}},[e._v("#")]),e._v(" Example Dependency Installation")]),e._v(" "),t("p",[e._v("The commands below are simply an example of how you might install these dependencies. Please consult with your\noperating system's package manager to determine the correct packages to install.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v('# Add "add-apt-repository" command')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-y")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" software-properties-common "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" apt-transport-https ca-certificates gnupg\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Add additional repositories for PHP (Ubuntu 22.04)")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t("span",{pre:!0,attrs:{class:"token environment constant"}},[e._v("LC_ALL")])]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("C.UTF-8 add-apt-repository "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-y")]),e._v(" ppa:ondrej/php\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Add Redis official APT repository")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-fsSL")]),e._v(" https://packages.redis.io/gpg "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" gpg "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--dearmor")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-o")]),e._v(" /usr/share/keyrings/redis-archive-keyring.gpg\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("echo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"deb [signed-by=/usr/share/keyrings/redis-archive-keyring.gpg] https://packages.redis.io/deb '),t("span",{pre:!0,attrs:{class:"token variable"}},[t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$(")]),e._v("lsb_release "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-cs")]),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v(")")])]),e._v(' main"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("tee")]),e._v(" /etc/apt/sources.list.d/redis.list\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Update repositories list")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" update\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Install Dependencies")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-y")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" php8.3 php8.3-"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("common,cli,gd,mysql,mbstring,bcmath,xml,fpm,curl,zip"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v(" mariadb-server nginx "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("tar")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("unzip")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" redis-server\n")])])]),t("h3",{attrs:{id:"installing-composer"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installing-composer"}},[e._v("#")]),e._v(" Installing Composer")]),e._v(" "),t("p",[e._v("Composer is a dependency manager for PHP that allows us to ship everything you'll need code wise to operate the Panel. You'll\nneed composer installed before continuing in this process.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-sS")]),e._v(" https://getcomposer.org/installer "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" php -- --install-dir"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("/usr/local/bin "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--filename")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("composer\n")])])]),t("h2",{attrs:{id:"download-files"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#download-files"}},[e._v("#")]),e._v(" Download Files")]),e._v(" "),t("p",[e._v("The first step in this process is to create the folder where the panel will live and then move ourselves into that\nnewly created folder. Below is an example of how to perform this operation.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("mkdir")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-p")]),e._v(" /var/www/pterodactyl\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" /var/www/pterodactyl\n")])])]),t("p",[e._v("Once you have created a new directory for the Panel and moved into it you'll need to download the Panel files. This\nis as simple as using "),t("code",[e._v("curl")]),e._v(" to download our pre-packaged content. Once it is downloaded you'll need to unpack the archive\nand then set the correct permissions on the "),t("code",[e._v("storage/")]),e._v(" and "),t("code",[e._v("bootstrap/cache/")]),e._v(" directories. These directories\nallow us to store files as well as keep a speedy cache available to reduce load times.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-Lo")]),e._v(" panel.tar.gz https://github.com/pterodactyl/panel/releases/latest/download/panel.tar.gz\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("tar")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-xzvf")]),e._v(" panel.tar.gz\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("chmod")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("755")]),e._v(" storage/* bootstrap/cache/\n")])])]),t("h2",{attrs:{id:"installation"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installation"}},[e._v("#")]),e._v(" Installation")]),e._v(" "),t("p",[e._v("Now that all of the files have been downloaded we need to configure some core aspects of the Panel.")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("Database Configuration")]),e._v(" "),t("p",[e._v("You will need a database setup and a user with the correct permissions created for that database before\ncontinuing any further. See below to create a user and database for your Pterodactyl panel quickly. To find more detailed information\nplease have a look at "),t("RouterLink",{attrs:{to:"/tutorials/mysql_setup.html"}},[e._v("Setting up MySQL")]),e._v(".")],1),e._v(" "),t("div",{staticClass:"language-sql extra-class"},[t("pre",{pre:!0,attrs:{class:"language-sql"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using MariaDB (v11.0.0+) (This is the default when installing Pterodactyl by following the documentation.)")]),e._v("\nmariadb "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("-")]),e._v("u root "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("-")]),e._v("p\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using MySQL")]),e._v("\nmysql "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("-")]),e._v("u root "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("-")]),e._v("p\n")])])]),t("div",{staticClass:"language-sql extra-class"},[t("pre",{pre:!0,attrs:{class:"language-sql"}},[t("code",[e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Remember to change 'yourPassword' below to be a unique password")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("CREATE")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("USER")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'pterodactyl'")]),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("@'127.0.0.1'")]),e._v(" IDENTIFIED "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("BY")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'yourPassword'")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("CREATE")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("DATABASE")]),e._v(" panel"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("GRANT")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("ALL")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("PRIVILEGES")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("ON")]),e._v(" panel"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("*")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("TO")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'pterodactyl'")]),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("@'127.0.0.1'")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("WITH")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("GRANT")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("OPTION")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("exit")]),e._v("\n")])])])]),e._v(" "),t("p",[e._v("First we will copy over our default environment settings file, install core dependencies, and then generate a\nnew application encryption key.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("cp")]),e._v(" .env.example .env\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("COMPOSER_ALLOW_SUPERUSER")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("composer")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" --no-dev --optimize-autoloader\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Only run the command below if you are installing this Panel for")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# the first time and do not have any Pterodactyl Panel data in the database.")]),e._v("\nphp artisan key:generate "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--force")]),e._v("\n")])])]),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("DANGER")]),e._v(" "),t("p",[e._v("Back up your encryption key (APP_KEY in the "),t("code",[e._v(".env")]),e._v(" file). It is used as an encryption key for all data that needs to be stored securely (e.g. api keys).\nStore it somewhere safe - not just on your server. If you lose it all encrypted data is irrecoverable -- even if you have database backups.")])]),e._v(" "),t("h3",{attrs:{id:"environment-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#environment-configuration"}},[e._v("#")]),e._v(" Environment Configuration")]),e._v(" "),t("p",[e._v("Pterodactyl's core environment is easily configured using a few different CLI commands built into the app. This step\nwill cover setting up things such as sessions, caching, database credentials, and email sending.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("php artisan p:environment:setup\nphp artisan p:environment:database\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v('# To use PHP\'s internal mail sending (not recommended), select "mail". To use a')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v('# custom SMTP server, select "smtp".')]),e._v("\nphp artisan p:environment:mail\n")])])]),t("h3",{attrs:{id:"database-setup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#database-setup"}},[e._v("#")]),e._v(" Database Setup")]),e._v(" "),t("p",[e._v("Now we need to setup all of the base data for the Panel in the database you created earlier. "),t("strong",[e._v("The command below\nmay take some time to run depending on your machine. Please "),t("em",[e._v("DO NOT")]),e._v(" exit the process until it is completed!")]),e._v(" This\ncommand will setup the database tables and then add all of the Nests & Eggs that power Pterodactyl.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("php artisan migrate "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--seed")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--force")]),e._v("\n")])])]),t("h3",{attrs:{id:"add-the-first-user"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#add-the-first-user"}},[e._v("#")]),e._v(" Add The First User")]),e._v(" "),t("p",[e._v("You'll then need to create an administrative user so that you can log into the panel. To do so, run the command below.\nAt this time passwords "),t("strong",[e._v("must")]),e._v(" meet the following requirements: 8 characters, mixed case, at least one number.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("php artisan p:user:make\n")])])]),t("h3",{attrs:{id:"set-permissions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-permissions"}},[e._v("#")]),e._v(" Set Permissions")]),e._v(" "),t("p",[e._v("The last step in the installation process is to set the correct permissions on the Panel files so that the webserver can\nuse them correctly.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using NGINX, Apache or Caddy (not on RHEL / Rocky Linux / AlmaLinux)")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("chown")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" www-data:www-data /var/www/pterodactyl/*\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using NGINX on RHEL / Rocky Linux / AlmaLinux")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("chown")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" nginx:nginx /var/www/pterodactyl/*\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using Apache on RHEL / Rocky Linux / AlmaLinux")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("chown")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" apache:apache /var/www/pterodactyl/*\n")])])]),t("h2",{attrs:{id:"queue-listeners"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#queue-listeners"}},[e._v("#")]),e._v(" Queue Listeners")]),e._v(" "),t("p",[e._v("We make use of queues to make the application faster and handle sending emails and other actions in the background.\nYou will need to setup the queue worker for these actions to be processed.")]),e._v(" "),t("h3",{attrs:{id:"crontab-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#crontab-configuration"}},[e._v("#")]),e._v(" Crontab Configuration")]),e._v(" "),t("p",[e._v("The first thing we need to do is create a new cronjob that runs every minute to process specific Pterodactyl tasks, such\nas session cleanup and sending scheduled tasks to daemons. You'll want to open your crontab using "),t("code",[e._v("sudo crontab -e")]),e._v(" and\nthen paste the line below.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("* * * * * php /var/www/pterodactyl/artisan schedule:run "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">>")]),e._v(" /dev/null "),t("span",{pre:!0,attrs:{class:"token operator"}},[t("span",{pre:!0,attrs:{class:"token file-descriptor important"}},[e._v("2")]),e._v(">")]),t("span",{pre:!0,attrs:{class:"token file-descriptor important"}},[e._v("&1")]),e._v("\n")])])]),t("h3",{attrs:{id:"create-queue-worker"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#create-queue-worker"}},[e._v("#")]),e._v(" Create Queue Worker")]),e._v(" "),t("p",[e._v("Next you need to create a new systemd worker to keep our queue process running in the background. This queue is responsible\nfor sending emails and handling many other background tasks for Pterodactyl.")]),e._v(" "),t("p",[e._v("Create a file called "),t("code",[e._v("pteroq.service")]),e._v(" in "),t("code",[e._v("/etc/systemd/system")]),e._v(" with the contents below.")]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("# Pterodactyl Queue Worker File\n# ----------------------------------\n\n[Unit]\nDescription=Pterodactyl Queue Worker\nAfter=redis-server.service\n\n[Service]\n# On some systems the user and group might be different.\n# Some systems use `apache` or `nginx` as the user and group.\nUser=www-data\nGroup=www-data\nRestart=always\nExecStart=/usr/bin/php /var/www/pterodactyl/artisan queue:work --queue=high,standard,low --sleep=3 --tries=3\nStartLimitInterval=180\nStartLimitBurst=30\nRestartSec=5s\n\n[Install]\nWantedBy=multi-user.target\n")])])]),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("Redis on RHEL / Rocky Linux / AlmaLinux")]),e._v(" "),t("p",[e._v("If you are using RHEL, Rocky Linux, or AlmaLinux, you will need to replace "),t("code",[e._v("redis-server.service")]),e._v(" with "),t("code",[e._v("redis.service")]),e._v(" at the "),t("code",[e._v("After=")]),e._v(" line in order to ensure "),t("code",[e._v("redis")]),e._v(" starts before the queue worker.")])]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("If you are not using "),t("code",[e._v("redis")]),e._v(" for anything you should remove the "),t("code",[e._v("After=")]),e._v(" line, otherwise you will encounter errors\nwhen the service starts.")])]),e._v(" "),t("p",[e._v("If you are using redis for your system, you will want to make sure to enable that it will start on boot. You can do that by running the following command:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" systemctl "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("enable")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--now")]),e._v(" redis-server\n")])])]),t("p",[e._v("Finally, enable the service and set it to boot on machine start.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" systemctl "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("enable")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--now")]),e._v(" pteroq.service\n")])])]),t("h3",{attrs:{id:"telemetry"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#telemetry"}},[e._v("#")]),e._v(" Telemetry")]),e._v(" "),t("p",[e._v("Since 1.11, Pterodactyl will collect anonymous telemetry to help us better understand how the\nsoftware is being used. To learn more about this feature and to opt-out, please see our "),t("RouterLink",{attrs:{to:"/panel/1.0/additional_configuration.html#telemetry"}},[e._v("Telemetry")]),e._v("\ndocumentation. Make sure to continue with the rest of the installation process.")],1),e._v(" "),t("h4",{attrs:{id:"next-step-webserver-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#next-step-webserver-configuration"}},[e._v("#")]),e._v(" Next Step: "),t("a",{attrs:{href:"./webserver_configuration"}},[e._v("Webserver Configuration")])])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/60.7c144676.js b/assets/js/60.7c144676.js deleted file mode 100644 index 9ac38f99..00000000 --- a/assets/js/60.7c144676.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[60],{320:function(e,t,a){"use strict";a.r(t);var s=a(15),n=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"getting-started"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getting-started"}},[e._v("#")]),e._v(" Getting Started")]),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#picking-a-server-os"}},[e._v("Picking a Server OS")])]),t("li",[t("a",{attrs:{href:"#dependencies"}},[e._v("Dependencies")]),t("ul",[t("li",[t("a",{attrs:{href:"#example-dependency-installation"}},[e._v("Example Dependency Installation")])]),t("li",[t("a",{attrs:{href:"#installing-composer"}},[e._v("Installing Composer")])])])]),t("li",[t("a",{attrs:{href:"#download-files"}},[e._v("Download Files")])]),t("li",[t("a",{attrs:{href:"#installation"}},[e._v("Installation")]),t("ul",[t("li",[t("a",{attrs:{href:"#environment-configuration"}},[e._v("Environment Configuration")])]),t("li",[t("a",{attrs:{href:"#database-setup"}},[e._v("Database Setup")])]),t("li",[t("a",{attrs:{href:"#add-the-first-user"}},[e._v("Add The First User")])]),t("li",[t("a",{attrs:{href:"#set-permissions"}},[e._v("Set Permissions")])])])]),t("li",[t("a",{attrs:{href:"#queue-listeners"}},[e._v("Queue Listeners")]),t("ul",[t("li",[t("a",{attrs:{href:"#crontab-configuration"}},[e._v("Crontab Configuration")])]),t("li",[t("a",{attrs:{href:"#create-queue-worker"}},[e._v("Create Queue Worker")])]),t("li",[t("a",{attrs:{href:"#telemetry"}},[e._v("Telemetry")])])])])])]),t("p"),e._v(" "),t("p",[e._v("Pterodactyl Panel is designed to run on your own web server. You will need to have root access to your server in order to run and use this panel.")]),e._v(" "),t("p",[e._v("You are expected to understand how to read documentation to use this Panel. We have spent many hours detailing how to install or upgrade our\nsoftware; take some time and read rather than copy and pasting and then complaining when things do not work. This panel does\nnot exist as a drag-and-drop service to run your servers. It is a highly complex system requiring multiple dependencies and\nadministrators willing to spend some time learning how to use it. "),t("strong",[e._v("If you expect to be able to install this with no understanding\nof basic linux system administration you should stop and turn around now.")])]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("Looking for something simple to setup?")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://wisp.gg",target:"_blank",rel:"noopener noreferrer"}},[e._v("WISP"),t("OutboundLink")],1),e._v(" is a Pterodactyl powered SaaS suitable for enterprise and personal use. Offering all the features without the setup hassle, and fully compatible with Pterodactyl eggs. Comparable to MultiCraft or TCAdmin while offering new and unique features. Click here to "),t("a",{attrs:{href:"https://wisp.gg/features",target:"_blank",rel:"noopener noreferrer"}},[e._v("learn more"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("h2",{attrs:{id:"picking-a-server-os"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#picking-a-server-os"}},[e._v("#")]),e._v(" Picking a Server OS")]),e._v(" "),t("p",[e._v("Pterodactyl runs on a wide range of operating systems, so pick whichever you are most comfortable using.")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("Pterodactyl does not support most OpenVZ systems due to incompatibilities with Docker. If you are planning on running\nthis software on an OpenVZ based system you will — most likely — not be successful.")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Operating System")]),e._v(" "),t("th",[e._v("Version")]),e._v(" "),t("th",{staticStyle:{"text-align":"center"}},[e._v("Supported")]),e._v(" "),t("th",[e._v("Notes")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("strong",[e._v("Ubuntu")])]),e._v(" "),t("td",[e._v("20.04")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td",[e._v("Documentation written assuming Ubuntu 20.04 as the base OS.")])]),e._v(" "),t("tr",[t("td"),e._v(" "),t("td",[e._v("22.04")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td",[e._v("MariaDB can be installed without the repo setup script.")])]),e._v(" "),t("tr",[t("td"),e._v(" "),t("td",[e._v("24.04")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td",[e._v("MariaDB can be installed without the repo setup script.")])]),e._v(" "),t("tr",[t("td",[t("strong",[e._v("RHEL / Rocky Linux / AlmaLinux")])]),e._v(" "),t("td",[e._v("8")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td",[e._v("Extra repos are required.")])]),e._v(" "),t("tr",[t("td"),e._v(" "),t("td",[e._v("9")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td")]),e._v(" "),t("tr",[t("td",[t("strong",[e._v("Debian")])]),e._v(" "),t("td",[e._v("11")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td")]),e._v(" "),t("tr",[t("td"),e._v(" "),t("td",[e._v("12")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("✅")]),e._v(" "),t("td")])])]),e._v(" "),t("h2",{attrs:{id:"dependencies"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dependencies"}},[e._v("#")]),e._v(" Dependencies")]),e._v(" "),t("ul",[t("li",[e._v("PHP "),t("code",[e._v("8.2")]),e._v(" or "),t("code",[e._v("8.3")]),e._v(" (recommended) with the following extensions: "),t("code",[e._v("cli")]),e._v(", "),t("code",[e._v("openssl")]),e._v(", "),t("code",[e._v("gd")]),e._v(", "),t("code",[e._v("mysql")]),e._v(", "),t("code",[e._v("PDO")]),e._v(", "),t("code",[e._v("mbstring")]),e._v(", "),t("code",[e._v("tokenizer")]),e._v(", "),t("code",[e._v("bcmath")]),e._v(", "),t("code",[e._v("xml")]),e._v(" or "),t("code",[e._v("dom")]),e._v(", "),t("code",[e._v("curl")]),e._v(", "),t("code",[e._v("zip")]),e._v(", and "),t("code",[e._v("fpm")]),e._v(" if you are planning to use NGINX.")]),e._v(" "),t("li",[e._v("MySQL "),t("code",[e._v("5.7.22")]),e._v(" and higher (MySQL "),t("code",[e._v("8")]),e._v(" recommended) "),t("strong",[e._v("or")]),e._v(" MariaDB "),t("code",[e._v("10.2")]),e._v(" and higher.")]),e._v(" "),t("li",[e._v("Redis ("),t("code",[e._v("redis-server")]),e._v(")")]),e._v(" "),t("li",[e._v("A webserver (Apache, NGINX, Caddy, etc.)")]),e._v(" "),t("li",[t("code",[e._v("curl")])]),e._v(" "),t("li",[t("code",[e._v("tar")])]),e._v(" "),t("li",[t("code",[e._v("unzip")])]),e._v(" "),t("li",[t("code",[e._v("git")])]),e._v(" "),t("li",[t("code",[e._v("composer")]),e._v(" v2")])]),e._v(" "),t("h3",{attrs:{id:"example-dependency-installation"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#example-dependency-installation"}},[e._v("#")]),e._v(" Example Dependency Installation")]),e._v(" "),t("p",[e._v("The commands below are simply an example of how you might install these dependencies. Please consult with your\noperating system's package manager to determine the correct packages to install.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v('# Add "add-apt-repository" command')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-y")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" software-properties-common "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" apt-transport-https ca-certificates gnupg\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Add additional repositories for PHP (Ubuntu 20.04 and Ubuntu 22.04)")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t("span",{pre:!0,attrs:{class:"token environment constant"}},[e._v("LC_ALL")])]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("C.UTF-8 add-apt-repository "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-y")]),e._v(" ppa:ondrej/php\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Add Redis official APT repository")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-fsSL")]),e._v(" https://packages.redis.io/gpg "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" gpg "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--dearmor")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-o")]),e._v(" /usr/share/keyrings/redis-archive-keyring.gpg\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("echo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"deb [signed-by=/usr/share/keyrings/redis-archive-keyring.gpg] https://packages.redis.io/deb '),t("span",{pre:!0,attrs:{class:"token variable"}},[t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$(")]),e._v("lsb_release "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-cs")]),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v(")")])]),e._v(' main"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("tee")]),e._v(" /etc/apt/sources.list.d/redis.list\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# MariaDB repo setup script (Ubuntu 20.04)")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-LsS")]),e._v(" https://r.mariadb.com/downloads/mariadb_repo_setup "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("bash")]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Update repositories list")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" update\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Install Dependencies")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-y")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" php8.3 php8.3-"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("common,cli,gd,mysql,mbstring,bcmath,xml,fpm,curl,zip"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v(" mariadb-server nginx "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("tar")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("unzip")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" redis-server\n")])])]),t("h3",{attrs:{id:"installing-composer"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installing-composer"}},[e._v("#")]),e._v(" Installing Composer")]),e._v(" "),t("p",[e._v("Composer is a dependency manager for PHP that allows us to ship everything you'll need code wise to operate the Panel. You'll\nneed composer installed before continuing in this process.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-sS")]),e._v(" https://getcomposer.org/installer "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" php -- --install-dir"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("/usr/local/bin "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--filename")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("composer\n")])])]),t("h2",{attrs:{id:"download-files"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#download-files"}},[e._v("#")]),e._v(" Download Files")]),e._v(" "),t("p",[e._v("The first step in this process is to create the folder where the panel will live and then move ourselves into that\nnewly created folder. Below is an example of how to perform this operation.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("mkdir")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-p")]),e._v(" /var/www/pterodactyl\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" /var/www/pterodactyl\n")])])]),t("p",[e._v("Once you have created a new directory for the Panel and moved into it you'll need to download the Panel files. This\nis as simple as using "),t("code",[e._v("curl")]),e._v(" to download our pre-packaged content. Once it is downloaded you'll need to unpack the archive\nand then set the correct permissions on the "),t("code",[e._v("storage/")]),e._v(" and "),t("code",[e._v("bootstrap/cache/")]),e._v(" directories. These directories\nallow us to store files as well as keep a speedy cache available to reduce load times.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-Lo")]),e._v(" panel.tar.gz https://github.com/pterodactyl/panel/releases/latest/download/panel.tar.gz\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("tar")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-xzvf")]),e._v(" panel.tar.gz\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("chmod")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("755")]),e._v(" storage/* bootstrap/cache/\n")])])]),t("h2",{attrs:{id:"installation"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installation"}},[e._v("#")]),e._v(" Installation")]),e._v(" "),t("p",[e._v("Now that all of the files have been downloaded we need to configure some core aspects of the Panel.")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("Database Configuration")]),e._v(" "),t("p",[e._v("You will need a database setup and a user with the correct permissions created for that database before\ncontinuing any further. See below to create a user and database for your Pterodactyl panel quickly. To find more detailed information\nplease have a look at "),t("RouterLink",{attrs:{to:"/tutorials/mysql_setup.html"}},[e._v("Setting up MySQL")]),e._v(".")],1),e._v(" "),t("div",{staticClass:"language-sql extra-class"},[t("pre",{pre:!0,attrs:{class:"language-sql"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using MariaDB (v11.0.0+) (This is the default when installing Pterodactyl by following the documentation.)")]),e._v("\nmariadb "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("-")]),e._v("u root "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("-")]),e._v("p\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using MySQL")]),e._v("\nmysql "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("-")]),e._v("u root "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("-")]),e._v("p\n")])])]),t("div",{staticClass:"language-sql extra-class"},[t("pre",{pre:!0,attrs:{class:"language-sql"}},[t("code",[e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Remember to change 'yourPassword' below to be a unique password")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("CREATE")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("USER")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'pterodactyl'")]),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("@'127.0.0.1'")]),e._v(" IDENTIFIED "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("BY")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'yourPassword'")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("CREATE")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("DATABASE")]),e._v(" panel"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("GRANT")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("ALL")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("PRIVILEGES")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("ON")]),e._v(" panel"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("*")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("TO")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'pterodactyl'")]),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("@'127.0.0.1'")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("WITH")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("GRANT")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("OPTION")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("exit")]),e._v("\n")])])])]),e._v(" "),t("p",[e._v("First we will copy over our default environment settings file, install core dependencies, and then generate a\nnew application encryption key.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("cp")]),e._v(" .env.example .env\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("COMPOSER_ALLOW_SUPERUSER")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("composer")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" --no-dev --optimize-autoloader\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Only run the command below if you are installing this Panel for")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# the first time and do not have any Pterodactyl Panel data in the database.")]),e._v("\nphp artisan key:generate "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--force")]),e._v("\n")])])]),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("DANGER")]),e._v(" "),t("p",[e._v("Back up your encryption key (APP_KEY in the "),t("code",[e._v(".env")]),e._v(" file). It is used as an encryption key for all data that needs to be stored securely (e.g. api keys).\nStore it somewhere safe - not just on your server. If you lose it all encrypted data is irrecoverable -- even if you have database backups.")])]),e._v(" "),t("h3",{attrs:{id:"environment-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#environment-configuration"}},[e._v("#")]),e._v(" Environment Configuration")]),e._v(" "),t("p",[e._v("Pterodactyl's core environment is easily configured using a few different CLI commands built into the app. This step\nwill cover setting up things such as sessions, caching, database credentials, and email sending.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("php artisan p:environment:setup\nphp artisan p:environment:database\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v('# To use PHP\'s internal mail sending (not recommended), select "mail". To use a')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v('# custom SMTP server, select "smtp".')]),e._v("\nphp artisan p:environment:mail\n")])])]),t("h3",{attrs:{id:"database-setup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#database-setup"}},[e._v("#")]),e._v(" Database Setup")]),e._v(" "),t("p",[e._v("Now we need to setup all of the base data for the Panel in the database you created earlier. "),t("strong",[e._v("The command below\nmay take some time to run depending on your machine. Please "),t("em",[e._v("DO NOT")]),e._v(" exit the process until it is completed!")]),e._v(" This\ncommand will setup the database tables and then add all of the Nests & Eggs that power Pterodactyl.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("php artisan migrate "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--seed")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--force")]),e._v("\n")])])]),t("h3",{attrs:{id:"add-the-first-user"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#add-the-first-user"}},[e._v("#")]),e._v(" Add The First User")]),e._v(" "),t("p",[e._v("You'll then need to create an administrative user so that you can log into the panel. To do so, run the command below.\nAt this time passwords "),t("strong",[e._v("must")]),e._v(" meet the following requirements: 8 characters, mixed case, at least one number.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("php artisan p:user:make\n")])])]),t("h3",{attrs:{id:"set-permissions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-permissions"}},[e._v("#")]),e._v(" Set Permissions")]),e._v(" "),t("p",[e._v("The last step in the installation process is to set the correct permissions on the Panel files so that the webserver can\nuse them correctly.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using NGINX, Apache or Caddy (not on RHEL / Rocky Linux / AlmaLinux)")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("chown")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" www-data:www-data /var/www/pterodactyl/*\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using NGINX on RHEL / Rocky Linux / AlmaLinux")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("chown")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" nginx:nginx /var/www/pterodactyl/*\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using Apache on RHEL / Rocky Linux / AlmaLinux")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("chown")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" apache:apache /var/www/pterodactyl/*\n")])])]),t("h2",{attrs:{id:"queue-listeners"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#queue-listeners"}},[e._v("#")]),e._v(" Queue Listeners")]),e._v(" "),t("p",[e._v("We make use of queues to make the application faster and handle sending emails and other actions in the background.\nYou will need to setup the queue worker for these actions to be processed.")]),e._v(" "),t("h3",{attrs:{id:"crontab-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#crontab-configuration"}},[e._v("#")]),e._v(" Crontab Configuration")]),e._v(" "),t("p",[e._v("The first thing we need to do is create a new cronjob that runs every minute to process specific Pterodactyl tasks, such\nas session cleanup and sending scheduled tasks to daemons. You'll want to open your crontab using "),t("code",[e._v("sudo crontab -e")]),e._v(" and\nthen paste the line below.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("* * * * * php /var/www/pterodactyl/artisan schedule:run "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">>")]),e._v(" /dev/null "),t("span",{pre:!0,attrs:{class:"token operator"}},[t("span",{pre:!0,attrs:{class:"token file-descriptor important"}},[e._v("2")]),e._v(">")]),t("span",{pre:!0,attrs:{class:"token file-descriptor important"}},[e._v("&1")]),e._v("\n")])])]),t("h3",{attrs:{id:"create-queue-worker"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#create-queue-worker"}},[e._v("#")]),e._v(" Create Queue Worker")]),e._v(" "),t("p",[e._v("Next you need to create a new systemd worker to keep our queue process running in the background. This queue is responsible\nfor sending emails and handling many other background tasks for Pterodactyl.")]),e._v(" "),t("p",[e._v("Create a file called "),t("code",[e._v("pteroq.service")]),e._v(" in "),t("code",[e._v("/etc/systemd/system")]),e._v(" with the contents below.")]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("# Pterodactyl Queue Worker File\n# ----------------------------------\n\n[Unit]\nDescription=Pterodactyl Queue Worker\nAfter=redis-server.service\n\n[Service]\n# On some systems the user and group might be different.\n# Some systems use `apache` or `nginx` as the user and group.\nUser=www-data\nGroup=www-data\nRestart=always\nExecStart=/usr/bin/php /var/www/pterodactyl/artisan queue:work --queue=high,standard,low --sleep=3 --tries=3\nStartLimitInterval=180\nStartLimitBurst=30\nRestartSec=5s\n\n[Install]\nWantedBy=multi-user.target\n")])])]),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("Redis on RHEL / Rocky Linux / AlmaLinux")]),e._v(" "),t("p",[e._v("If you are using RHEL, Rocky Linux, or AlmaLinux, you will need to replace "),t("code",[e._v("redis-server.service")]),e._v(" with "),t("code",[e._v("redis.service")]),e._v(" at the "),t("code",[e._v("After=")]),e._v(" line in order to ensure "),t("code",[e._v("redis")]),e._v(" starts before the queue worker.")])]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("If you are not using "),t("code",[e._v("redis")]),e._v(" for anything you should remove the "),t("code",[e._v("After=")]),e._v(" line, otherwise you will encounter errors\nwhen the service starts.")])]),e._v(" "),t("p",[e._v("If you are using redis for your system, you will want to make sure to enable that it will start on boot. You can do that by running the following command:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" systemctl "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("enable")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--now")]),e._v(" redis-server\n")])])]),t("p",[e._v("Finally, enable the service and set it to boot on machine start.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" systemctl "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("enable")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--now")]),e._v(" pteroq.service\n")])])]),t("h3",{attrs:{id:"telemetry"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#telemetry"}},[e._v("#")]),e._v(" Telemetry")]),e._v(" "),t("p",[e._v("Since 1.11, Pterodactyl will collect anonymous telemetry to help us better understand how the\nsoftware is being used. To learn more about this feature and to opt-out, please see our "),t("RouterLink",{attrs:{to:"/panel/1.0/additional_configuration.html#telemetry"}},[e._v("Telemetry")]),e._v("\ndocumentation. Make sure to continue with the rest of the installation process.")],1),e._v(" "),t("h4",{attrs:{id:"next-step-webserver-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#next-step-webserver-configuration"}},[e._v("#")]),e._v(" Next Step: "),t("a",{attrs:{href:"./webserver_configuration"}},[e._v("Webserver Configuration")])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/61.d30789b5.js b/assets/js/61.78ebf38b.js similarity index 99% rename from assets/js/61.d30789b5.js rename to assets/js/61.78ebf38b.js index ac3b02b6..6f45d5f4 100644 --- a/assets/js/61.d30789b5.js +++ b/assets/js/61.78ebf38b.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[61],{321:function(e,a,t){"use strict";t.r(a);var s=t(15),r=Object(s.a)({},(function(){var e=this,a=e._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"legacy-upgrades"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#legacy-upgrades"}},[e._v("#")]),e._v(" Legacy Upgrades")]),e._v(" "),a("p",[e._v("This upgrade guide is for "),a("strong",[e._v("upgrading from 0.7.X to 1.3.x")]),e._v(". If you are trying to do an upgrade on a 1.X Panel\nplease "),a("RouterLink",{attrs:{to:"/panel/1.0/updating.html"}},[e._v("use this guide instead")]),e._v(". During this upgrade process you will have some periods\nof Panel unavailability, however none of the underlying game server instances will be stopped.")],1),e._v(" "),a("h2",{attrs:{id:"enter-maintenance-mode"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#enter-maintenance-mode"}},[e._v("#")]),e._v(" Enter Maintenance Mode")]),e._v(" "),a("p",[e._v("You'll want to put your Panel into maintenance mode by running the "),a("code",[e._v("down")]),e._v(" command below before starting. This\nwill prevent users from accessing the Panel during a period where things will be broken or not working correctly. Make sure that you're in the "),a("code",[e._v("/var/www/pterodactyl")]),e._v(" directory when executing the command.")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Put the Panel into maintenance mode and deny user access")]),e._v("\nphp artisan down\n")])])]),a("h2",{attrs:{id:"update-dependencies"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#update-dependencies"}},[e._v("#")]),e._v(" Update Dependencies")]),e._v(" "),a("p",[e._v("You'll need to make sure your system dependencies are up to date before performing this upgrade. Please\nreference the list below to ensure you have all of the required versions.")]),e._v(" "),a("ul",[a("li",[e._v("PHP "),a("code",[e._v("8.0")]),e._v(" or "),a("code",[e._v("8.1")]),e._v(" (recommended) with the following extensions: "),a("code",[e._v("cli")]),e._v(", "),a("code",[e._v("openssl")]),e._v(", "),a("code",[e._v("gd")]),e._v(", "),a("code",[e._v("mysql")]),e._v(", "),a("code",[e._v("PDO")]),e._v(", "),a("code",[e._v("mbstring")]),e._v(",\n"),a("code",[e._v("tokenizer")]),e._v(", "),a("code",[e._v("bcmath")]),e._v(", "),a("code",[e._v("xml")]),e._v(" or "),a("code",[e._v("dom")]),e._v(", "),a("code",[e._v("curl")]),e._v(", "),a("code",[e._v("zip")]),e._v(", and "),a("code",[e._v("fpm")]),e._v(" if you are planning to use nginx. See our guide\nfor "),a("RouterLink",{attrs:{to:"/guides/php_upgrade.html"}},[e._v("Upgrading PHP")]),e._v(" for details.")],1),e._v(" "),a("li",[e._v("Composer v2 ("),a("code",[e._v("composer self-update --2")]),e._v(")")])]),e._v(" "),a("div",{staticClass:"custom-block warning"},[a("p",{staticClass:"custom-block-title"},[e._v("Nginx")]),e._v(" "),a("p",[e._v("If you upgrade your PHP version and are using nginx as your webserver, you will have to update the\n"),a("code",[e._v("fastcgi_pass")]),e._v(" value in your nginx's "),a("code",[e._v("pterodactyl.conf")]),e._v(" configuration to use the correct "),a("code",[e._v("php-fpm")]),e._v(" socket.")])]),e._v(" "),a("ul",[a("li",[e._v("MySQL "),a("code",[e._v("5.7.22")]),e._v(" or higher (MySQL "),a("code",[e._v("8")]),e._v(" recommended) "),a("strong",[e._v("or")]),e._v(" MariaDB "),a("code",[e._v("10.2")]),e._v(" or higher.")])]),e._v(" "),a("div",{staticClass:"custom-block warning"},[a("p",{staticClass:"custom-block-title"},[e._v("Seriously, Double Check your Database Version")]),e._v(" "),a("p",[e._v("Please make sure you are running the correct version of MariaDB or MySQL listed above! Failure to do so "),a("em",[e._v("will")]),e._v("\nresult in an error when you attempt to run the migrations.")]),e._v(" "),a("p",[e._v("Previous documentation (and just the age of this software) likely had you installing MariaDB 10.1 which "),a("em",[e._v("will not\nwork")]),e._v(" with this version of Pterodactyl.")])]),e._v(" "),a("h2",{attrs:{id:"fetch-updated-files"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#fetch-updated-files"}},[e._v("#")]),e._v(" Fetch Updated Files")]),e._v(" "),a("p",[e._v("The first step in the update process is to download the new panel files from GitHub. The command below will download\nthe release archive for the most recent version of Pterodactyl and save it in the current directory. Now is a good time\nto ensure that you're in the "),a("code",[e._v("/var/www/pterodactyl")]),e._v(" directory as the command below will automatically unpack the archive\ninto your current folder.")]),e._v(" "),a("p",[e._v("We will also be deleting the "),a("code",[e._v("app/")]),e._v(" directory. Because of the way we handle installations and upgrades deleted files\nare not always detected properly, so simply uppacking over this location will result in some confusing behavior.")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Delete the app directory to ensure we start with a clean slate here. This will not affect any")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# of your settings or servers.")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-L")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-o")]),e._v(" panel.tar.gz https://github.com/pterodactyl/panel/releases/latest/download/panel.tar.gz\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("rm")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-rf")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[a("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$(")]),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("find")]),e._v(" app public resources "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-depth")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("head")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-n")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-1")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("grep")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-Fv")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[a("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$(")]),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("tar")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-tf")]),e._v(" panel.tar.gz"),a("span",{pre:!0,attrs:{class:"token variable"}},[e._v(")")])]),e._v('"')]),a("span",{pre:!0,attrs:{class:"token variable"}},[e._v(")")])]),e._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Download the updated files and delete the archive file.")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("tar")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-xzvf")]),e._v(" panel.tar.gz "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("&&")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("rm")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-f")]),e._v(" panel.tar.gz\n")])])]),a("p",[e._v("Once all of the files are downloaded we need to set the correct permissions on the cache and storage directories to avoid\nany webserver related errors.")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("chmod")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("755")]),e._v(" storage/* bootstrap/cache\n")])])]),a("h2",{attrs:{id:"update-dependencies-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#update-dependencies-2"}},[e._v("#")]),e._v(" Update Dependencies")]),e._v(" "),a("p",[e._v("After you've downloaded all of the new files you will need to upgrade the core components of the panel. To do this,\nsimply run the commands below and follow any prompts.")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("composer")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" --no-dev --optimize-autoloader\n")])])]),a("h2",{attrs:{id:"clear-compiled-template-cache"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#clear-compiled-template-cache"}},[e._v("#")]),e._v(" Clear Compiled Template Cache")]),e._v(" "),a("p",[e._v("You'll also want to clear the compiled template cache to ensure that new and modified templates show up correctly for\nusers.")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("php artisan view:clear\nphp artisan config:clear\n")])])]),a("h2",{attrs:{id:"database-updates"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#database-updates"}},[e._v("#")]),e._v(" Database Updates")]),e._v(" "),a("p",[e._v("You'll also need to update your database schema for the newest version of Pterodactyl. Running the two commands below\nwill update the schema and ensure the default eggs we ship are up to date (and add any new ones we might have). Just\nremember, "),a("em",[e._v("never edit core eggs we ship")]),e._v("! They will be overwritten by this update process.")]),e._v(" "),a("div",{staticClass:"custom-block warning"},[a("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),a("p",[e._v("If you used a custom plugin that allowed for server transfers on "),a("code",[e._v("0.7")]),e._v(" you "),a("strong",[e._v("MUST")]),e._v(" delete or rename the "),a("code",[e._v("server_transfers")]),e._v(" table\nbefore continuing.")])]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("php artisan migrate "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--force")]),e._v("\nphp artisan db:seed "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--force")]),e._v("\n")])])]),a("h2",{attrs:{id:"set-permissions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#set-permissions"}},[e._v("#")]),e._v(" Set Permissions")]),e._v(" "),a("p",[e._v("The last step is to set the proper owner of the files to be the user that runs your webserver. In most cases this\nis "),a("code",[e._v("www-data")]),e._v(" but can vary from system to system — sometimes being "),a("code",[e._v("nginx")]),e._v(", "),a("code",[e._v("apache")]),e._v(", or even "),a("code",[e._v("nobody")]),e._v(".")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using NGINX or Apache (not on CentOS):")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("chown")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" www-data:www-data *\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using NGINX on CentOS:")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("chown")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" nginx:nginx *\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using Apache on CentOS")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("chown")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" apache:apache *\n")])])]),a("h2",{attrs:{id:"restarting-queue-workers"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#restarting-queue-workers"}},[e._v("#")]),e._v(" Restarting Queue Workers")]),e._v(" "),a("p",[e._v("After "),a("em",[e._v("every")]),e._v(" update you should restart the queue worker to ensure that the new code is loaded in and used.")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("php artisan queue:restart\n")])])]),a("h2",{attrs:{id:"exit-maintenance-mode"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#exit-maintenance-mode"}},[e._v("#")]),e._v(" Exit Maintenance Mode")]),e._v(" "),a("p",[e._v("Now that the upgrade is complete, exit maintenance mode and your Panel will now be available.")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Bring the Panel back up to receive connections.")]),e._v("\nphp artisan up\n")])])]),a("h2",{attrs:{id:"switch-to-wings"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#switch-to-wings"}},[e._v("#")]),e._v(" Switch to Wings")]),e._v(" "),a("p",[e._v("We've deprecated the old Node.js daemon in favor of "),a("a",{attrs:{href:"https://github.com/pterodactyl/wings",target:"_blank",rel:"noopener noreferrer"}},[e._v("Wings"),a("OutboundLink")],1),e._v(", our new server\ncontrol plane written in Go. This new system is significantly faster, easier to install, and much smaller. All you\nneed to do is install a single binary on your system and configure it to run on boot. "),a("strong",[e._v("You cannot use the old Node.js\nDaemon to run servers with Pterodactyl Panel 1.0.")])]),e._v(" "),a("p",[e._v("Please see "),a("RouterLink",{attrs:{to:"/wings/1.0/migrating.html"}},[e._v("Migrating to Wings")]),e._v(" for instructions.")],1)])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[61],{320:function(e,a,t){"use strict";t.r(a);var s=t(15),r=Object(s.a)({},(function(){var e=this,a=e._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"legacy-upgrades"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#legacy-upgrades"}},[e._v("#")]),e._v(" Legacy Upgrades")]),e._v(" "),a("p",[e._v("This upgrade guide is for "),a("strong",[e._v("upgrading from 0.7.X to 1.3.x")]),e._v(". If you are trying to do an upgrade on a 1.X Panel\nplease "),a("RouterLink",{attrs:{to:"/panel/1.0/updating.html"}},[e._v("use this guide instead")]),e._v(". During this upgrade process you will have some periods\nof Panel unavailability, however none of the underlying game server instances will be stopped.")],1),e._v(" "),a("h2",{attrs:{id:"enter-maintenance-mode"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#enter-maintenance-mode"}},[e._v("#")]),e._v(" Enter Maintenance Mode")]),e._v(" "),a("p",[e._v("You'll want to put your Panel into maintenance mode by running the "),a("code",[e._v("down")]),e._v(" command below before starting. This\nwill prevent users from accessing the Panel during a period where things will be broken or not working correctly. Make sure that you're in the "),a("code",[e._v("/var/www/pterodactyl")]),e._v(" directory when executing the command.")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Put the Panel into maintenance mode and deny user access")]),e._v("\nphp artisan down\n")])])]),a("h2",{attrs:{id:"update-dependencies"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#update-dependencies"}},[e._v("#")]),e._v(" Update Dependencies")]),e._v(" "),a("p",[e._v("You'll need to make sure your system dependencies are up to date before performing this upgrade. Please\nreference the list below to ensure you have all of the required versions.")]),e._v(" "),a("ul",[a("li",[e._v("PHP "),a("code",[e._v("8.0")]),e._v(" or "),a("code",[e._v("8.1")]),e._v(" (recommended) with the following extensions: "),a("code",[e._v("cli")]),e._v(", "),a("code",[e._v("openssl")]),e._v(", "),a("code",[e._v("gd")]),e._v(", "),a("code",[e._v("mysql")]),e._v(", "),a("code",[e._v("PDO")]),e._v(", "),a("code",[e._v("mbstring")]),e._v(",\n"),a("code",[e._v("tokenizer")]),e._v(", "),a("code",[e._v("bcmath")]),e._v(", "),a("code",[e._v("xml")]),e._v(" or "),a("code",[e._v("dom")]),e._v(", "),a("code",[e._v("curl")]),e._v(", "),a("code",[e._v("zip")]),e._v(", and "),a("code",[e._v("fpm")]),e._v(" if you are planning to use nginx. See our guide\nfor "),a("RouterLink",{attrs:{to:"/guides/php_upgrade.html"}},[e._v("Upgrading PHP")]),e._v(" for details.")],1),e._v(" "),a("li",[e._v("Composer v2 ("),a("code",[e._v("composer self-update --2")]),e._v(")")])]),e._v(" "),a("div",{staticClass:"custom-block warning"},[a("p",{staticClass:"custom-block-title"},[e._v("Nginx")]),e._v(" "),a("p",[e._v("If you upgrade your PHP version and are using nginx as your webserver, you will have to update the\n"),a("code",[e._v("fastcgi_pass")]),e._v(" value in your nginx's "),a("code",[e._v("pterodactyl.conf")]),e._v(" configuration to use the correct "),a("code",[e._v("php-fpm")]),e._v(" socket.")])]),e._v(" "),a("ul",[a("li",[e._v("MySQL "),a("code",[e._v("5.7.22")]),e._v(" or higher (MySQL "),a("code",[e._v("8")]),e._v(" recommended) "),a("strong",[e._v("or")]),e._v(" MariaDB "),a("code",[e._v("10.2")]),e._v(" or higher.")])]),e._v(" "),a("div",{staticClass:"custom-block warning"},[a("p",{staticClass:"custom-block-title"},[e._v("Seriously, Double Check your Database Version")]),e._v(" "),a("p",[e._v("Please make sure you are running the correct version of MariaDB or MySQL listed above! Failure to do so "),a("em",[e._v("will")]),e._v("\nresult in an error when you attempt to run the migrations.")]),e._v(" "),a("p",[e._v("Previous documentation (and just the age of this software) likely had you installing MariaDB 10.1 which "),a("em",[e._v("will not\nwork")]),e._v(" with this version of Pterodactyl.")])]),e._v(" "),a("h2",{attrs:{id:"fetch-updated-files"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#fetch-updated-files"}},[e._v("#")]),e._v(" Fetch Updated Files")]),e._v(" "),a("p",[e._v("The first step in the update process is to download the new panel files from GitHub. The command below will download\nthe release archive for the most recent version of Pterodactyl and save it in the current directory. Now is a good time\nto ensure that you're in the "),a("code",[e._v("/var/www/pterodactyl")]),e._v(" directory as the command below will automatically unpack the archive\ninto your current folder.")]),e._v(" "),a("p",[e._v("We will also be deleting the "),a("code",[e._v("app/")]),e._v(" directory. Because of the way we handle installations and upgrades deleted files\nare not always detected properly, so simply uppacking over this location will result in some confusing behavior.")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Delete the app directory to ensure we start with a clean slate here. This will not affect any")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# of your settings or servers.")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-L")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-o")]),e._v(" panel.tar.gz https://github.com/pterodactyl/panel/releases/latest/download/panel.tar.gz\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("rm")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-rf")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[a("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$(")]),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("find")]),e._v(" app public resources "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-depth")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("head")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-n")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-1")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("grep")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-Fv")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[a("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$(")]),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("tar")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-tf")]),e._v(" panel.tar.gz"),a("span",{pre:!0,attrs:{class:"token variable"}},[e._v(")")])]),e._v('"')]),a("span",{pre:!0,attrs:{class:"token variable"}},[e._v(")")])]),e._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Download the updated files and delete the archive file.")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("tar")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-xzvf")]),e._v(" panel.tar.gz "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("&&")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("rm")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-f")]),e._v(" panel.tar.gz\n")])])]),a("p",[e._v("Once all of the files are downloaded we need to set the correct permissions on the cache and storage directories to avoid\nany webserver related errors.")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("chmod")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("755")]),e._v(" storage/* bootstrap/cache\n")])])]),a("h2",{attrs:{id:"update-dependencies-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#update-dependencies-2"}},[e._v("#")]),e._v(" Update Dependencies")]),e._v(" "),a("p",[e._v("After you've downloaded all of the new files you will need to upgrade the core components of the panel. To do this,\nsimply run the commands below and follow any prompts.")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("composer")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" --no-dev --optimize-autoloader\n")])])]),a("h2",{attrs:{id:"clear-compiled-template-cache"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#clear-compiled-template-cache"}},[e._v("#")]),e._v(" Clear Compiled Template Cache")]),e._v(" "),a("p",[e._v("You'll also want to clear the compiled template cache to ensure that new and modified templates show up correctly for\nusers.")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("php artisan view:clear\nphp artisan config:clear\n")])])]),a("h2",{attrs:{id:"database-updates"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#database-updates"}},[e._v("#")]),e._v(" Database Updates")]),e._v(" "),a("p",[e._v("You'll also need to update your database schema for the newest version of Pterodactyl. Running the two commands below\nwill update the schema and ensure the default eggs we ship are up to date (and add any new ones we might have). Just\nremember, "),a("em",[e._v("never edit core eggs we ship")]),e._v("! They will be overwritten by this update process.")]),e._v(" "),a("div",{staticClass:"custom-block warning"},[a("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),a("p",[e._v("If you used a custom plugin that allowed for server transfers on "),a("code",[e._v("0.7")]),e._v(" you "),a("strong",[e._v("MUST")]),e._v(" delete or rename the "),a("code",[e._v("server_transfers")]),e._v(" table\nbefore continuing.")])]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("php artisan migrate "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--force")]),e._v("\nphp artisan db:seed "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--force")]),e._v("\n")])])]),a("h2",{attrs:{id:"set-permissions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#set-permissions"}},[e._v("#")]),e._v(" Set Permissions")]),e._v(" "),a("p",[e._v("The last step is to set the proper owner of the files to be the user that runs your webserver. In most cases this\nis "),a("code",[e._v("www-data")]),e._v(" but can vary from system to system — sometimes being "),a("code",[e._v("nginx")]),e._v(", "),a("code",[e._v("apache")]),e._v(", or even "),a("code",[e._v("nobody")]),e._v(".")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using NGINX or Apache (not on CentOS):")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("chown")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" www-data:www-data *\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using NGINX on CentOS:")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("chown")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" nginx:nginx *\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# If using Apache on CentOS")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("chown")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-R")]),e._v(" apache:apache *\n")])])]),a("h2",{attrs:{id:"restarting-queue-workers"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#restarting-queue-workers"}},[e._v("#")]),e._v(" Restarting Queue Workers")]),e._v(" "),a("p",[e._v("After "),a("em",[e._v("every")]),e._v(" update you should restart the queue worker to ensure that the new code is loaded in and used.")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("php artisan queue:restart\n")])])]),a("h2",{attrs:{id:"exit-maintenance-mode"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#exit-maintenance-mode"}},[e._v("#")]),e._v(" Exit Maintenance Mode")]),e._v(" "),a("p",[e._v("Now that the upgrade is complete, exit maintenance mode and your Panel will now be available.")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Bring the Panel back up to receive connections.")]),e._v("\nphp artisan up\n")])])]),a("h2",{attrs:{id:"switch-to-wings"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#switch-to-wings"}},[e._v("#")]),e._v(" Switch to Wings")]),e._v(" "),a("p",[e._v("We've deprecated the old Node.js daemon in favor of "),a("a",{attrs:{href:"https://github.com/pterodactyl/wings",target:"_blank",rel:"noopener noreferrer"}},[e._v("Wings"),a("OutboundLink")],1),e._v(", our new server\ncontrol plane written in Go. This new system is significantly faster, easier to install, and much smaller. All you\nneed to do is install a single binary on your system and configure it to run on boot. "),a("strong",[e._v("You cannot use the old Node.js\nDaemon to run servers with Pterodactyl Panel 1.0.")])]),e._v(" "),a("p",[e._v("Please see "),a("RouterLink",{attrs:{to:"/wings/1.0/migrating.html"}},[e._v("Migrating to Wings")]),e._v(" for instructions.")],1)])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/62.3ad9c42c.js b/assets/js/62.53e80a9f.js similarity index 78% rename from assets/js/62.3ad9c42c.js rename to assets/js/62.53e80a9f.js index 562c7657..45a7bf3b 100644 --- a/assets/js/62.3ad9c42c.js +++ b/assets/js/62.53e80a9f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[62],{322:function(e,t,r){"use strict";r.r(t);var a=r(15),s=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"troubleshooting"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#troubleshooting"}},[e._v("#")]),e._v(" Troubleshooting")]),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#reading-error-logs"}},[e._v("Reading Error Logs")]),t("ul",[t("li",[t("a",{attrs:{href:"#parsing-the-error"}},[e._v("Parsing the Error")])]),t("li",[t("a",{attrs:{href:"#understanding-the-error"}},[e._v("Understanding the Error")])]),t("li",[t("a",{attrs:{href:"#utilizing-grep"}},[e._v("Utilizing GREP")])])])]),t("li",[t("a",{attrs:{href:"#cannot-connect-to-server-errors"}},[e._v("Cannot Connect to Server Errors")]),t("ul",[t("li",[t("a",{attrs:{href:"#basic-debugging-steps"}},[e._v("Basic Debugging Steps")])]),t("li",[t("a",{attrs:{href:"#more-advanced-debugging-steps"}},[e._v("More Advanced Debugging Steps")])])])]),t("li",[t("a",{attrs:{href:"#invalid-mac-exception"}},[e._v("Invalid MAC Exception")])]),t("li",[t("a",{attrs:{href:"#selinux-issues"}},[e._v("SELinux Issues")]),t("ul",[t("li",[t("a",{attrs:{href:"#redis-permissions-errors"}},[e._v("Redis Permissions Errors")])]),t("li",[t("a",{attrs:{href:"#wings-connection-errors"}},[e._v("Wings Connection Errors")])])])]),t("li",[t("a",{attrs:{href:"#containers-don-t-have-internet-probably-a-dns-issue"}},[e._v("Containers don't have internet? Probably a DNS issue!")])]),t("li",[t("a",{attrs:{href:"#schedule-troubleshooting"}},[e._v("Schedule Troubleshooting")])]),t("li",[t("a",{attrs:{href:"#firewalld-issues"}},[e._v("FirewallD issues")])])])]),t("p"),e._v(" "),t("h2",{attrs:{id:"reading-error-logs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#reading-error-logs"}},[e._v("#")]),e._v(" Reading Error Logs")]),e._v(" "),t("p",[e._v("If you ever encounter an unexpected error with the Panel the first thing you will likely be asked for is the logs.\nTo retrieve these, simply execute the command below which will output the last 100 lines of the Panel's log file.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("tail")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-n")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("100")]),e._v(" /var/www/pterodactyl/storage/logs/laravel-"),t("span",{pre:!0,attrs:{class:"token variable"}},[t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$(")]),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("date")]),e._v(" +%F"),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v(")")])]),e._v(".log\n")])])]),t("h3",{attrs:{id:"parsing-the-error"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#parsing-the-error"}},[e._v("#")]),e._v(" Parsing the Error")]),e._v(" "),t("p",[e._v("When you run the command above, you'll probably be hit with a huge wall of text that might scare you. Fear not,\nthis is simply a stacktrace leading to the cause of the error, and you can actually ignore almost all of it when\nlooking for the cause of the error. Lets take a look at some example output below, which has been truncated to\nmake this easier to follow with.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("#70 /srv/www/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php(116): Illuminate\\Foundation\\Http\\Kernel->sendRequestThroughRouter(Object(Illuminate\\Http\\Request))\n#71 /srv/www/public/index.php(53): Illuminate\\Foundation\\Http\\Kernel->handle(Object(Illuminate\\Http\\Request))\n#72 {main}\n[2018-07-19 00:50:24] local.ERROR: ErrorException: file_put_contents(/srv/www/storage/framework/views/c9c05d1357df1ce4ec8fc5df78c16c493b0d4f48.php): failed to open stream: Permission denied in /srv/www/vendor/laravel/framework/src/Illuminate/Filesystem/Filesystem.php:122\nStack trace:\n#0 [internal function]: Illuminate\\Foundation\\Bootstrap\\HandleExceptions->handleError(2, 'file_put_conten...', '/srv/www/vendor...', 122, Array)\n#1 /srv/www/vendor/laravel/framework/src/Illuminate/Filesystem/Filesystem.php(122): file_put_contents('/srv/www/storag...', 's...', 0)\n#2 /srv/www/vendor/laravel/framework/src/Illuminate/View/Compilers/BladeCompiler.php(122): Illuminate\\Filesystem\\Filesystem->put('/srv/www/storag...', 's...')\n#3 /srv/www/vendor/laravel/framework/src/Illuminate/View/Engines/CompilerEngine.php(51): Illuminate\\View\\Compilers\\BladeCompiler->compile('/srv/www/resour...')\n#4 /srv/www/vendor/laravel/framework/src/Illuminate/View/View.php(142): Illuminate\\View\\Engines\\CompilerEngine->get('/srv/www/resour...', Array)\n#5 /srv/www/vendor/laravel/framework/src/Illuminate/View/View.php(125): Illuminate\\View\\View->getContents()\n")])])]),t("p",[e._v("The first thing you'll want to do is follow the chain of numbers "),t("em",[e._v("up")]),e._v(" until you find "),t("code",[e._v("#0")]),e._v(", this will be the function that\ntriggered the exception. Right above line 0 you will see a line that has the date and time in brackets, "),t("code",[e._v("[2018-07-19 00:50:24]")]),e._v("\nabove for example. This line will be the human readable exception that you can use to understand what went wrong.")]),e._v(" "),t("h3",{attrs:{id:"understanding-the-error"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#understanding-the-error"}},[e._v("#")]),e._v(" Understanding the Error")]),e._v(" "),t("p",[e._v("In the example above we can see that the actual error was:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("local.ERROR: ErrorException: file_put_contents(...): failed to open stream: Permission denied in /srv/www/vendor/laravel/framework/src/Illuminate/Filesystem/Filesystem.php:122\n")])])]),t("p",[e._v("From this error we can determine that there was an error performing a "),t("a",{attrs:{href:"http://php.net/manual/en/function.file-put-contents.php",target:"_blank",rel:"noopener noreferrer"}},[e._v("file_put_contents()"),t("OutboundLink")],1),e._v(" call, and the error was\nthat we couldn't open the file because permissions were denied. Its okay if you don't understand the error at all, but\nit does help you get faster support if you're able to provide these logs, and at least find the source of the error.\nSometimes the errors are pretty straightforward and will tell you exactly what went wrong, such as a "),t("code",[e._v("ConnectionException")]),e._v("\nbeing thrown when the Panel can't connect to the Daemon.")]),e._v(" "),t("h3",{attrs:{id:"utilizing-grep"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#utilizing-grep"}},[e._v("#")]),e._v(" Utilizing GREP")]),e._v(" "),t("p",[e._v("If you're trying to go through a bunch of errors quickly, you can use the command below which will limit the results returned to only\nbe the actual error lines, without all of the stack traces.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("tail")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-n")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1000")]),e._v(" /var/www/pterodactyl/storage/logs/laravel-"),t("span",{pre:!0,attrs:{class:"token variable"}},[t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$(")]),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("date")]),e._v(" +%F"),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v(")")])]),e._v(".log "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("grep")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"\\['),t("span",{pre:!0,attrs:{class:"token variable"}},[t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$(")]),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("date")]),e._v(" +%Y"),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v(")")])]),e._v('"')]),e._v("\n")])])]),t("h2",{attrs:{id:"cannot-connect-to-server-errors"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#cannot-connect-to-server-errors"}},[e._v("#")]),e._v(" Cannot Connect to Server Errors")]),e._v(" "),t("h3",{attrs:{id:"basic-debugging-steps"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#basic-debugging-steps"}},[e._v("#")]),e._v(" Basic Debugging Steps")]),e._v(" "),t("ul",[t("li",[e._v("Check that Wings is running, and not reporting errors. Use "),t("code",[e._v("systemctl status wings")]),e._v(" to check the current status of\nthe process.")]),e._v(" "),t("li",[e._v("Check your browser's console by pressing "),t("code",[e._v("Ctrl + Shift + J")]),e._v(" (in Chrome) or "),t("code",[e._v("Cmd + Alt + I")]),e._v(" (in Safari). If there is\na red error in it, chances are that it will narrow down the potential problem.")]),e._v(" "),t("li",[e._v("Make sure Wings is properly installed and the active configuration matches the configuration shown under\n"),t("code",[e._v("Admin -> Node -> Configuration")]),e._v(" in the Panel.")]),e._v(" "),t("li",[e._v("Check that the Wings ports are open on your firewall. Wings uses ports "),t("code",[e._v("8080")]),e._v(" or "),t("code",[e._v("8443")]),e._v(" for HTTP(s) traffic,\nand "),t("code",[e._v("2022")]),e._v(" for SFTP traffic.")]),e._v(" "),t("li",[e._v("Ensure you have AdBlock disabled or whitelisted for your Panel and Wings domains.")]),e._v(" "),t("li",[e._v("Check that the Panel can reach Wings using the domain that is configured on the Panel. Run "),t("code",[e._v("curl https://domain.com:8080")]),e._v(" on the Panel server and ensure that it can successfully connect to Wings.")]),e._v(" "),t("li",[e._v("Ensure that you are using the correct HTTP scheme for your Panel and Wings. If the Panel is running over HTTPS\nWings will also need to be running on HTTPS.")]),e._v(" "),t("li",[e._v("If using HTTPS for Wings, make sure that the certificates have not expired.")])]),e._v(" "),t("h3",{attrs:{id:"more-advanced-debugging-steps"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#more-advanced-debugging-steps"}},[e._v("#")]),e._v(" More Advanced Debugging Steps")]),e._v(" "),t("ul",[t("li",[e._v("Stop Wings and run "),t("code",[e._v("wings --debug")]),e._v(" to see if there are any errors being output. If so, try resolving them manually,\nor reach out on "),t("a",{attrs:{href:"https://discord.gg/pterodactyl",target:"_blank",rel:"noopener noreferrer"}},[e._v("Discord"),t("OutboundLink")],1),e._v(" for more assistance.")]),e._v(" "),t("li",[e._v("Check your DNS and ensure that the response you receive is the one you expect using a tool such as "),t("code",[e._v("nslookup")]),e._v(" or "),t("code",[e._v("dig")]),e._v(".")]),e._v(" "),t("li",[e._v("If you use CloudFlare make sure that the orange cloud is disabled for your Wings or Panel "),t("code",[e._v("A")]),e._v(" records.")]),e._v(" "),t("li",[e._v("Make sure when using Wings behind a firewall — pfSense, OpenSwitch, etc. — that the correct NAT settings to access\nthe Wing's ports from the outside network are setup.")]),e._v(" "),t("li",[e._v("If nothing is working so far, check your own DNS settings and consider switching DNS servers.")]),e._v(" "),t("li",[e._v("When running the Panel and Wings on one server it can sometimes help if to add an entry in "),t("code",[e._v("/etc/hosts")]),e._v(" that directs\nthe public IP back to the server. Sometimes the reverse path is also needed, so you may need to add an entry to your\nservers "),t("code",[e._v("/etc/hosts")]),e._v(" file that points the Panel's domain to the correct IP.")]),e._v(" "),t("li",[e._v("When running Wings and the Panel on separate VM's using the same adapter make sure the VM's can connect to each\nother. Promiscuous mode might be needed.")])]),e._v(" "),t("h2",{attrs:{id:"invalid-mac-exception"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#invalid-mac-exception"}},[e._v("#")]),e._v(" Invalid MAC Exception")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("This error should never happen if you correctly follow our installation and upgrade guides. The only time we have\never seen this error occur is when you blindly restore the Panel database from a backup and try to use a fresh\ninstallation of the Panel.")]),e._v(" "),t("p",[e._v("When restoring backups you should "),t("em",[e._v("always")]),e._v(" restore the "),t("code",[e._v(".env")]),e._v(" file!")])]),e._v(" "),t("p",[e._v("Sometimes when using the Panel you'll unexpectedly encounter a broken page, and upon checking the logs you'll see\nan exception mentioning an invalid MAC when decrypting. This error is caused by mismatched "),t("code",[e._v("APP_KEY")]),e._v("s in your "),t("code",[e._v(".env")]),e._v(" file\nwhen the data was encrypted versus decrypted.")]),e._v(" "),t("p",[e._v("If you are seeing this error the only solution is to restore the "),t("code",[e._v("APP_KEY")]),e._v(" from your "),t("code",[e._v(".env")]),e._v(" file. If you have lost that\noriginal key there is no way to recover the lost data.")]),e._v(" "),t("h2",{attrs:{id:"selinux-issues"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#selinux-issues"}},[e._v("#")]),e._v(" SELinux Issues")]),e._v(" "),t("p",[e._v("On systems with SELinux installed you might encounter unexpected errors when running redis or attempting to connect\nto the daemon to perform actions. These issues can generally be resolved by executing the commands below to allow\nthese programs to work with SELinux.")]),e._v(" "),t("h3",{attrs:{id:"redis-permissions-errors"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#redis-permissions-errors"}},[e._v("#")]),e._v(" Redis Permissions Errors")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("audit2allow "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-a")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-M")]),e._v(" redis_t\nsemodule "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-i")]),e._v(" redis_t.pp\n")])])]),t("h3",{attrs:{id:"wings-connection-errors"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#wings-connection-errors"}},[e._v("#")]),e._v(" Wings Connection Errors")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("audit2allow "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-a")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-M")]),e._v(" http_port_t\nsemodule "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-i")]),e._v(" http_port_t.pp\n")])])]),t("h2",{attrs:{id:"containers-don-t-have-internet-probably-a-dns-issue"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#containers-don-t-have-internet-probably-a-dns-issue"}},[e._v("#")]),e._v(" Containers don't have internet? Probably a DNS issue!")]),e._v(" "),t("p",[e._v("Now that Wings has run successfully and you have gotten the green heart on your Nodes page, the wings config at '/etc/pterodactyl/config.yml' will have new values.\nOne of those values is DNS, which by default will be 1.1.1.1 and 1.0.0.1\nIf you are using a host that blocks Cloudflare DNS, you will have to use different DNS Servers; typically the same ones your host system is using.\nYou can view what DNS Servers your host uses through a number of ways depending on how your operating system handles networking. If one of these doesn't work, try another one.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Network Manager (This will show both your IPV4 DNS and IPV6 DNS Servers in case you want to add the IPV6 DNS Server(s) from your host to your Wings Config as well.")]),e._v("\nnmcli "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-g")]),e._v(" ip4.dns,ip6.dns dev show\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Systemd-Resolve (Ubuntu 18.04 and 20.04)")]),e._v("\nsystemd-resolve "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--status")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Resolve-CTL (Newer Versions of Ubuntu)")]),e._v("\nresolvectl status\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Raw file locations that may have your host system's DNS Servers for various distributions")]),e._v("\n/etc/resolv.conf\n/etc/network/interfaces\n")])])]),t("p",[e._v("If this returns different DNS Servers than 1.1.1.1 and 1.0.0.1 you'll need to edit the wings 'config.yml' file to use the DNS servers that were returned from the command. If you see output that looks like an IPV6 address in addition to your IPV4 DNS Servers, make sure you put that in the IPV6 section and not the IPV4 section. To be clear, if you have to use different DNS Servers than the default, make sure to REMOVE 1.1.1.1 and 1.0.0.1 from the wings config; don't just add the new servers, replace the old servers.")]),e._v(" "),t("h2",{attrs:{id:"schedule-troubleshooting"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#schedule-troubleshooting"}},[e._v("#")]),e._v(" Schedule Troubleshooting")]),e._v(" "),t("ul",[t("li",[e._v("Check logs from your queue manager "),t("code",[e._v("journalctl -xeu pteroq")])]),e._v(" "),t("li",[e._v("Restart pteroq "),t("code",[e._v("systemctl restart pteroq")])]),e._v(" "),t("li",[e._v("Clear schedule cache "),t("code",[e._v("php /var/www/pterodactyl/artisan schedule:clear-cache")])]),e._v(" "),t("li",[e._v("Check your php version "),t("code",[e._v("php -v")]),e._v(" - "),t("a",{attrs:{href:"https://pterodactyl.io/panel/1.0/updating.html#panel-version-requirements",target:"_blank",rel:"noopener noreferrer"}},[e._v("this page"),t("OutboundLink")],1),e._v(" will tell you what versions of php are supported by what versions of the panel")]),e._v(" "),t("li",[e._v("Check your crontab syntax using https://crontab.guru - make sure it's what you intended")]),e._v(" "),t("li",[e._v("Verify the problem is with the schedule and not with the tasks you have set up (Set the first task in your schedule to something you know prints a message in the console, ie. run "),t("code",[e._v("say test")]),e._v(' in the console for a Minecraft server, if the text "test" shows up in the console successfully, set the first task to '),t("code",[e._v("say test")]),e._v(" so you know if it runs")]),e._v(" "),t("li",[e._v("Are your tasks off by a bit? Make sure you on the latest version of the panel? In version 1.11.5 there was a fix for schedules running at the wrong time. Alternatively, you may have the wrong timezone set. Make sure your timezones all match.")]),e._v(" "),t("li",[e._v("System Timezone "),t("code",[e._v("timedatectl")])]),e._v(" "),t("li",[e._v("Panel Timezone "),t("code",[e._v("nano /var/www/pterodactyl/.env")])]),e._v(" "),t("li",[e._v("Wings Timezone (Passed to containers as the TZ environmental variable, unrelated to schedules but while you're checking timezones you may as well set this too) "),t("code",[e._v("nano /etc/pterodactyl/config.yml")])]),e._v(" "),t("li",[e._v("Check your database where schedules are stored - MariaDB by default")]),e._v(" "),t("li",[t("code",[e._v("systemctl status mariadb")]),e._v(" - if it's not active, "),t("code",[e._v("journalctl -xeu mariadb")])]),e._v(" "),t("li",[e._v("Check queue handler - Redis by default")]),e._v(" "),t("li",[t("code",[e._v("systemctl status redis")]),e._v(" - if it's not active, "),t("code",[e._v("journalctl -xeu redis")]),e._v(" (On some distributions the service will be named "),t("code",[e._v("redis-server")]),e._v(" instead)")]),e._v(" "),t("li",[e._v("Check for panel errors "),t("code",[e._v("tail -n 150 /var/www/pterodactyl/storage/logs/laravel-$(date +%F).log | nc pteropaste.com 99")])])]),e._v(" "),t("h2",{attrs:{id:"firewalld-issues"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#firewalld-issues"}},[e._v("#")]),e._v(" FirewallD issues")]),e._v(" "),t("p",[e._v("If you are on a RHEL/CentOS server with "),t("code",[e._v("firewalld")]),e._v(" installed you may have broken DNS.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("firewall-cmd --permanent --zone=trusted --change-interface=pterodactyl0\nfirewall-cmd --reload\n")])])]),t("p",[e._v("Restart "),t("code",[e._v("docker")]),e._v(" and "),t("code",[e._v("wings")]),e._v(" after running these to be sure the rules are applied.")])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[62],{322:function(e,t,r){"use strict";r.r(t);var a=r(15),s=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"troubleshooting"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#troubleshooting"}},[e._v("#")]),e._v(" Troubleshooting")]),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#reading-error-logs"}},[e._v("Reading Error Logs")]),t("ul",[t("li",[t("a",{attrs:{href:"#parsing-the-error"}},[e._v("Parsing the Error")])]),t("li",[t("a",{attrs:{href:"#understanding-the-error"}},[e._v("Understanding the Error")])]),t("li",[t("a",{attrs:{href:"#utilizing-grep"}},[e._v("Utilizing GREP")])])])]),t("li",[t("a",{attrs:{href:"#cannot-connect-to-server-errors"}},[e._v("Cannot Connect to Server Errors")]),t("ul",[t("li",[t("a",{attrs:{href:"#basic-debugging-steps"}},[e._v("Basic Debugging Steps")])]),t("li",[t("a",{attrs:{href:"#more-advanced-debugging-steps"}},[e._v("More Advanced Debugging Steps")])])])]),t("li",[t("a",{attrs:{href:"#invalid-mac-exception"}},[e._v("Invalid MAC Exception")])]),t("li",[t("a",{attrs:{href:"#selinux-issues"}},[e._v("SELinux Issues")]),t("ul",[t("li",[t("a",{attrs:{href:"#redis-permissions-errors"}},[e._v("Redis Permissions Errors")])]),t("li",[t("a",{attrs:{href:"#wings-connection-errors"}},[e._v("Wings Connection Errors")])])])]),t("li",[t("a",{attrs:{href:"#containers-don-t-have-internet-probably-a-dns-issue"}},[e._v("Containers don't have internet? Probably a DNS issue!")])]),t("li",[t("a",{attrs:{href:"#schedule-troubleshooting"}},[e._v("Schedule Troubleshooting")])]),t("li",[t("a",{attrs:{href:"#firewalld-issues"}},[e._v("FirewallD issues")])])])]),t("p"),e._v(" "),t("h2",{attrs:{id:"reading-error-logs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#reading-error-logs"}},[e._v("#")]),e._v(" Reading Error Logs")]),e._v(" "),t("p",[e._v("If you ever encounter an unexpected error with the Panel the first thing you will likely be asked for is the logs.\nTo retrieve these, simply execute the command below which will output the last 100 lines of the Panel's log file.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("tail")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-n")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("100")]),e._v(" /var/www/pterodactyl/storage/logs/laravel-"),t("span",{pre:!0,attrs:{class:"token variable"}},[t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$(")]),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("date")]),e._v(" +%F"),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v(")")])]),e._v(".log\n")])])]),t("h3",{attrs:{id:"parsing-the-error"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#parsing-the-error"}},[e._v("#")]),e._v(" Parsing the Error")]),e._v(" "),t("p",[e._v("When you run the command above, you'll probably be hit with a huge wall of text that might scare you. Fear not,\nthis is simply a stacktrace leading to the cause of the error, and you can actually ignore almost all of it when\nlooking for the cause of the error. Lets take a look at some example output below, which has been truncated to\nmake this easier to follow with.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("#70 /srv/www/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php(116): Illuminate\\Foundation\\Http\\Kernel->sendRequestThroughRouter(Object(Illuminate\\Http\\Request))\n#71 /srv/www/public/index.php(53): Illuminate\\Foundation\\Http\\Kernel->handle(Object(Illuminate\\Http\\Request))\n#72 {main}\n[2018-07-19 00:50:24] local.ERROR: ErrorException: file_put_contents(/srv/www/storage/framework/views/c9c05d1357df1ce4ec8fc5df78c16c493b0d4f48.php): failed to open stream: Permission denied in /srv/www/vendor/laravel/framework/src/Illuminate/Filesystem/Filesystem.php:122\nStack trace:\n#0 [internal function]: Illuminate\\Foundation\\Bootstrap\\HandleExceptions->handleError(2, 'file_put_conten...', '/srv/www/vendor...', 122, Array)\n#1 /srv/www/vendor/laravel/framework/src/Illuminate/Filesystem/Filesystem.php(122): file_put_contents('/srv/www/storag...', 's...', 0)\n#2 /srv/www/vendor/laravel/framework/src/Illuminate/View/Compilers/BladeCompiler.php(122): Illuminate\\Filesystem\\Filesystem->put('/srv/www/storag...', 's...')\n#3 /srv/www/vendor/laravel/framework/src/Illuminate/View/Engines/CompilerEngine.php(51): Illuminate\\View\\Compilers\\BladeCompiler->compile('/srv/www/resour...')\n#4 /srv/www/vendor/laravel/framework/src/Illuminate/View/View.php(142): Illuminate\\View\\Engines\\CompilerEngine->get('/srv/www/resour...', Array)\n#5 /srv/www/vendor/laravel/framework/src/Illuminate/View/View.php(125): Illuminate\\View\\View->getContents()\n")])])]),t("p",[e._v("The first thing you'll want to do is follow the chain of numbers "),t("em",[e._v("up")]),e._v(" until you find "),t("code",[e._v("#0")]),e._v(", this will be the function that\ntriggered the exception. Right above line 0 you will see a line that has the date and time in brackets, "),t("code",[e._v("[2018-07-19 00:50:24]")]),e._v("\nabove for example. This line will be the human readable exception that you can use to understand what went wrong.")]),e._v(" "),t("h3",{attrs:{id:"understanding-the-error"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#understanding-the-error"}},[e._v("#")]),e._v(" Understanding the Error")]),e._v(" "),t("p",[e._v("In the example above we can see that the actual error was:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("local.ERROR: ErrorException: file_put_contents(...): failed to open stream: Permission denied in /srv/www/vendor/laravel/framework/src/Illuminate/Filesystem/Filesystem.php:122\n")])])]),t("p",[e._v("From this error we can determine that there was an error performing a "),t("a",{attrs:{href:"http://php.net/manual/en/function.file-put-contents.php",target:"_blank",rel:"noopener noreferrer"}},[e._v("file_put_contents()"),t("OutboundLink")],1),e._v(" call, and the error was\nthat we couldn't open the file because permissions were denied. Its okay if you don't understand the error at all, but\nit does help you get faster support if you're able to provide these logs, and at least find the source of the error.\nSometimes the errors are pretty straightforward and will tell you exactly what went wrong, such as a "),t("code",[e._v("ConnectionException")]),e._v("\nbeing thrown when the Panel can't connect to the Daemon.")]),e._v(" "),t("h3",{attrs:{id:"utilizing-grep"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#utilizing-grep"}},[e._v("#")]),e._v(" Utilizing GREP")]),e._v(" "),t("p",[e._v("If you're trying to go through a bunch of errors quickly, you can use the command below which will limit the results returned to only\nbe the actual error lines, without all of the stack traces.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("tail")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-n")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1000")]),e._v(" /var/www/pterodactyl/storage/logs/laravel-"),t("span",{pre:!0,attrs:{class:"token variable"}},[t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$(")]),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("date")]),e._v(" +%F"),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v(")")])]),e._v(".log "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("grep")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"\\['),t("span",{pre:!0,attrs:{class:"token variable"}},[t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$(")]),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("date")]),e._v(" +%Y"),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v(")")])]),e._v('"')]),e._v("\n")])])]),t("h2",{attrs:{id:"cannot-connect-to-server-errors"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#cannot-connect-to-server-errors"}},[e._v("#")]),e._v(" Cannot Connect to Server Errors")]),e._v(" "),t("h3",{attrs:{id:"basic-debugging-steps"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#basic-debugging-steps"}},[e._v("#")]),e._v(" Basic Debugging Steps")]),e._v(" "),t("ul",[t("li",[e._v("Check that Wings is running, and not reporting errors. Use "),t("code",[e._v("systemctl status wings")]),e._v(" to check the current status of\nthe process.")]),e._v(" "),t("li",[e._v("Check your browser's console by pressing "),t("code",[e._v("Ctrl + Shift + J")]),e._v(" (in Chrome) or "),t("code",[e._v("Cmd + Alt + I")]),e._v(" (in Safari). If there is\na red error in it, chances are that it will narrow down the potential problem.")]),e._v(" "),t("li",[e._v("Make sure Wings is properly installed and the active configuration matches the configuration shown under\n"),t("code",[e._v("Admin -> Node -> Configuration")]),e._v(" in the Panel.")]),e._v(" "),t("li",[e._v("Check that the Wings ports are open on your firewall. Wings uses ports "),t("code",[e._v("8080")]),e._v(" or "),t("code",[e._v("8443")]),e._v(" for HTTP(s) traffic,\nand "),t("code",[e._v("2022")]),e._v(" for SFTP traffic.")]),e._v(" "),t("li",[e._v("Ensure you have AdBlock disabled or whitelisted for your Panel and Wings domains.")]),e._v(" "),t("li",[e._v("Check that the Panel can reach Wings using the domain that is configured on the Panel. Run "),t("code",[e._v("curl https://domain.com:8080")]),e._v(" on the Panel server and ensure that it can successfully connect to Wings.")]),e._v(" "),t("li",[e._v("Ensure that you are using the correct HTTP scheme for your Panel and Wings. If the Panel is running over HTTPS\nWings will also need to be running on HTTPS.")]),e._v(" "),t("li",[e._v("If using HTTPS for Wings, make sure that the certificates have not expired.")])]),e._v(" "),t("h3",{attrs:{id:"more-advanced-debugging-steps"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#more-advanced-debugging-steps"}},[e._v("#")]),e._v(" More Advanced Debugging Steps")]),e._v(" "),t("ul",[t("li",[e._v("Stop Wings and run "),t("code",[e._v("wings --debug")]),e._v(" to see if there are any errors being output. If so, try resolving them manually,\nor reach out on "),t("a",{attrs:{href:"https://discord.gg/pterodactyl",target:"_blank",rel:"noopener noreferrer"}},[e._v("Discord"),t("OutboundLink")],1),e._v(" for more assistance.")]),e._v(" "),t("li",[e._v("Check your DNS and ensure that the response you receive is the one you expect using a tool such as "),t("code",[e._v("nslookup")]),e._v(" or "),t("code",[e._v("dig")]),e._v(".")]),e._v(" "),t("li",[e._v("If you use CloudFlare make sure that the orange cloud is disabled for your Wings or Panel "),t("code",[e._v("A")]),e._v(" records.")]),e._v(" "),t("li",[e._v("Make sure when using Wings behind a firewall — pfSense, OpenSwitch, etc. — that the correct NAT settings to access\nthe Wing's ports from the outside network are setup.")]),e._v(" "),t("li",[e._v("If nothing is working so far, check your own DNS settings and consider switching DNS servers.")]),e._v(" "),t("li",[e._v("When running the Panel and Wings on one server it can sometimes help if to add an entry in "),t("code",[e._v("/etc/hosts")]),e._v(" that directs\nthe public IP back to the server. Sometimes the reverse path is also needed, so you may need to add an entry to your\nservers "),t("code",[e._v("/etc/hosts")]),e._v(" file that points the Panel's domain to the correct IP.")]),e._v(" "),t("li",[e._v("When running Wings and the Panel on separate VM's using the same adapter make sure the VM's can connect to each\nother. Promiscuous mode might be needed.")])]),e._v(" "),t("h2",{attrs:{id:"invalid-mac-exception"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#invalid-mac-exception"}},[e._v("#")]),e._v(" Invalid MAC Exception")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("This error should never happen if you correctly follow our installation and upgrade guides. The only time we have\never seen this error occur is when you blindly restore the Panel database from a backup and try to use a fresh\ninstallation of the Panel.")]),e._v(" "),t("p",[e._v("When restoring backups you should "),t("em",[e._v("always")]),e._v(" restore the "),t("code",[e._v(".env")]),e._v(" file!")])]),e._v(" "),t("p",[e._v("Sometimes when using the Panel you'll unexpectedly encounter a broken page, and upon checking the logs you'll see\nan exception mentioning an invalid MAC when decrypting. This error is caused by mismatched "),t("code",[e._v("APP_KEY")]),e._v("s in your "),t("code",[e._v(".env")]),e._v(" file\nwhen the data was encrypted versus decrypted.")]),e._v(" "),t("p",[e._v("If you are seeing this error the only solution is to restore the "),t("code",[e._v("APP_KEY")]),e._v(" from your "),t("code",[e._v(".env")]),e._v(" file. If you have lost that\noriginal key there is no way to recover the lost data.")]),e._v(" "),t("h2",{attrs:{id:"selinux-issues"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#selinux-issues"}},[e._v("#")]),e._v(" SELinux Issues")]),e._v(" "),t("p",[e._v("On systems with SELinux installed you might encounter unexpected errors when running redis or attempting to connect\nto the daemon to perform actions. These issues can generally be resolved by executing the commands below to allow\nthese programs to work with SELinux.")]),e._v(" "),t("h3",{attrs:{id:"redis-permissions-errors"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#redis-permissions-errors"}},[e._v("#")]),e._v(" Redis Permissions Errors")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("audit2allow "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-a")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-M")]),e._v(" redis_t\nsemodule "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-i")]),e._v(" redis_t.pp\n")])])]),t("h3",{attrs:{id:"wings-connection-errors"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#wings-connection-errors"}},[e._v("#")]),e._v(" Wings Connection Errors")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("audit2allow "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-a")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-M")]),e._v(" http_port_t\nsemodule "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-i")]),e._v(" http_port_t.pp\n")])])]),t("h2",{attrs:{id:"containers-don-t-have-internet-probably-a-dns-issue"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#containers-don-t-have-internet-probably-a-dns-issue"}},[e._v("#")]),e._v(" Containers don't have internet? Probably a DNS issue!")]),e._v(" "),t("p",[e._v("Now that Wings has run successfully and you have gotten the green heart on your Nodes page, the wings config at '/etc/pterodactyl/config.yml' will have new values.\nOne of those values is DNS, which by default will be 1.1.1.1 and 1.0.0.1\nIf you are using a host that blocks Cloudflare DNS, you will have to use different DNS Servers; typically the same ones your host system is using.\nYou can view what DNS Servers your host uses through a number of ways depending on how your operating system handles networking. If one of these doesn't work, try another one.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Network Manager (This will show both your IPV4 DNS and IPV6 DNS Servers in case you want to add the IPV6 DNS Server(s) from your host to your Wings Config as well.")]),e._v("\nnmcli "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-g")]),e._v(" ip4.dns,ip6.dns dev show\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Resolve-CTL (Newer Versions of Ubuntu)")]),e._v("\nresolvectl status\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Raw file locations that may have your host system's DNS Servers for various distributions")]),e._v("\n/etc/resolv.conf\n/etc/network/interfaces\n")])])]),t("p",[e._v("If this returns different DNS Servers than 1.1.1.1 and 1.0.0.1 you'll need to edit the wings 'config.yml' file to use the DNS servers that were returned from the command. If you see output that looks like an IPV6 address in addition to your IPV4 DNS Servers, make sure you put that in the IPV6 section and not the IPV4 section. To be clear, if you have to use different DNS Servers than the default, make sure to REMOVE 1.1.1.1 and 1.0.0.1 from the wings config; don't just add the new servers, replace the old servers.")]),e._v(" "),t("h2",{attrs:{id:"schedule-troubleshooting"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#schedule-troubleshooting"}},[e._v("#")]),e._v(" Schedule Troubleshooting")]),e._v(" "),t("ul",[t("li",[e._v("Check logs from your queue manager "),t("code",[e._v("journalctl -xeu pteroq")])]),e._v(" "),t("li",[e._v("Restart pteroq "),t("code",[e._v("systemctl restart pteroq")])]),e._v(" "),t("li",[e._v("Clear schedule cache "),t("code",[e._v("php /var/www/pterodactyl/artisan schedule:clear-cache")])]),e._v(" "),t("li",[e._v("Check your php version "),t("code",[e._v("php -v")]),e._v(" - "),t("a",{attrs:{href:"https://pterodactyl.io/panel/1.0/updating.html#panel-version-requirements",target:"_blank",rel:"noopener noreferrer"}},[e._v("this page"),t("OutboundLink")],1),e._v(" will tell you what versions of php are supported by what versions of the panel")]),e._v(" "),t("li",[e._v("Check your crontab syntax using https://crontab.guru - make sure it's what you intended")]),e._v(" "),t("li",[e._v("Verify the problem is with the schedule and not with the tasks you have set up (Set the first task in your schedule to something you know prints a message in the console, ie. run "),t("code",[e._v("say test")]),e._v(' in the console for a Minecraft server, if the text "test" shows up in the console successfully, set the first task to '),t("code",[e._v("say test")]),e._v(" so you know if it runs")]),e._v(" "),t("li",[e._v("Are your tasks off by a bit? Make sure you on the latest version of the panel? In version 1.11.5 there was a fix for schedules running at the wrong time. Alternatively, you may have the wrong timezone set. Make sure your timezones all match.")]),e._v(" "),t("li",[e._v("System Timezone "),t("code",[e._v("timedatectl")])]),e._v(" "),t("li",[e._v("Panel Timezone "),t("code",[e._v("nano /var/www/pterodactyl/.env")])]),e._v(" "),t("li",[e._v("Wings Timezone (Passed to containers as the TZ environmental variable, unrelated to schedules but while you're checking timezones you may as well set this too) "),t("code",[e._v("nano /etc/pterodactyl/config.yml")])]),e._v(" "),t("li",[e._v("Check your database where schedules are stored - MariaDB by default")]),e._v(" "),t("li",[t("code",[e._v("systemctl status mariadb")]),e._v(" - if it's not active, "),t("code",[e._v("journalctl -xeu mariadb")])]),e._v(" "),t("li",[e._v("Check queue handler - Redis by default")]),e._v(" "),t("li",[t("code",[e._v("systemctl status redis")]),e._v(" - if it's not active, "),t("code",[e._v("journalctl -xeu redis")]),e._v(" (On some distributions the service will be named "),t("code",[e._v("redis-server")]),e._v(" instead)")]),e._v(" "),t("li",[e._v("Check for panel errors "),t("code",[e._v("tail -n 150 /var/www/pterodactyl/storage/logs/laravel-$(date +%F).log | nc pteropaste.com 99")])])]),e._v(" "),t("h2",{attrs:{id:"firewalld-issues"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#firewalld-issues"}},[e._v("#")]),e._v(" FirewallD issues")]),e._v(" "),t("p",[e._v("If you are on a RHEL/CentOS server with "),t("code",[e._v("firewalld")]),e._v(" installed you may have broken DNS.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("firewall-cmd --permanent --zone=trusted --change-interface=pterodactyl0\nfirewall-cmd --reload\n")])])]),t("p",[e._v("Restart "),t("code",[e._v("docker")]),e._v(" and "),t("code",[e._v("wings")]),e._v(" after running these to be sure the rules are applied.")])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/assets/js/66.6b9cb27a.js b/assets/js/66.6040c100.js similarity index 98% rename from assets/js/66.6b9cb27a.js rename to assets/js/66.6040c100.js index 8eceaacd..28b44571 100644 --- a/assets/js/66.6b9cb27a.js +++ b/assets/js/66.6040c100.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[66],{328:function(e,t,i){"use strict";i.r(t);var o=i(15),n=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"community-standards"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#community-standards"}},[e._v("#")]),e._v(" Community Standards")]),e._v(" "),t("p",[e._v("Pterodactyl has grown from a community of tens in 2015 to a community of thousands in 2020. During that time\nthere have been countless growing pains and community has changed in an innumerable number of ways. At our heart\nhowever, Pterodactyl continues to exist for one purpose: to be "),t("em",[e._v("the")]),e._v(" platform for running your game servers.")]),e._v(" "),t("p",[e._v("In order to keep true to that goal, and continue to foster one of the largest open-source game panel communities\nout there, we've adopted a simple set of guidelines for participating in this community. The goal of these guidelines\nis to foster an inclusive, welcoming environment for new users, and provide a space for the thousands of existing\nusers, administrators, network owners, and hosting companies to co-exist.")]),e._v(" "),t("p",[e._v("These rules and guidelines extend to all facets of the Pterodactyl Community, including but not limited to our\nDiscord Server and all activities within the GitHub Organization.")]),e._v(" "),t("h2",{attrs:{id:"community-guidelines"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#community-guidelines"}},[e._v("#")]),e._v(" Community Guidelines")]),e._v(" "),t("p",[e._v("At the most basic level, these guidelines can be distilled down to:")]),e._v(" "),t("ol",[t("li",[e._v("Be a decent human.")]),e._v(" "),t("li",[e._v("Patience is a virtue.")])]),e._v(" "),t("h3",{attrs:{id:"be-mature"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#be-mature"}},[e._v("#")]),e._v(" Be Mature")]),e._v(" "),t("p",[e._v('You are expected to be mature and control your behavior in a manner that adheres to basic human decency. If you are\nunable to do this you will be removed from the community. Personal attacks, spam (in any form), "doxxing", or otherwise\nacting out is not allowed.')]),e._v(" "),t("p",[e._v("This community is fairly lax in regards to moderating language. However, the following are some examples of\nbehavior that is absolutely "),t("em",[e._v("not")]),e._v(" tolerated and for which you will be removed from the community.")]),e._v(" "),t("ul",[t("li",[e._v("Racist, sexist, homophobic, transphobic, or otherwise deregatory speech, images, insinuations, or any language whose\nsole purpose is to denigrate any individual, organization, or class of individual.")]),e._v(" "),t("li",[e._v('Threats of violence against any person, group, or organization including "doxxing" of these entities.')]),e._v(" "),t("li",[e._v("Pornographic or excessively violent content.")])]),e._v(" "),t("h3",{attrs:{id:"limit-the-drama"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#limit-the-drama"}},[e._v("#")]),e._v(" Limit the Drama")]),e._v(" "),t("p",[e._v("Discussion, including linking to or discussing sites or software, that exists to cast a negative image of other\ncompanies or users is not allowed. This includes calling out hosts using nulled software, attempting to elicit negative\nreactions towards services or websites, or otherwise stirring up drama.")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("Assume someone is acting in good faith when responding to them. You don't have to agree with everyone, and you\ndon't need to respond to everything.")])]),e._v(" "),t("h3",{attrs:{id:"be-patient"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#be-patient"}},[e._v("#")]),e._v(" Be Patient")]),e._v(" "),t("p",[e._v("This is an open-source project. No members of the development team are paid in an official capacity to write,\nmaintain, nor support this software. The following actions are discouraged in this community.")]),e._v(" "),t("ul",[t("li",[e._v("Repeatedly asking identical questions within the same channel (or across channels) within short periods of time.\n"),t("ul",[t("li",[e._v("It is expected that some questions will be missed. If it has been a reasonable amount of time and your question\nremains unanswered, you're welcome to re-post it.")])])]),e._v(" "),t("li",[e._v("Keep all support questions within the realm of the support channels.")]),e._v(" "),t("li",[e._v("Do not interrupt conversations in non-support channels solely to request that someone look in a support channel\nand help you.")])]),e._v(" "),t("h3",{attrs:{id:"no-commercial-services"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#no-commercial-services"}},[e._v("#")]),e._v(" No Commercial Services")]),e._v(" "),t("p",[e._v("Discussion of paid installation/upgrade services, modifications, or any other commercial offerings is strictly\nprohibited unless otherwise noted. This also includes reaching out to individuals via Direct Message and offering\nyour services without provocation.")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("Check your Username")]),e._v(" "),t("p",[e._v("Advertising commercial services within your username or display name on Discord is forbidden.")])]),e._v(" "),t("p",[t("RouterLink",{attrs:{to:"/project/about.html#sponsors"}},[e._v("Sponsors")]),e._v(" at the silver tier and higher are exempt from this rule.")],1),e._v(" "),t("h3",{attrs:{id:"no-mention-or-ping-spam"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#no-mention-or-ping-spam"}},[e._v("#")]),e._v(" No Mention or Ping Spam")]),e._v(" "),t("p",[e._v("Please, do not direct message any administrative, development, or notable community members without first\nchecking with them. Keep all support queries within the public support channels unless you have been directly\nasked to move it elsewhere.")]),e._v(" "),t("p",[t("em",[e._v("But what if I am trying to respond back to someone?")]),e._v(" That is fine! We only ask that you not mention people\ndirectly if they're not already involved in a discussion with you.")])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[66],{329:function(e,t,i){"use strict";i.r(t);var o=i(15),n=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"community-standards"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#community-standards"}},[e._v("#")]),e._v(" Community Standards")]),e._v(" "),t("p",[e._v("Pterodactyl has grown from a community of tens in 2015 to a community of thousands in 2020. During that time\nthere have been countless growing pains and community has changed in an innumerable number of ways. At our heart\nhowever, Pterodactyl continues to exist for one purpose: to be "),t("em",[e._v("the")]),e._v(" platform for running your game servers.")]),e._v(" "),t("p",[e._v("In order to keep true to that goal, and continue to foster one of the largest open-source game panel communities\nout there, we've adopted a simple set of guidelines for participating in this community. The goal of these guidelines\nis to foster an inclusive, welcoming environment for new users, and provide a space for the thousands of existing\nusers, administrators, network owners, and hosting companies to co-exist.")]),e._v(" "),t("p",[e._v("These rules and guidelines extend to all facets of the Pterodactyl Community, including but not limited to our\nDiscord Server and all activities within the GitHub Organization.")]),e._v(" "),t("h2",{attrs:{id:"community-guidelines"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#community-guidelines"}},[e._v("#")]),e._v(" Community Guidelines")]),e._v(" "),t("p",[e._v("At the most basic level, these guidelines can be distilled down to:")]),e._v(" "),t("ol",[t("li",[e._v("Be a decent human.")]),e._v(" "),t("li",[e._v("Patience is a virtue.")])]),e._v(" "),t("h3",{attrs:{id:"be-mature"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#be-mature"}},[e._v("#")]),e._v(" Be Mature")]),e._v(" "),t("p",[e._v('You are expected to be mature and control your behavior in a manner that adheres to basic human decency. If you are\nunable to do this you will be removed from the community. Personal attacks, spam (in any form), "doxxing", or otherwise\nacting out is not allowed.')]),e._v(" "),t("p",[e._v("This community is fairly lax in regards to moderating language. However, the following are some examples of\nbehavior that is absolutely "),t("em",[e._v("not")]),e._v(" tolerated and for which you will be removed from the community.")]),e._v(" "),t("ul",[t("li",[e._v("Racist, sexist, homophobic, transphobic, or otherwise deregatory speech, images, insinuations, or any language whose\nsole purpose is to denigrate any individual, organization, or class of individual.")]),e._v(" "),t("li",[e._v('Threats of violence against any person, group, or organization including "doxxing" of these entities.')]),e._v(" "),t("li",[e._v("Pornographic or excessively violent content.")])]),e._v(" "),t("h3",{attrs:{id:"limit-the-drama"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#limit-the-drama"}},[e._v("#")]),e._v(" Limit the Drama")]),e._v(" "),t("p",[e._v("Discussion, including linking to or discussing sites or software, that exists to cast a negative image of other\ncompanies or users is not allowed. This includes calling out hosts using nulled software, attempting to elicit negative\nreactions towards services or websites, or otherwise stirring up drama.")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("Assume someone is acting in good faith when responding to them. You don't have to agree with everyone, and you\ndon't need to respond to everything.")])]),e._v(" "),t("h3",{attrs:{id:"be-patient"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#be-patient"}},[e._v("#")]),e._v(" Be Patient")]),e._v(" "),t("p",[e._v("This is an open-source project. No members of the development team are paid in an official capacity to write,\nmaintain, nor support this software. The following actions are discouraged in this community.")]),e._v(" "),t("ul",[t("li",[e._v("Repeatedly asking identical questions within the same channel (or across channels) within short periods of time.\n"),t("ul",[t("li",[e._v("It is expected that some questions will be missed. If it has been a reasonable amount of time and your question\nremains unanswered, you're welcome to re-post it.")])])]),e._v(" "),t("li",[e._v("Keep all support questions within the realm of the support channels.")]),e._v(" "),t("li",[e._v("Do not interrupt conversations in non-support channels solely to request that someone look in a support channel\nand help you.")])]),e._v(" "),t("h3",{attrs:{id:"no-commercial-services"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#no-commercial-services"}},[e._v("#")]),e._v(" No Commercial Services")]),e._v(" "),t("p",[e._v("Discussion of paid installation/upgrade services, modifications, or any other commercial offerings is strictly\nprohibited unless otherwise noted. This also includes reaching out to individuals via Direct Message and offering\nyour services without provocation.")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("Check your Username")]),e._v(" "),t("p",[e._v("Advertising commercial services within your username or display name on Discord is forbidden.")])]),e._v(" "),t("p",[t("RouterLink",{attrs:{to:"/project/about.html#sponsors"}},[e._v("Sponsors")]),e._v(" at the silver tier and higher are exempt from this rule.")],1),e._v(" "),t("h3",{attrs:{id:"no-mention-or-ping-spam"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#no-mention-or-ping-spam"}},[e._v("#")]),e._v(" No Mention or Ping Spam")]),e._v(" "),t("p",[e._v("Please, do not direct message any administrative, development, or notable community members without first\nchecking with them. Keep all support queries within the public support channels unless you have been directly\nasked to move it elsewhere.")]),e._v(" "),t("p",[t("em",[e._v("But what if I am trying to respond back to someone?")]),e._v(" That is fine! We only ask that you not mention people\ndirectly if they're not already involved in a discussion with you.")])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/67.8bad66f0.js b/assets/js/67.275f5b02.js similarity index 96% rename from assets/js/67.8bad66f0.js rename to assets/js/67.275f5b02.js index 10c40344..538aa4b8 100644 --- a/assets/js/67.8bad66f0.js +++ b/assets/js/67.275f5b02.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[67],{326:function(e,t,o){"use strict";o.r(t);var a=o(15),r=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"introduction"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#introduction"}},[e._v("#")]),e._v(" Introduction")]),e._v(" "),t("p",[e._v("Pterodactyl is the open-source game server management panel built with PHP, React, and Go. Designed with\nsecurity in mind, Pterodactyl runs all game servers in isolated Docker containers while exposing a beautiful\nand intuitive UI to administrators and users. What more are you waiting for? Make game servers a first-class\ncitizen on your platform today.")]),e._v(" "),t("h2",{attrs:{id:"supported-games"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#supported-games"}},[e._v("#")]),e._v(" Supported Games")]),e._v(" "),t("p",[e._v("We support a huge variety of games by utilizing Docker containers to isolate each instance, giving you the power\nto host your games across the world without having to bloat each physical machine with additional dependencies.")]),e._v(" "),t("p",[e._v("Some of our core supported games include:")]),e._v(" "),t("ul",[t("li",[e._v("Minecraft — including Spigot, Sponge, Bungeecord, Waterfall, and more")]),e._v(" "),t("li",[e._v("Rust")]),e._v(" "),t("li",[e._v("Terraria")]),e._v(" "),t("li",[e._v("Teamspeak")]),e._v(" "),t("li",[e._v("Mumble")]),e._v(" "),t("li",[e._v("Team Fortress 2")]),e._v(" "),t("li",[e._v("Counter Strike: Global Offensive")]),e._v(" "),t("li",[e._v("Garry's Mod")]),e._v(" "),t("li",[e._v("ARK: Survival Evolved")])]),e._v(" "),t("p",[e._v("In addition to our standard nest of supported games, our community is constantly pushing the limits of this software\nand there are plenty more games available provided by the community. Some of these games include:")]),e._v(" "),t("ul",[t("li",[e._v("Factorio")]),e._v(" "),t("li",[e._v("San Andreas: MP")]),e._v(" "),t("li",[e._v("Pocketmine MP")]),e._v(" "),t("li",[e._v("Squad")]),e._v(" "),t("li",[e._v("FiveM")]),e._v(" "),t("li",[e._v("Xonotic")]),e._v(" "),t("li",[e._v("Discord ATLBot")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://pterodactyleggs.com",target:"_blank",rel:"noopener noreferrer"}},[e._v("and many more..."),t("OutboundLink")],1)])]),e._v(" "),t("h2",{attrs:{id:"responsible-disclosure"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#responsible-disclosure"}},[e._v("#")]),e._v(" Responsible Disclosure")]),e._v(" "),t("p",[e._v("Pterodactyl is completely open-source, and as such completely open to independent users and auditors to browse our\ncode base and hunt for security issues. If you come across anything that raises red flags for you, please do not\nhesitate to reach out directly to "),t("code",[e._v("support@pterodactyl.io")]),e._v(". We ask that you please be responsible when disclosing\nany security concerns and "),t("em",[e._v("do not")]),e._v(" report them on our public facing bug tracker.")])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[67],{327:function(e,t,o){"use strict";o.r(t);var a=o(15),r=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"introduction"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#introduction"}},[e._v("#")]),e._v(" Introduction")]),e._v(" "),t("p",[e._v("Pterodactyl is the open-source game server management panel built with PHP, React, and Go. Designed with\nsecurity in mind, Pterodactyl runs all game servers in isolated Docker containers while exposing a beautiful\nand intuitive UI to administrators and users. What more are you waiting for? Make game servers a first-class\ncitizen on your platform today.")]),e._v(" "),t("h2",{attrs:{id:"supported-games"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#supported-games"}},[e._v("#")]),e._v(" Supported Games")]),e._v(" "),t("p",[e._v("We support a huge variety of games by utilizing Docker containers to isolate each instance, giving you the power\nto host your games across the world without having to bloat each physical machine with additional dependencies.")]),e._v(" "),t("p",[e._v("Some of our core supported games include:")]),e._v(" "),t("ul",[t("li",[e._v("Minecraft — including Spigot, Sponge, Bungeecord, Waterfall, and more")]),e._v(" "),t("li",[e._v("Rust")]),e._v(" "),t("li",[e._v("Terraria")]),e._v(" "),t("li",[e._v("Teamspeak")]),e._v(" "),t("li",[e._v("Mumble")]),e._v(" "),t("li",[e._v("Team Fortress 2")]),e._v(" "),t("li",[e._v("Counter Strike: Global Offensive")]),e._v(" "),t("li",[e._v("Garry's Mod")]),e._v(" "),t("li",[e._v("ARK: Survival Evolved")])]),e._v(" "),t("p",[e._v("In addition to our standard nest of supported games, our community is constantly pushing the limits of this software\nand there are plenty more games available provided by the community. Some of these games include:")]),e._v(" "),t("ul",[t("li",[e._v("Factorio")]),e._v(" "),t("li",[e._v("San Andreas: MP")]),e._v(" "),t("li",[e._v("Pocketmine MP")]),e._v(" "),t("li",[e._v("Squad")]),e._v(" "),t("li",[e._v("FiveM")]),e._v(" "),t("li",[e._v("Xonotic")]),e._v(" "),t("li",[e._v("Discord ATLBot")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://pterodactyleggs.com",target:"_blank",rel:"noopener noreferrer"}},[e._v("and many more..."),t("OutboundLink")],1)])]),e._v(" "),t("h2",{attrs:{id:"responsible-disclosure"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#responsible-disclosure"}},[e._v("#")]),e._v(" Responsible Disclosure")]),e._v(" "),t("p",[e._v("Pterodactyl is completely open-source, and as such completely open to independent users and auditors to browse our\ncode base and hunt for security issues. If you come across anything that raises red flags for you, please do not\nhesitate to reach out directly to "),t("code",[e._v("support@pterodactyl.io")]),e._v(". We ask that you please be responsible when disclosing\nany security concerns and "),t("em",[e._v("do not")]),e._v(" report them on our public facing bug tracker.")])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/68.66b31eec.js b/assets/js/68.06aa0e75.js similarity index 99% rename from assets/js/68.66b31eec.js rename to assets/js/68.06aa0e75.js index 56dac66d..beec31bc 100644 --- a/assets/js/68.66b31eec.js +++ b/assets/js/68.06aa0e75.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[68],{329:function(e,t,a){"use strict";a.r(t);var s=a(15),r=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"creating-ssl-certificates"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#creating-ssl-certificates"}},[e._v("#")]),e._v(" Creating SSL Certificates")]),e._v(" "),t("p",[e._v("This tutorial briefly covers creating new SSL certificates for your panel and wings.")]),e._v(" "),t("tabs",[t("tab",{attrs:{name:"Method 1: Certbot"}},[t("p",[e._v("To begin, we will install certbot, a simple script that automatically renews our certificates and allows much\neasier creation of them. The command below is for Ubuntu distributions, but you can always check "),t("a",{attrs:{href:"https://certbot.eff.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Certbot's official\nsite"),t("OutboundLink")],1),e._v(" for installation instructions. We have also included a command below to install certbot's\nNginx/Apache plugin so you won't have to stop your webserver.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" update\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-y")]),e._v(" certbot\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Run this if you use Nginx")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-y")]),e._v(" python3-certbot-nginx\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Run this if you use Apache")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-y")]),e._v(" python3-certbot-apache\n")])])]),t("h2",{attrs:{id:"creating-a-certificate"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#creating-a-certificate"}},[e._v("#")]),e._v(" Creating a Certificate")]),e._v(" "),t("p",[e._v("After installing the certbot, we need to generate a certificate. There are a couple of ways to do that, but the easiest\nis to use the web server-specific certbot plugin you just installed. For Wings-only machines that don't need a web server, use the standalone or DNS method of the certbot as you don't need a web server for it.")]),e._v(" "),t("p",[e._v("Then, in the command below, you should replace "),t("code",[e._v("example.com")]),e._v(" with the domain you would like to generate a certificate\nfor. When you have multiple domains you would like certificates for, simply add more "),t("code",[e._v("-d anotherdomain.com")]),e._v(" flags to the\ncommand. You can also look into generating a wildcard certificate but that is not covered in this tutorial.")]),e._v(" "),t("p",[e._v("When you are using certbot's Nginx/Apache plugin, you won't need to restart your webserver to have the certificate\napplied assuming that you've already configured the webservers to use SSL as instructed in the "),t("a",{attrs:{href:"https://pterodactyl.io/panel/1.0/webserver_configuration.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("web server configuration step"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"http-challenge"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#http-challenge"}},[e._v("#")]),e._v(" HTTP challenge")]),e._v(" "),t("p",[e._v("HTTP challenge requires you to expose port 80 for the challenge verification.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Nginx")]),e._v("\ncertbot certonly "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--nginx")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-d")]),e._v(" example.com\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Apache")]),e._v("\ncertbot certonly "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--apache")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-d")]),e._v(" example.com\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Standalone - Use this if neither works. Make sure to stop your webserver first when using this method.")]),e._v("\ncertbot certonly "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--standalone")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-d")]),e._v(" example.com\n")])])]),t("h3",{attrs:{id:"dns-challenge"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dns-challenge"}},[e._v("#")]),e._v(" DNS challenge")]),e._v(" "),t("p",[e._v("DNS challenge requires you to create a new TXT DNS record to verify domain ownership, instead of having to expose port 80. The instructions are displayed when you run the certbot command below.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("certbot "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-d")]),e._v(" example.com "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--manual")]),e._v(" --preferred-challenges dns certonly\n")])])]),t("h3",{attrs:{id:"auto-renewal"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#auto-renewal"}},[e._v("#")]),e._v(" Auto Renewal")]),e._v(" "),t("p",[e._v("You'll also probably want to configure the automatic renewal of certificates to prevent unexpected certificate expirations.\nYou can open crontab with "),t("code",[e._v("sudo crontab -e")]),e._v(" and add the line from below to the bottom of it for attempting renewal every day at 23 (11 PM).")]),e._v(" "),t("p",[e._v("Deploy hook would restart the Nginx service to apply a new certificate when it's renewed successfully. Change "),t("code",[e._v("nginx")]),e._v(" in the restart command to suit your own needs, such as to "),t("code",[e._v("apache")]),e._v(" or "),t("code",[e._v("wings")]),e._v(".")]),e._v(" "),t("p",[e._v("For advanced users, we suggest installing and using "),t("a",{attrs:{href:"https://acme.sh",target:"_blank",rel:"noopener noreferrer"}},[e._v("acme.sh"),t("OutboundLink")],1),e._v("\nwhich provides more options, and is much more powerful than certbot.")]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('0 23 * * * certbot renew --quiet --deploy-hook "systemctl restart nginx"\n')])])]),t("h3",{attrs:{id:"troubleshooting"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#troubleshooting"}},[e._v("#")]),e._v(" Troubleshooting")]),e._v(" "),t("p",[e._v("If you get an "),t("code",[e._v("Insecure Connection")]),e._v(" or SSL/TLS related error when trying to access your panel or wings, the certificate has likely expired.\nThis can be easily fixed by renewing the SSL certificate, although using the command "),t("code",[e._v("certbot renew")]),e._v(" might not do the job if port 80 is in use, as it'll return errors like: "),t("code",[e._v("Error: Attempting to renew cert (domain) from /etc/letsencrypt/renew/domain.conf produced an unexpected error")]),e._v(".")]),e._v(" "),t("p",[e._v("This will happen especially if you're running Nginx instead of Apache. The solution for this is to use Nginx or Apache plugins with "),t("code",[e._v("--nginx")]),e._v(" and "),t("code",[e._v("--apache")]),e._v(". Alternatively, you can stop Nginx, then renew the certificate, and finally restart Nginx. Replace "),t("code",[e._v("nginx")]),e._v(" with your own web server or with "),t("code",[e._v("wings")]),e._v(" should you be renewing the certificate for Wings.")]),e._v(" "),t("p",[e._v("Stop Nginx:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("systemctl stop nginx\n")])])]),t("p",[e._v("Renew the certificate:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("certbot renew\n")])])]),t("p",[e._v("Once the process has completed, you can restart the Nginx service:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("systemctl start nginx\n")])])]),t("p",[e._v("You may also need to restart Wings as not every service is able to automatically apply an updated certificate:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("systemctl restart wings\n")])])])]),e._v(" "),t("tab",{attrs:{name:"Method 2: acme.sh (using Cloudflare API)"}},[t("p",[e._v("This is for advanced users, whose server systems do not have access to port 80. The command below is for Ubuntu distributions and CloudFlare API (you may google for other APIs for other DNS providers), but you can always check "),t("a",{attrs:{href:"https://github.com/acmesh-official/acme.sh",target:"_blank",rel:"noopener noreferrer"}},[e._v("acme.sh's official site"),t("OutboundLink")],1),e._v(" for installation instructions. Make sure you read both instructions, as some people may have moved to CloudFlare's "),t("a",{attrs:{href:"https://blog.cloudflare.com/permissions-best-practices",target:"_blank",rel:"noopener noreferrer"}},[e._v("new authorization system"),t("OutboundLink")],1),e._v(" (Modern), but others "),t("a",{attrs:{href:"https://cloudflare.tv/event/ea8JJLgR",target:"_blank",rel:"noopener noreferrer"}},[e._v("have not"),t("OutboundLink")],1),e._v(" (Legacy).")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" https://get.acme.sh "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sh")]),e._v("\n")])])]),t("h3",{attrs:{id:"obtaining-cloudflare-api-key-legacy"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#obtaining-cloudflare-api-key-legacy"}},[e._v("#")]),e._v(" Obtaining CloudFlare API Key (Legacy)")]),e._v(" "),t("p",[e._v('After installing acme.sh, we need to fetch a CloudFlare API key. On Cloudfare\'s website, select your domain, then on the right side, copy your "Zone ID" and "Account ID" then click on "Get your API token", click on "Create Token" > select the template "Edit zone DNS" > select the scope of "Zone Resources" and then click on "Continue to summary", copy your token.')]),e._v(" "),t("h3",{attrs:{id:"creating-a-certificate-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#creating-a-certificate-2"}},[e._v("#")]),e._v(" Creating a Certificate")]),e._v(" "),t("p",[e._v("Since the configuration file is based on Certbot, we need to create the folder manually.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("mkdir")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-p")]),e._v(" /etc/letsencrypt/live/example.com\n")])])]),t("p",[e._v("After installing acme.sh and obtaining CloudFlare API key, we need to then generate a certificate. First, input the CloudFlare API credentials.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("CF_Token")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Your_CloudFlare_API_Key"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("CF_Account_ID")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Your_CloudFlare_Account_ID"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("CF_Zone_ID")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Your_CloudFlare_Zone_ID"')]),e._v("\n")])])]),t("h3",{attrs:{id:"obtaining-cloudflare-api-key-modern"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#obtaining-cloudflare-api-key-modern"}},[e._v("#")]),e._v(" Obtaining CloudFlare API Key (Modern)")]),e._v(" "),t("p",[e._v('After installing acme.sh, we need to fetch a CloudFlare API key. On Cloudfare\'s website, click on your profile on the top right. Then go to "My Profile", on the left you will find "API Tokens". Click it and it\'ll bring you to '),t("a",{attrs:{href:"https://dash.cloudflare.com/profile/api-tokens",target:"_blank",rel:"noopener noreferrer"}},[e._v("the API tokens page"),t("OutboundLink")],1),e._v('. Select "Create Token" and use the "Edit zone DNS" template. Then once on the next page, go to "Zone Resources" and "Include" - "Specific Zone" - (Select the domain you want to use). Then continue to the summary. Confirm you\'d like to create the token.')]),e._v(" "),t("h3",{attrs:{id:"creating-a-certificate-3"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#creating-a-certificate-3"}},[e._v("#")]),e._v(" Creating a Certificate")]),e._v(" "),t("p",[e._v("Since the configuration file is based on Certbot, we need to create the folder manually.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("mkdir")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-p")]),e._v(" /etc/letsencrypt/live/example.com\n")])])]),t("p",[e._v("After installing acme.sh and obtaining the CloudFlare API key, we need to then generate a certificate. First, input the CloudFlare API credentials.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("CF_Key")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Your_CloudFlare_API_Key"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("CF_Email")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Your_CloudFlare_Email"')]),e._v("\n")])])]),t("p",[e._v("Then create the certificate. Since the API key is bound to the domain, Cloudflare should allow you to generate one.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("acme.sh "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--issue")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--dns")]),e._v(" dns_cf "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-d")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"example.com"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--server")]),e._v(" letsencrypt "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n--key-file /etc/letsencrypt/live/example.com/privkey.pem "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n--fullchain-file /etc/letsencrypt/live/example.com/fullchain.pem\n")])])]),t("h3",{attrs:{id:"auto-renewal-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#auto-renewal-2"}},[e._v("#")]),e._v(" Auto Renewal")]),e._v(" "),t("p",[e._v("After running the script for the first time, it will be added to the crontab automatically. You may edit the auto-renewal interval by editing the crontab.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("crontab")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-e")]),e._v("\n")])])])]),e._v(" "),t("tab",{attrs:{name:"Method 3: Caddy (using Cloudflare API)"}},[t("p",[e._v("This is for advanced users, who are running Cloudflare in proxy mode or do not have access to port "),t("code",[e._v("80")]),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"installing-caddy-with-cloudflare-dns-plugin"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installing-caddy-with-cloudflare-dns-plugin"}},[e._v("#")]),e._v(" Installing Caddy with Cloudflare DNS plugin")]),e._v(" "),t("p",[e._v("Caddy does not come by default with Cloudflare DNS plugin, you need to install it yourself.")]),e._v(" "),t("p",[e._v("There are two main methods:")]),e._v(" "),t("ol",[t("li",[e._v("Using "),t("code",[e._v("xcaddy")]),e._v(" - CLI tool to build your own Caddy build")]),e._v(" "),t("li",[e._v("Downloading prebuilt binary from "),t("a",{attrs:{href:"https://caddyserver.com/download",target:"_blank",rel:"noopener noreferrer"}},[e._v("Caddy's download page"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[e._v("Using Ansible to download and install Caddy with plugins. See "),t("a",{attrs:{href:"https://github.com/caddy-ansible/caddy-ansible",target:"_blank",rel:"noopener noreferrer"}},[e._v("caddy-ansible"),t("OutboundLink")],1)])]),e._v(" "),t("h4",{attrs:{id:"build-caddy-using-xcaddy-on-your-server"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#build-caddy-using-xcaddy-on-your-server"}},[e._v("#")]),e._v(" Build Caddy using "),t("code",[e._v("xcaddy")]),e._v(" on your server")]),e._v(" "),t("p",[e._v("Please refer to "),t("a",{attrs:{href:"https://caddyserver.com/docs/build#xcaddy",target:"_blank",rel:"noopener noreferrer"}},[e._v("Caddy docs on building Caddy"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"obtaining-cloudflare-api-token"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#obtaining-cloudflare-api-token"}},[e._v("#")]),e._v(" Obtaining CloudFlare API Token")]),e._v(" "),t("p",[e._v('After installing acme.sh, we need to fetch a CloudFlare API key. Please make sure that a DNS record (A or CNAME record) is pointing to your target node, and set the cloud to grey (bypassing CloudFlare proxy). Then go to My Profile > API keys and on Global API Key subtab, click on "view", enter your CloudFlare password, and copy the API key to clipboard.')]),e._v(" "),t("p",[e._v('After install Caddy with Cloudflare DNS plugin, we need to fetch a Cloudflare API token. Please make sure that a DNS record (A or CNAME record) is pointing at your target node. Then go to My Profile > API Tokens and on API Tokens click "Create Token". Create API Token > API token templates, at the end of line with "Edit zone DNS", click "Use template". Under '),t("strong",[e._v("Zone Resources")]),e._v(', select your DNS zone for which you wish to create the API token, click "Continue to summary". Review the API token summary and click "Create Token". And finally copy the API token to clipboard.')]),e._v(" "),t("h3",{attrs:{id:"reconfiguring-caddy-to-use-cloudflare-dns-for-obtaining-certificates"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#reconfiguring-caddy-to-use-cloudflare-dns-for-obtaining-certificates"}},[e._v("#")]),e._v(" Reconfiguring Caddy to use Cloudflare DNS for obtaining certificates")]),e._v(" "),t("p",[e._v("Create an environment variable file (like "),t("code",[e._v(".env")]),e._v("), keep in mind that this file contains secrets and should not be accessed by public.")]),e._v(" "),t("p",[e._v("We recommend that you create the secret file in the following location: "),t("code",[e._v("/etc/caddy/.secrets.env")]),e._v(".")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("CLOUDFLARE_API_TOKEN")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("your cloudflare api token"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v("\n")])])]),t("p",[e._v("For security reasons, we recommend setting permissions to "),t("code",[e._v("0600")]),e._v(" (only owner can read or write to the file).")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Set ownership of the `.secrets.env` file to `caddy` system user")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("chown")]),e._v(" caddy:caddy /etc/caddy/.secrets.env\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Set read-write permissions only to owner - the `caddy` system user")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("chmod")]),e._v(" 0600 /etc/caddy/.secrets.env\n")])])]),t("p",[e._v("Modify the systemd unit file, to load environment variables from file (add "),t("code",[e._v("--envfile /etc/caddy/.secrets.env")]),e._v(" flag to "),t("code",[e._v("ExecStart")]),e._v("), the default systemd unit file location is "),t("code",[e._v("/etc/systemd/system/caddy.service")]),e._v(":")]),e._v(" "),t("div",{staticClass:"language-unit extra-class"},[t("div",{staticClass:"highlight-lines"},[t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("div",{staticClass:"highlighted"},[e._v(" ")]),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br")]),t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("[Unit]\nDescription=Caddy\nDocumentation=https://caddyserver.com/docs/\nAfter=network.target network-online.target\nRequires=network-online.target\n\n[Service]\nType=notify\nUser=caddy\nGroup=caddy\nExecStart=/usr/bin/caddy run --environ --envfile /etc/caddy/.secrets.env --config /etc/caddy/Caddyfile\nExecReload=/usr/bin/caddy reload --config /etc/caddy/Caddyfile\nTimeoutStopSec=5s\nLimitNOFILE=1048576\nLimitNPROC=512\nPrivateTmp=true\nProtectSystem=full\nAmbientCapabilities=CAP_NET_BIND_SERVICE\n\n[Install]\nWantedBy=multi-user.target\n")])])]),t("p",[e._v("You can add a "),t("code",[e._v("tls")]),e._v(" block to your "),t("code",[e._v("Caddyfile")]),e._v(", under the "),t("code",[e._v("")]),e._v(" block of your panel configuration, the Caddy config file location is "),t("code",[e._v("/etc/caddy/Caddyfile")]),e._v(":")]),e._v(" "),t("div",{staticClass:"language-caddyfile extra-class"},[t("div",{staticClass:"highlight-lines"},[t("br"),t("br"),t("br"),t("br"),t("div",{staticClass:"highlighted"},[e._v(" ")]),t("div",{staticClass:"highlighted"},[e._v(" ")]),t("div",{staticClass:"highlighted"},[e._v(" ")]),t("br")]),t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v(" {\n # ...\n\n tls {\n dns cloudflare {env.CLOUDFLARE_API_TOKEN}\n }\n}\n")])])])])],1)],1)}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[68],{328:function(e,t,a){"use strict";a.r(t);var s=a(15),r=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"creating-ssl-certificates"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#creating-ssl-certificates"}},[e._v("#")]),e._v(" Creating SSL Certificates")]),e._v(" "),t("p",[e._v("This tutorial briefly covers creating new SSL certificates for your panel and wings.")]),e._v(" "),t("tabs",[t("tab",{attrs:{name:"Method 1: Certbot"}},[t("p",[e._v("To begin, we will install certbot, a simple script that automatically renews our certificates and allows much\neasier creation of them. The command below is for Ubuntu distributions, but you can always check "),t("a",{attrs:{href:"https://certbot.eff.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Certbot's official\nsite"),t("OutboundLink")],1),e._v(" for installation instructions. We have also included a command below to install certbot's\nNginx/Apache plugin so you won't have to stop your webserver.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" update\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-y")]),e._v(" certbot\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Run this if you use Nginx")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-y")]),e._v(" python3-certbot-nginx\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Run this if you use Apache")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("apt")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("install")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-y")]),e._v(" python3-certbot-apache\n")])])]),t("h2",{attrs:{id:"creating-a-certificate"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#creating-a-certificate"}},[e._v("#")]),e._v(" Creating a Certificate")]),e._v(" "),t("p",[e._v("After installing the certbot, we need to generate a certificate. There are a couple of ways to do that, but the easiest\nis to use the web server-specific certbot plugin you just installed. For Wings-only machines that don't need a web server, use the standalone or DNS method of the certbot as you don't need a web server for it.")]),e._v(" "),t("p",[e._v("Then, in the command below, you should replace "),t("code",[e._v("example.com")]),e._v(" with the domain you would like to generate a certificate\nfor. When you have multiple domains you would like certificates for, simply add more "),t("code",[e._v("-d anotherdomain.com")]),e._v(" flags to the\ncommand. You can also look into generating a wildcard certificate but that is not covered in this tutorial.")]),e._v(" "),t("p",[e._v("When you are using certbot's Nginx/Apache plugin, you won't need to restart your webserver to have the certificate\napplied assuming that you've already configured the webservers to use SSL as instructed in the "),t("a",{attrs:{href:"https://pterodactyl.io/panel/1.0/webserver_configuration.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("web server configuration step"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"http-challenge"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#http-challenge"}},[e._v("#")]),e._v(" HTTP challenge")]),e._v(" "),t("p",[e._v("HTTP challenge requires you to expose port 80 for the challenge verification.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Nginx")]),e._v("\ncertbot certonly "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--nginx")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-d")]),e._v(" example.com\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Apache")]),e._v("\ncertbot certonly "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--apache")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-d")]),e._v(" example.com\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Standalone - Use this if neither works. Make sure to stop your webserver first when using this method.")]),e._v("\ncertbot certonly "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--standalone")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-d")]),e._v(" example.com\n")])])]),t("h3",{attrs:{id:"dns-challenge"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dns-challenge"}},[e._v("#")]),e._v(" DNS challenge")]),e._v(" "),t("p",[e._v("DNS challenge requires you to create a new TXT DNS record to verify domain ownership, instead of having to expose port 80. The instructions are displayed when you run the certbot command below.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("certbot "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-d")]),e._v(" example.com "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--manual")]),e._v(" --preferred-challenges dns certonly\n")])])]),t("h3",{attrs:{id:"auto-renewal"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#auto-renewal"}},[e._v("#")]),e._v(" Auto Renewal")]),e._v(" "),t("p",[e._v("You'll also probably want to configure the automatic renewal of certificates to prevent unexpected certificate expirations.\nYou can open crontab with "),t("code",[e._v("sudo crontab -e")]),e._v(" and add the line from below to the bottom of it for attempting renewal every day at 23 (11 PM).")]),e._v(" "),t("p",[e._v("Deploy hook would restart the Nginx service to apply a new certificate when it's renewed successfully. Change "),t("code",[e._v("nginx")]),e._v(" in the restart command to suit your own needs, such as to "),t("code",[e._v("apache")]),e._v(" or "),t("code",[e._v("wings")]),e._v(".")]),e._v(" "),t("p",[e._v("For advanced users, we suggest installing and using "),t("a",{attrs:{href:"https://acme.sh",target:"_blank",rel:"noopener noreferrer"}},[e._v("acme.sh"),t("OutboundLink")],1),e._v("\nwhich provides more options, and is much more powerful than certbot.")]),e._v(" "),t("div",{staticClass:"language-text extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('0 23 * * * certbot renew --quiet --deploy-hook "systemctl restart nginx"\n')])])]),t("h3",{attrs:{id:"troubleshooting"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#troubleshooting"}},[e._v("#")]),e._v(" Troubleshooting")]),e._v(" "),t("p",[e._v("If you get an "),t("code",[e._v("Insecure Connection")]),e._v(" or SSL/TLS related error when trying to access your panel or wings, the certificate has likely expired.\nThis can be easily fixed by renewing the SSL certificate, although using the command "),t("code",[e._v("certbot renew")]),e._v(" might not do the job if port 80 is in use, as it'll return errors like: "),t("code",[e._v("Error: Attempting to renew cert (domain) from /etc/letsencrypt/renew/domain.conf produced an unexpected error")]),e._v(".")]),e._v(" "),t("p",[e._v("This will happen especially if you're running Nginx instead of Apache. The solution for this is to use Nginx or Apache plugins with "),t("code",[e._v("--nginx")]),e._v(" and "),t("code",[e._v("--apache")]),e._v(". Alternatively, you can stop Nginx, then renew the certificate, and finally restart Nginx. Replace "),t("code",[e._v("nginx")]),e._v(" with your own web server or with "),t("code",[e._v("wings")]),e._v(" should you be renewing the certificate for Wings.")]),e._v(" "),t("p",[e._v("Stop Nginx:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("systemctl stop nginx\n")])])]),t("p",[e._v("Renew the certificate:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("certbot renew\n")])])]),t("p",[e._v("Once the process has completed, you can restart the Nginx service:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("systemctl start nginx\n")])])]),t("p",[e._v("You may also need to restart Wings as not every service is able to automatically apply an updated certificate:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("systemctl restart wings\n")])])])]),e._v(" "),t("tab",{attrs:{name:"Method 2: acme.sh (using Cloudflare API)"}},[t("p",[e._v("This is for advanced users, whose server systems do not have access to port 80. The command below is for Ubuntu distributions and CloudFlare API (you may google for other APIs for other DNS providers), but you can always check "),t("a",{attrs:{href:"https://github.com/acmesh-official/acme.sh",target:"_blank",rel:"noopener noreferrer"}},[e._v("acme.sh's official site"),t("OutboundLink")],1),e._v(" for installation instructions. Make sure you read both instructions, as some people may have moved to CloudFlare's "),t("a",{attrs:{href:"https://blog.cloudflare.com/permissions-best-practices",target:"_blank",rel:"noopener noreferrer"}},[e._v("new authorization system"),t("OutboundLink")],1),e._v(" (Modern), but others "),t("a",{attrs:{href:"https://cloudflare.tv/event/ea8JJLgR",target:"_blank",rel:"noopener noreferrer"}},[e._v("have not"),t("OutboundLink")],1),e._v(" (Legacy).")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" https://get.acme.sh "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sh")]),e._v("\n")])])]),t("h3",{attrs:{id:"obtaining-cloudflare-api-key-legacy"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#obtaining-cloudflare-api-key-legacy"}},[e._v("#")]),e._v(" Obtaining CloudFlare API Key (Legacy)")]),e._v(" "),t("p",[e._v('After installing acme.sh, we need to fetch a CloudFlare API key. On Cloudfare\'s website, select your domain, then on the right side, copy your "Zone ID" and "Account ID" then click on "Get your API token", click on "Create Token" > select the template "Edit zone DNS" > select the scope of "Zone Resources" and then click on "Continue to summary", copy your token.')]),e._v(" "),t("h3",{attrs:{id:"creating-a-certificate-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#creating-a-certificate-2"}},[e._v("#")]),e._v(" Creating a Certificate")]),e._v(" "),t("p",[e._v("Since the configuration file is based on Certbot, we need to create the folder manually.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("mkdir")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-p")]),e._v(" /etc/letsencrypt/live/example.com\n")])])]),t("p",[e._v("After installing acme.sh and obtaining CloudFlare API key, we need to then generate a certificate. First, input the CloudFlare API credentials.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("CF_Token")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Your_CloudFlare_API_Key"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("CF_Account_ID")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Your_CloudFlare_Account_ID"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("CF_Zone_ID")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Your_CloudFlare_Zone_ID"')]),e._v("\n")])])]),t("h3",{attrs:{id:"obtaining-cloudflare-api-key-modern"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#obtaining-cloudflare-api-key-modern"}},[e._v("#")]),e._v(" Obtaining CloudFlare API Key (Modern)")]),e._v(" "),t("p",[e._v('After installing acme.sh, we need to fetch a CloudFlare API key. On Cloudfare\'s website, click on your profile on the top right. Then go to "My Profile", on the left you will find "API Tokens". Click it and it\'ll bring you to '),t("a",{attrs:{href:"https://dash.cloudflare.com/profile/api-tokens",target:"_blank",rel:"noopener noreferrer"}},[e._v("the API tokens page"),t("OutboundLink")],1),e._v('. Select "Create Token" and use the "Edit zone DNS" template. Then once on the next page, go to "Zone Resources" and "Include" - "Specific Zone" - (Select the domain you want to use). Then continue to the summary. Confirm you\'d like to create the token.')]),e._v(" "),t("h3",{attrs:{id:"creating-a-certificate-3"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#creating-a-certificate-3"}},[e._v("#")]),e._v(" Creating a Certificate")]),e._v(" "),t("p",[e._v("Since the configuration file is based on Certbot, we need to create the folder manually.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("mkdir")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-p")]),e._v(" /etc/letsencrypt/live/example.com\n")])])]),t("p",[e._v("After installing acme.sh and obtaining the CloudFlare API key, we need to then generate a certificate. First, input the CloudFlare API credentials.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("CF_Key")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Your_CloudFlare_API_Key"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("CF_Email")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Your_CloudFlare_Email"')]),e._v("\n")])])]),t("p",[e._v("Then create the certificate. Since the API key is bound to the domain, Cloudflare should allow you to generate one.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("acme.sh "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--issue")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--dns")]),e._v(" dns_cf "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-d")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"example.com"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("--server")]),e._v(" letsencrypt "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n--key-file /etc/letsencrypt/live/example.com/privkey.pem "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n--fullchain-file /etc/letsencrypt/live/example.com/fullchain.pem\n")])])]),t("h3",{attrs:{id:"auto-renewal-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#auto-renewal-2"}},[e._v("#")]),e._v(" Auto Renewal")]),e._v(" "),t("p",[e._v("After running the script for the first time, it will be added to the crontab automatically. You may edit the auto-renewal interval by editing the crontab.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("crontab")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token parameter variable"}},[e._v("-e")]),e._v("\n")])])])]),e._v(" "),t("tab",{attrs:{name:"Method 3: Caddy (using Cloudflare API)"}},[t("p",[e._v("This is for advanced users, who are running Cloudflare in proxy mode or do not have access to port "),t("code",[e._v("80")]),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"installing-caddy-with-cloudflare-dns-plugin"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installing-caddy-with-cloudflare-dns-plugin"}},[e._v("#")]),e._v(" Installing Caddy with Cloudflare DNS plugin")]),e._v(" "),t("p",[e._v("Caddy does not come by default with Cloudflare DNS plugin, you need to install it yourself.")]),e._v(" "),t("p",[e._v("There are two main methods:")]),e._v(" "),t("ol",[t("li",[e._v("Using "),t("code",[e._v("xcaddy")]),e._v(" - CLI tool to build your own Caddy build")]),e._v(" "),t("li",[e._v("Downloading prebuilt binary from "),t("a",{attrs:{href:"https://caddyserver.com/download",target:"_blank",rel:"noopener noreferrer"}},[e._v("Caddy's download page"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[e._v("Using Ansible to download and install Caddy with plugins. See "),t("a",{attrs:{href:"https://github.com/caddy-ansible/caddy-ansible",target:"_blank",rel:"noopener noreferrer"}},[e._v("caddy-ansible"),t("OutboundLink")],1)])]),e._v(" "),t("h4",{attrs:{id:"build-caddy-using-xcaddy-on-your-server"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#build-caddy-using-xcaddy-on-your-server"}},[e._v("#")]),e._v(" Build Caddy using "),t("code",[e._v("xcaddy")]),e._v(" on your server")]),e._v(" "),t("p",[e._v("Please refer to "),t("a",{attrs:{href:"https://caddyserver.com/docs/build#xcaddy",target:"_blank",rel:"noopener noreferrer"}},[e._v("Caddy docs on building Caddy"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"obtaining-cloudflare-api-token"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#obtaining-cloudflare-api-token"}},[e._v("#")]),e._v(" Obtaining CloudFlare API Token")]),e._v(" "),t("p",[e._v('After installing acme.sh, we need to fetch a CloudFlare API key. Please make sure that a DNS record (A or CNAME record) is pointing to your target node, and set the cloud to grey (bypassing CloudFlare proxy). Then go to My Profile > API keys and on Global API Key subtab, click on "view", enter your CloudFlare password, and copy the API key to clipboard.')]),e._v(" "),t("p",[e._v('After install Caddy with Cloudflare DNS plugin, we need to fetch a Cloudflare API token. Please make sure that a DNS record (A or CNAME record) is pointing at your target node. Then go to My Profile > API Tokens and on API Tokens click "Create Token". Create API Token > API token templates, at the end of line with "Edit zone DNS", click "Use template". Under '),t("strong",[e._v("Zone Resources")]),e._v(', select your DNS zone for which you wish to create the API token, click "Continue to summary". Review the API token summary and click "Create Token". And finally copy the API token to clipboard.')]),e._v(" "),t("h3",{attrs:{id:"reconfiguring-caddy-to-use-cloudflare-dns-for-obtaining-certificates"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#reconfiguring-caddy-to-use-cloudflare-dns-for-obtaining-certificates"}},[e._v("#")]),e._v(" Reconfiguring Caddy to use Cloudflare DNS for obtaining certificates")]),e._v(" "),t("p",[e._v("Create an environment variable file (like "),t("code",[e._v(".env")]),e._v("), keep in mind that this file contains secrets and should not be accessed by public.")]),e._v(" "),t("p",[e._v("We recommend that you create the secret file in the following location: "),t("code",[e._v("/etc/caddy/.secrets.env")]),e._v(".")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("CLOUDFLARE_API_TOKEN")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("your cloudflare api token"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v("\n")])])]),t("p",[e._v("For security reasons, we recommend setting permissions to "),t("code",[e._v("0600")]),e._v(" (only owner can read or write to the file).")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Set ownership of the `.secrets.env` file to `caddy` system user")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("chown")]),e._v(" caddy:caddy /etc/caddy/.secrets.env\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Set read-write permissions only to owner - the `caddy` system user")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("chmod")]),e._v(" 0600 /etc/caddy/.secrets.env\n")])])]),t("p",[e._v("Modify the systemd unit file, to load environment variables from file (add "),t("code",[e._v("--envfile /etc/caddy/.secrets.env")]),e._v(" flag to "),t("code",[e._v("ExecStart")]),e._v("), the default systemd unit file location is "),t("code",[e._v("/etc/systemd/system/caddy.service")]),e._v(":")]),e._v(" "),t("div",{staticClass:"language-unit extra-class"},[t("div",{staticClass:"highlight-lines"},[t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("div",{staticClass:"highlighted"},[e._v(" ")]),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br"),t("br")]),t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("[Unit]\nDescription=Caddy\nDocumentation=https://caddyserver.com/docs/\nAfter=network.target network-online.target\nRequires=network-online.target\n\n[Service]\nType=notify\nUser=caddy\nGroup=caddy\nExecStart=/usr/bin/caddy run --environ --envfile /etc/caddy/.secrets.env --config /etc/caddy/Caddyfile\nExecReload=/usr/bin/caddy reload --config /etc/caddy/Caddyfile\nTimeoutStopSec=5s\nLimitNOFILE=1048576\nLimitNPROC=512\nPrivateTmp=true\nProtectSystem=full\nAmbientCapabilities=CAP_NET_BIND_SERVICE\n\n[Install]\nWantedBy=multi-user.target\n")])])]),t("p",[e._v("You can add a "),t("code",[e._v("tls")]),e._v(" block to your "),t("code",[e._v("Caddyfile")]),e._v(", under the "),t("code",[e._v("")]),e._v(" block of your panel configuration, the Caddy config file location is "),t("code",[e._v("/etc/caddy/Caddyfile")]),e._v(":")]),e._v(" "),t("div",{staticClass:"language-caddyfile extra-class"},[t("div",{staticClass:"highlight-lines"},[t("br"),t("br"),t("br"),t("br"),t("div",{staticClass:"highlighted"},[e._v(" ")]),t("div",{staticClass:"highlighted"},[e._v(" ")]),t("div",{staticClass:"highlighted"},[e._v(" ")]),t("br")]),t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v(" {\n # ...\n\n tls {\n dns cloudflare {env.CLOUDFLARE_API_TOKEN}\n }\n}\n")])])])])],1)],1)}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/70.cbd191fe.js b/assets/js/70.d1a2a03a.js similarity index 99% rename from assets/js/70.cbd191fe.js rename to assets/js/70.d1a2a03a.js index 83b8d13f..d5df3cca 100644 --- a/assets/js/70.cbd191fe.js +++ b/assets/js/70.d1a2a03a.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[70],{331:function(t,e,a){"use strict";a.r(e);var s=a(15),r=Object(s.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"additional-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#additional-configuration"}},[t._v("#")]),t._v(" Additional Configuration")]),t._v(" "),e("p"),e("div",{staticClass:"table-of-contents"},[e("ul",[e("li",[e("a",{attrs:{href:"#private-registries"}},[t._v("Private Registries")]),e("ul",[e("li",[e("a",{attrs:{href:"#available-keys"}},[t._v("Available Keys")])]),e("li",[e("a",{attrs:{href:"#example-of-usage"}},[t._v("Example of usage")])])])]),e("li",[e("a",{attrs:{href:"#custom-network-interfaces"}},[t._v("Custom Network Interfaces")]),e("ul",[e("li",[e("a",{attrs:{href:"#example-of-usage"}},[t._v("Example of usage")])])])]),e("li",[e("a",{attrs:{href:"#enabling-cloudflare-proxy"}},[t._v("Enabling Cloudflare proxy")])]),e("li",[e("a",{attrs:{href:"#container-pid-limit"}},[t._v("Container PID Limit")]),e("ul",[e("li",[e("a",{attrs:{href:"#example-of-usage"}},[t._v("Example of usage")])])])]),e("li",[e("a",{attrs:{href:"#throttles-limits"}},[t._v("Throttles Limits")]),e("ul",[e("li",[e("a",{attrs:{href:"#example-of-usage"}},[t._v("Example of usage")])])])]),e("li",[e("a",{attrs:{href:"#installer-limits"}},[t._v("Installer Limits")]),e("ul",[e("li",[e("a",{attrs:{href:"#example-of-usage"}},[t._v("Example of usage")])])])]),e("li",[e("a",{attrs:{href:"#other-values"}},[t._v("Other values")])])])]),e("p"),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),e("p",[t._v("These are advanced configurations for Wings. You risk breaking Wings and making containers unusable if\nyou misconfigure something. Proceed only if you know what each configuration value does.")])]),t._v(" "),e("p",[t._v("You must apply all changes to your Wings "),e("code",[t._v("config.yml")]),t._v(" file located at "),e("code",[t._v("/etc/pterodactyl")]),t._v(" and restart wings. Verify your config file using "),e("a",{attrs:{href:"http://www.yamllint.com/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Yaml Lint"),e("OutboundLink")],1),t._v(" should you receive errors related to YAML parsing.")]),t._v(" "),e("h2",{attrs:{id:"private-registries"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#private-registries"}},[t._v("#")]),t._v(" Private Registries")]),t._v(" "),e("p",[t._v("You can use these settings to authenticate against (private) docker registries when pulling images.")]),t._v(" "),e("h3",{attrs:{id:"available-keys"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#available-keys"}},[t._v("#")]),t._v(" Available Keys")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Setting Key")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Default Value")]),t._v(" "),e("th",[t._v("Notes")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("name")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("null")]),t._v(" "),e("td",[t._v("Registry address")])]),t._v(" "),e("tr",[e("td",[t._v("username")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("null")]),t._v(" "),e("td",[t._v("Registry username")])]),t._v(" "),e("tr",[e("td",[t._v("password")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("null")]),t._v(" "),e("td",[t._v("Registry password")])])])]),t._v(" "),e("h3",{attrs:{id:"example-of-usage"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#example-of-usage"}},[t._v("#")]),t._v(" Example of usage")]),t._v(" "),e("div",{staticClass:"language-yml extra-class"},[e("pre",{pre:!0,attrs:{class:"language-yml"}},[e("code",[e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("docker")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("registries")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("registry.example.com")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("username")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"registryusername"')]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("password")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"registrypassword"')]),t._v("\n")])])]),e("h2",{attrs:{id:"custom-network-interfaces"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#custom-network-interfaces"}},[t._v("#")]),t._v(" Custom Network Interfaces")]),t._v(" "),e("p",[t._v("You can change the network interface that Wings uses for all containers by editing the network name; it is by default set to "),e("code",[t._v("pterodactyl_nw")]),t._v(". For example, to enable Docker host mode change the network name to "),e("code",[t._v("host")]),t._v(".")]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),e("p",[t._v("Changing network mode to "),e("code",[t._v("host")]),t._v(" grants Pterodactyl direct access to all machine interfaces and Panel users can bind to any IP or Port even if it's not allocated to their container. You will lose all benefits of Docker network isolation. It is not recommended for public installations that are hosting other users' servers.")])]),t._v(" "),e("h3",{attrs:{id:"example-of-usage-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#example-of-usage-2"}},[t._v("#")]),t._v(" Example of usage")]),t._v(" "),e("div",{staticClass:"language-yml extra-class"},[e("pre",{pre:!0,attrs:{class:"language-yml"}},[e("code",[e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("docker")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("network")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" host\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("network_mode")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" host\n")])])]),e("p",[t._v("After making changes, the following commands will stop the Wings, remove the Pterodactyl network, and start the Wings again. Run at your own risk.\n"),e("code",[t._v("systemctl stop wings && docker network rm pterodactyl_nw && systemctl start wings")])]),t._v(" "),e("h2",{attrs:{id:"enabling-cloudflare-proxy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#enabling-cloudflare-proxy"}},[t._v("#")]),t._v(" Enabling Cloudflare proxy")]),t._v(" "),e("p",[t._v("Cloudflare proxying of the Wings isn't beneficial since users will be connecting to the machine directly and bypassing any Cloudflare protection. As such, your Node machine IP will still be exposed.")]),t._v(" "),e("p",[t._v("To enable Cloudflare proxy, you must change the Wings port to one of the Cloudflare HTTPS ports with caching enabled (more info "),e("a",{attrs:{href:"https://developers.cloudflare.com/fundamentals/get-started/reference/network-ports/",target:"_blank",rel:"noopener noreferrer"}},[t._v("here"),e("OutboundLink")],1),t._v('), such as 8443, because Cloudflare only supports HTTP on port 8080. Select your Node in the Admin Panel, and on the settings tab, change the port. Make sure that you set "Not Behind Proxy" when using Full SSL settings in Cloudflare. Then on Cloudflare dashboard, your FQDN must have an orange cloud enabled beside it.')]),t._v(" "),e("p",[t._v("You are unable to proxy the SFTP port through Cloudflare unless you have their enterprise plan.")]),t._v(" "),e("h2",{attrs:{id:"container-pid-limit"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#container-pid-limit"}},[t._v("#")]),t._v(" Container PID Limit")]),t._v(" "),e("p",[t._v("You can change the total number of processes that can be active in a container at any given moment by changing the "),e("code",[t._v("container_pid_limit")]),t._v(" value. The default value is "),e("code",[t._v("512")]),t._v(".\nYou can set it to "),e("code",[t._v("0")]),t._v(" to disable the limit completely. However, this is "),e("em",[t._v("not")]),t._v(" recommended as the limit prevents malicious overloading of the node.\nRestart wings and your game server to apply the new limit.")]),t._v(" "),e("h3",{attrs:{id:"example-of-usage-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#example-of-usage-3"}},[t._v("#")]),t._v(" Example of usage")]),t._v(" "),e("div",{staticClass:"language-yml extra-class"},[e("pre",{pre:!0,attrs:{class:"language-yml"}},[e("code",[e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("docker")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("...")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("container_pid_limit")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("512")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("...")]),t._v("\n")])])]),e("h2",{attrs:{id:"throttles-limits"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#throttles-limits"}},[t._v("#")]),t._v(" Throttles Limits")]),t._v(" "),e("p",[t._v("You can use these settings to adjust or completely disable throttling.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Setting Key")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Default Value")]),t._v(" "),e("th",[t._v("Notes")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[t._v("enabled")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("true")]),t._v(" "),e("td",[t._v("Whether or not the throttler is enabled")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[t._v("lines")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("2000")]),t._v(" "),e("td",[t._v("Total lines that can be output in a given line_reset_interval period")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[t._v("maximum_trigger_count")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("5")]),t._v(" "),e("td",[t._v("Amount of times throttle limit can be triggered before the server will be stopped")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[t._v("line_reset_interval")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("100")]),t._v(" "),e("td",[t._v("The amount of time after which the number of lines processed is reset to 0")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[t._v("decay_interval")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("10000")]),t._v(" "),e("td",[t._v("Time in milliseconds that must pass without triggering throttle limit before trigger count is decremented")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[t._v("stop_grace_period")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("15")]),t._v(" "),e("td",[t._v("Time that a server is allowed to be stopping for before it is terminated forcefully if it triggers output throttle")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[t._v("write_limit")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("0")]),t._v(" "),e("td",[t._v("Impose I/O write limit for backups to the disk, 0 = unlimited. Value greater than 0 throttles write speed to the set value in MiB/s")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[t._v("download_limit")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("0")]),t._v(" "),e("td",[t._v("Impose a Network I/O read limit for archives, 0 = unlimited. Value greater than 0 throttles read speed to the set value in MiB/s")])])])]),t._v(" "),e("h3",{attrs:{id:"example-of-usage-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#example-of-usage-4"}},[t._v("#")]),t._v(" Example of usage")]),t._v(" "),e("div",{staticClass:"language-yml extra-class"},[e("pre",{pre:!0,attrs:{class:"language-yml"}},[e("code",[e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("throttles")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("enabled")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token boolean important"}},[t._v("true")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("lines")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("2000")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("maximum_trigger_count")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("line_reset_interval")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("decay_interval")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("10000")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("stop_grace_period")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("15")]),t._v("\n")])])]),e("h2",{attrs:{id:"installer-limits"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#installer-limits"}},[t._v("#")]),t._v(" Installer Limits")]),t._v(" "),e("p",[t._v("Defines the limits on the installer containers that prevents a server's installation process from unintentionally consuming more resources than expected. This is used in conjunction with the server's defined limits. Whichever value is higher will take precedence in the install containers.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Setting Key")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Default Value")]),t._v(" "),e("th",[t._v("Notes")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[t._v("memory")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("1024")]),t._v(" "),e("td",[t._v("The maximum amount of memory install container can use unless server memory limit is higher than this value")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[t._v("cpu")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("100")]),t._v(" "),e("td",[t._v("The maximum amount of cpu install container can use unless server cpu limit is higher than this value")])])])]),t._v(" "),e("h3",{attrs:{id:"example-of-usage-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#example-of-usage-5"}},[t._v("#")]),t._v(" Example of usage")]),t._v(" "),e("div",{staticClass:"language-yml extra-class"},[e("pre",{pre:!0,attrs:{class:"language-yml"}},[e("code",[e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("installer_limits")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("memory")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("1024")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("cpu")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),t._v("\n")])])]),e("h2",{attrs:{id:"other-values"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#other-values"}},[t._v("#")]),t._v(" Other values")]),t._v(" "),e("p",[t._v("More commonly discussed values. View all Wings config values and explanations in "),e("a",{attrs:{href:"https://github.com/pterodactyl/wings/tree/develop/config",target:"_blank",rel:"noopener noreferrer"}},[t._v("these two files."),e("OutboundLink")],1)]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Setting Key")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Default Value")]),t._v(" "),e("th",[t._v("Notes")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("debug")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("false")]),t._v(" "),e("td",[t._v("Force Wings to run in debug mode")])]),t._v(" "),e("tr",[e("td",[t._v("tmpfs_size")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("100")]),t._v(" "),e("td",[t._v("The size of the /tmp directory in MB when mounted into a container")])]),t._v(" "),e("tr",[e("td",[t._v("websocket_log_count")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("150")]),t._v(" "),e("td",[t._v("The number of lines to display in the console")])]),t._v(" "),e("tr",[e("td",[t._v("detect_clean_exit_as_crash")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("true")]),t._v(" "),e("td",[t._v("Mark server as crashed if it's stopped without user interaction, e.g., not pressing stop button")])]),t._v(" "),e("tr",[e("td",[t._v("(crash detection) timeout")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("60")]),t._v(" "),e("td",[t._v("Timeout between server crashes that will not cause the server to be automatically restarted")])]),t._v(" "),e("tr",[e("td",[t._v("app_name")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v('"Pterodactyl"')]),t._v(" "),e("td",[t._v("Changes the name of the daemon, shown in the panel's game console")])]),t._v(" "),e("tr",[e("td",[t._v("check_permissions_on_boot")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("true")]),t._v(" "),e("td",[t._v("Check all file permissions on each boot. Disable this when you have a very large amount of files and the server startup is hanging on checking permissions")])])])])])}),[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[70],{334:function(t,e,a){"use strict";a.r(e);var s=a(15),r=Object(s.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"additional-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#additional-configuration"}},[t._v("#")]),t._v(" Additional Configuration")]),t._v(" "),e("p"),e("div",{staticClass:"table-of-contents"},[e("ul",[e("li",[e("a",{attrs:{href:"#private-registries"}},[t._v("Private Registries")]),e("ul",[e("li",[e("a",{attrs:{href:"#available-keys"}},[t._v("Available Keys")])]),e("li",[e("a",{attrs:{href:"#example-of-usage"}},[t._v("Example of usage")])])])]),e("li",[e("a",{attrs:{href:"#custom-network-interfaces"}},[t._v("Custom Network Interfaces")]),e("ul",[e("li",[e("a",{attrs:{href:"#example-of-usage"}},[t._v("Example of usage")])])])]),e("li",[e("a",{attrs:{href:"#enabling-cloudflare-proxy"}},[t._v("Enabling Cloudflare proxy")])]),e("li",[e("a",{attrs:{href:"#container-pid-limit"}},[t._v("Container PID Limit")]),e("ul",[e("li",[e("a",{attrs:{href:"#example-of-usage"}},[t._v("Example of usage")])])])]),e("li",[e("a",{attrs:{href:"#throttles-limits"}},[t._v("Throttles Limits")]),e("ul",[e("li",[e("a",{attrs:{href:"#example-of-usage"}},[t._v("Example of usage")])])])]),e("li",[e("a",{attrs:{href:"#installer-limits"}},[t._v("Installer Limits")]),e("ul",[e("li",[e("a",{attrs:{href:"#example-of-usage"}},[t._v("Example of usage")])])])]),e("li",[e("a",{attrs:{href:"#other-values"}},[t._v("Other values")])])])]),e("p"),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),e("p",[t._v("These are advanced configurations for Wings. You risk breaking Wings and making containers unusable if\nyou misconfigure something. Proceed only if you know what each configuration value does.")])]),t._v(" "),e("p",[t._v("You must apply all changes to your Wings "),e("code",[t._v("config.yml")]),t._v(" file located at "),e("code",[t._v("/etc/pterodactyl")]),t._v(" and restart wings. Verify your config file using "),e("a",{attrs:{href:"http://www.yamllint.com/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Yaml Lint"),e("OutboundLink")],1),t._v(" should you receive errors related to YAML parsing.")]),t._v(" "),e("h2",{attrs:{id:"private-registries"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#private-registries"}},[t._v("#")]),t._v(" Private Registries")]),t._v(" "),e("p",[t._v("You can use these settings to authenticate against (private) docker registries when pulling images.")]),t._v(" "),e("h3",{attrs:{id:"available-keys"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#available-keys"}},[t._v("#")]),t._v(" Available Keys")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Setting Key")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Default Value")]),t._v(" "),e("th",[t._v("Notes")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("name")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("null")]),t._v(" "),e("td",[t._v("Registry address")])]),t._v(" "),e("tr",[e("td",[t._v("username")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("null")]),t._v(" "),e("td",[t._v("Registry username")])]),t._v(" "),e("tr",[e("td",[t._v("password")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("null")]),t._v(" "),e("td",[t._v("Registry password")])])])]),t._v(" "),e("h3",{attrs:{id:"example-of-usage"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#example-of-usage"}},[t._v("#")]),t._v(" Example of usage")]),t._v(" "),e("div",{staticClass:"language-yml extra-class"},[e("pre",{pre:!0,attrs:{class:"language-yml"}},[e("code",[e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("docker")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("registries")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("registry.example.com")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("username")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"registryusername"')]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("password")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"registrypassword"')]),t._v("\n")])])]),e("h2",{attrs:{id:"custom-network-interfaces"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#custom-network-interfaces"}},[t._v("#")]),t._v(" Custom Network Interfaces")]),t._v(" "),e("p",[t._v("You can change the network interface that Wings uses for all containers by editing the network name; it is by default set to "),e("code",[t._v("pterodactyl_nw")]),t._v(". For example, to enable Docker host mode change the network name to "),e("code",[t._v("host")]),t._v(".")]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),e("p",[t._v("Changing network mode to "),e("code",[t._v("host")]),t._v(" grants Pterodactyl direct access to all machine interfaces and Panel users can bind to any IP or Port even if it's not allocated to their container. You will lose all benefits of Docker network isolation. It is not recommended for public installations that are hosting other users' servers.")])]),t._v(" "),e("h3",{attrs:{id:"example-of-usage-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#example-of-usage-2"}},[t._v("#")]),t._v(" Example of usage")]),t._v(" "),e("div",{staticClass:"language-yml extra-class"},[e("pre",{pre:!0,attrs:{class:"language-yml"}},[e("code",[e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("docker")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("network")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("name")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" host\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("network_mode")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" host\n")])])]),e("p",[t._v("After making changes, the following commands will stop the Wings, remove the Pterodactyl network, and start the Wings again. Run at your own risk.\n"),e("code",[t._v("systemctl stop wings && docker network rm pterodactyl_nw && systemctl start wings")])]),t._v(" "),e("h2",{attrs:{id:"enabling-cloudflare-proxy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#enabling-cloudflare-proxy"}},[t._v("#")]),t._v(" Enabling Cloudflare proxy")]),t._v(" "),e("p",[t._v("Cloudflare proxying of the Wings isn't beneficial since users will be connecting to the machine directly and bypassing any Cloudflare protection. As such, your Node machine IP will still be exposed.")]),t._v(" "),e("p",[t._v("To enable Cloudflare proxy, you must change the Wings port to one of the Cloudflare HTTPS ports with caching enabled (more info "),e("a",{attrs:{href:"https://developers.cloudflare.com/fundamentals/get-started/reference/network-ports/",target:"_blank",rel:"noopener noreferrer"}},[t._v("here"),e("OutboundLink")],1),t._v('), such as 8443, because Cloudflare only supports HTTP on port 8080. Select your Node in the Admin Panel, and on the settings tab, change the port. Make sure that you set "Not Behind Proxy" when using Full SSL settings in Cloudflare. Then on Cloudflare dashboard, your FQDN must have an orange cloud enabled beside it.')]),t._v(" "),e("p",[t._v("You are unable to proxy the SFTP port through Cloudflare unless you have their enterprise plan.")]),t._v(" "),e("h2",{attrs:{id:"container-pid-limit"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#container-pid-limit"}},[t._v("#")]),t._v(" Container PID Limit")]),t._v(" "),e("p",[t._v("You can change the total number of processes that can be active in a container at any given moment by changing the "),e("code",[t._v("container_pid_limit")]),t._v(" value. The default value is "),e("code",[t._v("512")]),t._v(".\nYou can set it to "),e("code",[t._v("0")]),t._v(" to disable the limit completely. However, this is "),e("em",[t._v("not")]),t._v(" recommended as the limit prevents malicious overloading of the node.\nRestart wings and your game server to apply the new limit.")]),t._v(" "),e("h3",{attrs:{id:"example-of-usage-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#example-of-usage-3"}},[t._v("#")]),t._v(" Example of usage")]),t._v(" "),e("div",{staticClass:"language-yml extra-class"},[e("pre",{pre:!0,attrs:{class:"language-yml"}},[e("code",[e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("docker")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("...")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("container_pid_limit")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("512")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("...")]),t._v("\n")])])]),e("h2",{attrs:{id:"throttles-limits"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#throttles-limits"}},[t._v("#")]),t._v(" Throttles Limits")]),t._v(" "),e("p",[t._v("You can use these settings to adjust or completely disable throttling.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Setting Key")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Default Value")]),t._v(" "),e("th",[t._v("Notes")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[t._v("enabled")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("true")]),t._v(" "),e("td",[t._v("Whether or not the throttler is enabled")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[t._v("lines")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("2000")]),t._v(" "),e("td",[t._v("Total lines that can be output in a given line_reset_interval period")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[t._v("maximum_trigger_count")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("5")]),t._v(" "),e("td",[t._v("Amount of times throttle limit can be triggered before the server will be stopped")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[t._v("line_reset_interval")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("100")]),t._v(" "),e("td",[t._v("The amount of time after which the number of lines processed is reset to 0")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[t._v("decay_interval")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("10000")]),t._v(" "),e("td",[t._v("Time in milliseconds that must pass without triggering throttle limit before trigger count is decremented")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[t._v("stop_grace_period")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("15")]),t._v(" "),e("td",[t._v("Time that a server is allowed to be stopping for before it is terminated forcefully if it triggers output throttle")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[t._v("write_limit")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("0")]),t._v(" "),e("td",[t._v("Impose I/O write limit for backups to the disk, 0 = unlimited. Value greater than 0 throttles write speed to the set value in MiB/s")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[t._v("download_limit")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("0")]),t._v(" "),e("td",[t._v("Impose a Network I/O read limit for archives, 0 = unlimited. Value greater than 0 throttles read speed to the set value in MiB/s")])])])]),t._v(" "),e("h3",{attrs:{id:"example-of-usage-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#example-of-usage-4"}},[t._v("#")]),t._v(" Example of usage")]),t._v(" "),e("div",{staticClass:"language-yml extra-class"},[e("pre",{pre:!0,attrs:{class:"language-yml"}},[e("code",[e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("throttles")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("enabled")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token boolean important"}},[t._v("true")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("lines")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("2000")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("maximum_trigger_count")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("line_reset_interval")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("decay_interval")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("10000")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("stop_grace_period")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("15")]),t._v("\n")])])]),e("h2",{attrs:{id:"installer-limits"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#installer-limits"}},[t._v("#")]),t._v(" Installer Limits")]),t._v(" "),e("p",[t._v("Defines the limits on the installer containers that prevents a server's installation process from unintentionally consuming more resources than expected. This is used in conjunction with the server's defined limits. Whichever value is higher will take precedence in the install containers.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Setting Key")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Default Value")]),t._v(" "),e("th",[t._v("Notes")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[t._v("memory")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("1024")]),t._v(" "),e("td",[t._v("The maximum amount of memory install container can use unless server memory limit is higher than this value")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[t._v("cpu")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("100")]),t._v(" "),e("td",[t._v("The maximum amount of cpu install container can use unless server cpu limit is higher than this value")])])])]),t._v(" "),e("h3",{attrs:{id:"example-of-usage-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#example-of-usage-5"}},[t._v("#")]),t._v(" Example of usage")]),t._v(" "),e("div",{staticClass:"language-yml extra-class"},[e("pre",{pre:!0,attrs:{class:"language-yml"}},[e("code",[e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("installer_limits")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("memory")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("1024")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token key atrule"}},[t._v("cpu")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),t._v("\n")])])]),e("h2",{attrs:{id:"other-values"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#other-values"}},[t._v("#")]),t._v(" Other values")]),t._v(" "),e("p",[t._v("More commonly discussed values. View all Wings config values and explanations in "),e("a",{attrs:{href:"https://github.com/pterodactyl/wings/tree/develop/config",target:"_blank",rel:"noopener noreferrer"}},[t._v("these two files."),e("OutboundLink")],1)]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Setting Key")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Default Value")]),t._v(" "),e("th",[t._v("Notes")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("debug")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("false")]),t._v(" "),e("td",[t._v("Force Wings to run in debug mode")])]),t._v(" "),e("tr",[e("td",[t._v("tmpfs_size")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("100")]),t._v(" "),e("td",[t._v("The size of the /tmp directory in MB when mounted into a container")])]),t._v(" "),e("tr",[e("td",[t._v("websocket_log_count")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("150")]),t._v(" "),e("td",[t._v("The number of lines to display in the console")])]),t._v(" "),e("tr",[e("td",[t._v("detect_clean_exit_as_crash")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("true")]),t._v(" "),e("td",[t._v("Mark server as crashed if it's stopped without user interaction, e.g., not pressing stop button")])]),t._v(" "),e("tr",[e("td",[t._v("(crash detection) timeout")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("60")]),t._v(" "),e("td",[t._v("Timeout between server crashes that will not cause the server to be automatically restarted")])]),t._v(" "),e("tr",[e("td",[t._v("app_name")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v('"Pterodactyl"')]),t._v(" "),e("td",[t._v("Changes the name of the daemon, shown in the panel's game console")])]),t._v(" "),e("tr",[e("td",[t._v("check_permissions_on_boot")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("true")]),t._v(" "),e("td",[t._v("Check all file permissions on each boot. Disable this when you have a very large amount of files and the server startup is hanging on checking permissions")])])])])])}),[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/71.e6dd244d.js b/assets/js/71.023c6d55.js similarity index 97% rename from assets/js/71.e6dd244d.js rename to assets/js/71.023c6d55.js index c569fe37..fa2aa1b7 100644 --- a/assets/js/71.e6dd244d.js +++ b/assets/js/71.023c6d55.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[71],{334:function(t,s,a){"use strict";a.r(s);var e=a(15),r=Object(e.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"upgrading-wings"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#upgrading-wings"}},[t._v("#")]),t._v(" Upgrading Wings")]),t._v(" "),s("p",[t._v("Upgrading Wings is a painless process and should take less than a minute to complete.")]),t._v(" "),s("h2",{attrs:{id:"wings-version-requirements"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#wings-version-requirements"}},[t._v("#")]),t._v(" Wings Version Requirements")]),t._v(" "),s("p",[t._v("Each version of Pterodactyl Panel also has a corresponding minimum version of Wings that\nis required for it to run. Please see the chart below for how these versions line up. In\nmost cases your base Wings version should match that of your Panel.")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Panel Version")]),t._v(" "),s("th",[t._v("Wings Version")]),t._v(" "),s("th",[t._v("Supported")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("1.0.x")]),t._v(" "),s("td",[t._v("1.0.x")]),t._v(" "),s("td")]),t._v(" "),s("tr",[s("td",[t._v("1.1.x")]),t._v(" "),s("td",[t._v("1.1.x")]),t._v(" "),s("td")]),t._v(" "),s("tr",[s("td",[t._v("1.2.x")]),t._v(" "),s("td",[t._v("1.2.x")]),t._v(" "),s("td")]),t._v(" "),s("tr",[s("td",[t._v("1.3.x")]),t._v(" "),s("td",[t._v("1.3.x")]),t._v(" "),s("td")]),t._v(" "),s("tr",[s("td",[t._v("1.4.x")]),t._v(" "),s("td",[t._v("1.4.x")]),t._v(" "),s("td")]),t._v(" "),s("tr",[s("td",[t._v("1.5.x")]),t._v(" "),s("td",[t._v("1.4.x")]),t._v(" "),s("td")]),t._v(" "),s("tr",[s("td",[t._v("1.6.x")]),t._v(" "),s("td",[t._v("1.4.x")]),t._v(" "),s("td")]),t._v(" "),s("tr",[s("td",[t._v("1.7.x")]),t._v(" "),s("td",[t._v("1.5.x")]),t._v(" "),s("td")]),t._v(" "),s("tr",[s("td",[t._v("1.8.x")]),t._v(" "),s("td",[t._v("1.6.x")]),t._v(" "),s("td")]),t._v(" "),s("tr",[s("td",[t._v("1.9.x")]),t._v(" "),s("td",[t._v("1.6.x")]),t._v(" "),s("td")]),t._v(" "),s("tr",[s("td",[t._v("1.10.x")]),t._v(" "),s("td",[t._v("1.7.x")]),t._v(" "),s("td")]),t._v(" "),s("tr",[s("td",[s("strong",[t._v("1.11.x")])]),t._v(" "),s("td",[s("strong",[t._v("1.11.x")])]),t._v(" "),s("td",[t._v("✅")])])])]),t._v(" "),s("p",[s("em",[t._v("NOTE: There are no 1.8.x, 1.9.x, or 1.10.x releases of Wings.")])]),t._v(" "),s("h2",{attrs:{id:"download-updated-binary"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#download-updated-binary"}},[t._v("#")]),t._v(" Download Updated Binary")]),t._v(" "),s("p",[t._v("First, download the updated wings binary into "),s("code",[t._v("/usr/local/bin")]),t._v(". You will need to stop Wings briefly. "),s("em",[t._v("Your running\nservers "),s("strong",[t._v("will not")]),t._v(" be affected.")])]),t._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[t._v("systemctl stop wings\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-L")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-o")]),t._v(" /usr/local/bin/wings "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://github.com/pterodactyl/wings/releases/latest/download/wings_linux_$([[ "'),s("span",{pre:!0,attrs:{class:"token variable"}},[s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$(")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("uname")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-m")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v(")")])]),t._v('"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("==")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"x86_64"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("&&")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("echo")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"amd64"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("echo")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"arm64"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v('"\n'),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("chmod")]),t._v(" u+x /usr/local/bin/wings\n")])])]),s("h2",{attrs:{id:"restart-process"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#restart-process"}},[t._v("#")]),t._v(" Restart Process")]),t._v(" "),s("p",[t._v("Finally, restart the wings process. Your running servers will not be affected and any open\nconnections to the instance will re-connect automatically.")]),t._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[t._v("systemctl restart wings\n")])])])])}),[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[71],{333:function(t,s,a){"use strict";a.r(s);var e=a(15),r=Object(e.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"upgrading-wings"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#upgrading-wings"}},[t._v("#")]),t._v(" Upgrading Wings")]),t._v(" "),s("p",[t._v("Upgrading Wings is a painless process and should take less than a minute to complete.")]),t._v(" "),s("h2",{attrs:{id:"wings-version-requirements"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#wings-version-requirements"}},[t._v("#")]),t._v(" Wings Version Requirements")]),t._v(" "),s("p",[t._v("Each version of Pterodactyl Panel also has a corresponding minimum version of Wings that\nis required for it to run. Please see the chart below for how these versions line up. In\nmost cases your base Wings version should match that of your Panel.")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Panel Version")]),t._v(" "),s("th",[t._v("Wings Version")]),t._v(" "),s("th",[t._v("Supported")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("1.0.x")]),t._v(" "),s("td",[t._v("1.0.x")]),t._v(" "),s("td")]),t._v(" "),s("tr",[s("td",[t._v("1.1.x")]),t._v(" "),s("td",[t._v("1.1.x")]),t._v(" "),s("td")]),t._v(" "),s("tr",[s("td",[t._v("1.2.x")]),t._v(" "),s("td",[t._v("1.2.x")]),t._v(" "),s("td")]),t._v(" "),s("tr",[s("td",[t._v("1.3.x")]),t._v(" "),s("td",[t._v("1.3.x")]),t._v(" "),s("td")]),t._v(" "),s("tr",[s("td",[t._v("1.4.x")]),t._v(" "),s("td",[t._v("1.4.x")]),t._v(" "),s("td")]),t._v(" "),s("tr",[s("td",[t._v("1.5.x")]),t._v(" "),s("td",[t._v("1.4.x")]),t._v(" "),s("td")]),t._v(" "),s("tr",[s("td",[t._v("1.6.x")]),t._v(" "),s("td",[t._v("1.4.x")]),t._v(" "),s("td")]),t._v(" "),s("tr",[s("td",[t._v("1.7.x")]),t._v(" "),s("td",[t._v("1.5.x")]),t._v(" "),s("td")]),t._v(" "),s("tr",[s("td",[t._v("1.8.x")]),t._v(" "),s("td",[t._v("1.6.x")]),t._v(" "),s("td")]),t._v(" "),s("tr",[s("td",[t._v("1.9.x")]),t._v(" "),s("td",[t._v("1.6.x")]),t._v(" "),s("td")]),t._v(" "),s("tr",[s("td",[t._v("1.10.x")]),t._v(" "),s("td",[t._v("1.7.x")]),t._v(" "),s("td")]),t._v(" "),s("tr",[s("td",[s("strong",[t._v("1.11.x")])]),t._v(" "),s("td",[s("strong",[t._v("1.11.x")])]),t._v(" "),s("td",[t._v("✅")])])])]),t._v(" "),s("p",[s("em",[t._v("NOTE: There are no 1.8.x, 1.9.x, or 1.10.x releases of Wings.")])]),t._v(" "),s("h2",{attrs:{id:"download-updated-binary"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#download-updated-binary"}},[t._v("#")]),t._v(" Download Updated Binary")]),t._v(" "),s("p",[t._v("First, download the updated wings binary into "),s("code",[t._v("/usr/local/bin")]),t._v(". You will need to stop Wings briefly. "),s("em",[t._v("Your running\nservers "),s("strong",[t._v("will not")]),t._v(" be affected.")])]),t._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[t._v("systemctl stop wings\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("curl")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-L")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-o")]),t._v(" /usr/local/bin/wings "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://github.com/pterodactyl/wings/releases/latest/download/wings_linux_$([[ "'),s("span",{pre:!0,attrs:{class:"token variable"}},[s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$(")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("uname")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token parameter variable"}},[t._v("-m")]),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v(")")])]),t._v('"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("==")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"x86_64"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("&&")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("echo")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"amd64"')]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("echo")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"arm64"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v('"\n'),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("chmod")]),t._v(" u+x /usr/local/bin/wings\n")])])]),s("h2",{attrs:{id:"restart-process"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#restart-process"}},[t._v("#")]),t._v(" Restart Process")]),t._v(" "),s("p",[t._v("Finally, restart the wings process. Your running servers will not be affected and any open\nconnections to the instance will re-connect automatically.")]),t._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[t._v("systemctl restart wings\n")])])])])}),[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/9.3e9e31a6.js b/assets/js/9.90f962cd.js similarity index 99% rename from assets/js/9.3e9e31a6.js rename to assets/js/9.90f962cd.js index dea25ca2..b0032e75 100644 --- a/assets/js/9.3e9e31a6.js +++ b/assets/js/9.90f962cd.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[9],{257:function(e,t,a){e.exports=a.p+"assets/img/Pterodactyl_Create_New_Egg_Process_Management.516b5b6f.png"},265:function(e,t,a){e.exports=a.p+"assets/img/Pterodactyl_Create_New_Egg_Select.5a2867ee.png"},266:function(e,t,a){e.exports=a.p+"assets/img/Pterodactyl_Create_New_Egg_Copy_Settings_From.e3102cdd.png"},267:function(e,t,a){e.exports=a.p+"assets/img/Pterodactyl_Create_New_Egg_Variables.3962b264.png"},268:function(e,t,a){e.exports=a.p+"assets/img/Pterodactyl_Create_New_Egg_Startup.b6e22637.png"},286:function(e,t,a){"use strict";a.r(t);var s=a(15),n=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"creating-a-custom-egg"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#creating-a-custom-egg"}},[e._v("#")]),e._v(" Creating a Custom Egg")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("You should not edit existing services or options that ship with the Panel. Each upgrade we push can make minor\nchanges to these, and you'll lose any changes you've made.")])]),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#create-new-option"}},[e._v("Create New Option")])]),t("li",[t("a",{attrs:{href:"#configure-process-management"}},[e._v("Configure Process Management")]),t("ul",[t("li",[t("a",{attrs:{href:"#stop-command"}},[e._v("Stop Command")])]),t("li",[t("a",{attrs:{href:"#log-storage"}},[e._v("Log Storage")])]),t("li",[t("a",{attrs:{href:"#configuration-files"}},[e._v("Configuration Files")])]),t("li",[t("a",{attrs:{href:"#start-configuration"}},[e._v("Start Configuration")])])])]),t("li",[t("a",{attrs:{href:"#copy-settings-from"}},[e._v("Copy Settings From")])]),t("li",[t("a",{attrs:{href:"#egg-variables"}},[e._v("Egg Variables")])]),t("li",[t("a",{attrs:{href:"#list-of-default-variables"}},[e._v("List of default variables")])])])]),t("p"),e._v(" "),t("p",[e._v("The first thing you'll need to do is create a new service. In this case, the name and description speak for themselves.\nThe "),t("code",[e._v("Folder Name")]),e._v(" "),t("em",[e._v("must be a unique name")]),e._v(" not being used by any other service, and should only\ncontain letters, numbers, underscores, and dashes. This is the name of the folder where the daemon will be storing\nthe service options on the daemon.")]),e._v(" "),t("p",[e._v("The default start command is also required, however it can be changed per-option.")]),e._v(" "),t("h2",{attrs:{id:"create-new-option"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#create-new-option"}},[e._v("#")]),e._v(" Create New Option")]),e._v(" "),t("p",[e._v("After creating the service, in the bottom right of the page you should see a button titled "),t("code",[e._v("New Egg")]),e._v(", press it.")]),e._v(" "),t("p",[t("img",{attrs:{src:a(265),alt:""}})]),e._v(" "),t("p",[e._v("You will be taken to a new service option page which is where most of the configuration happens. The first thing\nyou need to do is select your service that you created previously from the "),t("code",[e._v("Associated Nest")]),e._v(" dropdown.")]),e._v(" "),t("p",[t("img",{attrs:{src:a(257),alt:""}})]),e._v(" "),t("p",[e._v("After that, enter an Option Name to describe it, in this case I am using "),t("code",[e._v("Widget")]),e._v(". You will also need to provide a\n"),t("em",[e._v("valid")]),e._v(" docker image, as well as a start command to be assigned to servers under this service option (remember, this\ncan be tweaked per-server if needed).")]),e._v(" "),t("p",[t("em",[e._v("Docker images must be specifically designed to work with Pterodactyl Panel.")]),e._v(" You should read more about that in\nour "),t("RouterLink",{attrs:{to:"/community/config/eggs/creating_a_custom_image.html"}},[e._v("Creating a Docker Image")]),e._v(" guide.")],1),e._v(" "),t("h2",{attrs:{id:"configure-process-management"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#configure-process-management"}},[e._v("#")]),e._v(" Configure Process Management")]),e._v(" "),t("p",[e._v("This is perhaps the most important step in this service option configuration, as this tells the Daemon how to run everything.")]),e._v(" "),t("p",[t("img",{attrs:{src:a(257),alt:""}})]),e._v(" "),t("p",[e._v("The first field you'll encounter is "),t("code",[e._v("Copy Settings From")]),e._v(". The default selection is "),t("code",[e._v("None")]),e._v(". That is expected, and okay.\nThis dropdown is discussed at the end of this article.")]),e._v(" "),t("h3",{attrs:{id:"stop-command"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#stop-command"}},[e._v("#")]),e._v(" Stop Command")]),e._v(" "),t("p",[e._v("Next, you'll encounter "),t("code",[e._v("Stop Command")]),e._v(" and, as the name implies, this should be the command used to safely stop the\noption. For some games, this is "),t("code",[e._v("stop")]),e._v(" or "),t("code",[e._v("end")]),e._v(". Certain programs and games don't have a specified stop command, so\nyou can enter "),t("code",[e._v("^C")]),e._v(" to have the daemon execute a "),t("code",[e._v("SIGINT")]),e._v(" to end the process.")]),e._v(" "),t("h3",{attrs:{id:"log-storage"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#log-storage"}},[e._v("#")]),e._v(" Log Storage")]),e._v(" "),t("p",[e._v("Logs are competely handeled by the daemon now and use the docker logs to output the complete output from the server.\nThis can be set like below.")]),e._v(" "),t("div",{staticClass:"language-json extra-class"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("h3",{attrs:{id:"configuration-files"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#configuration-files"}},[e._v("#")]),e._v(" Configuration Files")]),e._v(" "),t("p",[e._v("The next block is one of the most complex blocks, the "),t("code",[e._v("Configuration Files")]),e._v(" descriptor. The Daemon will process this\nblock prior to booting the server to ensure all of the required settings are defined and set correctly.")]),e._v(" "),t("div",{staticClass:"language-json extra-class"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"server.properties"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"parser"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"properties"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"find"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"server-ip"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"0.0.0.0"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"enable-query"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"true"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"server-port"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"{{server.build.default.port}}"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"query.port"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"{{server.build.default.port}}"')]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("p",[e._v("In this example, we are telling the Daemon to read "),t("code",[e._v("server.properties")]),e._v(" in "),t("code",[e._v("/home/container")]),e._v(". Within this block, we\ndefine a "),t("code",[e._v("parser")]),e._v(", in this case "),t("code",[e._v("properties")]),e._v(" but the following are "),t("a",{attrs:{href:"https://github.com/pterodactyl/wings/blob/develop/parser/parser.go#L25-L30",target:"_blank",rel:"noopener noreferrer"}},[e._v("valid parsers"),t("OutboundLink")],1),e._v(":")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("file")]),e._v(" — This parser goes based on matching the beginning of lines, and not a specific property like the other five.\nAvoid using this parser if possible.")]),e._v(" "),t("li",[t("code",[e._v("yaml")]),e._v(" (supports "),t("code",[e._v("*")]),e._v(" notation)")]),e._v(" "),t("li",[t("code",[e._v("properties")])]),e._v(" "),t("li",[t("code",[e._v("ini")])]),e._v(" "),t("li",[t("code",[e._v("json")]),e._v(" (supports "),t("code",[e._v("*")]),e._v(" notation)")]),e._v(" "),t("li",[t("code",[e._v("xml")])])]),e._v(" "),t("p",[e._v("Once you have defined a parser, we then define a "),t("code",[e._v("find")]),e._v(" block which tells the Daemon what specific elements to find\nand replace. In this example, we have provided four separate items within the "),t("code",[e._v("server.properties")]),e._v(" file that we want to\nfind and replace to the assigned values. You can use either an exact value, or define a specific server setting from\nthe "),t("code",[e._v("server.json")]),e._v(" file. In this case, we're assigning the default server port to be used as the "),t("code",[e._v("server-port")]),e._v(" and\n"),t("code",[e._v("query.port")]),e._v(". "),t("strong",[e._v("These placeholders are case sensitive, and should have no spaces in them.")])]),e._v(" "),t("p",[e._v("You can have multiple files listed here, the Daemon will process them in parallel before starting the server. When\nusing "),t("code",[e._v("yaml")]),e._v(" or "),t("code",[e._v("json")]),e._v(" you can use more advanced searching for elements.")]),e._v(" "),t("div",{staticClass:"language-json extra-class"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"config.yml"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"parser"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"yaml"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"find"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"listeners[0].query_enabled"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"listeners[0].query_port"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"{{server.build.default.port}}"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"listeners[0].host"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"0.0.0.0:{{server.build.default.port}}"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"servers.*.address"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"127.0.0.1"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"{{config.docker.interface}}"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"localhost"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"{{config.docker.interface}}"')]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("p",[e._v("In this example, we are parsing "),t("code",[e._v("config.yml")]),e._v(" using the "),t("code",[e._v("yaml")]),e._v(" parser. The first three find items are simply assigning\nports and IPs for the first listener block. The last one, "),t("code",[e._v("servers.*.address")]),e._v(" uses wildcard matching to match any items\nwithin the "),t("code",[e._v("servers")]),e._v(" block, and then finding each "),t("code",[e._v("address")]),e._v(" block for those items.")]),e._v(" "),t("div",{pre:!0},[t("p",[e._v("An advanced feature of this file configuration is the ability to define multiple find and replace statements for a\nsingle matching line. In this case, we are looking for either "),t("code",[e._v("127.0.0.1")]),e._v(" or "),t("code",[e._v("localhost")]),e._v(" and replacing them with the\ndocker interface defined in the configuration file using "),t("code",[e._v("{{config.docker.interface}}")]),e._v(".")])]),t("h3",{attrs:{id:"start-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#start-configuration"}},[e._v("#")]),e._v(" Start Configuration")]),e._v(" "),t("p",[e._v("The last block to configure is the "),t("code",[e._v("Start Configuration")]),e._v(" for servers running using this service option.")]),e._v(" "),t("div",{staticClass:"language-json extra-class"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"done"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('")! For help, type "')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("p",[e._v("In the example block above, we define "),t("code",[e._v("done")]),e._v(" as the entire line, or part of a line that indicates a server is done\nstarting, and is ready for players to join. When the Daemon sees this output, it will mark the server as "),t("code",[e._v("ON")]),e._v(" rather\nthan "),t("code",[e._v("STARTING")]),e._v(".")]),e._v(" "),t("p",[e._v("That concludes basic service option configuration.")]),e._v(" "),t("h2",{attrs:{id:"copy-settings-from"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#copy-settings-from"}},[e._v("#")]),e._v(" Copy Settings From")]),e._v(" "),t("p",[e._v("As mentioned above, there is a unique "),t("code",[e._v("Copy Settings From")]),e._v(" dropdown when adding a new option. This gives you the\nability to, as the name suggests, copy settings defined above from a different option.")]),e._v(" "),t("p",[t("img",{attrs:{src:a(266),alt:""}})]),e._v(" "),t("p",[e._v("In the panel, we use this to copy settings that remain the same between similar service options, such as many of the\nMinecraft options.")]),e._v(" "),t("p",[e._v("For example, lets look at the "),t("code",[e._v("Sponge (SpongeVanilla)")]),e._v(" service option.")]),e._v(" "),t("p",[e._v("As you can see, it as been told to copy settings from "),t("code",[e._v("Vanilla Minecraft")]),e._v(". This means that any of the fields that are\nleft blank will inherit from the assigned parent. We then define a specific "),t("code",[e._v("userInteraction")]),e._v(" line that is different in\nSponge compared to Vanilla, but tell it that everything else should remain the same.")]),e._v(" "),t("p",[t("em",[e._v("Please note that "),t("code",[e._v("Copy Settings From")]),e._v(" does not support nested copies, you can only copy from a single parent,\nand that parent "),t("strong",[e._v("must not be copying from another option.")])])]),e._v(" "),t("h2",{attrs:{id:"egg-variables"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#egg-variables"}},[e._v("#")]),e._v(" Egg Variables")]),e._v(" "),t("p",[e._v("One of the great parts of the Egg Variables is the ability to define specific variables that users and/or admins can\ncontrol to tweak different settings without letting users modify the startup command. To create new variables, or edit\nexisting ones, visit the new service option you created, and click the "),t("code",[e._v("Variables")]),e._v(" tab at the top of the page. Lets take\na look at an example variable that we can create.")]),e._v(" "),t("p",[t("img",{attrs:{src:a(267),alt:""}})]),e._v(" "),t("div",{pre:!0},[t("p",[e._v("The name and description are rather self-explanitory, so I'll skip down to the "),t("code",[e._v("Environment Variable")]),e._v(" box. This should\nbe an Alpha-Numeric name with underscores, and should be uppercase. This will be the name of the environment variable\nwhich can be accessed in the startup command as "),t("code",[e._v("{{WOOZLE_WOO}}")]),e._v(", within file modifications as "),t("code",[e._v("{{env.WOOZLE_WOO}}")]),e._v(", or\njust "),t("code",[e._v("${WOOZLE_WOO}")]),e._v(" in any shell scripts (it is passed through in the environment). We also define a default value for\nthis environment variable in this example, but it is not required to do so.")])]),t("p",[e._v("The next section is "),t("code",[e._v("Permissions")]),e._v(", which is a dropdown with two options: "),t("code",[e._v("Users Can View")]),e._v(" and "),t("code",[e._v("Users Can Edit")]),e._v(".")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("Users Can View")]),e._v(" — allows a user to view the field on the front-end, as well as the assigned value of that variable.\nThey will be able to see it replaced in their startup command.")]),e._v(" "),t("li",[t("code",[e._v("Users Can Edit")]),e._v(" — allows a user to edit the value of the variable, for example the name of their "),t("code",[e._v("server.jar")]),e._v(" file\nif running Minecraft.")])]),e._v(" "),t("p",[e._v("You should use caution here, even if you assign neither of the permissions it does not mean that the value will be\nhidden. Crafty users will still be able to get the environment on their server. In most cases this is simply hiding\nit from the user, and then used within the Dockerfile to perform actions, thus it is not important for the user to see.")]),e._v(" "),t("p",[e._v("Finally, you will need to define some input rules to validate the value against. In this example, we use\n"),t("code",[e._v("required|string|between:1,10")]),e._v(", which means the field is "),t("code",[e._v("required")]),e._v(", must be a "),t("code",[e._v("string")]),e._v(", and must be between "),t("code",[e._v("1")]),e._v(" and\n"),t("code",[e._v("10")]),e._v(" characters in length. You can find "),t("a",{attrs:{href:"https://laravel.com/docs/5.6/validation#available-validation-rules",target:"_blank",rel:"noopener noreferrer"}},[e._v("all of the available validation rules"),t("OutboundLink")],1),e._v("\non the Laravel website. You can also use ReGEX based validation by using the "),t("code",[e._v("regex:")]),e._v(" rule flag. For example,\n"),t("a",{attrs:{href:"https://regex101.com/r/k4oEOn/1",target:"_blank",rel:"noopener noreferrer"}},[t("code",[e._v("required|regex:/^([\\w\\d._-]+)(\\.jar)$/")]),t("OutboundLink")],1),e._v(" will require the field, and will match the\nregex as any letters or numbers ("),t("code",[e._v("\\w\\d")]),e._v(") including underscore ("),t("code",[e._v("_")]),e._v("), periods ("),t("code",[e._v(".")]),e._v("), and dashes ("),t("code",[e._v("-")]),e._v(") ending in "),t("code",[e._v(".jar")]),e._v(".")]),e._v(" "),t("p",[e._v("They will then be visible when managing the startup for a server in both the Admin CP and on the Front-End.")]),e._v(" "),t("p",[t("img",{attrs:{src:a(268),alt:""}})]),e._v(" "),t("h2",{attrs:{id:"list-of-default-variables"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#list-of-default-variables"}},[e._v("#")]),e._v(" List of default variables")]),e._v(" "),t("p",[e._v("The default variables are always accessible to all eggs and don't have to be created separately. They can be used in the egg startup, install script, or the configuration file parser.")]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Variable")]),e._v(" "),t("th",[e._v("Description")]),e._v(" "),t("th",[e._v("Example")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[e._v("TZ")]),e._v(" "),t("td",[e._v("Time Zone")]),e._v(" "),t("td",[t("code",[e._v("Etc/UTC")])])]),e._v(" "),t("tr",[t("td",[e._v("STARTUP")]),e._v(" "),t("td",[e._v("Startup command of the egg")]),e._v(" "),t("td",[t("code",[e._v("java -Xms128M -Xmx"+e._s(e.SERVER_MEMORY)+"M -jar "+e._s(e.SERVER_JARFILE))])])]),e._v(" "),t("tr",[t("td",[e._v("SERVER_MEMORY")]),e._v(" "),t("td",[e._v("Memory available for the server in MB")]),e._v(" "),t("td",[t("code",[e._v("512")])])]),e._v(" "),t("tr",[t("td",[e._v("SERVER_IP")]),e._v(" "),t("td",[e._v("Default ip of the server")]),e._v(" "),t("td",[t("code",[e._v("127.0.0.1")])])]),e._v(" "),t("tr",[t("td",[e._v("SERVER_PORT")]),e._v(" "),t("td",[e._v("Primary Server Port")]),e._v(" "),t("td",[t("code",[e._v("27015")])])]),e._v(" "),t("tr",[t("td",[e._v("P_SERVER_LOCATION")]),e._v(" "),t("td",[e._v("Location of the server")]),e._v(" "),t("td",[t("code",[e._v("Example City")])])]),e._v(" "),t("tr",[t("td",[e._v("P_SERVER_UUID")]),e._v(" "),t("td",[e._v("UUID of the server")]),e._v(" "),t("td",[t("code",[e._v("539fdca8-4a08-4551-a8d2-8ee5475b50d9")])])]),e._v(" "),t("tr",[t("td",[e._v("P_SERVER_ALLOCATION_LIMIT")]),e._v(" "),t("td",[e._v("Limit of allocations allowed for the server")]),e._v(" "),t("td",[t("code",[e._v("0")])])])])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[9],{257:function(e,t,a){e.exports=a.p+"assets/img/Pterodactyl_Create_New_Egg_Process_Management.516b5b6f.png"},265:function(e,t,a){e.exports=a.p+"assets/img/Pterodactyl_Create_New_Egg_Select.5a2867ee.png"},266:function(e,t,a){e.exports=a.p+"assets/img/Pterodactyl_Create_New_Egg_Copy_Settings_From.e3102cdd.png"},267:function(e,t,a){e.exports=a.p+"assets/img/Pterodactyl_Create_New_Egg_Variables.3962b264.png"},268:function(e,t,a){e.exports=a.p+"assets/img/Pterodactyl_Create_New_Egg_Startup.b6e22637.png"},287:function(e,t,a){"use strict";a.r(t);var s=a(15),n=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"creating-a-custom-egg"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#creating-a-custom-egg"}},[e._v("#")]),e._v(" Creating a Custom Egg")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("You should not edit existing services or options that ship with the Panel. Each upgrade we push can make minor\nchanges to these, and you'll lose any changes you've made.")])]),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#create-new-option"}},[e._v("Create New Option")])]),t("li",[t("a",{attrs:{href:"#configure-process-management"}},[e._v("Configure Process Management")]),t("ul",[t("li",[t("a",{attrs:{href:"#stop-command"}},[e._v("Stop Command")])]),t("li",[t("a",{attrs:{href:"#log-storage"}},[e._v("Log Storage")])]),t("li",[t("a",{attrs:{href:"#configuration-files"}},[e._v("Configuration Files")])]),t("li",[t("a",{attrs:{href:"#start-configuration"}},[e._v("Start Configuration")])])])]),t("li",[t("a",{attrs:{href:"#copy-settings-from"}},[e._v("Copy Settings From")])]),t("li",[t("a",{attrs:{href:"#egg-variables"}},[e._v("Egg Variables")])]),t("li",[t("a",{attrs:{href:"#list-of-default-variables"}},[e._v("List of default variables")])])])]),t("p"),e._v(" "),t("p",[e._v("The first thing you'll need to do is create a new service. In this case, the name and description speak for themselves.\nThe "),t("code",[e._v("Folder Name")]),e._v(" "),t("em",[e._v("must be a unique name")]),e._v(" not being used by any other service, and should only\ncontain letters, numbers, underscores, and dashes. This is the name of the folder where the daemon will be storing\nthe service options on the daemon.")]),e._v(" "),t("p",[e._v("The default start command is also required, however it can be changed per-option.")]),e._v(" "),t("h2",{attrs:{id:"create-new-option"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#create-new-option"}},[e._v("#")]),e._v(" Create New Option")]),e._v(" "),t("p",[e._v("After creating the service, in the bottom right of the page you should see a button titled "),t("code",[e._v("New Egg")]),e._v(", press it.")]),e._v(" "),t("p",[t("img",{attrs:{src:a(265),alt:""}})]),e._v(" "),t("p",[e._v("You will be taken to a new service option page which is where most of the configuration happens. The first thing\nyou need to do is select your service that you created previously from the "),t("code",[e._v("Associated Nest")]),e._v(" dropdown.")]),e._v(" "),t("p",[t("img",{attrs:{src:a(257),alt:""}})]),e._v(" "),t("p",[e._v("After that, enter an Option Name to describe it, in this case I am using "),t("code",[e._v("Widget")]),e._v(". You will also need to provide a\n"),t("em",[e._v("valid")]),e._v(" docker image, as well as a start command to be assigned to servers under this service option (remember, this\ncan be tweaked per-server if needed).")]),e._v(" "),t("p",[t("em",[e._v("Docker images must be specifically designed to work with Pterodactyl Panel.")]),e._v(" You should read more about that in\nour "),t("RouterLink",{attrs:{to:"/community/config/eggs/creating_a_custom_image.html"}},[e._v("Creating a Docker Image")]),e._v(" guide.")],1),e._v(" "),t("h2",{attrs:{id:"configure-process-management"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#configure-process-management"}},[e._v("#")]),e._v(" Configure Process Management")]),e._v(" "),t("p",[e._v("This is perhaps the most important step in this service option configuration, as this tells the Daemon how to run everything.")]),e._v(" "),t("p",[t("img",{attrs:{src:a(257),alt:""}})]),e._v(" "),t("p",[e._v("The first field you'll encounter is "),t("code",[e._v("Copy Settings From")]),e._v(". The default selection is "),t("code",[e._v("None")]),e._v(". That is expected, and okay.\nThis dropdown is discussed at the end of this article.")]),e._v(" "),t("h3",{attrs:{id:"stop-command"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#stop-command"}},[e._v("#")]),e._v(" Stop Command")]),e._v(" "),t("p",[e._v("Next, you'll encounter "),t("code",[e._v("Stop Command")]),e._v(" and, as the name implies, this should be the command used to safely stop the\noption. For some games, this is "),t("code",[e._v("stop")]),e._v(" or "),t("code",[e._v("end")]),e._v(". Certain programs and games don't have a specified stop command, so\nyou can enter "),t("code",[e._v("^C")]),e._v(" to have the daemon execute a "),t("code",[e._v("SIGINT")]),e._v(" to end the process.")]),e._v(" "),t("h3",{attrs:{id:"log-storage"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#log-storage"}},[e._v("#")]),e._v(" Log Storage")]),e._v(" "),t("p",[e._v("Logs are competely handeled by the daemon now and use the docker logs to output the complete output from the server.\nThis can be set like below.")]),e._v(" "),t("div",{staticClass:"language-json extra-class"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("h3",{attrs:{id:"configuration-files"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#configuration-files"}},[e._v("#")]),e._v(" Configuration Files")]),e._v(" "),t("p",[e._v("The next block is one of the most complex blocks, the "),t("code",[e._v("Configuration Files")]),e._v(" descriptor. The Daemon will process this\nblock prior to booting the server to ensure all of the required settings are defined and set correctly.")]),e._v(" "),t("div",{staticClass:"language-json extra-class"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"server.properties"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"parser"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"properties"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"find"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"server-ip"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"0.0.0.0"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"enable-query"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"true"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"server-port"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"{{server.build.default.port}}"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"query.port"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"{{server.build.default.port}}"')]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("p",[e._v("In this example, we are telling the Daemon to read "),t("code",[e._v("server.properties")]),e._v(" in "),t("code",[e._v("/home/container")]),e._v(". Within this block, we\ndefine a "),t("code",[e._v("parser")]),e._v(", in this case "),t("code",[e._v("properties")]),e._v(" but the following are "),t("a",{attrs:{href:"https://github.com/pterodactyl/wings/blob/develop/parser/parser.go#L25-L30",target:"_blank",rel:"noopener noreferrer"}},[e._v("valid parsers"),t("OutboundLink")],1),e._v(":")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("file")]),e._v(" — This parser goes based on matching the beginning of lines, and not a specific property like the other five.\nAvoid using this parser if possible.")]),e._v(" "),t("li",[t("code",[e._v("yaml")]),e._v(" (supports "),t("code",[e._v("*")]),e._v(" notation)")]),e._v(" "),t("li",[t("code",[e._v("properties")])]),e._v(" "),t("li",[t("code",[e._v("ini")])]),e._v(" "),t("li",[t("code",[e._v("json")]),e._v(" (supports "),t("code",[e._v("*")]),e._v(" notation)")]),e._v(" "),t("li",[t("code",[e._v("xml")])])]),e._v(" "),t("p",[e._v("Once you have defined a parser, we then define a "),t("code",[e._v("find")]),e._v(" block which tells the Daemon what specific elements to find\nand replace. In this example, we have provided four separate items within the "),t("code",[e._v("server.properties")]),e._v(" file that we want to\nfind and replace to the assigned values. You can use either an exact value, or define a specific server setting from\nthe "),t("code",[e._v("server.json")]),e._v(" file. In this case, we're assigning the default server port to be used as the "),t("code",[e._v("server-port")]),e._v(" and\n"),t("code",[e._v("query.port")]),e._v(". "),t("strong",[e._v("These placeholders are case sensitive, and should have no spaces in them.")])]),e._v(" "),t("p",[e._v("You can have multiple files listed here, the Daemon will process them in parallel before starting the server. When\nusing "),t("code",[e._v("yaml")]),e._v(" or "),t("code",[e._v("json")]),e._v(" you can use more advanced searching for elements.")]),e._v(" "),t("div",{staticClass:"language-json extra-class"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"config.yml"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"parser"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"yaml"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"find"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"listeners[0].query_enabled"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"listeners[0].query_port"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"{{server.build.default.port}}"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"listeners[0].host"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"0.0.0.0:{{server.build.default.port}}"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"servers.*.address"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"127.0.0.1"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"{{config.docker.interface}}"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"localhost"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"{{config.docker.interface}}"')]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("p",[e._v("In this example, we are parsing "),t("code",[e._v("config.yml")]),e._v(" using the "),t("code",[e._v("yaml")]),e._v(" parser. The first three find items are simply assigning\nports and IPs for the first listener block. The last one, "),t("code",[e._v("servers.*.address")]),e._v(" uses wildcard matching to match any items\nwithin the "),t("code",[e._v("servers")]),e._v(" block, and then finding each "),t("code",[e._v("address")]),e._v(" block for those items.")]),e._v(" "),t("div",{pre:!0},[t("p",[e._v("An advanced feature of this file configuration is the ability to define multiple find and replace statements for a\nsingle matching line. In this case, we are looking for either "),t("code",[e._v("127.0.0.1")]),e._v(" or "),t("code",[e._v("localhost")]),e._v(" and replacing them with the\ndocker interface defined in the configuration file using "),t("code",[e._v("{{config.docker.interface}}")]),e._v(".")])]),t("h3",{attrs:{id:"start-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#start-configuration"}},[e._v("#")]),e._v(" Start Configuration")]),e._v(" "),t("p",[e._v("The last block to configure is the "),t("code",[e._v("Start Configuration")]),e._v(" for servers running using this service option.")]),e._v(" "),t("div",{staticClass:"language-json extra-class"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"done"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('")! For help, type "')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("p",[e._v("In the example block above, we define "),t("code",[e._v("done")]),e._v(" as the entire line, or part of a line that indicates a server is done\nstarting, and is ready for players to join. When the Daemon sees this output, it will mark the server as "),t("code",[e._v("ON")]),e._v(" rather\nthan "),t("code",[e._v("STARTING")]),e._v(".")]),e._v(" "),t("p",[e._v("That concludes basic service option configuration.")]),e._v(" "),t("h2",{attrs:{id:"copy-settings-from"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#copy-settings-from"}},[e._v("#")]),e._v(" Copy Settings From")]),e._v(" "),t("p",[e._v("As mentioned above, there is a unique "),t("code",[e._v("Copy Settings From")]),e._v(" dropdown when adding a new option. This gives you the\nability to, as the name suggests, copy settings defined above from a different option.")]),e._v(" "),t("p",[t("img",{attrs:{src:a(266),alt:""}})]),e._v(" "),t("p",[e._v("In the panel, we use this to copy settings that remain the same between similar service options, such as many of the\nMinecraft options.")]),e._v(" "),t("p",[e._v("For example, lets look at the "),t("code",[e._v("Sponge (SpongeVanilla)")]),e._v(" service option.")]),e._v(" "),t("p",[e._v("As you can see, it as been told to copy settings from "),t("code",[e._v("Vanilla Minecraft")]),e._v(". This means that any of the fields that are\nleft blank will inherit from the assigned parent. We then define a specific "),t("code",[e._v("userInteraction")]),e._v(" line that is different in\nSponge compared to Vanilla, but tell it that everything else should remain the same.")]),e._v(" "),t("p",[t("em",[e._v("Please note that "),t("code",[e._v("Copy Settings From")]),e._v(" does not support nested copies, you can only copy from a single parent,\nand that parent "),t("strong",[e._v("must not be copying from another option.")])])]),e._v(" "),t("h2",{attrs:{id:"egg-variables"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#egg-variables"}},[e._v("#")]),e._v(" Egg Variables")]),e._v(" "),t("p",[e._v("One of the great parts of the Egg Variables is the ability to define specific variables that users and/or admins can\ncontrol to tweak different settings without letting users modify the startup command. To create new variables, or edit\nexisting ones, visit the new service option you created, and click the "),t("code",[e._v("Variables")]),e._v(" tab at the top of the page. Lets take\na look at an example variable that we can create.")]),e._v(" "),t("p",[t("img",{attrs:{src:a(267),alt:""}})]),e._v(" "),t("div",{pre:!0},[t("p",[e._v("The name and description are rather self-explanitory, so I'll skip down to the "),t("code",[e._v("Environment Variable")]),e._v(" box. This should\nbe an Alpha-Numeric name with underscores, and should be uppercase. This will be the name of the environment variable\nwhich can be accessed in the startup command as "),t("code",[e._v("{{WOOZLE_WOO}}")]),e._v(", within file modifications as "),t("code",[e._v("{{env.WOOZLE_WOO}}")]),e._v(", or\njust "),t("code",[e._v("${WOOZLE_WOO}")]),e._v(" in any shell scripts (it is passed through in the environment). We also define a default value for\nthis environment variable in this example, but it is not required to do so.")])]),t("p",[e._v("The next section is "),t("code",[e._v("Permissions")]),e._v(", which is a dropdown with two options: "),t("code",[e._v("Users Can View")]),e._v(" and "),t("code",[e._v("Users Can Edit")]),e._v(".")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("Users Can View")]),e._v(" — allows a user to view the field on the front-end, as well as the assigned value of that variable.\nThey will be able to see it replaced in their startup command.")]),e._v(" "),t("li",[t("code",[e._v("Users Can Edit")]),e._v(" — allows a user to edit the value of the variable, for example the name of their "),t("code",[e._v("server.jar")]),e._v(" file\nif running Minecraft.")])]),e._v(" "),t("p",[e._v("You should use caution here, even if you assign neither of the permissions it does not mean that the value will be\nhidden. Crafty users will still be able to get the environment on their server. In most cases this is simply hiding\nit from the user, and then used within the Dockerfile to perform actions, thus it is not important for the user to see.")]),e._v(" "),t("p",[e._v("Finally, you will need to define some input rules to validate the value against. In this example, we use\n"),t("code",[e._v("required|string|between:1,10")]),e._v(", which means the field is "),t("code",[e._v("required")]),e._v(", must be a "),t("code",[e._v("string")]),e._v(", and must be between "),t("code",[e._v("1")]),e._v(" and\n"),t("code",[e._v("10")]),e._v(" characters in length. You can find "),t("a",{attrs:{href:"https://laravel.com/docs/5.6/validation#available-validation-rules",target:"_blank",rel:"noopener noreferrer"}},[e._v("all of the available validation rules"),t("OutboundLink")],1),e._v("\non the Laravel website. You can also use ReGEX based validation by using the "),t("code",[e._v("regex:")]),e._v(" rule flag. For example,\n"),t("a",{attrs:{href:"https://regex101.com/r/k4oEOn/1",target:"_blank",rel:"noopener noreferrer"}},[t("code",[e._v("required|regex:/^([\\w\\d._-]+)(\\.jar)$/")]),t("OutboundLink")],1),e._v(" will require the field, and will match the\nregex as any letters or numbers ("),t("code",[e._v("\\w\\d")]),e._v(") including underscore ("),t("code",[e._v("_")]),e._v("), periods ("),t("code",[e._v(".")]),e._v("), and dashes ("),t("code",[e._v("-")]),e._v(") ending in "),t("code",[e._v(".jar")]),e._v(".")]),e._v(" "),t("p",[e._v("They will then be visible when managing the startup for a server in both the Admin CP and on the Front-End.")]),e._v(" "),t("p",[t("img",{attrs:{src:a(268),alt:""}})]),e._v(" "),t("h2",{attrs:{id:"list-of-default-variables"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#list-of-default-variables"}},[e._v("#")]),e._v(" List of default variables")]),e._v(" "),t("p",[e._v("The default variables are always accessible to all eggs and don't have to be created separately. They can be used in the egg startup, install script, or the configuration file parser.")]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Variable")]),e._v(" "),t("th",[e._v("Description")]),e._v(" "),t("th",[e._v("Example")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[e._v("TZ")]),e._v(" "),t("td",[e._v("Time Zone")]),e._v(" "),t("td",[t("code",[e._v("Etc/UTC")])])]),e._v(" "),t("tr",[t("td",[e._v("STARTUP")]),e._v(" "),t("td",[e._v("Startup command of the egg")]),e._v(" "),t("td",[t("code",[e._v("java -Xms128M -Xmx"+e._s(e.SERVER_MEMORY)+"M -jar "+e._s(e.SERVER_JARFILE))])])]),e._v(" "),t("tr",[t("td",[e._v("SERVER_MEMORY")]),e._v(" "),t("td",[e._v("Memory available for the server in MB")]),e._v(" "),t("td",[t("code",[e._v("512")])])]),e._v(" "),t("tr",[t("td",[e._v("SERVER_IP")]),e._v(" "),t("td",[e._v("Default ip of the server")]),e._v(" "),t("td",[t("code",[e._v("127.0.0.1")])])]),e._v(" "),t("tr",[t("td",[e._v("SERVER_PORT")]),e._v(" "),t("td",[e._v("Primary Server Port")]),e._v(" "),t("td",[t("code",[e._v("27015")])])]),e._v(" "),t("tr",[t("td",[e._v("P_SERVER_LOCATION")]),e._v(" "),t("td",[e._v("Location of the server")]),e._v(" "),t("td",[t("code",[e._v("Example City")])])]),e._v(" "),t("tr",[t("td",[e._v("P_SERVER_UUID")]),e._v(" "),t("td",[e._v("UUID of the server")]),e._v(" "),t("td",[t("code",[e._v("539fdca8-4a08-4551-a8d2-8ee5475b50d9")])])]),e._v(" "),t("tr",[t("td",[e._v("P_SERVER_ALLOCATION_LIMIT")]),e._v(" "),t("td",[e._v("Limit of allocations allowed for the server")]),e._v(" "),t("td",[t("code",[e._v("0")])])])])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/app.c4b579df.js b/assets/js/app.b423fbf1.js similarity index 83% rename from assets/js/app.c4b579df.js rename to assets/js/app.b423fbf1.js index ad05f369..de6ec000 100644 --- a/assets/js/app.c4b579df.js +++ b/assets/js/app.b423fbf1.js @@ -1,4 +1,4 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[0],[]]);!function(t){function e(e){for(var r,a,s=e[0],l=e[1],u=e[2],f=0,p=[];f=0&&(e=t.slice(r),t=t.slice(0,r));var o=t.indexOf("?");return o>=0&&(n=t.slice(o+1),t=t.slice(0,o)),{path:t,query:n,hash:e}}(i.path||""),p=e&&e.path||"/",d=u.path?k(u.path,p,n||i.append):p,h=function(t,e,n){void 0===e&&(e={});var r,o=n||f;try{r=o(t||"")}catch(t){r={}}for(var i in e){var a=e[i];r[i]=Array.isArray(a)?a.map(c):c(a)}return r}(u.query,i.query,r&&r.options.parseQuery),v=i.hash||u.hash;return v&&"#"!==v.charAt(0)&&(v="#"+v),{_normalized:!0,path:d,query:h,hash:v}}var q,W=function(){},G={name:"RouterLink",props:{to:{type:[String,Object],required:!0},tag:{type:String,default:"a"},custom:Boolean,exact:Boolean,exactPath:Boolean,append:Boolean,replace:Boolean,activeClass:String,exactActiveClass:String,ariaCurrentValue:{type:String,default:"page"},event:{type:[String,Array],default:"click"}},render:function(t){var e=this,n=this.$router,r=this.$route,i=n.resolve(this.to,r,this.append),a=i.location,s=i.route,l=i.href,u={},c=n.options.linkActiveClass,f=n.options.linkExactActiveClass,p=null==c?"router-link-active":c,v=null==f?"router-link-exact-active":f,g=null==this.activeClass?p:this.activeClass,m=null==this.exactActiveClass?v:this.exactActiveClass,y=s.redirectedFrom?h(null,H(s.redirectedFrom),null,n):s;u[m]=b(r,y,this.exactPath),u[g]=this.exact||this.exactPath?u[m]:function(t,e){return 0===t.path.replace(d,"/").indexOf(e.path.replace(d,"/"))&&(!e.hash||t.hash===e.hash)&&function(t,e){for(var n in e)if(!(n in t))return!1;return!0}(t.query,e.query)}(r,y);var _=u[m]?this.ariaCurrentValue:null,w=function(t){K(t)&&(e.replace?n.replace(a,W):n.push(a,W))},x={click:K};Array.isArray(this.event)?this.event.forEach((function(t){x[t]=w})):x[this.event]=w;var C={class:u},k=!this.$scopedSlots.$hasNormal&&this.$scopedSlots.default&&this.$scopedSlots.default({href:l,route:s,navigate:w,isActive:u[g],isExactActive:u[m]});if(k){if(1===k.length)return k[0];if(k.length>1||!k.length)return 0===k.length?t():t("span",{},k)}if("a"===this.tag)C.on=x,C.attrs={href:l,"aria-current":_};else{var S=function t(e){var n;if(e)for(var r=0;r-1&&(s.params[p]=n.params[p]);return s.path=V(c.path,s.params),l(c,s,a)}if(s.path){s.params={};for(var d=0;d-1}function St(t,e){return kt(t)&&t._isRouter&&(null==e||t.type===e)}function Pt(t,e,n){var r=function(o){o>=t.length?n():t[o]?e(t[o],(function(){r(o+1)})):r(o+1)};r(0)}function Ot(t){return function(e,n,r){var o=!1,i=0,a=null;Et(t,(function(t,e,n,s){if("function"==typeof t&&void 0===t.cid){o=!0,i++;var l,u=Tt((function(e){var o;((o=e).__esModule||$t&&"Module"===o[Symbol.toStringTag])&&(e=e.default),t.resolved="function"==typeof e?e:q.extend(e),n.components[s]=e,--i<=0&&r()})),c=Tt((function(t){var e="Failed to resolve async component "+s+": "+t;a||(a=kt(t)?t:new Error(e),r(a))}));try{l=t(u,c)}catch(t){c(t)}if(l)if("function"==typeof l.then)l.then(u,c);else{var f=l.component;f&&"function"==typeof f.then&&f.then(u,c)}}})),o||r()}}function Et(t,e){return jt(t.map((function(t){return Object.keys(t.components).map((function(n){return e(t.components[n],t.instances[n],t,n)}))})))}function jt(t){return Array.prototype.concat.apply([],t)}var $t="function"==typeof Symbol&&"symbol"==typeof Symbol.toStringTag;function Tt(t){var e=!1;return function(){for(var n=[],r=arguments.length;r--;)n[r]=arguments[r];if(!e)return e=!0,t.apply(this,n)}}var At=function(t,e){this.router=t,this.base=function(t){if(!t)if(X){var e=document.querySelector("base");t=(t=e&&e.getAttribute("href")||"/").replace(/^https?:\/\/[^\/]+/,"")}else t="/";"/"!==t.charAt(0)&&(t="/"+t);return t.replace(/\/$/,"")}(e),this.current=g,this.pending=null,this.ready=!1,this.readyCbs=[],this.readyErrorCbs=[],this.errorCbs=[],this.listeners=[]};function Lt(t,e,n,r){var o=Et(t,(function(t,r,o,i){var a=function(t,e){"function"!=typeof t&&(t=q.extend(t));return t.options[e]}(t,e);if(a)return Array.isArray(a)?a.map((function(t){return n(t,r,o,i)})):n(a,r,o,i)}));return jt(r?o.reverse():o)}function Dt(t,e){if(e)return function(){return t.apply(e,arguments)}}At.prototype.listen=function(t){this.cb=t},At.prototype.onReady=function(t,e){this.ready?t():(this.readyCbs.push(t),e&&this.readyErrorCbs.push(e))},At.prototype.onError=function(t){this.errorCbs.push(t)},At.prototype.transitionTo=function(t,e,n){var r,o=this;try{r=this.router.match(t,this.current)}catch(t){throw this.errorCbs.forEach((function(e){e(t)})),t}var i=this.current;this.confirmTransition(r,(function(){o.updateRoute(r),e&&e(r),o.ensureURL(),o.router.afterHooks.forEach((function(t){t&&t(r,i)})),o.ready||(o.ready=!0,o.readyCbs.forEach((function(t){t(r)})))}),(function(t){n&&n(t),t&&!o.ready&&(St(t,bt.redirected)&&i===g||(o.ready=!0,o.readyErrorCbs.forEach((function(e){e(t)}))))}))},At.prototype.confirmTransition=function(t,e,n){var r=this,o=this.current;this.pending=t;var i,a,s=function(t){!St(t)&&kt(t)&&(r.errorCbs.length?r.errorCbs.forEach((function(e){e(t)})):console.error(t)),n&&n(t)},l=t.matched.length-1,u=o.matched.length-1;if(b(t,o)&&l===u&&t.matched[l]===o.matched[u])return this.ensureURL(),t.hash&&st(this.router,o,t,!1),s(((a=xt(i=o,t,bt.duplicated,'Avoided redundant navigation to current location: "'+i.fullPath+'".')).name="NavigationDuplicated",a));var c=function(t,e){var n,r=Math.max(t.length,e.length);for(n=0;n0)){var e=this.router,n=e.options.scrollBehavior,r=gt&&n;r&&this.listeners.push(at());var o=function(){var n=t.current,o=Rt(t.base);t.current===g&&o===t._startLocation||t.transitionTo(o,(function(t){r&&st(e,t,n,!0)}))};window.addEventListener("popstate",o),this.listeners.push((function(){window.removeEventListener("popstate",o)}))}},e.prototype.go=function(t){window.history.go(t)},e.prototype.push=function(t,e,n){var r=this,o=this.current;this.transitionTo(t,(function(t){mt(S(r.base+t.fullPath)),st(r.router,t,o,!1),e&&e(t)}),n)},e.prototype.replace=function(t,e,n){var r=this,o=this.current;this.transitionTo(t,(function(t){yt(S(r.base+t.fullPath)),st(r.router,t,o,!1),e&&e(t)}),n)},e.prototype.ensureURL=function(t){if(Rt(this.base)!==this.current.fullPath){var e=S(this.base+this.current.fullPath);t?mt(e):yt(e)}},e.prototype.getCurrentLocation=function(){return Rt(this.base)},e}(At);function Rt(t){var e=window.location.pathname,n=e.toLowerCase(),r=t.toLowerCase();return!t||n!==r&&0!==n.indexOf(S(r+"/"))||(e=e.slice(t.length)),(e||"/")+window.location.search+window.location.hash}var Mt=function(t){function e(e,n,r){t.call(this,e,n),r&&function(t){var e=Rt(t);if(!/^\/#/.test(e))return window.location.replace(S(t+"/#"+e)),!0}(this.base)||Nt()}return t&&(e.__proto__=t),e.prototype=Object.create(t&&t.prototype),e.prototype.constructor=e,e.prototype.setupListeners=function(){var t=this;if(!(this.listeners.length>0)){var e=this.router.options.scrollBehavior,n=gt&&e;n&&this.listeners.push(at());var r=function(){var e=t.current;Nt()&&t.transitionTo(Ut(),(function(r){n&&st(t.router,r,e,!0),gt||Bt(r.fullPath)}))},o=gt?"popstate":"hashchange";window.addEventListener(o,r),this.listeners.push((function(){window.removeEventListener(o,r)}))}},e.prototype.push=function(t,e,n){var r=this,o=this.current;this.transitionTo(t,(function(t){zt(t.fullPath),st(r.router,t,o,!1),e&&e(t)}),n)},e.prototype.replace=function(t,e,n){var r=this,o=this.current;this.transitionTo(t,(function(t){Bt(t.fullPath),st(r.router,t,o,!1),e&&e(t)}),n)},e.prototype.go=function(t){window.history.go(t)},e.prototype.ensureURL=function(t){var e=this.current.fullPath;Ut()!==e&&(t?zt(e):Bt(e))},e.prototype.getCurrentLocation=function(){return Ut()},e}(At);function Nt(){var t=Ut();return"/"===t.charAt(0)||(Bt("/"+t),!1)}function Ut(){var t=window.location.href,e=t.indexOf("#");return e<0?"":t=t.slice(e+1)}function Ft(t){var e=window.location.href,n=e.indexOf("#");return(n>=0?e.slice(0,n):e)+"#"+t}function zt(t){gt?mt(Ft(t)):window.location.hash=t}function Bt(t){gt?yt(Ft(t)):window.location.replace(Ft(t))}var Vt=function(t){function e(e,n){t.call(this,e,n),this.stack=[],this.index=-1}return t&&(e.__proto__=t),e.prototype=Object.create(t&&t.prototype),e.prototype.constructor=e,e.prototype.push=function(t,e,n){var r=this;this.transitionTo(t,(function(t){r.stack=r.stack.slice(0,r.index+1).concat(t),r.index++,e&&e(t)}),n)},e.prototype.replace=function(t,e,n){var r=this;this.transitionTo(t,(function(t){r.stack=r.stack.slice(0,r.index).concat(t),e&&e(t)}),n)},e.prototype.go=function(t){var e=this,n=this.index+t;if(!(n<0||n>=this.stack.length)){var r=this.stack[n];this.confirmTransition(r,(function(){var t=e.current;e.index=n,e.updateRoute(r),e.router.afterHooks.forEach((function(e){e&&e(r,t)}))}),(function(t){St(t,bt.duplicated)&&(e.index=n)}))}},e.prototype.getCurrentLocation=function(){var t=this.stack[this.stack.length-1];return t?t.fullPath:"/"},e.prototype.ensureURL=function(){},e}(At),Ht=function(t){void 0===t&&(t={}),this.app=null,this.apps=[],this.options=t,this.beforeHooks=[],this.resolveHooks=[],this.afterHooks=[],this.matcher=Y(t.routes||[],this);var e=t.mode||"hash";switch(this.fallback="history"===e&&!gt&&!1!==t.fallback,this.fallback&&(e="hash"),X||(e="abstract"),this.mode=e,e){case"history":this.history=new It(this,t.base);break;case"hash":this.history=new Mt(this,t.base,this.fallback);break;case"abstract":this.history=new Vt(this,t.base);break;default:0}},qt={currentRoute:{configurable:!0}};Ht.prototype.match=function(t,e,n){return this.matcher.match(t,e,n)},qt.currentRoute.get=function(){return this.history&&this.history.current},Ht.prototype.init=function(t){var e=this;if(this.apps.push(t),t.$once("hook:destroyed",(function(){var n=e.apps.indexOf(t);n>-1&&e.apps.splice(n,1),e.app===t&&(e.app=e.apps[0]||null),e.app||e.history.teardown()})),!this.app){this.app=t;var n=this.history;if(n instanceof It||n instanceof Mt){var r=function(t){n.setupListeners(),function(t){var r=n.current,o=e.options.scrollBehavior;gt&&o&&"fullPath"in t&&st(e,t,r,!1)}(t)};n.transitionTo(n.getCurrentLocation(),r,r)}n.listen((function(t){e.apps.forEach((function(e){e._route=t}))}))}},Ht.prototype.beforeEach=function(t){return Gt(this.beforeHooks,t)},Ht.prototype.beforeResolve=function(t){return Gt(this.resolveHooks,t)},Ht.prototype.afterEach=function(t){return Gt(this.afterHooks,t)},Ht.prototype.onReady=function(t,e){this.history.onReady(t,e)},Ht.prototype.onError=function(t){this.history.onError(t)},Ht.prototype.push=function(t,e,n){var r=this;if(!e&&!n&&"undefined"!=typeof Promise)return new Promise((function(e,n){r.history.push(t,e,n)}));this.history.push(t,e,n)},Ht.prototype.replace=function(t,e,n){var r=this;if(!e&&!n&&"undefined"!=typeof Promise)return new Promise((function(e,n){r.history.replace(t,e,n)}));this.history.replace(t,e,n)},Ht.prototype.go=function(t){this.history.go(t)},Ht.prototype.back=function(){this.go(-1)},Ht.prototype.forward=function(){this.go(1)},Ht.prototype.getMatchedComponents=function(t){var e=t?t.matched?t:this.resolve(t).route:this.currentRoute;return e?[].concat.apply([],e.matched.map((function(t){return Object.keys(t.components).map((function(e){return t.components[e]}))}))):[]},Ht.prototype.resolve=function(t,e,n){var r=H(t,e=e||this.history.current,n,this),o=this.match(r,e),i=o.redirectedFrom||o.fullPath;return{location:r,route:o,href:function(t,e,n){var r="hash"===n?"#"+e:e;return t?S(t+"/"+r):r}(this.history.base,i,this.mode),normalizedTo:r,resolved:o}},Ht.prototype.getRoutes=function(){return this.matcher.getRoutes()},Ht.prototype.addRoute=function(t,e){this.matcher.addRoute(t,e),this.history.current!==g&&this.history.transitionTo(this.history.getCurrentLocation())},Ht.prototype.addRoutes=function(t){this.matcher.addRoutes(t),this.history.current!==g&&this.history.transitionTo(this.history.getCurrentLocation())},Object.defineProperties(Ht.prototype,qt);var Wt=Ht;function Gt(t,e){return t.push(e),function(){var n=t.indexOf(e);n>-1&&t.splice(n,1)}}Ht.install=function t(e){if(!t.installed||q!==e){t.installed=!0,q=e;var n=function(t){return void 0!==t},r=function(t,e){var r=t.$options._parentVnode;n(r)&&n(r=r.data)&&n(r=r.registerRouteInstance)&&r(t,e)};e.mixin({beforeCreate:function(){n(this.$options.router)?(this._routerRoot=this,this._router=this.$options.router,this._router.init(this),e.util.defineReactive(this,"_route",this._router.history.current)):this._routerRoot=this.$parent&&this.$parent._routerRoot||this,r(this,this)},destroyed:function(){r(this)}}),Object.defineProperty(e.prototype,"$router",{get:function(){return this._routerRoot._router}}),Object.defineProperty(e.prototype,"$route",{get:function(){return this._routerRoot._route}}),e.component("RouterView",x),e.component("RouterLink",G);var o=e.config.optionMergeStrategies;o.beforeRouteEnter=o.beforeRouteLeave=o.beforeRouteUpdate=o.created}},Ht.version="3.6.5",Ht.isNavigationFailure=St,Ht.NavigationFailureType=bt,Ht.START_LOCATION=g,X&&window.Vue&&window.Vue.use(Ht);n(92);n(121),n(90);var Kt={DropdownLink:()=>Promise.all([n.e(0),n.e(8)]).then(n.bind(null,244)),DropdownTransition:()=>Promise.all([n.e(0),n.e(13)]).then(n.bind(null,243)),Home:()=>Promise.all([n.e(1),n.e(11)]).then(n.bind(null,258)),Layout:()=>Promise.all([n.e(0),n.e(1),n.e(2),n.e(4)]).then(n.bind(null,282)),NavLink:()=>n.e(16).then(n.bind(null,241)),NavLinks:()=>Promise.all([n.e(0),n.e(7)]).then(n.bind(null,246)),Navbar:()=>Promise.all([n.e(0),n.e(5)]).then(n.bind(null,259)),NotFound:()=>n.e(24).then(n.bind(null,283)),Page:()=>n.e(17).then(n.bind(null,260)),SearchBox:()=>n.e(25).then(n.bind(null,250)),Sidebar:()=>Promise.all([n.e(0),n.e(2)]).then(n.bind(null,281)),SidebarButton:()=>n.e(26).then(n.bind(null,252)),SidebarGroup:()=>Promise.all([n.e(0),n.e(6)]).then(n.bind(null,261)),SidebarLink:()=>n.e(18).then(n.bind(null,247)),SlickCarousel:()=>Promise.all([n.e(1),n.e(27)]).then(n.bind(null,249)),VersionSelect:()=>n.e(19).then(n.bind(null,251)),VersionSelectItem:()=>n.e(28).then(n.bind(null,245))},Xt={"v-680eebc3":()=>n.e(29).then(n.bind(null,284)),"v-7d127123":()=>n.e(31).then(n.bind(null,285)),"v-4a1e6e3a":()=>n.e(9).then(n.bind(null,286)),"v-10fe793a":()=>n.e(32).then(n.bind(null,287)),"v-4e72e1d8":()=>n.e(30).then(n.bind(null,288)),"v-ef34fffa":()=>n.e(33).then(n.bind(null,289)),"v-090070fa":()=>n.e(34).then(n.bind(null,290)),"v-622f23e3":()=>n.e(12).then(n.bind(null,291)),"v-0af75f63":()=>n.e(35).then(n.bind(null,292)),"v-67c3f2ba":()=>n.e(10).then(n.bind(null,293)),"v-cc322cfa":()=>n.e(36).then(n.bind(null,294)),"v-e4c1f74e":()=>n.e(37).then(n.bind(null,295)),"v-26037fe3":()=>n.e(38).then(n.bind(null,296)),"v-37f7de3e":()=>n.e(40).then(n.bind(null,297)),"v-7c7b3203":()=>n.e(41).then(n.bind(null,298)),"v-9619ebfa":()=>n.e(39).then(n.bind(null,299)),"v-00d38f11":()=>n.e(43).then(n.bind(null,300)),"v-07a77f72":()=>n.e(42).then(n.bind(null,301)),"v-d39223ba":()=>n.e(20).then(n.bind(null,302)),"v-a31c3dba":()=>n.e(44).then(n.bind(null,303)),"v-481dea23":()=>n.e(46).then(n.bind(null,304)),"v-6f0eac21":()=>n.e(45).then(n.bind(null,305)),"v-15b388aa":()=>n.e(47).then(n.bind(null,306)),"v-8a6363ba":()=>n.e(48).then(n.bind(null,307)),"v-7f0b5429":()=>n.e(49).then(n.bind(null,308)),"v-29055241":()=>n.e(50).then(n.bind(null,309)),"v-c0e60bfa":()=>n.e(21).then(n.bind(null,310)),"v-589003f5":()=>n.e(51).then(n.bind(null,311)),"v-7ffeb723":()=>n.e(53).then(n.bind(null,312)),"v-019cb63a":()=>n.e(52).then(n.bind(null,313)),"v-4f03fe0f":()=>n.e(55).then(n.bind(null,314)),"v-9478f2ba":()=>n.e(54).then(n.bind(null,315)),"v-5baa92ba":()=>n.e(56).then(n.bind(null,316)),"v-c249e07a":()=>n.e(57).then(n.bind(null,317)),"v-27941b23":()=>n.e(58).then(n.bind(null,318)),"v-6f4baca5":()=>n.e(59).then(n.bind(null,319)),"v-fa75e63a":()=>n.e(60).then(n.bind(null,320)),"v-dacf6e56":()=>n.e(61).then(n.bind(null,321)),"v-8eec473a":()=>n.e(62).then(n.bind(null,322)),"v-29d5bc56":()=>n.e(63).then(n.bind(null,323)),"v-cbda523a":()=>n.e(64).then(n.bind(null,324)),"v-a75af93a":()=>n.e(65).then(n.bind(null,325)),"v-d6319362":()=>n.e(67).then(n.bind(null,326)),"v-7b99cfba":()=>n.e(14).then(n.bind(null,327)),"v-22ba6d3a":()=>n.e(66).then(n.bind(null,328)),"v-6ec4d123":()=>n.e(68).then(n.bind(null,329)),"v-5c5d50fa":()=>n.e(69).then(n.bind(null,330)),"v-6cd19ba3":()=>n.e(70).then(n.bind(null,331)),"v-55eb8eca":()=>n.e(15).then(n.bind(null,332)),"v-1ec46263":()=>n.e(22).then(n.bind(null,333)),"v-9213d4fa":()=>n.e(71).then(n.bind(null,334))};function Qt(t){const e=Object.create(null);return function(n){return e[n]||(e[n]=t(n))}}const Jt=/-(\w)/g,Yt=Qt(t=>t.replace(Jt,(t,e)=>e?e.toUpperCase():"")),Zt=/\B([A-Z])/g,te=Qt(t=>t.replace(Zt,"-$1").toLowerCase()),ee=Qt(t=>t.charAt(0).toUpperCase()+t.slice(1));function ne(t,e){if(!e)return;if(t(e))return t(e);return e.includes("-")?t(ee(Yt(e))):t(ee(e))||t(te(e))}const re=Object.assign({},Kt,Xt),oe=t=>re[t],ie=t=>Xt[t],ae=t=>Kt[t],se=t=>r.a.component(t);function le(t){return ne(ie,t)}function ue(t){return ne(ae,t)}function ce(t){return ne(oe,t)}function fe(t){return ne(se,t)}function pe(...t){return Promise.all(t.filter(t=>t).map(async t=>{if(!fe(t)&&ce(t)){const e=await ce(t)();r.a.component(t,e.default)}}))}function de(t,e){"undefined"!=typeof window&&window.__VUEPRESS__&&(window.__VUEPRESS__[t]=e)}var he=n(87),ve=n.n(he),ge=n(88),me=n.n(ge);function ye(){const t=document.querySelector("link[rel='canonical']");t&&t.remove()}function be(t=""){return t?``:""}function _e(t,e){if(e&&[...e].filter(t=>t.parentNode===document.head).forEach(t=>document.head.removeChild(t)),t)return t.map(t=>{const e=document.createElement("meta");return Object.keys(t).forEach(n=>{e.setAttribute(n,t[n])}),document.head.appendChild(e),e})}function we(t){for(const e of["name","property","itemprop"])if(t.hasOwnProperty(e))return t[e]+e;return JSON.stringify(t)}var xe=[{created(){if(this.siteMeta=this.$site.headTags.filter(([t])=>"meta"===t).map(([t,e])=>e),this.$ssrContext){const e=this.getMergedMetaTags();this.$ssrContext.title=this.$title,this.$ssrContext.lang=this.$lang,this.$ssrContext.pageMeta=(t=e)?t.map(t=>{let e="{e+=` ${n}="${me()(t[n])}"`}),e+">"}).join("\n "):"",this.$ssrContext.canonicalLink=be(this.$canonicalUrl)}var t},mounted(){this.currentMetaTags=[...document.querySelectorAll("meta")],this.updateMeta(),this.updateCanonicalLink()},methods:{updateMeta(){document.title=this.$title,document.documentElement.lang=this.$lang;const t=this.getMergedMetaTags();this.currentMetaTags=_e(t,this.currentMetaTags)},getMergedMetaTags(){const t=this.$page.frontmatter.meta||[];return ve()([{name:"description",content:this.$description}],t,this.siteMeta,we)},updateCanonicalLink(){ye(),this.$canonicalUrl&&document.head.insertAdjacentHTML("beforeend",be(this.$canonicalUrl))}},watch:{$page(){this.updateMeta(),this.updateCanonicalLink()}},beforeDestroy(){_e(null,this.currentMetaTags),ye()}}],Ce={name:"GlobalLayout",computed:{layout(){const t=this.getLayout();return de("layout",t),r.a.component(t)}},methods:{getLayout(){if(this.$page.path){const t=this.$page.frontmatter.layout;return t&&(this.$vuepress.getLayoutAsyncComponent(t)||this.$vuepress.getVueComponent(t))?t:"Layout"}return"NotFound"}}},ke=n(15),Se=Object(ke.a)(Ce,(function(){return(0,this._self._c)(this.layout,{tag:"component"})}),[],!1,null,null,null).exports;!function(t,e,n){switch(e){case"components":t[e]||(t[e]={}),Object.assign(t[e],n);break;case"mixins":t[e]||(t[e]=[]),t[e].push(...n);break;default:throw new Error("Unknown option name.")}}(Se,"mixins",xe);const Pe=[{name:"v-680eebc3",path:"/404.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-680eebc3").then(n)}},{name:"v-7d127123",path:"/community/about.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-7d127123").then(n)}},{name:"v-4a1e6e3a",path:"/community/config/eggs/creating_a_custom_egg.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-4a1e6e3a").then(n)}},{name:"v-10fe793a",path:"/community/config/eggs/creating_a_custom_image.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-10fe793a").then(n)}},{name:"v-4e72e1d8",path:"/",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-4e72e1d8").then(n)}},{path:"/index.html",redirect:"/"},{name:"v-ef34fffa",path:"/community/customization/panel.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-ef34fffa").then(n)}},{name:"v-090070fa",path:"/community/customization/wings.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-090070fa").then(n)}},{name:"v-622f23e3",path:"/community/config/nodes/add_node.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-622f23e3").then(n)}},{name:"v-0af75f63",path:"/community/installation-guides/panel/centos7.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-0af75f63").then(n)}},{name:"v-67c3f2ba",path:"/community/games/minecraft.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-67c3f2ba").then(n)}},{name:"v-cc322cfa",path:"/community/installation-guides/panel/centos8.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-cc322cfa").then(n)}},{name:"v-e4c1f74e",path:"/community/installation-guides/panel/debian.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-e4c1f74e").then(n)}},{name:"v-26037fe3",path:"/community/installation-guides/wings/centos7.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-26037fe3").then(n)}},{name:"v-37f7de3e",path:"/community/installation-guides/wings/debian.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-37f7de3e").then(n)}},{name:"v-7c7b3203",path:"/community/tutorials/artisan.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-7c7b3203").then(n)}},{name:"v-9619ebfa",path:"/community/installation-guides/wings/centos8.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-9619ebfa").then(n)}},{name:"v-00d38f11",path:"/daemon/0.6/debian_8_docker.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-00d38f11").then(n)}},{name:"v-07a77f72",path:"/daemon/0.6/configuration.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-07a77f72").then(n)}},{name:"v-d39223ba",path:"/daemon/0.6/installing.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-d39223ba").then(n)}},{name:"v-a31c3dba",path:"/daemon/0.6/kernel_modifications.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-a31c3dba").then(n)}},{name:"v-481dea23",path:"/daemon/0.6/upgrade/0.4_to_0.5.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-481dea23").then(n)}},{name:"v-6f0eac21",path:"/daemon/0.6/standalone_sftp.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-6f0eac21").then(n)}},{name:"v-15b388aa",path:"/daemon/0.6/upgrade/0.5.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-15b388aa").then(n)}},{name:"v-8a6363ba",path:"/daemon/0.6/upgrade/0.5_to_0.6.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-8a6363ba").then(n)}},{name:"v-7f0b5429",path:"/daemon/0.6/upgrade/0.6.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-7f0b5429").then(n)}},{name:"v-29055241",path:"/daemon/0.6/upgrading.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-29055241").then(n)}},{name:"v-c0e60bfa",path:"/guides/mounts.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-c0e60bfa").then(n)}},{name:"v-589003f5",path:"/guides/php_upgrade.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-589003f5").then(n)}},{name:"v-7ffeb723",path:"/panel/0.7/getting_started.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-7ffeb723").then(n)}},{name:"v-019cb63a",path:"/panel/0.7/configuration.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-019cb63a").then(n)}},{name:"v-4f03fe0f",path:"/panel/0.7/upgrade/0.6_to_0.7.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-4f03fe0f").then(n)}},{name:"v-9478f2ba",path:"/panel/0.7/troubleshooting.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-9478f2ba").then(n)}},{name:"v-5baa92ba",path:"/panel/0.7/upgrade/0.7.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-5baa92ba").then(n)}},{name:"v-c249e07a",path:"/panel/0.7/upgrading.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-c249e07a").then(n)}},{name:"v-27941b23",path:"/panel/0.7/webserver_configuration.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-27941b23").then(n)}},{name:"v-6f4baca5",path:"/panel/1.0/additional_configuration.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-6f4baca5").then(n)}},{name:"v-fa75e63a",path:"/panel/1.0/getting_started.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-fa75e63a").then(n)}},{name:"v-dacf6e56",path:"/panel/1.0/legacy_upgrade.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-dacf6e56").then(n)}},{name:"v-8eec473a",path:"/panel/1.0/troubleshooting.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-8eec473a").then(n)}},{name:"v-29d5bc56",path:"/panel/1.0/updating.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-29d5bc56").then(n)}},{name:"v-cbda523a",path:"/panel/1.0/webserver_configuration.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-cbda523a").then(n)}},{name:"v-a75af93a",path:"/project/about.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-a75af93a").then(n)}},{name:"v-d6319362",path:"/project/introduction.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-d6319362").then(n)}},{name:"v-7b99cfba",path:"/project/terms.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-7b99cfba").then(n)}},{name:"v-22ba6d3a",path:"/project/community.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-22ba6d3a").then(n)}},{name:"v-6ec4d123",path:"/tutorials/creating_ssl_certificates.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-6ec4d123").then(n)}},{name:"v-5c5d50fa",path:"/tutorials/mysql_setup.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-5c5d50fa").then(n)}},{name:"v-6cd19ba3",path:"/wings/1.0/configuration.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-6cd19ba3").then(n)}},{name:"v-55eb8eca",path:"/wings/1.0/installing.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-55eb8eca").then(n)}},{name:"v-1ec46263",path:"/wings/1.0/migrating.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-1ec46263").then(n)}},{name:"v-9213d4fa",path:"/wings/1.0/upgrading.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-9213d4fa").then(n)}},{path:"*",component:Se}],Oe={title:"Pterodactyl",description:"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.",base:"/",headTags:[["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:"msapplication-config",content:"/favicons/browserconfig.xml"}],["meta",{name:"theme-color",content:"#0e4688"}]],pages:[{frontmatter:{},regularPath:"/404.html",relativePath:"404.md",key:"v-680eebc3",path:"/404.html"},{title:"Community Guides and Tutorials",frontmatter:{},regularPath:"/community/about.html",relativePath:"community/about.md",key:"v-7d127123",path:"/community/about.html",headers:[{level:2,title:"About",slug:"about"}]},{title:"Creating a Custom Egg",frontmatter:{},regularPath:"/community/config/eggs/creating_a_custom_egg.html",relativePath:"community/config/eggs/creating_a_custom_egg.md",key:"v-4a1e6e3a",path:"/community/config/eggs/creating_a_custom_egg.html",headers:[{level:2,title:"Create New Option",slug:"create-new-option"},{level:2,title:"Configure Process Management",slug:"configure-process-management"},{level:3,title:"Stop Command",slug:"stop-command"},{level:3,title:"Log Storage",slug:"log-storage"},{level:3,title:"Configuration Files",slug:"configuration-files"},{level:3,title:"Start Configuration",slug:"start-configuration"},{level:2,title:"Copy Settings From",slug:"copy-settings-from"},{level:2,title:"Egg Variables",slug:"egg-variables"},{level:2,title:"List of default variables",slug:"list-of-default-variables"}]},{title:"Creating a Custom Docker Image",frontmatter:{},regularPath:"/community/config/eggs/creating_a_custom_image.html",relativePath:"community/config/eggs/creating_a_custom_image.md",key:"v-10fe793a",path:"/community/config/eggs/creating_a_custom_image.html",headers:[{level:2,title:"Creating the Dockerfile",slug:"creating-the-dockerfile"},{level:2,title:"Installing Dependencies",slug:"installing-dependencies"},{level:2,title:"Creating a Container User",slug:"creating-a-container-user"},{level:2,title:"Work Directory & Entrypoint",slug:"work-directory-entrypoint"},{level:2,title:"Entrypoint Script",slug:"entrypoint-script"},{level:2,title:"Modifying the Startup Command",slug:"modifying-the-startup-command"},{level:2,title:"Run the Command",slug:"run-the-command"},{level:3,title:"Note",slug:"note"}]},{title:"Home",frontmatter:{home:!0,heroImage:"/doc_pterry.png",actionText:"Get Started →",actionLink:"/project/introduction",features:[{title:"Security First",details:"Security is a first-class citizen on this platform with bcrypt hashing, AES-256-CBC encryption, and HTTPS support out of the box."},{title:"Modern Tooling",details:"Built on a modern stack utilizing the best design practices that make it easy to jump in and make modifications."},{title:"Docker to the Core",details:"All servers run in isolated Docker containers that limit attack vectors, provide strict resource limits, and provide environments tailored to each specific game."}],footer:"MIT Licensed | Copyright © Dane Everitt and contributors"},regularPath:"/",relativePath:"README.md",key:"v-4e72e1d8",path:"/"},{title:"Building Panel Assets",frontmatter:{},regularPath:"/community/customization/panel.html",relativePath:"community/customization/panel.md",key:"v-ef34fffa",path:"/community/customization/panel.html",headers:[{level:2,title:"Install Dependencies",slug:"install-dependencies"},{level:2,title:"Build Panel Assets",slug:"build-panel-assets"}]},{title:"Building Wings",frontmatter:{},regularPath:"/community/customization/wings.html",relativePath:"community/customization/wings.md",key:"v-090070fa",path:"/community/customization/wings.html",headers:[{level:2,title:"Build Requirements",slug:"build-requirements"},{level:2,title:"Building",slug:"building"},{level:2,title:"Install the new binary",slug:"install-the-new-binary"},{level:2,title:"Troubleshooting",slug:"troubleshooting"}]},{title:"Creating a New Node",frontmatter:{},regularPath:"/community/config/nodes/add_node.html",relativePath:"community/config/nodes/add_node.md",key:"v-622f23e3",path:"/community/config/nodes/add_node.html",headers:[{level:2,title:"Location",slug:"location"},{level:2,title:"Information Required",slug:"information-required"},{level:2,title:"Install the Daemon",slug:"install-the-daemon"},{level:2,title:"Configuring the Node",slug:"configuring-the-node"},{level:3,title:"Auto-Deploy",slug:"auto-deploy"}]},{title:"CentOS 7",frontmatter:{},regularPath:"/community/installation-guides/panel/centos7.html",relativePath:"community/installation-guides/panel/centos7.md",key:"v-0af75f63",path:"/community/installation-guides/panel/centos7.html",headers:[{level:2,title:"Install Dependencies",slug:"install-dependencies"},{level:3,title:"SELinux Configuration",slug:"selinux-configuration"},{level:3,title:"Installing Dependencies",slug:"installing-dependencies"},{level:2,title:"Server Configuration",slug:"server-configuration"},{level:3,title:"PHP Configuration",slug:"php-configuration"},{level:3,title:"SELinux configuration",slug:"selinux-configuration-2"},{level:2,title:"Installing the Panel",slug:"installing-the-panel"}]},{title:"Minecraft",frontmatter:{},regularPath:"/community/games/minecraft.html",relativePath:"community/games/minecraft.md",key:"v-67c3f2ba",path:"/community/games/minecraft.html",headers:[{level:2,title:"Configuring a Server Network (BungeeCord, Waterfall, HexaCord, etc.)",slug:"configuring-a-server-network-bungeecord-waterfall-hexacord-etc"},{level:3,title:"Allocations in the Panel",slug:"allocations-in-the-panel"},{level:3,title:"proxy server settings",slug:"proxy-server-settings"},{level:3,title:"paper/spigot/bukkit settings",slug:"paper-spigot-bukkit-settings"},{level:3,title:"Firewalls",slug:"firewalls"}]},{title:"Enterprise Linux 8 and Fedora Server 40",frontmatter:{},regularPath:"/community/installation-guides/panel/centos8.html",relativePath:"community/installation-guides/panel/centos8.md",key:"v-cc322cfa",path:"/community/installation-guides/panel/centos8.html",headers:[{level:2,title:"Install Dependencies",slug:"install-dependencies"},{level:3,title:"SELinux Configuration",slug:"selinux-configuration"},{level:3,title:"Installing Dependencies",slug:"installing-dependencies"},{level:2,title:"PHP Configuration",slug:"php-configuration"},{level:2,title:"Installing the Panel",slug:"installing-the-panel"}]},{title:"Debian 11 & 12",frontmatter:{},regularPath:"/community/installation-guides/panel/debian.html",relativePath:"community/installation-guides/panel/debian.md",key:"v-e4c1f74e",path:"/community/installation-guides/panel/debian.html",headers:[{level:2,title:"Dependency Installation",slug:"dependency-installation"},{level:3,title:"Installing Composer",slug:"installing-composer"},{level:3,title:"Download Files",slug:"download-files"}]},{title:"CentOS 7",frontmatter:{},regularPath:"/community/installation-guides/wings/centos7.html",relativePath:"community/installation-guides/wings/centos7.md",key:"v-26037fe3",path:"/community/installation-guides/wings/centos7.html",headers:[{level:2,title:"Install Dependencies",slug:"install-dependencies"},{level:2,title:"Installing Wings",slug:"installing-wings"}]},{title:"Debian 11 & 12",frontmatter:{},regularPath:"/community/installation-guides/wings/debian.html",relativePath:"community/installation-guides/wings/debian.md",key:"v-37f7de3e",path:"/community/installation-guides/wings/debian.html",headers:[{level:2,title:"Install",slug:"install"}]},{title:"Artisan CLI",frontmatter:{},regularPath:"/community/tutorials/artisan.html",relativePath:"community/tutorials/artisan.md",key:"v-7c7b3203",path:"/community/tutorials/artisan.html",headers:[{level:2,title:"User Management",slug:"user-management"},{level:3,title:"Create User",slug:"create-user"},{level:3,title:"Delete User",slug:"delete-user"},{level:3,title:"Disable 2FA",slug:"disable-2fa"},{level:2,title:"Server & Node Management",slug:"server-node-management"},{level:3,title:"Create Location",slug:"create-location"},{level:3,title:"Delete Location",slug:"delete-location"},{level:3,title:"Server Bulk Power",slug:"server-bulk-power"},{level:2,title:"Panel Management",slug:"panel-management"},{level:3,title:"View Panel Info",slug:"view-panel-info"},{level:3,title:"Update Panel",slug:"update-panel"}]},{title:"Enterprise Linux 8 and Fedora Server 40",frontmatter:{},regularPath:"/community/installation-guides/wings/centos8.html",relativePath:"community/installation-guides/wings/centos8.md",key:"v-9619ebfa",path:"/community/installation-guides/wings/centos8.html",headers:[{level:2,title:"Install Dependencies",slug:"install-dependencies"},{level:2,title:"Installing Wings",slug:"installing-wings"}]},{title:"Docker on Debian 8",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/daemon/0.6/debian_8_docker.html",relativePath:"daemon/0.6/debian_8_docker.md",key:"v-00d38f11",path:"/daemon/0.6/debian_8_docker.html",headers:[{level:2,title:"Install Docker",slug:"install-docker"},{level:2,title:"Update GRUB Startup",slug:"update-grub-startup"},{level:2,title:"Add Backports Repo",slug:"add-backports-repo"},{level:2,title:"Update Software & Setup Docker",slug:"update-software-setup-docker"}]},{title:"Additional Configuration",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/daemon/0.6/configuration.html",relativePath:"daemon/0.6/configuration.md",key:"v-07a77f72",path:"/daemon/0.6/configuration.html",headers:[{level:2,title:"Output Throttles",slug:"output-throttles"},{level:2,title:"Custom Network Interfaces",slug:"custom-network-interfaces"},{level:2,title:"Private Registries",slug:"private-registries"},{level:2,title:"Security Policies",slug:"security-policies"},{level:2,title:"Container Policy",slug:"container-policy"},{level:3,title:"Default Security Opts Array",slug:"default-security-opts-array"},{level:3,title:"Default Capabilities Drop Array",slug:"default-capabilities-drop-array"},{level:2,title:"Enabling Cloudflare",slug:"enabling-cloudflare"}]},{title:"Installation",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/daemon/0.6/installing.html",relativePath:"daemon/0.6/installing.md",key:"v-d39223ba",path:"/daemon/0.6/installing.html",headers:[{level:2,title:"Supported Systems",slug:"supported-systems"},{level:2,title:"System Requirements",slug:"system-requirements"},{level:2,title:"Dependencies",slug:"dependencies"},{level:3,title:"Installing Docker",slug:"installing-docker"},{level:3,title:"Installing Nodejs",slug:"installing-nodejs"},{level:2,title:"Installing Daemon Software",slug:"installing-daemon-software"},{level:2,title:"Configure Daemon",slug:"configure-daemon"},{level:2,title:"Starting the Daemon",slug:"starting-the-daemon"},{level:3,title:"Daemonizing (using systemd)",slug:"daemonizing-using-systemd"}]},{title:"Kernel Modifications",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/daemon/0.6/kernel_modifications.html",relativePath:"daemon/0.6/kernel_modifications.md",key:"v-a31c3dba",path:"/daemon/0.6/kernel_modifications.html",headers:[{level:2,title:"Update Kernel",slug:"update-kernel"},{level:2,title:"Confirm Kernel",slug:"confirm-kernel"},{level:2,title:"Set Default Boot",slug:"set-default-boot"},{level:2,title:"Boot from hard disk",slug:"boot-from-hard-disk"}]},{title:"Upgrading 0.4.X to 0.5.X",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/daemon/0.6/upgrade/0.4_to_0.5.html",relativePath:"daemon/0.6/upgrade/0.4_to_0.5.md",key:"v-481dea23",path:"/daemon/0.6/upgrade/0.4_to_0.5.html",headers:[{level:2,title:"Docker Adjustments",slug:"docker-adjustments"},{level:2,title:"Download Files",slug:"download-files"},{level:2,title:"SFTP Cleanup",slug:"sftp-cleanup"},{level:2,title:"File Migration",slug:"file-migration"},{level:3,title:"Rebuild Containers",slug:"rebuild-containers"}]},{title:"Standalone SFTP Server",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/daemon/0.6/standalone_sftp.html",relativePath:"daemon/0.6/standalone_sftp.md",key:"v-6f0eac21",path:"/daemon/0.6/standalone_sftp.html",headers:[{level:2,title:"Disable Daemon's Server",slug:"disable-daemon-s-server"},{level:2,title:"Run the Standalone Server",slug:"run-the-standalone-server"},{level:3,title:"Start the Server",slug:"start-the-server"},{level:2,title:"Daemonize Server",slug:"daemonize-server"},{level:3,title:"Customizing Startup",slug:"customizing-startup"}]},{title:"Upgrading 0.5 Series",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/daemon/0.6/upgrade/0.5.html",relativePath:"daemon/0.6/upgrade/0.5.md",key:"v-15b388aa",path:"/daemon/0.6/upgrade/0.5.html",headers:[{level:2,title:"Download Newest Release",slug:"download-newest-release"},{level:2,title:"Update Components",slug:"update-components"}]},{title:"Upgrading 0.5.X to 0.6.X",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/daemon/0.6/upgrade/0.5_to_0.6.html",relativePath:"daemon/0.6/upgrade/0.5_to_0.6.md",key:"v-8a6363ba",path:"/daemon/0.6/upgrade/0.5_to_0.6.html",headers:[{level:2,title:"Breaking Changes",slug:"breaking-changes"},{level:2,title:"Download Files",slug:"download-files"},{level:3,title:"Start the Daemon",slug:"start-the-daemon"},{level:2,title:"Rebuild Containers",slug:"rebuild-containers"}]},{title:"Upgrading 0.6 Series",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/daemon/0.6/upgrade/0.6.html",relativePath:"daemon/0.6/upgrade/0.6.md",key:"v-7f0b5429",path:"/daemon/0.6/upgrade/0.6.html",headers:[{level:2,title:"Download Newest Release",slug:"download-newest-release"},{level:2,title:"Update Components",slug:"update-components"}]},{title:"Upgrading",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/daemon/0.6/upgrading.html",relativePath:"daemon/0.6/upgrading.md",key:"v-29055241",path:"/daemon/0.6/upgrading.html",headers:[{level:2,title:"Version Specific Guides",slug:"version-specific-guides"}]},{title:"Using Mounts",frontmatter:{},regularPath:"/guides/mounts.html",relativePath:"guides/mounts.md",key:"v-c0e60bfa",path:"/guides/mounts.html",headers:[{level:2,title:"Wings Configuration",slug:"wings-configuration"},{level:2,title:"Panel Configuration",slug:"panel-configuration"},{level:3,title:"Creating a Mount",slug:"creating-a-mount"},{level:3,title:"Assigning a Mount to a Server",slug:"assigning-a-mount-to-a-server"},{level:3,title:"Example Mount",slug:"example-mount"}]},{title:"Upgrading PHP",frontmatter:{},regularPath:"/guides/php_upgrade.html",relativePath:"guides/php_upgrade.md",key:"v-589003f5",path:"/guides/php_upgrade.html",headers:[{level:2,title:"Install PHP",slug:"install-php"},{level:2,title:"Update Composer",slug:"update-composer"},{level:2,title:"Webserver Configuration",slug:"webserver-configuration"},{level:3,title:"Return to the 1.X.X Upgrade Guide",slug:"return-to-the-1-x-x-upgrade-guide"}]},{title:"Getting Started",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/panel/0.7/getting_started.html",relativePath:"panel/0.7/getting_started.md",key:"v-7ffeb723",path:"/panel/0.7/getting_started.html",headers:[{level:2,title:"Picking a Server OS",slug:"picking-a-server-os"},{level:2,title:"Dependencies",slug:"dependencies"},{level:3,title:"Example Dependency Installation",slug:"example-dependency-installation"},{level:3,title:"Installing Composer",slug:"installing-composer"},{level:2,title:"Download Files",slug:"download-files"},{level:2,title:"Installation",slug:"installation"},{level:3,title:"Environment Configuration",slug:"environment-configuration"},{level:3,title:"Database Setup",slug:"database-setup"},{level:3,title:"Add The First User",slug:"add-the-first-user"},{level:3,title:"Set Permissions",slug:"set-permissions"},{level:2,title:"Queue Listeners",slug:"queue-listeners"},{level:3,title:"Crontab Configuration",slug:"crontab-configuration"},{level:3,title:"Create Queue Worker",slug:"create-queue-worker"}]},{title:"Environment Configuration",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/panel/0.7/configuration.html",relativePath:"panel/0.7/configuration.md",key:"v-019cb63a",path:"/panel/0.7/configuration.html",headers:[{level:2,title:"Reporting All Exceptions",slug:"reporting-all-exceptions"},{level:2,title:"Client Databases",slug:"client-databases"},{level:2,title:"Reverse Proxy Setup",slug:"reverse-proxy-setup"},{level:3,title:"NGINX Specific Configuration",slug:"nginx-specific-configuration"},{level:3,title:"Cloudflare Specific Configuration",slug:"cloudflare-specific-configuration"},{level:2,title:"Increasing the Editable File Size",slug:"increasing-the-editable-file-size"},{level:2,title:"Disable or Modify ReCaptcha",slug:"disable-or-modify-recaptcha"},{level:3,title:"Using Your Own Keys",slug:"using-your-own-keys"}]},{title:"Upgrading 0.6 to 0.7",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/panel/0.7/upgrade/0.6_to_0.7.html",relativePath:"panel/0.7/upgrade/0.6_to_0.7.md",key:"v-4f03fe0f",path:"/panel/0.7/upgrade/0.6_to_0.7.html",headers:[{level:2,title:"Fetch Updated Files",slug:"fetch-updated-files"},{level:2,title:"Clear Compiled Assets",slug:"clear-compiled-assets"},{level:2,title:"Update Dependencies",slug:"update-dependencies"},{level:2,title:"Update Environment",slug:"update-environment"},{level:2,title:"Database Updates",slug:"database-updates"},{level:2,title:"Cleanup API Keys",slug:"cleanup-api-keys"},{level:2,title:"Set Permissions",slug:"set-permissions"}]},{title:"Troubleshooting",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/panel/0.7/troubleshooting.html",relativePath:"panel/0.7/troubleshooting.md",key:"v-9478f2ba",path:"/panel/0.7/troubleshooting.html",headers:[{level:2,title:"Reading Error Logs",slug:"reading-error-logs"},{level:3,title:"Parsing the Error",slug:"parsing-the-error"},{level:3,title:"Understanding the Error",slug:"understanding-the-error"},{level:3,title:"Utilizing GREP",slug:"utilizing-grep"},{level:2,title:"Transfer Exceptions / XHR Poll Error",slug:"transfer-exceptions-xhr-poll-error"},{level:3,title:"Example Errors",slug:"example-errors"},{level:3,title:"Basic Debugging Steps",slug:"basic-debugging-steps"},{level:3,title:"More Advanced Debugging Steps",slug:"more-advanced-debugging-steps"},{level:2,title:"Invalid MAC Exception",slug:"invalid-mac-exception"},{level:2,title:"SELinux Issues",slug:"selinux-issues"},{level:3,title:"Redis Permissions Errors",slug:"redis-permissions-errors"},{level:3,title:"In case there is any weirdness with parts of the panel",slug:"in-case-there-is-any-weirdness-with-parts-of-the-panel"},{level:3,title:"Daemon Connection Errors",slug:"daemon-connection-errors"},{level:2,title:"FirewallD issues",slug:"firewalld-issues"},{level:2,title:"Database Errors",slug:"database-errors"},{level:3,title:"DatabaseController.php:142",slug:"databasecontroller-php-142"}]},{title:"Upgrading 0.7 Series",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/panel/0.7/upgrade/0.7.html",relativePath:"panel/0.7/upgrade/0.7.md",key:"v-5baa92ba",path:"/panel/0.7/upgrade/0.7.html",headers:[{level:2,title:"Fetch Updated Files",slug:"fetch-updated-files"},{level:2,title:"Update Dependencies",slug:"update-dependencies"},{level:2,title:"Clear Compiled Template Cache",slug:"clear-compiled-template-cache"},{level:2,title:"Database Updates",slug:"database-updates"},{level:2,title:"Set Permissions",slug:"set-permissions"}]},{title:"Upgrading",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/panel/0.7/upgrading.html",relativePath:"panel/0.7/upgrading.md",key:"v-c249e07a",path:"/panel/0.7/upgrading.html",headers:[{level:2,title:"Maintenance Mode",slug:"maintenance-mode"},{level:2,title:"Restarting Queue Workers",slug:"restarting-queue-workers"},{level:2,title:"Version Specific Guides",slug:"version-specific-guides"}]},{title:"Webserver Configuration",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/panel/0.7/webserver_configuration.html",relativePath:"panel/0.7/webserver_configuration.md",key:"v-27941b23",path:"/panel/0.7/webserver_configuration.html",headers:[{level:2,title:"NGINX",slug:"nginx"},{level:3,title:"NGINX With SSL",slug:"nginx-with-ssl"},{level:3,title:"NGINX Without SSL",slug:"nginx-without-ssl"},{level:3,title:"Enabling Configuration",slug:"enabling-configuration"},{level:2,title:"Apache",slug:"apache"},{level:3,title:"Apache With SSL",slug:"apache-with-ssl"},{level:3,title:"Apache Without SSL",slug:"apache-without-ssl"},{level:3,title:"Enabling Configuration",slug:"enabling-configuration-2"}]},{title:"Additional Configuration",frontmatter:{},regularPath:"/panel/1.0/additional_configuration.html",relativePath:"panel/1.0/additional_configuration.md",key:"v-6f4baca5",path:"/panel/1.0/additional_configuration.html",headers:[{level:2,title:"Backups",slug:"backups"},{level:3,title:"Using Local Backups",slug:"using-local-backups"},{level:3,title:"Using S3 Backups",slug:"using-s3-backups"},{level:2,title:"Reverse Proxy Setup",slug:"reverse-proxy-setup"},{level:3,title:"NGINX Specific Configuration",slug:"nginx-specific-configuration"},{level:3,title:"Cloudflare Specific Configuration",slug:"cloudflare-specific-configuration"},{level:2,title:"reCAPTCHA",slug:"recaptcha"},{level:3,title:"Configuring reCAPTCHA",slug:"configuring-recaptcha"},{level:3,title:"Disabling reCAPTCHA",slug:"disabling-recaptcha"},{level:2,title:"2FA",slug:"_2fa"},{level:3,title:"Disable 2FA requirement",slug:"disable-2fa-requirement"},{level:3,title:"Disable 2FA for a specific user",slug:"disable-2fa-for-a-specific-user"},{level:2,title:"Telemetry",slug:"telemetry"},{level:3,title:"How does it work?",slug:"how-does-it-work"},{level:3,title:"What data is collected?",slug:"what-data-is-collected"},{level:3,title:"How is the data stored?",slug:"how-is-the-data-stored"},{level:3,title:"Why?",slug:"why"},{level:3,title:"Enabling Telemetry",slug:"enabling-telemetry"},{level:3,title:"Disabling Telemetry",slug:"disabling-telemetry"}]},{title:"Getting Started",frontmatter:{},regularPath:"/panel/1.0/getting_started.html",relativePath:"panel/1.0/getting_started.md",key:"v-fa75e63a",path:"/panel/1.0/getting_started.html",headers:[{level:2,title:"Picking a Server OS",slug:"picking-a-server-os"},{level:2,title:"Dependencies",slug:"dependencies"},{level:3,title:"Example Dependency Installation",slug:"example-dependency-installation"},{level:3,title:"Installing Composer",slug:"installing-composer"},{level:2,title:"Download Files",slug:"download-files"},{level:2,title:"Installation",slug:"installation"},{level:3,title:"Environment Configuration",slug:"environment-configuration"},{level:3,title:"Database Setup",slug:"database-setup"},{level:3,title:"Add The First User",slug:"add-the-first-user"},{level:3,title:"Set Permissions",slug:"set-permissions"},{level:2,title:"Queue Listeners",slug:"queue-listeners"},{level:3,title:"Crontab Configuration",slug:"crontab-configuration"},{level:3,title:"Create Queue Worker",slug:"create-queue-worker"},{level:3,title:"Telemetry",slug:"telemetry"}]},{title:"Legacy Upgrades",frontmatter:{},regularPath:"/panel/1.0/legacy_upgrade.html",relativePath:"panel/1.0/legacy_upgrade.md",key:"v-dacf6e56",path:"/panel/1.0/legacy_upgrade.html",headers:[{level:2,title:"Enter Maintenance Mode",slug:"enter-maintenance-mode"},{level:2,title:"Update Dependencies",slug:"update-dependencies"},{level:2,title:"Fetch Updated Files",slug:"fetch-updated-files"},{level:2,title:"Update Dependencies",slug:"update-dependencies-2"},{level:2,title:"Clear Compiled Template Cache",slug:"clear-compiled-template-cache"},{level:2,title:"Database Updates",slug:"database-updates"},{level:2,title:"Set Permissions",slug:"set-permissions"},{level:2,title:"Restarting Queue Workers",slug:"restarting-queue-workers"},{level:2,title:"Exit Maintenance Mode",slug:"exit-maintenance-mode"},{level:2,title:"Switch to Wings",slug:"switch-to-wings"}]},{title:"Troubleshooting",frontmatter:{},regularPath:"/panel/1.0/troubleshooting.html",relativePath:"panel/1.0/troubleshooting.md",key:"v-8eec473a",path:"/panel/1.0/troubleshooting.html",headers:[{level:2,title:"Reading Error Logs",slug:"reading-error-logs"},{level:3,title:"Parsing the Error",slug:"parsing-the-error"},{level:3,title:"Understanding the Error",slug:"understanding-the-error"},{level:3,title:"Utilizing GREP",slug:"utilizing-grep"},{level:2,title:"Cannot Connect to Server Errors",slug:"cannot-connect-to-server-errors"},{level:3,title:"Basic Debugging Steps",slug:"basic-debugging-steps"},{level:3,title:"More Advanced Debugging Steps",slug:"more-advanced-debugging-steps"},{level:2,title:"Invalid MAC Exception",slug:"invalid-mac-exception"},{level:2,title:"SELinux Issues",slug:"selinux-issues"},{level:3,title:"Redis Permissions Errors",slug:"redis-permissions-errors"},{level:3,title:"Wings Connection Errors",slug:"wings-connection-errors"},{level:2,title:"Containers don't have internet? Probably a DNS issue!",slug:"containers-don-t-have-internet-probably-a-dns-issue"},{level:2,title:"Schedule Troubleshooting",slug:"schedule-troubleshooting"},{level:2,title:"FirewallD issues",slug:"firewalld-issues"}]},{title:"Updating the Panel",frontmatter:{},regularPath:"/panel/1.0/updating.html",relativePath:"panel/1.0/updating.md",key:"v-29d5bc56",path:"/panel/1.0/updating.html",headers:[{level:2,title:"Panel Version Requirements",slug:"panel-version-requirements"},{level:2,title:"Update Dependencies",slug:"update-dependencies"},{level:2,title:"Self Upgrade",slug:"self-upgrade"},{level:2,title:"Manual Upgrade",slug:"manual-upgrade"},{level:3,title:"Enter Maintenance Mode",slug:"enter-maintenance-mode"},{level:3,title:"Download the Update",slug:"download-the-update"},{level:3,title:"Update Dependencies",slug:"update-dependencies-2"},{level:3,title:"Clear Compiled Template Cache",slug:"clear-compiled-template-cache"},{level:3,title:"Database Updates",slug:"database-updates"},{level:3,title:"Set Permissions",slug:"set-permissions"},{level:3,title:"Restarting Queue Workers",slug:"restarting-queue-workers"},{level:3,title:"Exit Maintenance Mode",slug:"exit-maintenance-mode"},{level:3,title:"Telemetry",slug:"telemetry"}]},{title:"Webserver Configuration",frontmatter:{},regularPath:"/panel/1.0/webserver_configuration.html",relativePath:"panel/1.0/webserver_configuration.md",key:"v-cbda523a",path:"/panel/1.0/webserver_configuration.html",headers:[{level:3,title:"Enabling Configuration",slug:"enabling-configuration"},{level:3,title:"Enabling Configuration",slug:"enabling-configuration-2"},{level:3,title:"Enabling Configuration",slug:"enabling-configuration-3"},{level:3,title:"Enabling Configuration",slug:"enabling-configuration-4"},{level:3,title:"Enabling Configuration",slug:"enabling-configuration-5"},{level:3,title:"Enabling Configuration",slug:"enabling-configuration-6"}]},{title:"About",frontmatter:{},regularPath:"/project/about.html",relativePath:"project/about.md",key:"v-a75af93a",path:"/project/about.html",headers:[{level:2,title:"Core Project Team",slug:"core-project-team"},{level:2,title:"Community Team",slug:"community-team"},{level:2,title:"Sponsors",slug:"sponsors"},{level:2,title:"License",slug:"license"},{level:2,title:"Release Signing",slug:"release-signing"}]},{title:"Introduction",frontmatter:{},regularPath:"/project/introduction.html",relativePath:"project/introduction.md",key:"v-d6319362",path:"/project/introduction.html",headers:[{level:2,title:"Supported Games",slug:"supported-games"},{level:2,title:"Responsible Disclosure",slug:"responsible-disclosure"}]},{title:"Terminology",frontmatter:{},regularPath:"/project/terms.html",relativePath:"project/terms.md",key:"v-7b99cfba",path:"/project/terms.html",headers:[{level:2,title:"Simple Setup Diagram",slug:"simple-setup-diagram"},{level:2,title:"Advanced Setup Diagram",slug:"advanced-setup-diagram"}]},{title:"Community Standards",frontmatter:{},regularPath:"/project/community.html",relativePath:"project/community.md",key:"v-22ba6d3a",path:"/project/community.html",headers:[{level:2,title:"Community Guidelines",slug:"community-guidelines"},{level:3,title:"Be Mature",slug:"be-mature"},{level:3,title:"Limit the Drama",slug:"limit-the-drama"},{level:3,title:"Be Patient",slug:"be-patient"},{level:3,title:"No Commercial Services",slug:"no-commercial-services"},{level:3,title:"No Mention or Ping Spam",slug:"no-mention-or-ping-spam"}]},{title:"Creating SSL Certificates",frontmatter:{},regularPath:"/tutorials/creating_ssl_certificates.html",relativePath:"tutorials/creating_ssl_certificates.md",key:"v-6ec4d123",path:"/tutorials/creating_ssl_certificates.html",headers:[{level:2,title:"Creating a Certificate",slug:"creating-a-certificate"},{level:3,title:"HTTP challenge",slug:"http-challenge"},{level:3,title:"DNS challenge",slug:"dns-challenge"},{level:3,title:"Auto Renewal",slug:"auto-renewal"},{level:3,title:"Troubleshooting",slug:"troubleshooting"},{level:3,title:"Obtaining CloudFlare API Key (Legacy)",slug:"obtaining-cloudflare-api-key-legacy"},{level:3,title:"Creating a Certificate",slug:"creating-a-certificate-2"},{level:3,title:"Obtaining CloudFlare API Key (Modern)",slug:"obtaining-cloudflare-api-key-modern"},{level:3,title:"Creating a Certificate",slug:"creating-a-certificate-3"},{level:3,title:"Auto Renewal",slug:"auto-renewal-2"},{level:3,title:"Installing Caddy with Cloudflare DNS plugin",slug:"installing-caddy-with-cloudflare-dns-plugin"},{level:3,title:"Obtaining CloudFlare API Token",slug:"obtaining-cloudflare-api-token"},{level:3,title:"Reconfiguring Caddy to use Cloudflare DNS for obtaining certificates",slug:"reconfiguring-caddy-to-use-cloudflare-dns-for-obtaining-certificates"}]},{title:"Setting up MySQL",frontmatter:{},regularPath:"/tutorials/mysql_setup.html",relativePath:"tutorials/mysql_setup.md",key:"v-5c5d50fa",path:"/tutorials/mysql_setup.html",headers:[{level:2,title:"Creating a database for Pterodactyl",slug:"creating-a-database-for-pterodactyl"},{level:3,title:"Logging In",slug:"logging-in"},{level:3,title:"Creating a user",slug:"creating-a-user"},{level:3,title:"Create a database",slug:"create-a-database"},{level:3,title:"Assigning permissions",slug:"assigning-permissions"},{level:2,title:"Creating a Database Host for Nodes",slug:"creating-a-database-host-for-nodes"},{level:3,title:"Creating a user",slug:"creating-a-user-2"},{level:3,title:"Assigning permissions",slug:"assigning-permissions-2"},{level:3,title:"Allowing external database access",slug:"allowing-external-database-access"}]},{title:"Additional Configuration",frontmatter:{},regularPath:"/wings/1.0/configuration.html",relativePath:"wings/1.0/configuration.md",key:"v-6cd19ba3",path:"/wings/1.0/configuration.html",headers:[{level:2,title:"Private Registries",slug:"private-registries"},{level:3,title:"Available Keys",slug:"available-keys"},{level:3,title:"Example of usage",slug:"example-of-usage"},{level:2,title:"Custom Network Interfaces",slug:"custom-network-interfaces"},{level:3,title:"Example of usage",slug:"example-of-usage-2"},{level:2,title:"Enabling Cloudflare proxy",slug:"enabling-cloudflare-proxy"},{level:2,title:"Container PID Limit",slug:"container-pid-limit"},{level:3,title:"Example of usage",slug:"example-of-usage-3"},{level:2,title:"Throttles Limits",slug:"throttles-limits"},{level:3,title:"Example of usage",slug:"example-of-usage-4"},{level:2,title:"Installer Limits",slug:"installer-limits"},{level:3,title:"Example of usage",slug:"example-of-usage-5"},{level:2,title:"Other values",slug:"other-values"}]},{title:"Installing Wings",frontmatter:{},regularPath:"/wings/1.0/installing.html",relativePath:"wings/1.0/installing.md",key:"v-55eb8eca",path:"/wings/1.0/installing.html",headers:[{level:2,title:"Supported Systems",slug:"supported-systems"},{level:2,title:"System Requirements",slug:"system-requirements"},{level:2,title:"Dependencies",slug:"dependencies"},{level:3,title:"Installing Docker",slug:"installing-docker"},{level:2,title:"Installing Wings",slug:"installing-wings-2"},{level:2,title:"Configure",slug:"configure"},{level:3,title:"Starting Wings",slug:"starting-wings"},{level:3,title:"Daemonizing (using systemd)",slug:"daemonizing-using-systemd"},{level:3,title:"Node Allocations",slug:"node-allocations"}]},{title:"Migrating to Wings",frontmatter:{},regularPath:"/wings/1.0/migrating.html",relativePath:"wings/1.0/migrating.md",key:"v-1ec46263",path:"/wings/1.0/migrating.html",headers:[{level:2,title:"Install Wings",slug:"install-wings"},{level:2,title:"Copy New Configuration File",slug:"copy-new-configuration-file"},{level:2,title:"Remove Old Daemon",slug:"remove-old-daemon"},{level:3,title:"Remove Standalone SFTP",slug:"remove-standalone-sftp"},{level:2,title:"Daemonize Wings",slug:"daemonize-wings"}]},{title:"Upgrading Wings",frontmatter:{},regularPath:"/wings/1.0/upgrading.html",relativePath:"wings/1.0/upgrading.md",key:"v-9213d4fa",path:"/wings/1.0/upgrading.html",headers:[{level:2,title:"Wings Version Requirements",slug:"wings-version-requirements"},{level:2,title:"Download Updated Binary",slug:"download-updated-binary"},{level:2,title:"Restart Process",slug:"restart-process"}]}],themeConfig:{repo:"pterodactyl/panel",docsRepo:"pterodactyl/documentation",repoLabel:"GitHub",editLinkText:"Help us improve this page.",editLinks:!0,logo:"/logos/pterry.svg",nav:[{text:"Documentation",link:"/project/introduction.md"},{text:"Community Guides",link:"/community/about.md"},{text:"Get Help",link:"https://discord.gg/pterodactyl"},{text:"API",link:"https://dashflo.net/docs/api/pterodactyl/v1/"}],sidebar:{"/community/":[{title:"Community Guides",collapsable:!1,children:["/community/about.md"]},{title:"Panel Installation",collapsable:!1,children:["/community/installation-guides/panel/centos7.md","/community/installation-guides/panel/centos8.md","/community/installation-guides/panel/debian.md"]},{title:"Wings Installation",collapsable:!1,children:["/community/installation-guides/wings/centos7.md","/community/installation-guides/wings/centos8.md","/community/installation-guides/wings/debian.md"]},{title:"Creating Eggs",collapsable:!1,children:["/community/config/eggs/creating_a_custom_egg.md","/community/config/eggs/creating_a_custom_image.md"]},{title:"Game Configuration",collapsable:!1,children:["/community/games/minecraft.md"]},{title:"Tutorials",collapsable:!1,children:["/community/config/nodes/add_node.md","/community/tutorials/artisan.md"]},{title:"Customization",collapsable:!1,children:["/community/customization/panel.md","/community/customization/wings.md"]}],"/":[{title:"Project Information",collapsable:!1,children:["/project/introduction.md","/project/about.md","/project/terms.md","/project/community.md"]},{title:"Panel",collapsable:!1,path:"/panel/",currentVersion:"1.0",versions:[{title:"1.11",name:"1.0",status:"stable",children:["/getting_started","/webserver_configuration","/additional_configuration","/updating","/troubleshooting","/legacy_upgrade"]}]},{title:"Wings",collapsable:!1,path:"/wings/",currentVersion:"1.0",versions:[{title:"1.11",name:"1.0",status:"stable",children:["/installing","/upgrading","/migrating","/configuration"]}]},{title:"Tutorials",collapsable:!1,children:["/tutorials/mysql_setup.md","/tutorials/creating_ssl_certificates.md"]},{title:"Guides",collapsable:!1,children:["/guides/mounts.md"]}]}}};function Ee(...t){const e=new RegExp("/{1,}","g");return t.join("/").replace(e,"/")}n(235);r.a.component("Badge",()=>n.e(23).then(n.bind(null,335)));var je=n(89),$e=n.n(je),Te=[({Vue:t,options:e,router:n,siteData:r,isServer:o})=>{var i;(i=r.themeConfig.sidebar,Object.entries(i).map(([t,e])=>e.filter(t=>Array.isArray(t.versions)).map(e=>({...e,path:Ee(t,e.path)}))).flat()).forEach(t=>{n.addRoutes(n.options.routes.map(e=>{if(e.path.startsWith(t.path+t.currentVersion))return[{path:e.path.replace(t.currentVersion,"current"),redirect:e.path},{path:e.path.replace(t.currentVersion+"/",""),redirect:e.path}]}).filter(t=>t).flat().concat([{path:"/panel/1.0/upgrade/1.0.html",redirect:"/panel/1.0/updating.html"},{path:"/panel/1.0/upgrade/0.7_to_1.0.html",redirect:"/panel/1.0/legacy_upgrade.html"}]))})},{},({Vue:t})=>{t.mixin({computed:{$dataBlock(){return this.$options.__data__block__}}})},{},({Vue:t})=>t.use($e.a)],Ae=[];class Le extends class{constructor(){this.store=new r.a({data:{state:{}}})}$get(t){return this.store.state[t]}$set(t,e){r.a.set(this.store.state,t,e)}$emit(...t){this.store.$emit(...t)}$on(...t){this.store.$on(...t)}}{}Object.assign(Le.prototype,{getPageAsyncComponent:le,getLayoutAsyncComponent:ue,getAsyncComponent:ce,getVueComponent:fe});var De={install(t){const e=new Le;t.$vuepress=e,t.prototype.$vuepress=e}};function Ie(t,e){const n=e.toLowerCase();return t.options.routes.some(t=>t.path.toLowerCase()===n)}var Re={props:{pageKey:String,slotKey:{type:String,default:"default"}},render(t){const e=this.pageKey||this.$parent.$page.key;return de("pageKey",e),r.a.component(e)||r.a.component(e,le(e)),r.a.component(e)?t(e):t("")}},Me={functional:!0,props:{slotKey:String,required:!0},render:(t,{props:e,slots:n})=>t("div",{class:["content__"+e.slotKey]},n()[e.slotKey])},Ne={computed:{openInNewWindowTitle(){return this.$themeLocaleConfig.openNewWindowText||"(opens new window)"}}},Ue=(n(236),n(237),Object(ke.a)(Ne,(function(){var t=this._self._c;return t("span",[t("svg",{staticClass:"icon outbound",attrs:{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"}},[t("path",{attrs:{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"}}),this._v(" "),t("polygon",{attrs:{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"}})]),this._v(" "),t("span",{staticClass:"sr-only"},[this._v(this._s(this.openInNewWindowTitle))])])}),[],!1,null,null,null).exports),Fe={functional:!0,render(t,{parent:e,children:n}){if(e._isMounted)return n;e.$once("hook:mounted",()=>{e.$forceUpdate()})}};r.a.config.productionTip=!1,r.a.use(Wt),r.a.use(De),r.a.mixin(function(t,e,n=r.a){!function(t){t.locales&&Object.keys(t.locales).forEach(e=>{t.locales[e].path=e});Object.freeze(t)}(e),n.$vuepress.$set("siteData",e);const o=new(t(n.$vuepress.$get("siteData"))),i=Object.getOwnPropertyDescriptors(Object.getPrototypeOf(o)),a={};return Object.keys(i).reduce((t,e)=>(e.startsWith("$")&&(t[e]=i[e].get),t),a),{computed:a}}(t=>class{setPage(t){this.__page=t}get $site(){return t}get $themeConfig(){return this.$site.themeConfig}get $frontmatter(){return this.$page.frontmatter}get $localeConfig(){const{locales:t={}}=this.$site;let e,n;for(const r in t)"/"===r?n=t[r]:0===this.$page.path.indexOf(r)&&(e=t[r]);return e||n||{}}get $siteTitle(){return this.$localeConfig.title||this.$site.title||""}get $canonicalUrl(){const{canonicalUrl:t}=this.$page.frontmatter;return"string"==typeof t&&t}get $title(){const t=this.$page,{metaTitle:e}=this.$page.frontmatter;if("string"==typeof e)return e;const n=this.$siteTitle,r=t.frontmatter.home?null:t.frontmatter.title||t.title;return n?r?r+" | "+n:n:r||"VuePress"}get $description(){const t=function(t){if(t){const e=t.filter(t=>"description"===t.name)[0];if(e)return e.content}}(this.$page.frontmatter.meta);return t||(this.$page.frontmatter.description||this.$localeConfig.description||this.$site.description||"")}get $lang(){return this.$page.frontmatter.lang||this.$localeConfig.lang||"en-US"}get $localePath(){return this.$localeConfig.path||"/"}get $themeLocaleConfig(){return(this.$site.themeConfig.locales||{})[this.$localePath]||{}}get $page(){return this.__page?this.__page:function(t,e){for(let n=0;nn||(t.hash?!r.a.$vuepress.$get("disableScrollBehavior")&&{selector:decodeURIComponent(t.hash)}:{x:0,y:0})});!function(t){t.beforeEach((e,n,r)=>{if(Ie(t,e.path))r();else if(/(\/|\.html)$/.test(e.path))if(/\/$/.test(e.path)){const n=e.path.replace(/\/$/,"")+".html";Ie(t,n)?r(n):r()}else r();else{const n=e.path+"/",o=e.path+".html";Ie(t,o)?r(o):Ie(t,n)?r(n):r()}})}(n);const o={};try{await Promise.all(Te.filter(t=>"function"==typeof t).map(e=>e({Vue:r.a,options:o,router:n,siteData:Oe,isServer:t})))}catch(t){console.error(t)}return{app:new r.a(Object.assign(o,{router:n,render:t=>t("div",{attrs:{id:"app"}},[t("RouterView",{ref:"layout"}),t("div",{class:"global-ui"},Ae.map(e=>t(e)))])})),router:n}}(!1).then(({app:t,router:e})=>{e.onReady(()=>{t.$mount("#app")})})}]); \ No newline at end of file + */function o(t,e){for(var n in e)t[n]=e[n];return t}var i=/[!'()*]/g,a=function(t){return"%"+t.charCodeAt(0).toString(16)},s=/%2C/g,l=function(t){return encodeURIComponent(t).replace(i,a).replace(s,",")};function u(t){try{return decodeURIComponent(t)}catch(t){0}return t}var c=function(t){return null==t||"object"==typeof t?t:String(t)};function f(t){var e={};return(t=t.trim().replace(/^(\?|#|&)/,""))?(t.split("&").forEach((function(t){var n=t.replace(/\+/g," ").split("="),r=u(n.shift()),o=n.length>0?u(n.join("=")):null;void 0===e[r]?e[r]=o:Array.isArray(e[r])?e[r].push(o):e[r]=[e[r],o]})),e):e}function p(t){var e=t?Object.keys(t).map((function(e){var n=t[e];if(void 0===n)return"";if(null===n)return l(e);if(Array.isArray(n)){var r=[];return n.forEach((function(t){void 0!==t&&(null===t?r.push(l(e)):r.push(l(e)+"="+l(t)))})),r.join("&")}return l(e)+"="+l(n)})).filter((function(t){return t.length>0})).join("&"):null;return e?"?"+e:""}var d=/\/?$/;function h(t,e,n,r){var o=r&&r.options.stringifyQuery,i=e.query||{};try{i=v(i)}catch(t){}var a={name:e.name||t&&t.name,meta:t&&t.meta||{},path:e.path||"/",hash:e.hash||"",query:i,params:e.params||{},fullPath:y(e,o),matched:t?m(t):[]};return n&&(a.redirectedFrom=y(n,o)),Object.freeze(a)}function v(t){if(Array.isArray(t))return t.map(v);if(t&&"object"==typeof t){var e={};for(var n in t)e[n]=v(t[n]);return e}return t}var g=h(null,{path:"/"});function m(t){for(var e=[];t;)e.unshift(t),t=t.parent;return e}function y(t,e){var n=t.path,r=t.query;void 0===r&&(r={});var o=t.hash;return void 0===o&&(o=""),(n||"/")+(e||p)(r)+o}function b(t,e,n){return e===g?t===e:!!e&&(t.path&&e.path?t.path.replace(d,"")===e.path.replace(d,"")&&(n||t.hash===e.hash&&_(t.query,e.query)):!(!t.name||!e.name)&&(t.name===e.name&&(n||t.hash===e.hash&&_(t.query,e.query)&&_(t.params,e.params))))}function _(t,e){if(void 0===t&&(t={}),void 0===e&&(e={}),!t||!e)return t===e;var n=Object.keys(t).sort(),r=Object.keys(e).sort();return n.length===r.length&&n.every((function(n,o){var i=t[n];if(r[o]!==n)return!1;var a=e[n];return null==i||null==a?i===a:"object"==typeof i&&"object"==typeof a?_(i,a):String(i)===String(a)}))}function w(t){for(var e=0;e=0&&(e=t.slice(r),t=t.slice(0,r));var o=t.indexOf("?");return o>=0&&(n=t.slice(o+1),t=t.slice(0,o)),{path:t,query:n,hash:e}}(i.path||""),p=e&&e.path||"/",d=u.path?k(u.path,p,n||i.append):p,h=function(t,e,n){void 0===e&&(e={});var r,o=n||f;try{r=o(t||"")}catch(t){r={}}for(var i in e){var a=e[i];r[i]=Array.isArray(a)?a.map(c):c(a)}return r}(u.query,i.query,r&&r.options.parseQuery),v=i.hash||u.hash;return v&&"#"!==v.charAt(0)&&(v="#"+v),{_normalized:!0,path:d,query:h,hash:v}}var q,W=function(){},G={name:"RouterLink",props:{to:{type:[String,Object],required:!0},tag:{type:String,default:"a"},custom:Boolean,exact:Boolean,exactPath:Boolean,append:Boolean,replace:Boolean,activeClass:String,exactActiveClass:String,ariaCurrentValue:{type:String,default:"page"},event:{type:[String,Array],default:"click"}},render:function(t){var e=this,n=this.$router,r=this.$route,i=n.resolve(this.to,r,this.append),a=i.location,s=i.route,l=i.href,u={},c=n.options.linkActiveClass,f=n.options.linkExactActiveClass,p=null==c?"router-link-active":c,v=null==f?"router-link-exact-active":f,g=null==this.activeClass?p:this.activeClass,m=null==this.exactActiveClass?v:this.exactActiveClass,y=s.redirectedFrom?h(null,H(s.redirectedFrom),null,n):s;u[m]=b(r,y,this.exactPath),u[g]=this.exact||this.exactPath?u[m]:function(t,e){return 0===t.path.replace(d,"/").indexOf(e.path.replace(d,"/"))&&(!e.hash||t.hash===e.hash)&&function(t,e){for(var n in e)if(!(n in t))return!1;return!0}(t.query,e.query)}(r,y);var _=u[m]?this.ariaCurrentValue:null,w=function(t){K(t)&&(e.replace?n.replace(a,W):n.push(a,W))},x={click:K};Array.isArray(this.event)?this.event.forEach((function(t){x[t]=w})):x[this.event]=w;var C={class:u},k=!this.$scopedSlots.$hasNormal&&this.$scopedSlots.default&&this.$scopedSlots.default({href:l,route:s,navigate:w,isActive:u[g],isExactActive:u[m]});if(k){if(1===k.length)return k[0];if(k.length>1||!k.length)return 0===k.length?t():t("span",{},k)}if("a"===this.tag)C.on=x,C.attrs={href:l,"aria-current":_};else{var S=function t(e){var n;if(e)for(var r=0;r-1&&(s.params[p]=n.params[p]);return s.path=V(c.path,s.params),l(c,s,a)}if(s.path){s.params={};for(var d=0;d-1}function St(t,e){return kt(t)&&t._isRouter&&(null==e||t.type===e)}function Pt(t,e,n){var r=function(o){o>=t.length?n():t[o]?e(t[o],(function(){r(o+1)})):r(o+1)};r(0)}function Ot(t){return function(e,n,r){var o=!1,i=0,a=null;Et(t,(function(t,e,n,s){if("function"==typeof t&&void 0===t.cid){o=!0,i++;var l,u=Tt((function(e){var o;((o=e).__esModule||$t&&"Module"===o[Symbol.toStringTag])&&(e=e.default),t.resolved="function"==typeof e?e:q.extend(e),n.components[s]=e,--i<=0&&r()})),c=Tt((function(t){var e="Failed to resolve async component "+s+": "+t;a||(a=kt(t)?t:new Error(e),r(a))}));try{l=t(u,c)}catch(t){c(t)}if(l)if("function"==typeof l.then)l.then(u,c);else{var f=l.component;f&&"function"==typeof f.then&&f.then(u,c)}}})),o||r()}}function Et(t,e){return jt(t.map((function(t){return Object.keys(t.components).map((function(n){return e(t.components[n],t.instances[n],t,n)}))})))}function jt(t){return Array.prototype.concat.apply([],t)}var $t="function"==typeof Symbol&&"symbol"==typeof Symbol.toStringTag;function Tt(t){var e=!1;return function(){for(var n=[],r=arguments.length;r--;)n[r]=arguments[r];if(!e)return e=!0,t.apply(this,n)}}var At=function(t,e){this.router=t,this.base=function(t){if(!t)if(X){var e=document.querySelector("base");t=(t=e&&e.getAttribute("href")||"/").replace(/^https?:\/\/[^\/]+/,"")}else t="/";"/"!==t.charAt(0)&&(t="/"+t);return t.replace(/\/$/,"")}(e),this.current=g,this.pending=null,this.ready=!1,this.readyCbs=[],this.readyErrorCbs=[],this.errorCbs=[],this.listeners=[]};function Lt(t,e,n,r){var o=Et(t,(function(t,r,o,i){var a=function(t,e){"function"!=typeof t&&(t=q.extend(t));return t.options[e]}(t,e);if(a)return Array.isArray(a)?a.map((function(t){return n(t,r,o,i)})):n(a,r,o,i)}));return jt(r?o.reverse():o)}function Dt(t,e){if(e)return function(){return t.apply(e,arguments)}}At.prototype.listen=function(t){this.cb=t},At.prototype.onReady=function(t,e){this.ready?t():(this.readyCbs.push(t),e&&this.readyErrorCbs.push(e))},At.prototype.onError=function(t){this.errorCbs.push(t)},At.prototype.transitionTo=function(t,e,n){var r,o=this;try{r=this.router.match(t,this.current)}catch(t){throw this.errorCbs.forEach((function(e){e(t)})),t}var i=this.current;this.confirmTransition(r,(function(){o.updateRoute(r),e&&e(r),o.ensureURL(),o.router.afterHooks.forEach((function(t){t&&t(r,i)})),o.ready||(o.ready=!0,o.readyCbs.forEach((function(t){t(r)})))}),(function(t){n&&n(t),t&&!o.ready&&(St(t,bt.redirected)&&i===g||(o.ready=!0,o.readyErrorCbs.forEach((function(e){e(t)}))))}))},At.prototype.confirmTransition=function(t,e,n){var r=this,o=this.current;this.pending=t;var i,a,s=function(t){!St(t)&&kt(t)&&(r.errorCbs.length?r.errorCbs.forEach((function(e){e(t)})):console.error(t)),n&&n(t)},l=t.matched.length-1,u=o.matched.length-1;if(b(t,o)&&l===u&&t.matched[l]===o.matched[u])return this.ensureURL(),t.hash&&st(this.router,o,t,!1),s(((a=xt(i=o,t,bt.duplicated,'Avoided redundant navigation to current location: "'+i.fullPath+'".')).name="NavigationDuplicated",a));var c=function(t,e){var n,r=Math.max(t.length,e.length);for(n=0;n0)){var e=this.router,n=e.options.scrollBehavior,r=gt&&n;r&&this.listeners.push(at());var o=function(){var n=t.current,o=Rt(t.base);t.current===g&&o===t._startLocation||t.transitionTo(o,(function(t){r&&st(e,t,n,!0)}))};window.addEventListener("popstate",o),this.listeners.push((function(){window.removeEventListener("popstate",o)}))}},e.prototype.go=function(t){window.history.go(t)},e.prototype.push=function(t,e,n){var r=this,o=this.current;this.transitionTo(t,(function(t){mt(S(r.base+t.fullPath)),st(r.router,t,o,!1),e&&e(t)}),n)},e.prototype.replace=function(t,e,n){var r=this,o=this.current;this.transitionTo(t,(function(t){yt(S(r.base+t.fullPath)),st(r.router,t,o,!1),e&&e(t)}),n)},e.prototype.ensureURL=function(t){if(Rt(this.base)!==this.current.fullPath){var e=S(this.base+this.current.fullPath);t?mt(e):yt(e)}},e.prototype.getCurrentLocation=function(){return Rt(this.base)},e}(At);function Rt(t){var e=window.location.pathname,n=e.toLowerCase(),r=t.toLowerCase();return!t||n!==r&&0!==n.indexOf(S(r+"/"))||(e=e.slice(t.length)),(e||"/")+window.location.search+window.location.hash}var Mt=function(t){function e(e,n,r){t.call(this,e,n),r&&function(t){var e=Rt(t);if(!/^\/#/.test(e))return window.location.replace(S(t+"/#"+e)),!0}(this.base)||Nt()}return t&&(e.__proto__=t),e.prototype=Object.create(t&&t.prototype),e.prototype.constructor=e,e.prototype.setupListeners=function(){var t=this;if(!(this.listeners.length>0)){var e=this.router.options.scrollBehavior,n=gt&&e;n&&this.listeners.push(at());var r=function(){var e=t.current;Nt()&&t.transitionTo(Ut(),(function(r){n&&st(t.router,r,e,!0),gt||Bt(r.fullPath)}))},o=gt?"popstate":"hashchange";window.addEventListener(o,r),this.listeners.push((function(){window.removeEventListener(o,r)}))}},e.prototype.push=function(t,e,n){var r=this,o=this.current;this.transitionTo(t,(function(t){zt(t.fullPath),st(r.router,t,o,!1),e&&e(t)}),n)},e.prototype.replace=function(t,e,n){var r=this,o=this.current;this.transitionTo(t,(function(t){Bt(t.fullPath),st(r.router,t,o,!1),e&&e(t)}),n)},e.prototype.go=function(t){window.history.go(t)},e.prototype.ensureURL=function(t){var e=this.current.fullPath;Ut()!==e&&(t?zt(e):Bt(e))},e.prototype.getCurrentLocation=function(){return Ut()},e}(At);function Nt(){var t=Ut();return"/"===t.charAt(0)||(Bt("/"+t),!1)}function Ut(){var t=window.location.href,e=t.indexOf("#");return e<0?"":t=t.slice(e+1)}function Ft(t){var e=window.location.href,n=e.indexOf("#");return(n>=0?e.slice(0,n):e)+"#"+t}function zt(t){gt?mt(Ft(t)):window.location.hash=t}function Bt(t){gt?yt(Ft(t)):window.location.replace(Ft(t))}var Vt=function(t){function e(e,n){t.call(this,e,n),this.stack=[],this.index=-1}return t&&(e.__proto__=t),e.prototype=Object.create(t&&t.prototype),e.prototype.constructor=e,e.prototype.push=function(t,e,n){var r=this;this.transitionTo(t,(function(t){r.stack=r.stack.slice(0,r.index+1).concat(t),r.index++,e&&e(t)}),n)},e.prototype.replace=function(t,e,n){var r=this;this.transitionTo(t,(function(t){r.stack=r.stack.slice(0,r.index).concat(t),e&&e(t)}),n)},e.prototype.go=function(t){var e=this,n=this.index+t;if(!(n<0||n>=this.stack.length)){var r=this.stack[n];this.confirmTransition(r,(function(){var t=e.current;e.index=n,e.updateRoute(r),e.router.afterHooks.forEach((function(e){e&&e(r,t)}))}),(function(t){St(t,bt.duplicated)&&(e.index=n)}))}},e.prototype.getCurrentLocation=function(){var t=this.stack[this.stack.length-1];return t?t.fullPath:"/"},e.prototype.ensureURL=function(){},e}(At),Ht=function(t){void 0===t&&(t={}),this.app=null,this.apps=[],this.options=t,this.beforeHooks=[],this.resolveHooks=[],this.afterHooks=[],this.matcher=Y(t.routes||[],this);var e=t.mode||"hash";switch(this.fallback="history"===e&&!gt&&!1!==t.fallback,this.fallback&&(e="hash"),X||(e="abstract"),this.mode=e,e){case"history":this.history=new It(this,t.base);break;case"hash":this.history=new Mt(this,t.base,this.fallback);break;case"abstract":this.history=new Vt(this,t.base);break;default:0}},qt={currentRoute:{configurable:!0}};Ht.prototype.match=function(t,e,n){return this.matcher.match(t,e,n)},qt.currentRoute.get=function(){return this.history&&this.history.current},Ht.prototype.init=function(t){var e=this;if(this.apps.push(t),t.$once("hook:destroyed",(function(){var n=e.apps.indexOf(t);n>-1&&e.apps.splice(n,1),e.app===t&&(e.app=e.apps[0]||null),e.app||e.history.teardown()})),!this.app){this.app=t;var n=this.history;if(n instanceof It||n instanceof Mt){var r=function(t){n.setupListeners(),function(t){var r=n.current,o=e.options.scrollBehavior;gt&&o&&"fullPath"in t&&st(e,t,r,!1)}(t)};n.transitionTo(n.getCurrentLocation(),r,r)}n.listen((function(t){e.apps.forEach((function(e){e._route=t}))}))}},Ht.prototype.beforeEach=function(t){return Gt(this.beforeHooks,t)},Ht.prototype.beforeResolve=function(t){return Gt(this.resolveHooks,t)},Ht.prototype.afterEach=function(t){return Gt(this.afterHooks,t)},Ht.prototype.onReady=function(t,e){this.history.onReady(t,e)},Ht.prototype.onError=function(t){this.history.onError(t)},Ht.prototype.push=function(t,e,n){var r=this;if(!e&&!n&&"undefined"!=typeof Promise)return new Promise((function(e,n){r.history.push(t,e,n)}));this.history.push(t,e,n)},Ht.prototype.replace=function(t,e,n){var r=this;if(!e&&!n&&"undefined"!=typeof Promise)return new Promise((function(e,n){r.history.replace(t,e,n)}));this.history.replace(t,e,n)},Ht.prototype.go=function(t){this.history.go(t)},Ht.prototype.back=function(){this.go(-1)},Ht.prototype.forward=function(){this.go(1)},Ht.prototype.getMatchedComponents=function(t){var e=t?t.matched?t:this.resolve(t).route:this.currentRoute;return e?[].concat.apply([],e.matched.map((function(t){return Object.keys(t.components).map((function(e){return t.components[e]}))}))):[]},Ht.prototype.resolve=function(t,e,n){var r=H(t,e=e||this.history.current,n,this),o=this.match(r,e),i=o.redirectedFrom||o.fullPath;return{location:r,route:o,href:function(t,e,n){var r="hash"===n?"#"+e:e;return t?S(t+"/"+r):r}(this.history.base,i,this.mode),normalizedTo:r,resolved:o}},Ht.prototype.getRoutes=function(){return this.matcher.getRoutes()},Ht.prototype.addRoute=function(t,e){this.matcher.addRoute(t,e),this.history.current!==g&&this.history.transitionTo(this.history.getCurrentLocation())},Ht.prototype.addRoutes=function(t){this.matcher.addRoutes(t),this.history.current!==g&&this.history.transitionTo(this.history.getCurrentLocation())},Object.defineProperties(Ht.prototype,qt);var Wt=Ht;function Gt(t,e){return t.push(e),function(){var n=t.indexOf(e);n>-1&&t.splice(n,1)}}Ht.install=function t(e){if(!t.installed||q!==e){t.installed=!0,q=e;var n=function(t){return void 0!==t},r=function(t,e){var r=t.$options._parentVnode;n(r)&&n(r=r.data)&&n(r=r.registerRouteInstance)&&r(t,e)};e.mixin({beforeCreate:function(){n(this.$options.router)?(this._routerRoot=this,this._router=this.$options.router,this._router.init(this),e.util.defineReactive(this,"_route",this._router.history.current)):this._routerRoot=this.$parent&&this.$parent._routerRoot||this,r(this,this)},destroyed:function(){r(this)}}),Object.defineProperty(e.prototype,"$router",{get:function(){return this._routerRoot._router}}),Object.defineProperty(e.prototype,"$route",{get:function(){return this._routerRoot._route}}),e.component("RouterView",x),e.component("RouterLink",G);var o=e.config.optionMergeStrategies;o.beforeRouteEnter=o.beforeRouteLeave=o.beforeRouteUpdate=o.created}},Ht.version="3.6.5",Ht.isNavigationFailure=St,Ht.NavigationFailureType=bt,Ht.START_LOCATION=g,X&&window.Vue&&window.Vue.use(Ht);n(92);n(121),n(90);var Kt={DropdownLink:()=>Promise.all([n.e(0),n.e(8)]).then(n.bind(null,244)),DropdownTransition:()=>Promise.all([n.e(0),n.e(13)]).then(n.bind(null,243)),Home:()=>Promise.all([n.e(1),n.e(11)]).then(n.bind(null,258)),Layout:()=>Promise.all([n.e(0),n.e(1),n.e(2),n.e(4)]).then(n.bind(null,282)),NavLink:()=>n.e(16).then(n.bind(null,241)),NavLinks:()=>Promise.all([n.e(0),n.e(7)]).then(n.bind(null,246)),Navbar:()=>Promise.all([n.e(0),n.e(5)]).then(n.bind(null,259)),NotFound:()=>n.e(24).then(n.bind(null,283)),Page:()=>n.e(17).then(n.bind(null,260)),SearchBox:()=>n.e(25).then(n.bind(null,250)),Sidebar:()=>Promise.all([n.e(0),n.e(2)]).then(n.bind(null,281)),SidebarButton:()=>n.e(26).then(n.bind(null,252)),SidebarGroup:()=>Promise.all([n.e(0),n.e(6)]).then(n.bind(null,261)),SidebarLink:()=>n.e(18).then(n.bind(null,247)),SlickCarousel:()=>Promise.all([n.e(1),n.e(27)]).then(n.bind(null,249)),VersionSelect:()=>n.e(19).then(n.bind(null,251)),VersionSelectItem:()=>n.e(28).then(n.bind(null,245))},Xt={"v-7d127123":()=>n.e(31).then(n.bind(null,284)),"v-680eebc3":()=>n.e(29).then(n.bind(null,285)),"v-4e72e1d8":()=>n.e(30).then(n.bind(null,286)),"v-4a1e6e3a":()=>n.e(9).then(n.bind(null,287)),"v-10fe793a":()=>n.e(32).then(n.bind(null,288)),"v-622f23e3":()=>n.e(12).then(n.bind(null,289)),"v-ef34fffa":()=>n.e(33).then(n.bind(null,290)),"v-090070fa":()=>n.e(34).then(n.bind(null,291)),"v-67c3f2ba":()=>n.e(10).then(n.bind(null,292)),"v-0af75f63":()=>n.e(35).then(n.bind(null,293)),"v-e4c1f74e":()=>n.e(37).then(n.bind(null,294)),"v-26037fe3":()=>n.e(38).then(n.bind(null,295)),"v-9619ebfa":()=>n.e(39).then(n.bind(null,296)),"v-cc322cfa":()=>n.e(36).then(n.bind(null,297)),"v-7c7b3203":()=>n.e(41).then(n.bind(null,298)),"v-37f7de3e":()=>n.e(40).then(n.bind(null,299)),"v-07a77f72":()=>n.e(42).then(n.bind(null,300)),"v-00d38f11":()=>n.e(43).then(n.bind(null,301)),"v-6f0eac21":()=>n.e(45).then(n.bind(null,302)),"v-d39223ba":()=>n.e(20).then(n.bind(null,303)),"v-481dea23":()=>n.e(46).then(n.bind(null,304)),"v-a31c3dba":()=>n.e(44).then(n.bind(null,305)),"v-15b388aa":()=>n.e(47).then(n.bind(null,306)),"v-7f0b5429":()=>n.e(49).then(n.bind(null,307)),"v-8a6363ba":()=>n.e(48).then(n.bind(null,308)),"v-29055241":()=>n.e(50).then(n.bind(null,309)),"v-c0e60bfa":()=>n.e(21).then(n.bind(null,310)),"v-589003f5":()=>n.e(51).then(n.bind(null,311)),"v-019cb63a":()=>n.e(52).then(n.bind(null,312)),"v-7ffeb723":()=>n.e(53).then(n.bind(null,313)),"v-9478f2ba":()=>n.e(54).then(n.bind(null,314)),"v-4f03fe0f":()=>n.e(55).then(n.bind(null,315)),"v-5baa92ba":()=>n.e(56).then(n.bind(null,316)),"v-6f4baca5":()=>n.e(59).then(n.bind(null,317)),"v-fa75e63a":()=>n.e(60).then(n.bind(null,318)),"v-c249e07a":()=>n.e(57).then(n.bind(null,319)),"v-dacf6e56":()=>n.e(61).then(n.bind(null,320)),"v-27941b23":()=>n.e(58).then(n.bind(null,321)),"v-8eec473a":()=>n.e(62).then(n.bind(null,322)),"v-29d5bc56":()=>n.e(63).then(n.bind(null,323)),"v-cbda523a":()=>n.e(64).then(n.bind(null,324)),"v-a75af93a":()=>n.e(65).then(n.bind(null,325)),"v-7b99cfba":()=>n.e(14).then(n.bind(null,326)),"v-d6319362":()=>n.e(67).then(n.bind(null,327)),"v-6ec4d123":()=>n.e(68).then(n.bind(null,328)),"v-22ba6d3a":()=>n.e(66).then(n.bind(null,329)),"v-5c5d50fa":()=>n.e(69).then(n.bind(null,330)),"v-55eb8eca":()=>n.e(15).then(n.bind(null,331)),"v-1ec46263":()=>n.e(22).then(n.bind(null,332)),"v-9213d4fa":()=>n.e(71).then(n.bind(null,333)),"v-6cd19ba3":()=>n.e(70).then(n.bind(null,334))};function Qt(t){const e=Object.create(null);return function(n){return e[n]||(e[n]=t(n))}}const Jt=/-(\w)/g,Yt=Qt(t=>t.replace(Jt,(t,e)=>e?e.toUpperCase():"")),Zt=/\B([A-Z])/g,te=Qt(t=>t.replace(Zt,"-$1").toLowerCase()),ee=Qt(t=>t.charAt(0).toUpperCase()+t.slice(1));function ne(t,e){if(!e)return;if(t(e))return t(e);return e.includes("-")?t(ee(Yt(e))):t(ee(e))||t(te(e))}const re=Object.assign({},Kt,Xt),oe=t=>re[t],ie=t=>Xt[t],ae=t=>Kt[t],se=t=>r.a.component(t);function le(t){return ne(ie,t)}function ue(t){return ne(ae,t)}function ce(t){return ne(oe,t)}function fe(t){return ne(se,t)}function pe(...t){return Promise.all(t.filter(t=>t).map(async t=>{if(!fe(t)&&ce(t)){const e=await ce(t)();r.a.component(t,e.default)}}))}function de(t,e){"undefined"!=typeof window&&window.__VUEPRESS__&&(window.__VUEPRESS__[t]=e)}var he=n(87),ve=n.n(he),ge=n(88),me=n.n(ge);function ye(){const t=document.querySelector("link[rel='canonical']");t&&t.remove()}function be(t=""){return t?``:""}function _e(t,e){if(e&&[...e].filter(t=>t.parentNode===document.head).forEach(t=>document.head.removeChild(t)),t)return t.map(t=>{const e=document.createElement("meta");return Object.keys(t).forEach(n=>{e.setAttribute(n,t[n])}),document.head.appendChild(e),e})}function we(t){for(const e of["name","property","itemprop"])if(t.hasOwnProperty(e))return t[e]+e;return JSON.stringify(t)}var xe=[{created(){if(this.siteMeta=this.$site.headTags.filter(([t])=>"meta"===t).map(([t,e])=>e),this.$ssrContext){const e=this.getMergedMetaTags();this.$ssrContext.title=this.$title,this.$ssrContext.lang=this.$lang,this.$ssrContext.pageMeta=(t=e)?t.map(t=>{let e="{e+=` ${n}="${me()(t[n])}"`}),e+">"}).join("\n "):"",this.$ssrContext.canonicalLink=be(this.$canonicalUrl)}var t},mounted(){this.currentMetaTags=[...document.querySelectorAll("meta")],this.updateMeta(),this.updateCanonicalLink()},methods:{updateMeta(){document.title=this.$title,document.documentElement.lang=this.$lang;const t=this.getMergedMetaTags();this.currentMetaTags=_e(t,this.currentMetaTags)},getMergedMetaTags(){const t=this.$page.frontmatter.meta||[];return ve()([{name:"description",content:this.$description}],t,this.siteMeta,we)},updateCanonicalLink(){ye(),this.$canonicalUrl&&document.head.insertAdjacentHTML("beforeend",be(this.$canonicalUrl))}},watch:{$page(){this.updateMeta(),this.updateCanonicalLink()}},beforeDestroy(){_e(null,this.currentMetaTags),ye()}}],Ce={name:"GlobalLayout",computed:{layout(){const t=this.getLayout();return de("layout",t),r.a.component(t)}},methods:{getLayout(){if(this.$page.path){const t=this.$page.frontmatter.layout;return t&&(this.$vuepress.getLayoutAsyncComponent(t)||this.$vuepress.getVueComponent(t))?t:"Layout"}return"NotFound"}}},ke=n(15),Se=Object(ke.a)(Ce,(function(){return(0,this._self._c)(this.layout,{tag:"component"})}),[],!1,null,null,null).exports;!function(t,e,n){switch(e){case"components":t[e]||(t[e]={}),Object.assign(t[e],n);break;case"mixins":t[e]||(t[e]=[]),t[e].push(...n);break;default:throw new Error("Unknown option name.")}}(Se,"mixins",xe);const Pe=[{name:"v-7d127123",path:"/community/about.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-7d127123").then(n)}},{name:"v-680eebc3",path:"/404.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-680eebc3").then(n)}},{name:"v-4e72e1d8",path:"/",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-4e72e1d8").then(n)}},{path:"/index.html",redirect:"/"},{name:"v-4a1e6e3a",path:"/community/config/eggs/creating_a_custom_egg.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-4a1e6e3a").then(n)}},{name:"v-10fe793a",path:"/community/config/eggs/creating_a_custom_image.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-10fe793a").then(n)}},{name:"v-622f23e3",path:"/community/config/nodes/add_node.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-622f23e3").then(n)}},{name:"v-ef34fffa",path:"/community/customization/panel.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-ef34fffa").then(n)}},{name:"v-090070fa",path:"/community/customization/wings.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-090070fa").then(n)}},{name:"v-67c3f2ba",path:"/community/games/minecraft.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-67c3f2ba").then(n)}},{name:"v-0af75f63",path:"/community/installation-guides/panel/centos7.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-0af75f63").then(n)}},{name:"v-e4c1f74e",path:"/community/installation-guides/panel/debian.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-e4c1f74e").then(n)}},{name:"v-26037fe3",path:"/community/installation-guides/wings/centos7.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-26037fe3").then(n)}},{name:"v-9619ebfa",path:"/community/installation-guides/wings/centos8.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-9619ebfa").then(n)}},{name:"v-cc322cfa",path:"/community/installation-guides/panel/centos8.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-cc322cfa").then(n)}},{name:"v-7c7b3203",path:"/community/tutorials/artisan.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-7c7b3203").then(n)}},{name:"v-37f7de3e",path:"/community/installation-guides/wings/debian.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-37f7de3e").then(n)}},{name:"v-07a77f72",path:"/daemon/0.6/configuration.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-07a77f72").then(n)}},{name:"v-00d38f11",path:"/daemon/0.6/debian_8_docker.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-00d38f11").then(n)}},{name:"v-6f0eac21",path:"/daemon/0.6/standalone_sftp.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-6f0eac21").then(n)}},{name:"v-d39223ba",path:"/daemon/0.6/installing.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-d39223ba").then(n)}},{name:"v-481dea23",path:"/daemon/0.6/upgrade/0.4_to_0.5.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-481dea23").then(n)}},{name:"v-a31c3dba",path:"/daemon/0.6/kernel_modifications.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-a31c3dba").then(n)}},{name:"v-15b388aa",path:"/daemon/0.6/upgrade/0.5.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-15b388aa").then(n)}},{name:"v-7f0b5429",path:"/daemon/0.6/upgrade/0.6.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-7f0b5429").then(n)}},{name:"v-8a6363ba",path:"/daemon/0.6/upgrade/0.5_to_0.6.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-8a6363ba").then(n)}},{name:"v-29055241",path:"/daemon/0.6/upgrading.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-29055241").then(n)}},{name:"v-c0e60bfa",path:"/guides/mounts.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-c0e60bfa").then(n)}},{name:"v-589003f5",path:"/guides/php_upgrade.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-589003f5").then(n)}},{name:"v-019cb63a",path:"/panel/0.7/configuration.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-019cb63a").then(n)}},{name:"v-7ffeb723",path:"/panel/0.7/getting_started.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-7ffeb723").then(n)}},{name:"v-9478f2ba",path:"/panel/0.7/troubleshooting.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-9478f2ba").then(n)}},{name:"v-4f03fe0f",path:"/panel/0.7/upgrade/0.6_to_0.7.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-4f03fe0f").then(n)}},{name:"v-5baa92ba",path:"/panel/0.7/upgrade/0.7.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-5baa92ba").then(n)}},{name:"v-6f4baca5",path:"/panel/1.0/additional_configuration.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-6f4baca5").then(n)}},{name:"v-fa75e63a",path:"/panel/1.0/getting_started.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-fa75e63a").then(n)}},{name:"v-c249e07a",path:"/panel/0.7/upgrading.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-c249e07a").then(n)}},{name:"v-dacf6e56",path:"/panel/1.0/legacy_upgrade.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-dacf6e56").then(n)}},{name:"v-27941b23",path:"/panel/0.7/webserver_configuration.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-27941b23").then(n)}},{name:"v-8eec473a",path:"/panel/1.0/troubleshooting.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-8eec473a").then(n)}},{name:"v-29d5bc56",path:"/panel/1.0/updating.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-29d5bc56").then(n)}},{name:"v-cbda523a",path:"/panel/1.0/webserver_configuration.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-cbda523a").then(n)}},{name:"v-a75af93a",path:"/project/about.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-a75af93a").then(n)}},{name:"v-7b99cfba",path:"/project/terms.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-7b99cfba").then(n)}},{name:"v-d6319362",path:"/project/introduction.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-d6319362").then(n)}},{name:"v-6ec4d123",path:"/tutorials/creating_ssl_certificates.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-6ec4d123").then(n)}},{name:"v-22ba6d3a",path:"/project/community.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-22ba6d3a").then(n)}},{name:"v-5c5d50fa",path:"/tutorials/mysql_setup.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-5c5d50fa").then(n)}},{name:"v-55eb8eca",path:"/wings/1.0/installing.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-55eb8eca").then(n)}},{name:"v-1ec46263",path:"/wings/1.0/migrating.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-1ec46263").then(n)}},{name:"v-9213d4fa",path:"/wings/1.0/upgrading.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-9213d4fa").then(n)}},{name:"v-6cd19ba3",path:"/wings/1.0/configuration.html",component:Se,beforeEnter:(t,e,n)=>{pe("Layout","v-6cd19ba3").then(n)}},{path:"*",component:Se}],Oe={title:"Pterodactyl",description:"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.",base:"/",headTags:[["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:"msapplication-config",content:"/favicons/browserconfig.xml"}],["meta",{name:"theme-color",content:"#0e4688"}]],pages:[{title:"Community Guides and Tutorials",frontmatter:{},regularPath:"/community/about.html",relativePath:"community/about.md",key:"v-7d127123",path:"/community/about.html",headers:[{level:2,title:"About",slug:"about"}]},{frontmatter:{},regularPath:"/404.html",relativePath:"404.md",key:"v-680eebc3",path:"/404.html"},{title:"Home",frontmatter:{home:!0,heroImage:"/doc_pterry.png",actionText:"Get Started →",actionLink:"/project/introduction",features:[{title:"Security First",details:"Security is a first-class citizen on this platform with bcrypt hashing, AES-256-CBC encryption, and HTTPS support out of the box."},{title:"Modern Tooling",details:"Built on a modern stack utilizing the best design practices that make it easy to jump in and make modifications."},{title:"Docker to the Core",details:"All servers run in isolated Docker containers that limit attack vectors, provide strict resource limits, and provide environments tailored to each specific game."}],footer:"MIT Licensed | Copyright © Dane Everitt and contributors"},regularPath:"/",relativePath:"README.md",key:"v-4e72e1d8",path:"/"},{title:"Creating a Custom Egg",frontmatter:{},regularPath:"/community/config/eggs/creating_a_custom_egg.html",relativePath:"community/config/eggs/creating_a_custom_egg.md",key:"v-4a1e6e3a",path:"/community/config/eggs/creating_a_custom_egg.html",headers:[{level:2,title:"Create New Option",slug:"create-new-option"},{level:2,title:"Configure Process Management",slug:"configure-process-management"},{level:3,title:"Stop Command",slug:"stop-command"},{level:3,title:"Log Storage",slug:"log-storage"},{level:3,title:"Configuration Files",slug:"configuration-files"},{level:3,title:"Start Configuration",slug:"start-configuration"},{level:2,title:"Copy Settings From",slug:"copy-settings-from"},{level:2,title:"Egg Variables",slug:"egg-variables"},{level:2,title:"List of default variables",slug:"list-of-default-variables"}]},{title:"Creating a Custom Docker Image",frontmatter:{},regularPath:"/community/config/eggs/creating_a_custom_image.html",relativePath:"community/config/eggs/creating_a_custom_image.md",key:"v-10fe793a",path:"/community/config/eggs/creating_a_custom_image.html",headers:[{level:2,title:"Creating the Dockerfile",slug:"creating-the-dockerfile"},{level:2,title:"Installing Dependencies",slug:"installing-dependencies"},{level:2,title:"Creating a Container User",slug:"creating-a-container-user"},{level:2,title:"Work Directory & Entrypoint",slug:"work-directory-entrypoint"},{level:2,title:"Entrypoint Script",slug:"entrypoint-script"},{level:2,title:"Modifying the Startup Command",slug:"modifying-the-startup-command"},{level:2,title:"Run the Command",slug:"run-the-command"},{level:3,title:"Note",slug:"note"}]},{title:"Creating a New Node",frontmatter:{},regularPath:"/community/config/nodes/add_node.html",relativePath:"community/config/nodes/add_node.md",key:"v-622f23e3",path:"/community/config/nodes/add_node.html",headers:[{level:2,title:"Location",slug:"location"},{level:2,title:"Information Required",slug:"information-required"},{level:2,title:"Install the Daemon",slug:"install-the-daemon"},{level:2,title:"Configuring the Node",slug:"configuring-the-node"},{level:3,title:"Auto-Deploy",slug:"auto-deploy"}]},{title:"Building Panel Assets",frontmatter:{},regularPath:"/community/customization/panel.html",relativePath:"community/customization/panel.md",key:"v-ef34fffa",path:"/community/customization/panel.html",headers:[{level:2,title:"Install Dependencies",slug:"install-dependencies"},{level:2,title:"Build Panel Assets",slug:"build-panel-assets"}]},{title:"Building Wings",frontmatter:{},regularPath:"/community/customization/wings.html",relativePath:"community/customization/wings.md",key:"v-090070fa",path:"/community/customization/wings.html",headers:[{level:2,title:"Build Requirements",slug:"build-requirements"},{level:2,title:"Building",slug:"building"},{level:2,title:"Install the new binary",slug:"install-the-new-binary"},{level:2,title:"Troubleshooting",slug:"troubleshooting"}]},{title:"Minecraft",frontmatter:{},regularPath:"/community/games/minecraft.html",relativePath:"community/games/minecraft.md",key:"v-67c3f2ba",path:"/community/games/minecraft.html",headers:[{level:2,title:"Configuring a Server Network (BungeeCord, Waterfall, HexaCord, etc.)",slug:"configuring-a-server-network-bungeecord-waterfall-hexacord-etc"},{level:3,title:"Allocations in the Panel",slug:"allocations-in-the-panel"},{level:3,title:"proxy server settings",slug:"proxy-server-settings"},{level:3,title:"paper/spigot/bukkit settings",slug:"paper-spigot-bukkit-settings"},{level:3,title:"Firewalls",slug:"firewalls"}]},{title:"CentOS 7",frontmatter:{},regularPath:"/community/installation-guides/panel/centos7.html",relativePath:"community/installation-guides/panel/centos7.md",key:"v-0af75f63",path:"/community/installation-guides/panel/centos7.html",headers:[{level:2,title:"Install Dependencies",slug:"install-dependencies"},{level:3,title:"SELinux Configuration",slug:"selinux-configuration"},{level:3,title:"Installing Dependencies",slug:"installing-dependencies"},{level:2,title:"Server Configuration",slug:"server-configuration"},{level:3,title:"PHP Configuration",slug:"php-configuration"},{level:3,title:"SELinux configuration",slug:"selinux-configuration-2"},{level:2,title:"Installing the Panel",slug:"installing-the-panel"}]},{title:"Debian 11 & 12",frontmatter:{},regularPath:"/community/installation-guides/panel/debian.html",relativePath:"community/installation-guides/panel/debian.md",key:"v-e4c1f74e",path:"/community/installation-guides/panel/debian.html",headers:[{level:2,title:"Dependency Installation",slug:"dependency-installation"},{level:3,title:"Installing Composer",slug:"installing-composer"},{level:3,title:"Download Files",slug:"download-files"}]},{title:"CentOS 7",frontmatter:{},regularPath:"/community/installation-guides/wings/centos7.html",relativePath:"community/installation-guides/wings/centos7.md",key:"v-26037fe3",path:"/community/installation-guides/wings/centos7.html",headers:[{level:2,title:"Install Dependencies",slug:"install-dependencies"},{level:2,title:"Installing Wings",slug:"installing-wings"}]},{title:"Enterprise Linux 8 and Fedora Server 40",frontmatter:{},regularPath:"/community/installation-guides/wings/centos8.html",relativePath:"community/installation-guides/wings/centos8.md",key:"v-9619ebfa",path:"/community/installation-guides/wings/centos8.html",headers:[{level:2,title:"Install Dependencies",slug:"install-dependencies"},{level:2,title:"Installing Wings",slug:"installing-wings"}]},{title:"Enterprise Linux 8 and Fedora Server 40",frontmatter:{},regularPath:"/community/installation-guides/panel/centos8.html",relativePath:"community/installation-guides/panel/centos8.md",key:"v-cc322cfa",path:"/community/installation-guides/panel/centos8.html",headers:[{level:2,title:"Install Dependencies",slug:"install-dependencies"},{level:3,title:"SELinux Configuration",slug:"selinux-configuration"},{level:3,title:"Installing Dependencies",slug:"installing-dependencies"},{level:2,title:"PHP Configuration",slug:"php-configuration"},{level:2,title:"Installing the Panel",slug:"installing-the-panel"}]},{title:"Artisan CLI",frontmatter:{},regularPath:"/community/tutorials/artisan.html",relativePath:"community/tutorials/artisan.md",key:"v-7c7b3203",path:"/community/tutorials/artisan.html",headers:[{level:2,title:"User Management",slug:"user-management"},{level:3,title:"Create User",slug:"create-user"},{level:3,title:"Delete User",slug:"delete-user"},{level:3,title:"Disable 2FA",slug:"disable-2fa"},{level:2,title:"Server & Node Management",slug:"server-node-management"},{level:3,title:"Create Location",slug:"create-location"},{level:3,title:"Delete Location",slug:"delete-location"},{level:3,title:"Server Bulk Power",slug:"server-bulk-power"},{level:2,title:"Panel Management",slug:"panel-management"},{level:3,title:"View Panel Info",slug:"view-panel-info"},{level:3,title:"Update Panel",slug:"update-panel"}]},{title:"Debian 11 & 12",frontmatter:{},regularPath:"/community/installation-guides/wings/debian.html",relativePath:"community/installation-guides/wings/debian.md",key:"v-37f7de3e",path:"/community/installation-guides/wings/debian.html",headers:[{level:2,title:"Install",slug:"install"}]},{title:"Additional Configuration",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/daemon/0.6/configuration.html",relativePath:"daemon/0.6/configuration.md",key:"v-07a77f72",path:"/daemon/0.6/configuration.html",headers:[{level:2,title:"Output Throttles",slug:"output-throttles"},{level:2,title:"Custom Network Interfaces",slug:"custom-network-interfaces"},{level:2,title:"Private Registries",slug:"private-registries"},{level:2,title:"Security Policies",slug:"security-policies"},{level:2,title:"Container Policy",slug:"container-policy"},{level:3,title:"Default Security Opts Array",slug:"default-security-opts-array"},{level:3,title:"Default Capabilities Drop Array",slug:"default-capabilities-drop-array"},{level:2,title:"Enabling Cloudflare",slug:"enabling-cloudflare"}]},{title:"Docker on Debian 8",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/daemon/0.6/debian_8_docker.html",relativePath:"daemon/0.6/debian_8_docker.md",key:"v-00d38f11",path:"/daemon/0.6/debian_8_docker.html",headers:[{level:2,title:"Install Docker",slug:"install-docker"},{level:2,title:"Update GRUB Startup",slug:"update-grub-startup"},{level:2,title:"Add Backports Repo",slug:"add-backports-repo"},{level:2,title:"Update Software & Setup Docker",slug:"update-software-setup-docker"}]},{title:"Standalone SFTP Server",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/daemon/0.6/standalone_sftp.html",relativePath:"daemon/0.6/standalone_sftp.md",key:"v-6f0eac21",path:"/daemon/0.6/standalone_sftp.html",headers:[{level:2,title:"Disable Daemon's Server",slug:"disable-daemon-s-server"},{level:2,title:"Run the Standalone Server",slug:"run-the-standalone-server"},{level:3,title:"Start the Server",slug:"start-the-server"},{level:2,title:"Daemonize Server",slug:"daemonize-server"},{level:3,title:"Customizing Startup",slug:"customizing-startup"}]},{title:"Installation",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/daemon/0.6/installing.html",relativePath:"daemon/0.6/installing.md",key:"v-d39223ba",path:"/daemon/0.6/installing.html",headers:[{level:2,title:"Supported Systems",slug:"supported-systems"},{level:2,title:"System Requirements",slug:"system-requirements"},{level:2,title:"Dependencies",slug:"dependencies"},{level:3,title:"Installing Docker",slug:"installing-docker"},{level:3,title:"Installing Nodejs",slug:"installing-nodejs"},{level:2,title:"Installing Daemon Software",slug:"installing-daemon-software"},{level:2,title:"Configure Daemon",slug:"configure-daemon"},{level:2,title:"Starting the Daemon",slug:"starting-the-daemon"},{level:3,title:"Daemonizing (using systemd)",slug:"daemonizing-using-systemd"}]},{title:"Upgrading 0.4.X to 0.5.X",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/daemon/0.6/upgrade/0.4_to_0.5.html",relativePath:"daemon/0.6/upgrade/0.4_to_0.5.md",key:"v-481dea23",path:"/daemon/0.6/upgrade/0.4_to_0.5.html",headers:[{level:2,title:"Docker Adjustments",slug:"docker-adjustments"},{level:2,title:"Download Files",slug:"download-files"},{level:2,title:"SFTP Cleanup",slug:"sftp-cleanup"},{level:2,title:"File Migration",slug:"file-migration"},{level:3,title:"Rebuild Containers",slug:"rebuild-containers"}]},{title:"Kernel Modifications",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/daemon/0.6/kernel_modifications.html",relativePath:"daemon/0.6/kernel_modifications.md",key:"v-a31c3dba",path:"/daemon/0.6/kernel_modifications.html",headers:[{level:2,title:"Update Kernel",slug:"update-kernel"},{level:2,title:"Confirm Kernel",slug:"confirm-kernel"},{level:2,title:"Set Default Boot",slug:"set-default-boot"},{level:2,title:"Boot from hard disk",slug:"boot-from-hard-disk"}]},{title:"Upgrading 0.5 Series",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/daemon/0.6/upgrade/0.5.html",relativePath:"daemon/0.6/upgrade/0.5.md",key:"v-15b388aa",path:"/daemon/0.6/upgrade/0.5.html",headers:[{level:2,title:"Download Newest Release",slug:"download-newest-release"},{level:2,title:"Update Components",slug:"update-components"}]},{title:"Upgrading 0.6 Series",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/daemon/0.6/upgrade/0.6.html",relativePath:"daemon/0.6/upgrade/0.6.md",key:"v-7f0b5429",path:"/daemon/0.6/upgrade/0.6.html",headers:[{level:2,title:"Download Newest Release",slug:"download-newest-release"},{level:2,title:"Update Components",slug:"update-components"}]},{title:"Upgrading 0.5.X to 0.6.X",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/daemon/0.6/upgrade/0.5_to_0.6.html",relativePath:"daemon/0.6/upgrade/0.5_to_0.6.md",key:"v-8a6363ba",path:"/daemon/0.6/upgrade/0.5_to_0.6.html",headers:[{level:2,title:"Breaking Changes",slug:"breaking-changes"},{level:2,title:"Download Files",slug:"download-files"},{level:3,title:"Start the Daemon",slug:"start-the-daemon"},{level:2,title:"Rebuild Containers",slug:"rebuild-containers"}]},{title:"Upgrading",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/daemon/0.6/upgrading.html",relativePath:"daemon/0.6/upgrading.md",key:"v-29055241",path:"/daemon/0.6/upgrading.html",headers:[{level:2,title:"Version Specific Guides",slug:"version-specific-guides"}]},{title:"Using Mounts",frontmatter:{},regularPath:"/guides/mounts.html",relativePath:"guides/mounts.md",key:"v-c0e60bfa",path:"/guides/mounts.html",headers:[{level:2,title:"Wings Configuration",slug:"wings-configuration"},{level:2,title:"Panel Configuration",slug:"panel-configuration"},{level:3,title:"Creating a Mount",slug:"creating-a-mount"},{level:3,title:"Assigning a Mount to a Server",slug:"assigning-a-mount-to-a-server"},{level:3,title:"Example Mount",slug:"example-mount"}]},{title:"Upgrading PHP",frontmatter:{},regularPath:"/guides/php_upgrade.html",relativePath:"guides/php_upgrade.md",key:"v-589003f5",path:"/guides/php_upgrade.html",headers:[{level:2,title:"Install PHP",slug:"install-php"},{level:2,title:"Update Composer",slug:"update-composer"},{level:2,title:"Webserver Configuration",slug:"webserver-configuration"},{level:3,title:"Return to the 1.X.X Upgrade Guide",slug:"return-to-the-1-x-x-upgrade-guide"}]},{title:"Environment Configuration",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/panel/0.7/configuration.html",relativePath:"panel/0.7/configuration.md",key:"v-019cb63a",path:"/panel/0.7/configuration.html",headers:[{level:2,title:"Reporting All Exceptions",slug:"reporting-all-exceptions"},{level:2,title:"Client Databases",slug:"client-databases"},{level:2,title:"Reverse Proxy Setup",slug:"reverse-proxy-setup"},{level:3,title:"NGINX Specific Configuration",slug:"nginx-specific-configuration"},{level:3,title:"Cloudflare Specific Configuration",slug:"cloudflare-specific-configuration"},{level:2,title:"Increasing the Editable File Size",slug:"increasing-the-editable-file-size"},{level:2,title:"Disable or Modify ReCaptcha",slug:"disable-or-modify-recaptcha"},{level:3,title:"Using Your Own Keys",slug:"using-your-own-keys"}]},{title:"Getting Started",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/panel/0.7/getting_started.html",relativePath:"panel/0.7/getting_started.md",key:"v-7ffeb723",path:"/panel/0.7/getting_started.html",headers:[{level:2,title:"Picking a Server OS",slug:"picking-a-server-os"},{level:2,title:"Dependencies",slug:"dependencies"},{level:3,title:"Example Dependency Installation",slug:"example-dependency-installation"},{level:3,title:"Installing Composer",slug:"installing-composer"},{level:2,title:"Download Files",slug:"download-files"},{level:2,title:"Installation",slug:"installation"},{level:3,title:"Environment Configuration",slug:"environment-configuration"},{level:3,title:"Database Setup",slug:"database-setup"},{level:3,title:"Add The First User",slug:"add-the-first-user"},{level:3,title:"Set Permissions",slug:"set-permissions"},{level:2,title:"Queue Listeners",slug:"queue-listeners"},{level:3,title:"Crontab Configuration",slug:"crontab-configuration"},{level:3,title:"Create Queue Worker",slug:"create-queue-worker"}]},{title:"Troubleshooting",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/panel/0.7/troubleshooting.html",relativePath:"panel/0.7/troubleshooting.md",key:"v-9478f2ba",path:"/panel/0.7/troubleshooting.html",headers:[{level:2,title:"Reading Error Logs",slug:"reading-error-logs"},{level:3,title:"Parsing the Error",slug:"parsing-the-error"},{level:3,title:"Understanding the Error",slug:"understanding-the-error"},{level:3,title:"Utilizing GREP",slug:"utilizing-grep"},{level:2,title:"Transfer Exceptions / XHR Poll Error",slug:"transfer-exceptions-xhr-poll-error"},{level:3,title:"Example Errors",slug:"example-errors"},{level:3,title:"Basic Debugging Steps",slug:"basic-debugging-steps"},{level:3,title:"More Advanced Debugging Steps",slug:"more-advanced-debugging-steps"},{level:2,title:"Invalid MAC Exception",slug:"invalid-mac-exception"},{level:2,title:"SELinux Issues",slug:"selinux-issues"},{level:3,title:"Redis Permissions Errors",slug:"redis-permissions-errors"},{level:3,title:"In case there is any weirdness with parts of the panel",slug:"in-case-there-is-any-weirdness-with-parts-of-the-panel"},{level:3,title:"Daemon Connection Errors",slug:"daemon-connection-errors"},{level:2,title:"FirewallD issues",slug:"firewalld-issues"},{level:2,title:"Database Errors",slug:"database-errors"},{level:3,title:"DatabaseController.php:142",slug:"databasecontroller-php-142"}]},{title:"Upgrading 0.6 to 0.7",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/panel/0.7/upgrade/0.6_to_0.7.html",relativePath:"panel/0.7/upgrade/0.6_to_0.7.md",key:"v-4f03fe0f",path:"/panel/0.7/upgrade/0.6_to_0.7.html",headers:[{level:2,title:"Fetch Updated Files",slug:"fetch-updated-files"},{level:2,title:"Clear Compiled Assets",slug:"clear-compiled-assets"},{level:2,title:"Update Dependencies",slug:"update-dependencies"},{level:2,title:"Update Environment",slug:"update-environment"},{level:2,title:"Database Updates",slug:"database-updates"},{level:2,title:"Cleanup API Keys",slug:"cleanup-api-keys"},{level:2,title:"Set Permissions",slug:"set-permissions"}]},{title:"Upgrading 0.7 Series",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/panel/0.7/upgrade/0.7.html",relativePath:"panel/0.7/upgrade/0.7.md",key:"v-5baa92ba",path:"/panel/0.7/upgrade/0.7.html",headers:[{level:2,title:"Fetch Updated Files",slug:"fetch-updated-files"},{level:2,title:"Update Dependencies",slug:"update-dependencies"},{level:2,title:"Clear Compiled Template Cache",slug:"clear-compiled-template-cache"},{level:2,title:"Database Updates",slug:"database-updates"},{level:2,title:"Set Permissions",slug:"set-permissions"}]},{title:"Additional Configuration",frontmatter:{},regularPath:"/panel/1.0/additional_configuration.html",relativePath:"panel/1.0/additional_configuration.md",key:"v-6f4baca5",path:"/panel/1.0/additional_configuration.html",headers:[{level:2,title:"Backups",slug:"backups"},{level:3,title:"Using Local Backups",slug:"using-local-backups"},{level:3,title:"Using S3 Backups",slug:"using-s3-backups"},{level:2,title:"Reverse Proxy Setup",slug:"reverse-proxy-setup"},{level:3,title:"NGINX Specific Configuration",slug:"nginx-specific-configuration"},{level:3,title:"Cloudflare Specific Configuration",slug:"cloudflare-specific-configuration"},{level:2,title:"reCAPTCHA",slug:"recaptcha"},{level:3,title:"Configuring reCAPTCHA",slug:"configuring-recaptcha"},{level:3,title:"Disabling reCAPTCHA",slug:"disabling-recaptcha"},{level:2,title:"2FA",slug:"_2fa"},{level:3,title:"Disable 2FA requirement",slug:"disable-2fa-requirement"},{level:3,title:"Disable 2FA for a specific user",slug:"disable-2fa-for-a-specific-user"},{level:2,title:"Telemetry",slug:"telemetry"},{level:3,title:"How does it work?",slug:"how-does-it-work"},{level:3,title:"What data is collected?",slug:"what-data-is-collected"},{level:3,title:"How is the data stored?",slug:"how-is-the-data-stored"},{level:3,title:"Why?",slug:"why"},{level:3,title:"Enabling Telemetry",slug:"enabling-telemetry"},{level:3,title:"Disabling Telemetry",slug:"disabling-telemetry"}]},{title:"Getting Started",frontmatter:{},regularPath:"/panel/1.0/getting_started.html",relativePath:"panel/1.0/getting_started.md",key:"v-fa75e63a",path:"/panel/1.0/getting_started.html",headers:[{level:2,title:"Picking a Server OS",slug:"picking-a-server-os"},{level:2,title:"Dependencies",slug:"dependencies"},{level:3,title:"Example Dependency Installation",slug:"example-dependency-installation"},{level:3,title:"Installing Composer",slug:"installing-composer"},{level:2,title:"Download Files",slug:"download-files"},{level:2,title:"Installation",slug:"installation"},{level:3,title:"Environment Configuration",slug:"environment-configuration"},{level:3,title:"Database Setup",slug:"database-setup"},{level:3,title:"Add The First User",slug:"add-the-first-user"},{level:3,title:"Set Permissions",slug:"set-permissions"},{level:2,title:"Queue Listeners",slug:"queue-listeners"},{level:3,title:"Crontab Configuration",slug:"crontab-configuration"},{level:3,title:"Create Queue Worker",slug:"create-queue-worker"},{level:3,title:"Telemetry",slug:"telemetry"}]},{title:"Upgrading",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/panel/0.7/upgrading.html",relativePath:"panel/0.7/upgrading.md",key:"v-c249e07a",path:"/panel/0.7/upgrading.html",headers:[{level:2,title:"Maintenance Mode",slug:"maintenance-mode"},{level:2,title:"Restarting Queue Workers",slug:"restarting-queue-workers"},{level:2,title:"Version Specific Guides",slug:"version-specific-guides"}]},{title:"Legacy Upgrades",frontmatter:{},regularPath:"/panel/1.0/legacy_upgrade.html",relativePath:"panel/1.0/legacy_upgrade.md",key:"v-dacf6e56",path:"/panel/1.0/legacy_upgrade.html",headers:[{level:2,title:"Enter Maintenance Mode",slug:"enter-maintenance-mode"},{level:2,title:"Update Dependencies",slug:"update-dependencies"},{level:2,title:"Fetch Updated Files",slug:"fetch-updated-files"},{level:2,title:"Update Dependencies",slug:"update-dependencies-2"},{level:2,title:"Clear Compiled Template Cache",slug:"clear-compiled-template-cache"},{level:2,title:"Database Updates",slug:"database-updates"},{level:2,title:"Set Permissions",slug:"set-permissions"},{level:2,title:"Restarting Queue Workers",slug:"restarting-queue-workers"},{level:2,title:"Exit Maintenance Mode",slug:"exit-maintenance-mode"},{level:2,title:"Switch to Wings",slug:"switch-to-wings"}]},{title:"Webserver Configuration",frontmatter:{meta:[{name:"robots",content:"noindex"}]},regularPath:"/panel/0.7/webserver_configuration.html",relativePath:"panel/0.7/webserver_configuration.md",key:"v-27941b23",path:"/panel/0.7/webserver_configuration.html",headers:[{level:2,title:"NGINX",slug:"nginx"},{level:3,title:"NGINX With SSL",slug:"nginx-with-ssl"},{level:3,title:"NGINX Without SSL",slug:"nginx-without-ssl"},{level:3,title:"Enabling Configuration",slug:"enabling-configuration"},{level:2,title:"Apache",slug:"apache"},{level:3,title:"Apache With SSL",slug:"apache-with-ssl"},{level:3,title:"Apache Without SSL",slug:"apache-without-ssl"},{level:3,title:"Enabling Configuration",slug:"enabling-configuration-2"}]},{title:"Troubleshooting",frontmatter:{},regularPath:"/panel/1.0/troubleshooting.html",relativePath:"panel/1.0/troubleshooting.md",key:"v-8eec473a",path:"/panel/1.0/troubleshooting.html",headers:[{level:2,title:"Reading Error Logs",slug:"reading-error-logs"},{level:3,title:"Parsing the Error",slug:"parsing-the-error"},{level:3,title:"Understanding the Error",slug:"understanding-the-error"},{level:3,title:"Utilizing GREP",slug:"utilizing-grep"},{level:2,title:"Cannot Connect to Server Errors",slug:"cannot-connect-to-server-errors"},{level:3,title:"Basic Debugging Steps",slug:"basic-debugging-steps"},{level:3,title:"More Advanced Debugging Steps",slug:"more-advanced-debugging-steps"},{level:2,title:"Invalid MAC Exception",slug:"invalid-mac-exception"},{level:2,title:"SELinux Issues",slug:"selinux-issues"},{level:3,title:"Redis Permissions Errors",slug:"redis-permissions-errors"},{level:3,title:"Wings Connection Errors",slug:"wings-connection-errors"},{level:2,title:"Containers don't have internet? Probably a DNS issue!",slug:"containers-don-t-have-internet-probably-a-dns-issue"},{level:2,title:"Schedule Troubleshooting",slug:"schedule-troubleshooting"},{level:2,title:"FirewallD issues",slug:"firewalld-issues"}]},{title:"Updating the Panel",frontmatter:{},regularPath:"/panel/1.0/updating.html",relativePath:"panel/1.0/updating.md",key:"v-29d5bc56",path:"/panel/1.0/updating.html",headers:[{level:2,title:"Panel Version Requirements",slug:"panel-version-requirements"},{level:2,title:"Update Dependencies",slug:"update-dependencies"},{level:2,title:"Self Upgrade",slug:"self-upgrade"},{level:2,title:"Manual Upgrade",slug:"manual-upgrade"},{level:3,title:"Enter Maintenance Mode",slug:"enter-maintenance-mode"},{level:3,title:"Download the Update",slug:"download-the-update"},{level:3,title:"Update Dependencies",slug:"update-dependencies-2"},{level:3,title:"Clear Compiled Template Cache",slug:"clear-compiled-template-cache"},{level:3,title:"Database Updates",slug:"database-updates"},{level:3,title:"Set Permissions",slug:"set-permissions"},{level:3,title:"Restarting Queue Workers",slug:"restarting-queue-workers"},{level:3,title:"Exit Maintenance Mode",slug:"exit-maintenance-mode"},{level:3,title:"Telemetry",slug:"telemetry"}]},{title:"Webserver Configuration",frontmatter:{},regularPath:"/panel/1.0/webserver_configuration.html",relativePath:"panel/1.0/webserver_configuration.md",key:"v-cbda523a",path:"/panel/1.0/webserver_configuration.html",headers:[{level:3,title:"Enabling Configuration",slug:"enabling-configuration"},{level:3,title:"Enabling Configuration",slug:"enabling-configuration-2"},{level:3,title:"Enabling Configuration",slug:"enabling-configuration-3"},{level:3,title:"Enabling Configuration",slug:"enabling-configuration-4"},{level:3,title:"Enabling Configuration",slug:"enabling-configuration-5"},{level:3,title:"Enabling Configuration",slug:"enabling-configuration-6"}]},{title:"About",frontmatter:{},regularPath:"/project/about.html",relativePath:"project/about.md",key:"v-a75af93a",path:"/project/about.html",headers:[{level:2,title:"Core Project Team",slug:"core-project-team"},{level:2,title:"Community Team",slug:"community-team"},{level:2,title:"Sponsors",slug:"sponsors"},{level:2,title:"License",slug:"license"},{level:2,title:"Release Signing",slug:"release-signing"}]},{title:"Terminology",frontmatter:{},regularPath:"/project/terms.html",relativePath:"project/terms.md",key:"v-7b99cfba",path:"/project/terms.html",headers:[{level:2,title:"Simple Setup Diagram",slug:"simple-setup-diagram"},{level:2,title:"Advanced Setup Diagram",slug:"advanced-setup-diagram"}]},{title:"Introduction",frontmatter:{},regularPath:"/project/introduction.html",relativePath:"project/introduction.md",key:"v-d6319362",path:"/project/introduction.html",headers:[{level:2,title:"Supported Games",slug:"supported-games"},{level:2,title:"Responsible Disclosure",slug:"responsible-disclosure"}]},{title:"Creating SSL Certificates",frontmatter:{},regularPath:"/tutorials/creating_ssl_certificates.html",relativePath:"tutorials/creating_ssl_certificates.md",key:"v-6ec4d123",path:"/tutorials/creating_ssl_certificates.html",headers:[{level:2,title:"Creating a Certificate",slug:"creating-a-certificate"},{level:3,title:"HTTP challenge",slug:"http-challenge"},{level:3,title:"DNS challenge",slug:"dns-challenge"},{level:3,title:"Auto Renewal",slug:"auto-renewal"},{level:3,title:"Troubleshooting",slug:"troubleshooting"},{level:3,title:"Obtaining CloudFlare API Key (Legacy)",slug:"obtaining-cloudflare-api-key-legacy"},{level:3,title:"Creating a Certificate",slug:"creating-a-certificate-2"},{level:3,title:"Obtaining CloudFlare API Key (Modern)",slug:"obtaining-cloudflare-api-key-modern"},{level:3,title:"Creating a Certificate",slug:"creating-a-certificate-3"},{level:3,title:"Auto Renewal",slug:"auto-renewal-2"},{level:3,title:"Installing Caddy with Cloudflare DNS plugin",slug:"installing-caddy-with-cloudflare-dns-plugin"},{level:3,title:"Obtaining CloudFlare API Token",slug:"obtaining-cloudflare-api-token"},{level:3,title:"Reconfiguring Caddy to use Cloudflare DNS for obtaining certificates",slug:"reconfiguring-caddy-to-use-cloudflare-dns-for-obtaining-certificates"}]},{title:"Community Standards",frontmatter:{},regularPath:"/project/community.html",relativePath:"project/community.md",key:"v-22ba6d3a",path:"/project/community.html",headers:[{level:2,title:"Community Guidelines",slug:"community-guidelines"},{level:3,title:"Be Mature",slug:"be-mature"},{level:3,title:"Limit the Drama",slug:"limit-the-drama"},{level:3,title:"Be Patient",slug:"be-patient"},{level:3,title:"No Commercial Services",slug:"no-commercial-services"},{level:3,title:"No Mention or Ping Spam",slug:"no-mention-or-ping-spam"}]},{title:"Setting up MySQL",frontmatter:{},regularPath:"/tutorials/mysql_setup.html",relativePath:"tutorials/mysql_setup.md",key:"v-5c5d50fa",path:"/tutorials/mysql_setup.html",headers:[{level:2,title:"Creating a database for Pterodactyl",slug:"creating-a-database-for-pterodactyl"},{level:3,title:"Logging In",slug:"logging-in"},{level:3,title:"Creating a user",slug:"creating-a-user"},{level:3,title:"Create a database",slug:"create-a-database"},{level:3,title:"Assigning permissions",slug:"assigning-permissions"},{level:2,title:"Creating a Database Host for Nodes",slug:"creating-a-database-host-for-nodes"},{level:3,title:"Creating a user",slug:"creating-a-user-2"},{level:3,title:"Assigning permissions",slug:"assigning-permissions-2"},{level:3,title:"Allowing external database access",slug:"allowing-external-database-access"}]},{title:"Installing Wings",frontmatter:{},regularPath:"/wings/1.0/installing.html",relativePath:"wings/1.0/installing.md",key:"v-55eb8eca",path:"/wings/1.0/installing.html",headers:[{level:2,title:"Supported Systems",slug:"supported-systems"},{level:2,title:"System Requirements",slug:"system-requirements"},{level:2,title:"Dependencies",slug:"dependencies"},{level:3,title:"Installing Docker",slug:"installing-docker"},{level:2,title:"Installing Wings",slug:"installing-wings-2"},{level:2,title:"Configure",slug:"configure"},{level:3,title:"Starting Wings",slug:"starting-wings"},{level:3,title:"Daemonizing (using systemd)",slug:"daemonizing-using-systemd"},{level:3,title:"Node Allocations",slug:"node-allocations"}]},{title:"Migrating to Wings",frontmatter:{},regularPath:"/wings/1.0/migrating.html",relativePath:"wings/1.0/migrating.md",key:"v-1ec46263",path:"/wings/1.0/migrating.html",headers:[{level:2,title:"Install Wings",slug:"install-wings"},{level:2,title:"Copy New Configuration File",slug:"copy-new-configuration-file"},{level:2,title:"Remove Old Daemon",slug:"remove-old-daemon"},{level:3,title:"Remove Standalone SFTP",slug:"remove-standalone-sftp"},{level:2,title:"Daemonize Wings",slug:"daemonize-wings"}]},{title:"Upgrading Wings",frontmatter:{},regularPath:"/wings/1.0/upgrading.html",relativePath:"wings/1.0/upgrading.md",key:"v-9213d4fa",path:"/wings/1.0/upgrading.html",headers:[{level:2,title:"Wings Version Requirements",slug:"wings-version-requirements"},{level:2,title:"Download Updated Binary",slug:"download-updated-binary"},{level:2,title:"Restart Process",slug:"restart-process"}]},{title:"Additional Configuration",frontmatter:{},regularPath:"/wings/1.0/configuration.html",relativePath:"wings/1.0/configuration.md",key:"v-6cd19ba3",path:"/wings/1.0/configuration.html",headers:[{level:2,title:"Private Registries",slug:"private-registries"},{level:3,title:"Available Keys",slug:"available-keys"},{level:3,title:"Example of usage",slug:"example-of-usage"},{level:2,title:"Custom Network Interfaces",slug:"custom-network-interfaces"},{level:3,title:"Example of usage",slug:"example-of-usage-2"},{level:2,title:"Enabling Cloudflare proxy",slug:"enabling-cloudflare-proxy"},{level:2,title:"Container PID Limit",slug:"container-pid-limit"},{level:3,title:"Example of usage",slug:"example-of-usage-3"},{level:2,title:"Throttles Limits",slug:"throttles-limits"},{level:3,title:"Example of usage",slug:"example-of-usage-4"},{level:2,title:"Installer Limits",slug:"installer-limits"},{level:3,title:"Example of usage",slug:"example-of-usage-5"},{level:2,title:"Other values",slug:"other-values"}]}],themeConfig:{repo:"pterodactyl/panel",docsRepo:"pterodactyl/documentation",repoLabel:"GitHub",editLinkText:"Help us improve this page.",editLinks:!0,logo:"/logos/pterry.svg",nav:[{text:"Documentation",link:"/project/introduction.md"},{text:"Community Guides",link:"/community/about.md"},{text:"Get Help",link:"https://discord.gg/pterodactyl"},{text:"API",link:"https://dashflo.net/docs/api/pterodactyl/v1/"}],sidebar:{"/community/":[{title:"Community Guides",collapsable:!1,children:["/community/about.md"]},{title:"Panel Installation",collapsable:!1,children:["/community/installation-guides/panel/centos7.md","/community/installation-guides/panel/centos8.md","/community/installation-guides/panel/debian.md"]},{title:"Wings Installation",collapsable:!1,children:["/community/installation-guides/wings/centos7.md","/community/installation-guides/wings/centos8.md","/community/installation-guides/wings/debian.md"]},{title:"Creating Eggs",collapsable:!1,children:["/community/config/eggs/creating_a_custom_egg.md","/community/config/eggs/creating_a_custom_image.md"]},{title:"Game Configuration",collapsable:!1,children:["/community/games/minecraft.md"]},{title:"Tutorials",collapsable:!1,children:["/community/config/nodes/add_node.md","/community/tutorials/artisan.md"]},{title:"Customization",collapsable:!1,children:["/community/customization/panel.md","/community/customization/wings.md"]}],"/":[{title:"Project Information",collapsable:!1,children:["/project/introduction.md","/project/about.md","/project/terms.md","/project/community.md"]},{title:"Panel",collapsable:!1,path:"/panel/",currentVersion:"1.0",versions:[{title:"1.11",name:"1.0",status:"stable",children:["/getting_started","/webserver_configuration","/additional_configuration","/updating","/troubleshooting","/legacy_upgrade"]}]},{title:"Wings",collapsable:!1,path:"/wings/",currentVersion:"1.0",versions:[{title:"1.11",name:"1.0",status:"stable",children:["/installing","/upgrading","/migrating","/configuration"]}]},{title:"Tutorials",collapsable:!1,children:["/tutorials/mysql_setup.md","/tutorials/creating_ssl_certificates.md"]},{title:"Guides",collapsable:!1,children:["/guides/mounts.md"]}]}}};function Ee(...t){const e=new RegExp("/{1,}","g");return t.join("/").replace(e,"/")}n(235);r.a.component("Badge",()=>n.e(23).then(n.bind(null,335)));var je=n(89),$e=n.n(je),Te=[({Vue:t,options:e,router:n,siteData:r,isServer:o})=>{var i;(i=r.themeConfig.sidebar,Object.entries(i).map(([t,e])=>e.filter(t=>Array.isArray(t.versions)).map(e=>({...e,path:Ee(t,e.path)}))).flat()).forEach(t=>{n.addRoutes(n.options.routes.map(e=>{if(e.path.startsWith(t.path+t.currentVersion))return[{path:e.path.replace(t.currentVersion,"current"),redirect:e.path},{path:e.path.replace(t.currentVersion+"/",""),redirect:e.path}]}).filter(t=>t).flat().concat([{path:"/panel/1.0/upgrade/1.0.html",redirect:"/panel/1.0/updating.html"},{path:"/panel/1.0/upgrade/0.7_to_1.0.html",redirect:"/panel/1.0/legacy_upgrade.html"}]))})},{},({Vue:t})=>{t.mixin({computed:{$dataBlock(){return this.$options.__data__block__}}})},{},({Vue:t})=>t.use($e.a)],Ae=[];class Le extends class{constructor(){this.store=new r.a({data:{state:{}}})}$get(t){return this.store.state[t]}$set(t,e){r.a.set(this.store.state,t,e)}$emit(...t){this.store.$emit(...t)}$on(...t){this.store.$on(...t)}}{}Object.assign(Le.prototype,{getPageAsyncComponent:le,getLayoutAsyncComponent:ue,getAsyncComponent:ce,getVueComponent:fe});var De={install(t){const e=new Le;t.$vuepress=e,t.prototype.$vuepress=e}};function Ie(t,e){const n=e.toLowerCase();return t.options.routes.some(t=>t.path.toLowerCase()===n)}var Re={props:{pageKey:String,slotKey:{type:String,default:"default"}},render(t){const e=this.pageKey||this.$parent.$page.key;return de("pageKey",e),r.a.component(e)||r.a.component(e,le(e)),r.a.component(e)?t(e):t("")}},Me={functional:!0,props:{slotKey:String,required:!0},render:(t,{props:e,slots:n})=>t("div",{class:["content__"+e.slotKey]},n()[e.slotKey])},Ne={computed:{openInNewWindowTitle(){return this.$themeLocaleConfig.openNewWindowText||"(opens new window)"}}},Ue=(n(236),n(237),Object(ke.a)(Ne,(function(){var t=this._self._c;return t("span",[t("svg",{staticClass:"icon outbound",attrs:{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"}},[t("path",{attrs:{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"}}),this._v(" "),t("polygon",{attrs:{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"}})]),this._v(" "),t("span",{staticClass:"sr-only"},[this._v(this._s(this.openInNewWindowTitle))])])}),[],!1,null,null,null).exports),Fe={functional:!0,render(t,{parent:e,children:n}){if(e._isMounted)return n;e.$once("hook:mounted",()=>{e.$forceUpdate()})}};r.a.config.productionTip=!1,r.a.use(Wt),r.a.use(De),r.a.mixin(function(t,e,n=r.a){!function(t){t.locales&&Object.keys(t.locales).forEach(e=>{t.locales[e].path=e});Object.freeze(t)}(e),n.$vuepress.$set("siteData",e);const o=new(t(n.$vuepress.$get("siteData"))),i=Object.getOwnPropertyDescriptors(Object.getPrototypeOf(o)),a={};return Object.keys(i).reduce((t,e)=>(e.startsWith("$")&&(t[e]=i[e].get),t),a),{computed:a}}(t=>class{setPage(t){this.__page=t}get $site(){return t}get $themeConfig(){return this.$site.themeConfig}get $frontmatter(){return this.$page.frontmatter}get $localeConfig(){const{locales:t={}}=this.$site;let e,n;for(const r in t)"/"===r?n=t[r]:0===this.$page.path.indexOf(r)&&(e=t[r]);return e||n||{}}get $siteTitle(){return this.$localeConfig.title||this.$site.title||""}get $canonicalUrl(){const{canonicalUrl:t}=this.$page.frontmatter;return"string"==typeof t&&t}get $title(){const t=this.$page,{metaTitle:e}=this.$page.frontmatter;if("string"==typeof e)return e;const n=this.$siteTitle,r=t.frontmatter.home?null:t.frontmatter.title||t.title;return n?r?r+" | "+n:n:r||"VuePress"}get $description(){const t=function(t){if(t){const e=t.filter(t=>"description"===t.name)[0];if(e)return e.content}}(this.$page.frontmatter.meta);return t||(this.$page.frontmatter.description||this.$localeConfig.description||this.$site.description||"")}get $lang(){return this.$page.frontmatter.lang||this.$localeConfig.lang||"en-US"}get $localePath(){return this.$localeConfig.path||"/"}get $themeLocaleConfig(){return(this.$site.themeConfig.locales||{})[this.$localePath]||{}}get $page(){return this.__page?this.__page:function(t,e){for(let n=0;nn||(t.hash?!r.a.$vuepress.$get("disableScrollBehavior")&&{selector:decodeURIComponent(t.hash)}:{x:0,y:0})});!function(t){t.beforeEach((e,n,r)=>{if(Ie(t,e.path))r();else if(/(\/|\.html)$/.test(e.path))if(/\/$/.test(e.path)){const n=e.path.replace(/\/$/,"")+".html";Ie(t,n)?r(n):r()}else r();else{const n=e.path+"/",o=e.path+".html";Ie(t,o)?r(o):Ie(t,n)?r(n):r()}})}(n);const o={};try{await Promise.all(Te.filter(t=>"function"==typeof t).map(e=>e({Vue:r.a,options:o,router:n,siteData:Oe,isServer:t})))}catch(t){console.error(t)}return{app:new r.a(Object.assign(o,{router:n,render:t=>t("div",{attrs:{id:"app"}},[t("RouterView",{ref:"layout"}),t("div",{class:"global-ui"},Ae.map(e=>t(e)))])})),router:n}}(!1).then(({app:t,router:e})=>{e.onReady(()=>{t.$mount("#app")})})}]); \ No newline at end of file diff --git a/community/about.html b/community/about.html index d29eaf21..58a5548f 100644 --- a/community/about.html +++ b/community/about.html @@ -15,7 +15,7 @@ - + @@ -39,6 +39,6 @@ feel are important to share with the community, but do not fit into the theme of our core documentation.

    Here you'll find in-depth OS-specific installation guides, advanced network configurations, individual game setup instructions, and so much more.

    Help us improve this page. (opens new window)

    - + diff --git a/community/config/eggs/creating_a_custom_egg.html b/community/config/eggs/creating_a_custom_egg.html index 2e6be204..1afde392 100644 --- a/community/config/eggs/creating_a_custom_egg.html +++ b/community/config/eggs/creating_a_custom_egg.html @@ -15,7 +15,7 @@ - + @@ -115,6 +115,6 @@ regex as any letters or numbers (\w\d) including underscore ( ← Debian 11 & 12
    - + diff --git a/community/config/eggs/creating_a_custom_image.html b/community/config/eggs/creating_a_custom_image.html index f4e32401..bc8f181d 100644 --- a/community/config/eggs/creating_a_custom_image.html +++ b/community/config/eggs/creating_a_custom_image.html @@ -15,7 +15,7 @@ - + @@ -100,6 +100,6 @@ curly braces {{EXAMPLE}} with a matching environment variable (such ← Creating a Custom Egg
    - + diff --git a/community/config/nodes/add_node.html b/community/config/nodes/add_node.html index 9c986951..d76c77c6 100644 --- a/community/config/nodes/add_node.html +++ b/community/config/nodes/add_node.html @@ -15,7 +15,7 @@ - + @@ -48,6 +48,6 @@ or Debian.

    Minecraft
    - + diff --git a/community/customization/panel.html b/community/customization/panel.html index d06a82b0..c1eba194 100644 --- a/community/customization/panel.html +++ b/community/customization/panel.html @@ -15,7 +15,7 @@ - + @@ -55,6 +55,6 @@ This also applies to style sheets. The following sections explain how to do so.< ← Artisan CLI
    - + diff --git a/community/customization/wings.html b/community/customization/wings.html index d294dd7d..0e72b7e8 100644 --- a/community/customization/wings.html +++ b/community/customization/wings.html @@ -15,7 +15,7 @@ - + @@ -47,6 +47,6 @@ systemctl start wings
    Help us improve this page. (opens new window)

    - + diff --git a/community/games/minecraft.html b/community/games/minecraft.html index ca3fe33f..b0926caf 100644 --- a/community/games/minecraft.html +++ b/community/games/minecraft.html @@ -15,7 +15,7 @@ - + @@ -41,6 +41,6 @@ ← Creating a Custom Docker Image
    - + diff --git a/community/installation-guides/panel/centos7.html b/community/installation-guides/panel/centos7.html index 352f573a..8d58440e 100644 --- a/community/installation-guides/panel/centos7.html +++ b/community/installation-guides/panel/centos7.html @@ -15,7 +15,7 @@ - + @@ -94,6 +94,6 @@ setsebool -P httpd_unified Community Guides and Tutorials
    - + diff --git a/community/installation-guides/panel/centos8.html b/community/installation-guides/panel/centos8.html index 3f4db24d..5b1bcea7 100644 --- a/community/installation-guides/panel/centos8.html +++ b/community/installation-guides/panel/centos8.html @@ -15,7 +15,7 @@ - + @@ -82,6 +82,6 @@ pm.max_requests = 200 ← CentOS 7
    - + diff --git a/community/installation-guides/panel/debian.html b/community/installation-guides/panel/debian.html index f76630f8..78e9906b 100644 --- a/community/installation-guides/panel/debian.html +++ b/community/installation-guides/panel/debian.html @@ -15,7 +15,7 @@ - + @@ -56,6 +56,6 @@ ← Enterprise Linux 8 and Fedora Server 40
    - + diff --git a/community/installation-guides/wings/centos7.html b/community/installation-guides/wings/centos7.html index 9ec0f039..7f554f95 100644 --- a/community/installation-guides/wings/centos7.html +++ b/community/installation-guides/wings/centos7.html @@ -15,7 +15,7 @@ - + @@ -57,6 +57,6 @@ firewall-cmd --reload ← Debian 11 & 12
    - + diff --git a/community/installation-guides/wings/centos8.html b/community/installation-guides/wings/centos8.html index 62849e45..94d043e8 100644 --- a/community/installation-guides/wings/centos8.html +++ b/community/installation-guides/wings/centos8.html @@ -15,7 +15,7 @@ - + @@ -59,6 +59,6 @@ firewall-cmd --reload ← CentOS 7
    - + diff --git a/community/installation-guides/wings/debian.html b/community/installation-guides/wings/debian.html index 124ee4cb..7c0a2192 100644 --- a/community/installation-guides/wings/debian.html +++ b/community/installation-guides/wings/debian.html @@ -15,7 +15,7 @@ - + @@ -39,6 +39,6 @@ ← Enterprise Linux 8 and Fedora Server 40
    - + diff --git a/community/tutorials/artisan.html b/community/tutorials/artisan.html index 013e3f81..23931616 100644 --- a/community/tutorials/artisan.html +++ b/community/tutorials/artisan.html @@ -15,7 +15,7 @@ - + @@ -62,6 +62,6 @@ ← Creating a New Node
    - + diff --git a/daemon/0.6/configuration.html b/daemon/0.6/configuration.html index e9edc480..f5423ecc 100644 --- a/daemon/0.6/configuration.html +++ b/daemon/0.6/configuration.html @@ -16,7 +16,7 @@ - + @@ -98,6 +98,6 @@ a private instance and are willing to decrease some of the security measures.

    , ]

    # Enabling Cloudflare

    Enabling Cloudflare on the daemon isn't particularly useful since users do not connect directly to the daemon port, and users need an unproxied hostname to access any servers on the node. As a result it's not possible to conceal the IP address of your node machine, but some people want to enable it regardless.

    Cloudflare only proxies the default daemon port (8080) when using HTTP. In order to get the daemon to work with Cloudflare when HTTPS is enabled you must change the daemon port to one that Cloudflare will proxy such as 8443. Since Cloudflare only proxies HTTP/HTTPS traffic for non-enterprise plans you cannot proxy the SFTP port.

    Help us improve this page. (opens new window)
    - + diff --git a/daemon/0.6/debian_8_docker.html b/daemon/0.6/debian_8_docker.html index 05b9bffb..6ef5c2b4 100644 --- a/daemon/0.6/debian_8_docker.html +++ b/daemon/0.6/debian_8_docker.html @@ -16,7 +16,7 @@ - + @@ -70,6 +70,6 @@ supported on this kernel currently. Run the command below to do so.

    Finally, update systemd and start docker using the following commands.

    systemctl daemon-reload
 service docker start

    Docker should now be running and reporting no errors if you run docker info!

    Help us improve this page. (opens new window)
    - + diff --git a/daemon/0.6/installing.html b/daemon/0.6/installing.html index a2976de4..2e580e06 100644 --- a/daemon/0.6/installing.html +++ b/daemon/0.6/installing.html @@ -16,7 +16,7 @@ - + @@ -105,6 +105,6 @@ StartLimitInterval=600 WantedBy=multi-user.target

    Then, run the commands below to reload systemd and start the daemon.

    systemctl enable --now wings
    Help us improve this page. (opens new window)
    - + diff --git a/daemon/0.6/kernel_modifications.html b/daemon/0.6/kernel_modifications.html index a91163fa..2d7ac030 100644 --- a/daemon/0.6/kernel_modifications.html +++ b/daemon/0.6/kernel_modifications.html @@ -16,7 +16,7 @@ - + @@ -70,6 +70,6 @@ command and also the version of the kernel that we installed above. Once you've update grub and reboot, and you should be set.

    sudo update-grub
 sudo reboot

    # Boot from hard disk

    It's possible that even after you modified the GRUB configuration the server's still booted into a OVH kernel. If this happens to you, go to the OVH control panel and check the server's booting settings and make sure it's booting from hard disk instead of network boot.

    Help us improve this page. (opens new window)
    - + diff --git a/daemon/0.6/standalone_sftp.html b/daemon/0.6/standalone_sftp.html index 01304477..0b735e1d 100644 --- a/daemon/0.6/standalone_sftp.html +++ b/daemon/0.6/standalone_sftp.html @@ -16,7 +16,7 @@ - + @@ -85,6 +85,6 @@ WantedBy=multi-user.target

    Then, run the command below to enable it in systemd and start the SFTP server.

    systemctl enable --now pterosftp

    # Customizing Startup

    If you're trying to pass additional arguments to the server when starting it using SystemD you'll want to modify the ExecStart line. Something like ExecStart=/srv/daemon/sftp-server --port 2022 for example.

    Help us improve this page. (opens new window)
    - + diff --git a/daemon/0.6/upgrade/0.4_to_0.5.html b/daemon/0.6/upgrade/0.4_to_0.5.html index 66e6680f..2e1d3b81 100644 --- a/daemon/0.6/upgrade/0.4_to_0.5.html +++ b/daemon/0.6/upgrade/0.4_to_0.5.html @@ -16,7 +16,7 @@ - + @@ -76,6 +76,6 @@ well as push the latest information to their configurations. Once this is done, and then boot it. If you have all daemons running and wish to update them all at once, remove the --node flag.

    Boot the Daemon one last time in the foreground, make sure it completes without errors, and then you can stop it and restart it using your service: sudo systemctl start wings.

    Thanks!

    You're all finished! Thanks for bearing with us, this update addresses a lot of flaws in the previous implementations of the software, and also prepares your data for the eventual migration to our new daemon — which is still in the works.

    Help us improve this page. (opens new window)
    - + diff --git a/daemon/0.6/upgrade/0.5.html b/daemon/0.6/upgrade/0.5.html index a998e24b..a9ff5368 100644 --- a/daemon/0.6/upgrade/0.5.html +++ b/daemon/0.6/upgrade/0.5.html @@ -16,7 +16,7 @@ - + @@ -53,6 +53,6 @@ that, run the command below to pull down the latest files and unpack them in the components and then restart the daemon.

    npm update --only=production
 systemctl restart wings
    Help us improve this page. (opens new window)
    - + diff --git a/daemon/0.6/upgrade/0.5_to_0.6.html b/daemon/0.6/upgrade/0.5_to_0.6.html index 24282c58..9fc157f8 100644 --- a/daemon/0.6/upgrade/0.5_to_0.6.html +++ b/daemon/0.6/upgrade/0.5_to_0.6.html @@ -16,7 +16,7 @@ - + @@ -63,6 +63,6 @@ you will not be able to see any console output.

    Run the following command ID of the node you just upgraded, or remove the --node flag entirely to rebuild on all nodes.

    php artisan p:server:rebuild --node=###

    Then, restart all of the servers using the following command, or by manually restarting them one at a time in the Panel.

    php artisan p:server:bulk-power restart --nodes=###
    Help us improve this page. (opens new window)
    - + diff --git a/daemon/0.6/upgrade/0.6.html b/daemon/0.6/upgrade/0.6.html index e25a1d21..84c883cd 100644 --- a/daemon/0.6/upgrade/0.6.html +++ b/daemon/0.6/upgrade/0.6.html @@ -16,7 +16,7 @@ - + @@ -55,6 +55,6 @@ you are running at least version 10. You can run node -v to check, You can safely ignore this output. Do not run the audit fix command, you will break your Daemon.

    npm install --only=production --no-audit --unsafe-perm
 systemctl restart wings
    Help us improve this page. (opens new window)
    - + diff --git a/daemon/0.6/upgrading.html b/daemon/0.6/upgrading.html index 4940e531..9afd0991 100644 --- a/daemon/0.6/upgrading.html +++ b/daemon/0.6/upgrading.html @@ -16,7 +16,7 @@ - + @@ -47,6 +47,6 @@ current

  • Tutorials

  • Guides

    • # Upgrading

    This Software is Abandoned

    This documentation is for abandoned software which does not recieve any security updates or support from the community. This documentation has been left accessible for historial reasons.

    You should be installing and using Wings in production environments with Pterodactyl Panel 1.0.

    # Version Specific Guides

    Help us improve this page. (opens new window)
    - + diff --git a/guides/mounts.html b/guides/mounts.html index c98f5dcd..138636ba 100644 --- a/guides/mounts.html +++ b/guides/mounts.html @@ -15,7 +15,7 @@ - + @@ -52,6 +52,6 @@ Keep in mind that the folder you want to mount into needs to exist for the mount

    Help us improve this page. (opens new window)

    - + diff --git a/guides/php_upgrade.html b/guides/php_upgrade.html index a2d9c69f..672da057 100644 --- a/guides/php_upgrade.html +++ b/guides/php_upgrade.html @@ -15,7 +15,7 @@ - + @@ -62,6 +62,6 @@ a2dismod php* a2enmod php8.3

    # Return to the 1.X.X Upgrade Guide

    Help us improve this page. (opens new window)
    - + diff --git a/index.html b/index.html index 74cb474b..1e2296c1 100644 --- a/index.html +++ b/index.html @@ -15,7 +15,7 @@ - + @@ -57,6 +57,6 @@ Take the plunge today and discover why thousands of users trust Pterodactyl® to manage their game servers.

    MIT Licensed | Pterodactyl® Copyright © Dane Everitt and contributors
    - + diff --git a/panel/0.7/configuration.html b/panel/0.7/configuration.html index ffbf82ed..c20f000e 100644 --- a/panel/0.7/configuration.html +++ b/panel/0.7/configuration.html @@ -16,7 +16,7 @@ - + @@ -81,6 +81,6 @@ also be set using the .env file. The default value is 50,000<

    # Disable or Modify ReCaptcha

    To disable reCAPTCHA on login or password reset, simply set RECAPTCHA_ENABLED=false in the environment file. This change will take effect immediately.

    # Using Your Own Keys

    Pterodactyl comes preconfigured using a public set of reCAPTCHA keys but you may wish to use your own site specific keys. To do so, follow the instructions below.

    1. Visit Google's reCAPTCHA Admin Console (opens new window).
    2. Click "Register New Site" and fill in a name for your keys.
    3. Choose reCAPTCHA v2 and ensure that the option for Invisible is selected.
    4. Include the domain that your panel is located on.
    5. On the next page displayed, locate the "Site Key" and "Secret Key". In Pterodactyl's control panel click on "Settings" and then the "Advanced" tab. Enter the keys in the boxes "Site Key" and "Secret Key", respectively.

    Disabling Domain Verification

    If you do not want reCAPTCHA to verify the domain making the validation request you can uncheck "Verify the origin of reCaptcha solution" under "Advanced Settings" after generating your key.

    Help us improve this page. (opens new window)
    - + diff --git a/panel/0.7/getting_started.html b/panel/0.7/getting_started.html index 6ea68fb9..fc819508 100644 --- a/panel/0.7/getting_started.html +++ b/panel/0.7/getting_started.html @@ -16,7 +16,7 @@ - + @@ -141,6 +141,6 @@ WantedBy=multi-user.target when the service starts.

    If you are are using redis for your system, you will want to make sure to enable that it will start on boot. You can do that by running the following command:

    sudo systemctl enable --now redis-server

    Finally, enable the service and set it to boot on machine start.

    sudo systemctl enable --now pteroq.service

    # Next Step: Webserver Configuration

    Help us improve this page. (opens new window)
    - + diff --git a/panel/0.7/troubleshooting.html b/panel/0.7/troubleshooting.html index 936fa1b6..6c4b65f5 100644 --- a/panel/0.7/troubleshooting.html +++ b/panel/0.7/troubleshooting.html @@ -16,7 +16,7 @@ - + @@ -95,6 +95,6 @@ semodule -i http_port_t.pp firewall-cmd --reload

    restart docker and wings after running these to be sure the rules are applied.

    # Database Errors

    # DatabaseController.php:142

    production.ERROR: ErrorException: Undefined variable: host in /var/www/pterodactyl/app/Http/Controllers/Admin/DatabaseController.php:142

    The database user you are trying to use doesn't have appropriate grants/has used incorrect password.

    Help us improve this page. (opens new window)
    - + diff --git a/panel/0.7/upgrade/0.6_to_0.7.html b/panel/0.7/upgrade/0.6_to_0.7.html index ef6b9e70..591c3072 100644 --- a/panel/0.7/upgrade/0.6_to_0.7.html +++ b/panel/0.7/upgrade/0.6_to_0.7.html @@ -16,7 +16,7 @@ - + @@ -82,6 +82,6 @@ is www-data but can vary from system to system — sometimes being # If using Apache on CentOS chown -R apache:apache *
    Help us improve this page. (opens new window)
    - + diff --git a/panel/0.7/upgrade/0.7.html b/panel/0.7/upgrade/0.7.html index a3d104a3..5e55648d 100644 --- a/panel/0.7/upgrade/0.7.html +++ b/panel/0.7/upgrade/0.7.html @@ -16,7 +16,7 @@ - + @@ -72,6 +72,6 @@ is www-data but can vary from system to system — sometimes being # If using Apache on CentOS chown -R apache:apache *
    Help us improve this page. (opens new window)
    - + diff --git a/panel/0.7/upgrading.html b/panel/0.7/upgrading.html index 272d6b29..ab047eba 100644 --- a/panel/0.7/upgrading.html +++ b/panel/0.7/upgrading.html @@ -16,7 +16,7 @@ - + @@ -54,6 +54,6 @@ php artisan down php artisan up

    # Restarting Queue Workers

    After every update, you should restart the queue worker to ensure that the new code is being loaded in and used.

    php artisan queue:restart

    # Version Specific Guides

    Help us improve this page. (opens new window)
    - + diff --git a/panel/0.7/webserver_configuration.html b/panel/0.7/webserver_configuration.html index faed70d1..d53d64d1 100644 --- a/panel/0.7/webserver_configuration.html +++ b/panel/0.7/webserver_configuration.html @@ -16,7 +16,7 @@ - + @@ -214,6 +214,6 @@ below! You only need to run systemctl restart httpd.

    sudo a2enmod rewrite systemctl restart apache2
    Help us improve this page. (opens new window)
    - + diff --git a/panel/1.0/additional_configuration.html b/panel/1.0/additional_configuration.html index 86fb0bf1..2c23f6a0 100644 --- a/panel/1.0/additional_configuration.html +++ b/panel/1.0/additional_configuration.html @@ -15,7 +15,7 @@ - + @@ -140,6 +140,6 @@ and either remove the PTERODACTYL_TELEMETRY_ENABLED line, or set it the --telemetry flag for a non-interactive setup.

    # Disabling Telemetry

    To disable telemetry, edit your .env file and set PTERODACTYL_TELEMETRY_ENABLED to false.

    PTERODACTYL_TELEMETRY_ENABLED=false

    You may also use the php artisan p:environment:setup command to disable telemetry, optionally with the --telemetry=false flag for a non-interactive setup.

    Help us improve this page. (opens new window)
    - + diff --git a/panel/1.0/getting_started.html b/panel/1.0/getting_started.html index 3b88c8dd..4596f579 100644 --- a/panel/1.0/getting_started.html +++ b/panel/1.0/getting_started.html @@ -15,7 +15,7 @@ - + @@ -48,20 +48,17 @@ software; take some time and read rather than copy and pasting and then complain not exist as a drag-and-drop service to run your servers. It is a highly complex system requiring multiple dependencies and administrators willing to spend some time learning how to use it. If you expect to be able to install this with no understanding of basic linux system administration you should stop and turn around now.

    Looking for something simple to setup?

    WISP (opens new window) is a Pterodactyl powered SaaS suitable for enterprise and personal use. Offering all the features without the setup hassle, and fully compatible with Pterodactyl eggs. Comparable to MultiCraft or TCAdmin while offering new and unique features. Click here to learn more (opens new window).

    # Picking a Server OS

    Pterodactyl runs on a wide range of operating systems, so pick whichever you are most comfortable using.

    WARNING

    Pterodactyl does not support most OpenVZ systems due to incompatibilities with Docker. If you are planning on running -this software on an OpenVZ based system you will — most likely — not be successful.

    Operating System Version Supported Notes
    Ubuntu 20.04 ✅ Documentation written assuming Ubuntu 20.04 as the base OS.
    22.04 ✅ MariaDB can be installed without the repo setup script.
    24.04 ✅ MariaDB can be installed without the repo setup script.
    RHEL / Rocky Linux / AlmaLinux 8 ✅ Extra repos are required.
    9 ✅
    Debian 11 ✅
    12 ✅

    # Dependencies

    • PHP 8.2 or 8.3 (recommended) with the following extensions: cli, openssl, gd, mysql, PDO, mbstring, tokenizer, bcmath, xml or dom, curl, zip, and fpm if you are planning to use NGINX.
    • MySQL 5.7.22 and higher (MySQL 8 recommended) or MariaDB 10.2 and higher.
    • Redis (redis-server)
    • A webserver (Apache, NGINX, Caddy, etc.)
    • curl
    • tar
    • unzip
    • git
    • composer v2

    # Example Dependency Installation

    The commands below are simply an example of how you might install these dependencies. Please consult with your +this software on an OpenVZ based system you will — most likely — not be successful.

    Operating System Version Supported Notes
    Ubuntu 22.04 ✅ Requires additional repositories for PHP
    24.04 ✅ MariaDB can be installed without the repo setup script.
    RHEL / Rocky Linux / AlmaLinux 8 ✅ Extra repos are required.
    9 ✅
    Debian 11 ✅
    12 ✅

    # Dependencies

    • PHP 8.2 or 8.3 (recommended) with the following extensions: cli, openssl, gd, mysql, PDO, mbstring, tokenizer, bcmath, xml or dom, curl, zip, and fpm if you are planning to use NGINX.
    • MySQL 5.7.22 and higher (MySQL 8 recommended) or MariaDB 10.2 and higher.
    • Redis (redis-server)
    • A webserver (Apache, NGINX, Caddy, etc.)
    • curl
    • tar
    • unzip
    • git
    • composer v2

    # Example Dependency Installation

    The commands below are simply an example of how you might install these dependencies. Please consult with your operating system's package manager to determine the correct packages to install.

    # Add "add-apt-repository" command
 apt -y install software-properties-common curl apt-transport-https ca-certificates gnupg
 
-# Add additional repositories for PHP (Ubuntu 20.04 and Ubuntu 22.04)
+# Add additional repositories for PHP (Ubuntu 22.04)
 LC_ALL=C.UTF-8 add-apt-repository -y ppa:ondrej/php
 
 # Add Redis official APT repository
 curl -fsSL https://packages.redis.io/gpg | sudo gpg --dearmor -o /usr/share/keyrings/redis-archive-keyring.gpg
 echo "deb [signed-by=/usr/share/keyrings/redis-archive-keyring.gpg] https://packages.redis.io/deb $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/redis.list
 
-# MariaDB repo setup script (Ubuntu 20.04)
-curl -LsS https://r.mariadb.com/downloads/mariadb_repo_setup | sudo bash
-
 # Update repositories list
 apt update
 
@@ -151,6 +148,6 @@ when the service starts.

    If you are using redis for your system, yo

    # Telemetry

    Since 1.11, Pterodactyl will collect anonymous telemetry to help us better understand how the software is being used. To learn more about this feature and to opt-out, please see our Telemetry documentation. Make sure to continue with the rest of the installation process.

    # Next Step: Webserver Configuration

    Help us improve this page. (opens new window)
    - + diff --git a/panel/1.0/legacy_upgrade.html b/panel/1.0/legacy_upgrade.html index 9f68549e..7a37fb7e 100644 --- a/panel/1.0/legacy_upgrade.html +++ b/panel/1.0/legacy_upgrade.html @@ -15,7 +15,7 @@ - + @@ -93,6 +93,6 @@ php artisan up control plane written in Go. This new system is significantly faster, easier to install, and much smaller. All you need to do is install a single binary on your system and configure it to run on boot. You cannot use the old Node.js Daemon to run servers with Pterodactyl Panel 1.0.

    Please see Migrating to Wings for instructions.

    Help us improve this page. (opens new window)
    - + diff --git a/panel/1.0/troubleshooting.html b/panel/1.0/troubleshooting.html index bea2194f..e678bdf5 100644 --- a/panel/1.0/troubleshooting.html +++ b/panel/1.0/troubleshooting.html @@ -15,7 +15,7 @@ - + @@ -94,8 +94,6 @@ One of those values is DNS, which by default will be 1.1.1.1 and 1.0.0.1 If you are using a host that blocks Cloudflare DNS, you will have to use different DNS Servers; typically the same ones your host system is using. You can view what DNS Servers your host uses through a number of ways depending on how your operating system handles networking. If one of these doesn't work, try another one.

    # Network Manager (This will show both your IPV4 DNS and IPV6 DNS Servers in case you want to add the IPV6 DNS Server(s) from your host to your Wings Config as well.
 nmcli -g ip4.dns,ip6.dns dev show
-# Systemd-Resolve (Ubuntu 18.04 and 20.04)
-systemd-resolve --status
 # Resolve-CTL (Newer Versions of Ubuntu)
 resolvectl status
 # Raw file locations that may have your host system's DNS Servers for various distributions
@@ -104,6 +102,6 @@ resolvectl status

    If this returns different DNS Servers than 1.1.1.1 and 1.0.0.1 you'll need to edit the wings 'config.yml' file to use the DNS servers that were returned from the command. If you see output that looks like an IPV6 address in addition to your IPV4 DNS Servers, make sure you put that in the IPV6 section and not the IPV4 section. To be clear, if you have to use different DNS Servers than the default, make sure to REMOVE 1.1.1.1 and 1.0.0.1 from the wings config; don't just add the new servers, replace the old servers.

    # Schedule Troubleshooting

    • Check logs from your queue manager journalctl -xeu pteroq
    • Restart pteroq systemctl restart pteroq
    • Clear schedule cache php /var/www/pterodactyl/artisan schedule:clear-cache
    • Check your php version php -v - this page (opens new window) will tell you what versions of php are supported by what versions of the panel
    • Check your crontab syntax using https://crontab.guru - make sure it's what you intended
    • Verify the problem is with the schedule and not with the tasks you have set up (Set the first task in your schedule to something you know prints a message in the console, ie. run say test in the console for a Minecraft server, if the text "test" shows up in the console successfully, set the first task to say test so you know if it runs
    • Are your tasks off by a bit? Make sure you on the latest version of the panel? In version 1.11.5 there was a fix for schedules running at the wrong time. Alternatively, you may have the wrong timezone set. Make sure your timezones all match.
    • System Timezone timedatectl
    • Panel Timezone nano /var/www/pterodactyl/.env
    • Wings Timezone (Passed to containers as the TZ environmental variable, unrelated to schedules but while you're checking timezones you may as well set this too) nano /etc/pterodactyl/config.yml
    • Check your database where schedules are stored - MariaDB by default
    • systemctl status mariadb - if it's not active, journalctl -xeu mariadb
    • Check queue handler - Redis by default
    • systemctl status redis - if it's not active, journalctl -xeu redis (On some distributions the service will be named redis-server instead)
    • Check for panel errors tail -n 150 /var/www/pterodactyl/storage/logs/laravel-$(date +%F).log | nc pteropaste.com 99

    # FirewallD issues

    If you are on a RHEL/CentOS server with firewalld installed you may have broken DNS.

    firewall-cmd --permanent --zone=trusted --change-interface=pterodactyl0
 firewall-cmd --reload

    Restart docker and wings after running these to be sure the rules are applied.

    Help us improve this page. (opens new window)
    - + diff --git a/panel/1.0/updating.html b/panel/1.0/updating.html index 4d1cc1ab..86ef1dc9 100644 --- a/panel/1.0/updating.html +++ b/panel/1.0/updating.html @@ -15,7 +15,7 @@ - + @@ -91,6 +91,6 @@ connections.

    # Telemetry 
    Since 1.11, Pterodactyl will collect anonymous telemetry to help us better understand how the
 software is being used. To learn more about this feature and to opt-out, please see our Telemetry
 documentation. Remember to continue with the rest of the upgrade.
     
    Final Step: Upgrade Wings
    Help us improve this page. (opens new window)
    - + diff --git a/panel/1.0/webserver_configuration.html b/panel/1.0/webserver_configuration.html index 0bf43b02..5951e512 100644 --- a/panel/1.0/webserver_configuration.html +++ b/panel/1.0/webserver_configuration.html @@ -15,7 +15,7 @@ - + @@ -329,6 +329,6 @@ below! You only need to run systemctl restart httpd.

    # Enabling Configuration

    The final step is to restart Caddy.

    systemctl restart caddy

    # Next Step: Wings Installation

    Help us improve this page. (opens new window)
    - + diff --git a/project/about.html b/project/about.html index 2808469e..295929b4 100644 --- a/project/about.html +++ b/project/about.html @@ -15,7 +15,7 @@ - + @@ -50,6 +50,6 @@ members can be found in our Discord server and are distinguished with a yellow u ← Introduction
    - + diff --git a/project/community.html b/project/community.html index e70f4978..00e32cd4 100644 --- a/project/community.html +++ b/project/community.html @@ -15,7 +15,7 @@ - + @@ -69,6 +69,6 @@ directly if they're not already involved in a discussion with you.

    Terminology
    - + diff --git a/project/introduction.html b/project/introduction.html index 6acb7c33..8755f90e 100644 --- a/project/introduction.html +++ b/project/introduction.html @@ -15,7 +15,7 @@ - + @@ -53,6 +53,6 @@ code base and hunt for security issues. If you come across anything that raises hesitate to reach out directly to support@pterodactyl.io. We ask that you please be responsible when disclosing any security concerns and do not report them on our public facing bug tracker.

    Help us improve this page. (opens new window)

    - + diff --git a/project/terms.html b/project/terms.html index 53d8302f..eac302a2 100644 --- a/project/terms.html +++ b/project/terms.html @@ -15,7 +15,7 @@ - + @@ -51,6 +51,6 @@ created on nodes, and you can have multiple servers per node.

    Doc ← About

    - + diff --git a/tutorials/creating_ssl_certificates.html b/tutorials/creating_ssl_certificates.html index 6803613a..ee636670 100644 --- a/tutorials/creating_ssl_certificates.html +++ b/tutorials/creating_ssl_certificates.html @@ -15,7 +15,7 @@ - + @@ -121,6 +121,6 @@ WantedBy=multi-user.target ← Setting up MySQL
    - + diff --git a/tutorials/mysql_setup.html b/tutorials/mysql_setup.html index abbd0a49..2dac7ba8 100644 --- a/tutorials/mysql_setup.html +++ b/tutorials/mysql_setup.html @@ -15,7 +15,7 @@ - + @@ -70,6 +70,6 @@ bind-address=0.0.0.0 ← Community Standards
    - + diff --git a/wings/1.0/configuration.html b/wings/1.0/configuration.html index d6804176..cf1cc415 100644 --- a/wings/1.0/configuration.html +++ b/wings/1.0/configuration.html @@ -15,7 +15,7 @@ - + @@ -71,6 +71,6 @@ Restart wings and your game server to apply the new limit.

    memory: 1024 cpu: 100

    # Other values

    More commonly discussed values. View all Wings config values and explanations in these two files. (opens new window)

    Setting Key Default Value Notes
    debug false Force Wings to run in debug mode
    tmpfs_size 100 The size of the /tmp directory in MB when mounted into a container
    websocket_log_count 150 The number of lines to display in the console
    detect_clean_exit_as_crash true Mark server as crashed if it's stopped without user interaction, e.g., not pressing stop button
    (crash detection) timeout 60 Timeout between server crashes that will not cause the server to be automatically restarted
    app_name "Pterodactyl" Changes the name of the daemon, shown in the panel's game console
    check_permissions_on_boot true Check all file permissions on each boot. Disable this when you have a very large amount of files and the server startup is hanging on checking permissions
    Help us improve this page. (opens new window)
    - + diff --git a/wings/1.0/installing.html b/wings/1.0/installing.html index c458db01..17c361d5 100644 --- a/wings/1.0/installing.html +++ b/wings/1.0/installing.html @@ -15,7 +15,7 @@ - + @@ -90,6 +90,6 @@ RestartSec=5s WantedBy=multi-user.target

    Then, run the commands below to reload systemd and start Wings.

    sudo systemctl enable --now wings

    # Node Allocations

    Allocation is a combination of IP and Port that you can assign to a server. Each created server must have at least one allocation. The allocation would be the IP address of your network interface. In some cases, such as when behind NAT, it would be the internal IP. To create new allocations go to Nodes > your node > Allocation.

    example image of node allocations

    Type hostname -I | awk '{print $1}' to find the IP to be used for the allocation. Alternatively, you can type ip addr | grep "inet " to see all your available interfaces and IP addresses. Do not use 127.0.0.1 for allocations.

    Help us improve this page. (opens new window)
    - + diff --git a/wings/1.0/migrating.html b/wings/1.0/migrating.html index 0ae878bc..7571a5fb 100644 --- a/wings/1.0/migrating.html +++ b/wings/1.0/migrating.html @@ -15,7 +15,7 @@ - + @@ -93,6 +93,6 @@ systemctl enable --now wings

    What if Wings doesn't start?

    If you encounter issues starting Wings at this point, run the following command to start Wings directly and check for any specific error output.

    sudo wings --debug
    Help us improve this page. (opens new window)
    - + diff --git a/wings/1.0/upgrading.html b/wings/1.0/upgrading.html index 78a9e1da..3ed89271 100644 --- a/wings/1.0/upgrading.html +++ b/wings/1.0/upgrading.html @@ -15,7 +15,7 @@ - + @@ -52,6 +52,6 @@ servers will not be affected.

    # Restart Process

    Finally, restart the wings process. Your running servers will not be affected and any open connections to the instance will re-connect automatically.

    systemctl restart wings
    Help us improve this page. (opens new window)
    - +