Creating servers in Pterodactyl: Difference between revisions

(5 intermediate revisions by the same user not shown)

Line 7:

== Eggs ==

An ''egg'' is a ~~Pterodactyl-specific configuration~~ file which tells Pterodactyl ''how'' to install~~, launch~~, and ~~manage~~ a ~~particular~~ application ~~autonomously~~. ~~It also sets what configuration options are available to operators in the panel itself~~.~~<ref>For example,~~ for ~~the Arma server, it~~'s ~~egg is configured to give operators an option~~ in the panel ~~to change the server's active modlist. The egg maps this created option to the appropriate line on Arma's <code>server.cfg</code> file~~.~~</ref>~~

An ''egg'' is a file which tells Pterodactyl how to install a particular application, and then Pterodactyl executes those instructions inside a docker container. The egg also translates application-specific settings (e.g. player slots for a ''Garry's Mod'' server) as options which are instead configurable in the panel.

While the adding of a new egg to the panel is always the same, because by their nature all game servers<ref>Pterodactyl can be used for non-game servers too, like [https://foundryvtt.com/ FoundryVTT] or TeamSpeak, but the point stands.</ref> are different, the configuration and effort required to get a server to launch for the first time is case-by-case.

== Step 0: Checking if we have the egg ==

Before we scour the internet for an egg let's first check we don't already have it ~~and save ourselves the trouble~~.

Before we scour the internet for an egg let's first check that we don't already have it.

# Log into the panel at https://edcgaming.org.

Line 19:

You will then be greeted with the following list (or similar looking list).

[[File:Pterodactyl list of nests.png|none|thumb|820x820px|''List of Pterodactyl egg nests.'']]

~~The term~~ ''~~nest~~'' is ~~fairly self-explanatory~~. ~~Click into the nests and see~~ if an egg ~~for~~ the ~~software you want to spin up is present~~.

'''<u>This is not a list of all available eggs</u>'''. '''This is a list of ''nests''''' {{Em dash}} '''a ''grouping'' of eggs.''' To check if an egg exists, look into all of the nests (e.g click <code>Non-Default Games</code> in most cases, or <code>Source Engine</code>, and so on)

Review the table below for what you should do now.

Line 32:

== Step 1: Finding and installing an egg ==

{{Ambox|type=content|image=|text='''Please be cautious of uploading duplicate eggs'''. Pterodactyl ~~allows the same egg to be uploading repeatedly~~, and ~~it's also possible to find 2 different~~ eggs ~~made by different people~~ for the same application.

{{Ambox|type=content|image=|text='''Please be cautious of uploading duplicate eggs'''. Pterodactyl does not in any way stop this. To maintain consistency of server setup, and general organization, multiple eggs for the same application is not desirable.

}}

Line 40:

* https://pelican-eggs.github.io/pterodactyl/ (Option 1)

Regardless as to where an egg is found, it will always be a JSON file~~. This JSON file will be uploaded directly to Pterodactyl~~. For example, on the ''Option 1'' list, when we select ''Mordhau's'' entry, we are sent to the raw text of the egg. Right click and select <code>Save as</code> on your browser, or copy the contents into a new text file and change the extension to <code>.json</code>.

Regardless as to where an egg is found, it will always be a JSON file. For example, on the ''Option 1'' list, when we select ''Mordhau's'' entry, we are sent to the raw text of the egg. Right click and select <code>Save as</code> on your browser, or copy the contents into a new text file and change the extension to <code>.json</code>.

=== b. Installing the egg ===

Now, we going to take the egg and upload it to our Pterodactyl instance. Once done, EDC has this egg forever, and it will be possible boot up and terminate it's associated application at will.

Now, we are going to take the egg and upload it to our Pterodactyl instance. Once done, EDC has this egg forever, and it will be possible boot up and terminate it's associated application at will.

#Log into the panel at https://edcgaming.org.

# Click the cog icon to the left of the colored smiley face to access the administrative section of Pterodactyl.[[File:Pterodactyl admin panel icon.png|none|thumb|''The Pterodactyl panel button to get to the administrative section.'']]

@@ Line 7: / Line 7: @@
 == Eggs ==
-An ''egg'' is a Pterodactyl-specific configuration file which tells Pterodactyl ''how'' to install, launch, and manage a particular application autonomously. It also sets what configuration options are available to operators in the panel itself.<ref>For example, for the Arma server, it's egg is configured to give operators an option in the panel to change the server's active modlist. The egg maps this created option to the appropriate line on Arma's <code>server.cfg</code> file.</ref>
+An ''egg'' is a file which tells Pterodactyl how to install a particular application, and then Pterodactyl executes those instructions inside a docker container. The egg also translates application-specific settings (e.g. player slots for a ''Garry's Mod'' server) as options which are instead configurable in the panel.
 While the adding of a new egg to the panel is always the same, because by their nature all game servers<ref>Pterodactyl can be used for non-game servers too, like [https://foundryvtt.com/ FoundryVTT] or TeamSpeak, but the point stands.</ref> are different, the configuration and effort required to get a server to launch for the first time is case-by-case.
 == Step 0: Checking if we have the egg ==
-Before we scour the internet for an egg let's first check we don't already have it and save ourselves the trouble.
+Before we scour the internet for an egg let's first check that we don't already have it.
 # Log into the panel at https://edcgaming.org.
@@ Line 19: / Line 19: @@
 You will then be greeted with the following list (or similar looking list).
 [[File:Pterodactyl list of nests.png|none|thumb|820x820px|''List of Pterodactyl egg nests.'']]
-The term ''nest'' is fairly self-explanatory. Click into the nests and see if an egg for the software you want to spin up is present.
+'''<u>This is not a list of all available eggs</u>'''. '''This is a list of ''nests''''' {{Em dash}} '''a ''grouping'' of eggs.''' To check if an egg exists, look into all of the nests (e.g click <code>Non-Default Games</code> in most cases, or <code>Source Engine</code>, and so on)
 Review the table below for what you should do now.
@@ Line 32: / Line 32: @@
 == Step 1: Finding and installing an egg ==
-{{Ambox|type=content|image=|text='''Please be cautious of uploading duplicate eggs'''. Pterodactyl allows the same egg to be uploading repeatedly, and it's also possible to find 2 different eggs made by different people for the same application.
+{{Ambox|type=content|image=|text='''Please be cautious of uploading duplicate eggs'''. Pterodactyl does not in any way stop this. To maintain consistency of server setup, and general organization, multiple eggs for the same application is not desirable.
 }}
@@ Line 40: / Line 40: @@
 * https://pelican-eggs.github.io/pterodactyl/ (Option 1)
-Regardless as to where an egg is found, it will always be a JSON file. This JSON file will be uploaded directly to Pterodactyl. For example, on the ''Option 1'' list, when we select ''Mordhau's'' entry, we are sent to the raw text of the egg. Right click and select <code>Save as</code> on your browser, or copy the contents into a new text file and change the extension to <code>.json</code>.
+Regardless as to where an egg is found, it will always be a JSON file. For example, on the ''Option 1'' list, when we select ''Mordhau's'' entry, we are sent to the raw text of the egg. Right click and select <code>Save as</code> on your browser, or copy the contents into a new text file and change the extension to <code>.json</code>.
 === b. Installing the egg ===
-Now, we going to take the egg and upload it to our Pterodactyl instance. Once done, EDC has this egg forever, and it will be possible boot up and terminate it's associated application at will.
+Now, we are going to take the egg and upload it to our Pterodactyl instance. Once done, EDC has this egg forever, and it will be possible boot up and terminate it's associated application at will.
 #Log into the panel at https://edcgaming.org.
 # Click the cog icon to the left of the colored smiley face to access the administrative section of Pterodactyl.[[File:Pterodactyl admin panel icon.png|none|thumb|''The Pterodactyl panel button to get to the administrative section.'']]