documentation/assets/js/46.c04b0749.js

(window.webpackJsonp=window.webpackJsonp||[]).push([[46],{387:function(a,t,s){"use strict";s.r(t);var e=s(48),r=Object(e.a)({},(function(){var a=this,t=a.$createElement,s=a._self._c||t;return s("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[s("h1",{attrs:{id:"artisan-cli"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#artisan-cli"}},[a._v("#")]),a._v(" Artisan CLI")]),a._v(" "),s("p",[a._v("The Artisan CLI, command line interface, is part of the Laravel framework, which Pterodactyl is built on. The Artisan file is located in "),s("code",[a._v("/var/www/pterodactyl")]),a._v(" if you followed the official guide. This guide goes over some more Pterodactyl specific/related Artisan commands, which are all prefixed with the letter "),s("code",[a._v("p")]),a._v(" (e.g. "),s("code",[a._v("p:user:make")]),a._v("). If you'd like to view all commands, you can do so by running:")]),a._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[a._v("php artisan list\n")])])]),s("p",[a._v("To get information regarding a specific command you can do so by running:")]),a._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[a._v("php artisan "),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v("help")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("command"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n")])])]),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[a._v("TIP")]),a._v(" "),s("p",[a._v("To simplify this documentation, in command usage you'll see things like the following:")]),a._v(" "),s("p",[s("code",[a._v("<hello-world>")]),a._v(" - Required argument")]),a._v(" "),s("p",[s("code",[a._v("[hello-world]")]),a._v(" - Optional argument")]),a._v(" "),s("p",[s("code",[a._v("{--hello-world}")]),a._v(" - Option")])]),a._v(" "),s("h2",{attrs:{id:"user-management"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#user-management"}},[a._v("#")]),a._v(" User Management")]),a._v(" "),s("p",[a._v("When running any of the following commands, you can either use the options or don't pass through anything and use the interactive prompt. You can also do both passing through options and using interactive prompts as well.")]),a._v(" "),s("h3",{attrs:{id:"create-user"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#create-user"}},[a._v("#")]),a._v(" Create User")]),a._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[a._v("php artisan p:user:make "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("--email"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("user@example.com"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n                        "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("--username"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("myusername"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n                        "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("--name-first"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("My"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n                        "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("--name-last"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("Name"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n                        "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("--password"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("supersecret"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n                        "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("--admin"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),s("span",{pre:!0,attrs:{class:"token number"}},[a._v("1")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("|")]),s("span",{pre:!0,attrs:{class:"token number"}},[a._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n                        "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("--no-password"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n")])])]),s("h3",{attrs:{id:"delete-user"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#delete-user"}},[a._v("#")]),a._v(" Delete User")]),a._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[a._v("php artisan p:user:delete "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("--user"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("username/email/UUID"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n")])])]),s("h3",{attrs:{id:"disable-2fa"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#disable-2fa"}},[a._v("#")]),a._v(" Disable 2FA")]),a._v(" "),s("div",{staticClass:"custom-block warning"},[s("p",{staticClass:"custom-block-title"},[a._v("WARNING")]),a._v(" "),s("p",[a._v("Disabling 2-factor authentication should only be used as a last restort for user recovery. "),s("strong",[a._v("Please use this with caution.")])])]),a._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[a._v("php artisan p:user:disable2fa "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("--email"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("user@example.com"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n")])])]),s("h2",{attrs:{id:"server-node-management"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#server-node-management"}},[a._v("#")]),a._v(" Server & Node Management")]),a._v(" "),s("h3",{attrs:{id:"create-location"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#create-location"}},[a._v("#")]),a._v(" Create Location")]),a._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[a._v("php artisan p:location:make "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("--short"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("us1"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n                            "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("--long"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"A description of this location."')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n")])])]),s("h3",{attrs:{id:"delete-location"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#delete-location"}},[a._v("#")]),a._v(" Delete Location")]),a._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[a._v("php artisan p:location:delete "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("--short"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("us1"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n")])])]),s("h3",{attrs:{id:"server-bulk-power"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#server-bulk-power"}},[a._v("#")]),a._v(" Server Bulk Power")]),a._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[a._v("php artisan p:server:bulk-power "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("start, stop, kill, restart"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n                                "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("--servers"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),s("span",{pre:!0,attrs:{class:"token number"}},[a._v("1,2")]),a._v(",3"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n                                "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("--nodes"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),s("span",{pre:!0,attrs:{class:"token number"}},[a._v("1,2")]),a._v(",3"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n")])])]),s("h3",{attrs:{id:"server-rebuild"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#server-rebuild"}},[a._v("#")]),a._v(" Server Rebuild")]),a._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[a._v("php artisan p:server:rebuild "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),a._v("server-id"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("--node"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),s("span",{pre:!0,attrs:{class:"token number"}},[a._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n")])])]),s("p",[a._v("This will initiate a rebuild on all servers, all servers on a node, or a specific server depending on the information given.")]),a._v(" "),s("h2",{attrs:{id:"panel-management"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#panel-management"}},[a._v("#")]),a._v(" Panel Management")]),a._v(" "),s("h3",{attrs:{id:"view-panel-info"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#view-panel-info"}},[a._v("#")]),a._v(" View Panel Info")]),a._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[a._v("php artisan p:info\n")])])]),s("p",[a._v("Displays a variety of panel information which can be used to check the configuation of this like database and email.")])])}),[],!1,null,null,null);t.default=r.exports}}]);