...
| Field Name | Description |
|---|---|
| Server Label | Enter a label for this Pterodactyl server, it can be anything you like. |
| Hostname | Enter the FQDN hostname for your Pterodactyl server, ie "server1.domain.com". |
| Account API Key | Enter your Pterodactyl API Key from your Pterodactyl Panel. (Under " API Credentials") Your username > API Credentials Click screenshot for full version:
|
| Application API Key | Enter your Pterodactyl API Key from your Pterodactyl Panel. (Under "Admin Control Panel" > "Application API"). Select "Read & Write" for all permissions. Click screenshot for full version: |
| Use SSL when connecting to the API (recommended) | Whether to use SSL when connecting to the Pterodactyl Panel's API. Recommended. |
...
The above screenshot references the variables that are available to use for config options for the Source Engine Nest, and Team Fortress 2 Egg. This example would allow config options with the names: SRCDS_GAME, SERVER_PORT, and SRCDS_MAP to be used. The variables available will vary depending the Nest and Egg selected, so it's important to check in Pterodactyl Panel firstEgg. This example would allow config options with the names: SRCDS_GAME, SERVER_PORT, and SRCDS_MAP to be used. The variables available will vary depending the Nest and Egg selected, so it's important to check in Pterodactyl Panel first.
Configurable Options that Override Package Options
As of version 1.7.1 of the module, or Blesta 5.1.0, the following options are available to override their Package option counterparts.
| Option Name | Possible Values | Recommended Field Type | Description |
|---|---|---|---|
| location_id | integer >= 0 | Dropdown | Sets the location where the server will be deployed. |
| egg_id | integer >= 0 | Dropdown | Sets the ID of the egg the server will use. |
| memory | integer >= 1 | Quantity, Dropdown | Sets the amount of memory to be assigned to the server in MB. |
| cpu | integer >= 1 | Quantity, Dropdown | Sets the amount of CPU to be assigned to the server in %. 100% is equivalent to one core. |
| disk | integer >= 1 | Quantity, Dropdown | Sets the amount of disk space to be assigned to the server in MB. |
| io | integer >= 10 | Quantity, Dropdown | Sets the IO weight of the server. Within a range from 10 to 1000. |
| startup | string | Text | Sets the custom startup command to assign to the server. |
| image | string | Text, Dropdown | Sets the Docker image to be deployed to the server. |
| databases | integer >= 1 | Quantity, Dropdown | Sets the total amount of databases the user can create for the server. |
| allocations | integer >= 1 | Quantity, Dropdown | Sets the total amount of allocations the user can create for the server |
| backups | integer >= 1 | Quantity, Dropdown | Sets the total amount of backups the user is allowed to create for the server. |
| nest_id | integer >= 0 | Dropdown | Sets the ID of the nest the server will use. |
| port_range | string | Text | Sets the port range that will be allocated to the server separated by comma. e.g. 25565-25570,25580-25590 |
| pack_id | integer >= 0 | Dropdown | Sets the ID of the pack that will be installed in the server. |
| swap | integer >= 0 | Quantity, Dropdown | Sets the amount of SWAP memory to be assigned to the server in MB. |
Creating Packages
Packages define the pricing, welcome email, module and more. Packages can be assigned to Package Groups, and added to Order Forms. To create a Package, visit [Packages] > Browse, and click the "Create Package" button.
...
| Field Name | Description |
|---|---|
| Server Group | Select "Any" if you wish to specify a specific server, or select the Server Group to provision from. Selecting a group means that accounts will be provisioned from the group. Selecting a group is recommended. |
| Location | Select the Location as configured in Pterodactyl. |
| Nest | Select the Nest as configured in Pterodactyl. |
| Egg ID | Select the Egg ID as configured in Pterodactyl. (In Pterodactyl click Nests, then the Game to see a list of Egg's and their ID's.) |
| Dedicated IP (optional) | Check the box to use a dedicated IP address. |
| Pack ID (optional) | |
| Memory (MB) | Enter the amount of memory in MB for this server. e.g. 1024 |
| Swap | Enter the amount of swap in MB for this server. e.g. 512 |
| CPU Limit (%) | Enter the CPU limit for this server. |
| Disk Space (MB) | Enter the amount of disk space in MB for this server. e.g. 2048 |
Block IO Weign | Enter the block IO weight for this server, with a value of 10-1000. e.g. 100 |
| Startup (optional) | Enter an optional startup command. |
| Image (optional) | Enter an optional custom docker image. |
| Database Limit (optional) | Enter an optional limit to the total number of databases a user can create. |
| Allocation Limit (optional) | Enter an optional allocation limit for a user. |
| Server Jar File (EGG DEPENDENT) | The name of the server jarfile to run the server with. Check to allow clients to modify this value during service add/edit. Leave unchecked if you plan to use a configurable option for this field. Defaults to "server.jar". The variable is dependent on the egg. For Vanilla Minecraft it is SERVER_JARFILE |
| Server Version (EGG DEPENDENT) | The version of Minecraft Vanilla to install. Use "latest" to install the latest version. Check to allow clients to modify this value during service add/edit. Leave unchecked if you plan to use a configurable option for this field. Defaults to "latest". |
...
| Tags | Description | Notes |
|---|---|---|
| {module.host_name} | The host name of the server that the service was provisioned on | e.g. "pterodactyl-panel.domain.com" |
| {module.server_name} | The name of this game server | e.g. "Hostmaster's Minecraft Server" |
| {package.location_id} | The ID of the location in Pterodactyl Panel. | e.g. "1" |
| {package.nest_id} | The ID of the Nest as configured in Pterodactyl Panel. | e.g. "2" |
| {package.egg_id} | The ID of the Egg as configured in Pterodactyl Panelof the Egg as configured in Pterodactyl Panel. | e.g. "5" |
| {package.image} | The Docker image of the game server. | e.g. "5quay.io/pterodactyl/core:java-glibc" |
| {package.image}{service.server_name} | The name of the server as defined in the module within Blesta. | e.g. "Pterodactyl 1" |
| {service.server_ip} | The IP address of the game server. | e.g. "192.168.0.23" |
| {service.server_port} | The port this game server is running on at the above IP. | e.g. "25535" |
| {service.server_username} | The username for the Pterodactyl panel. | Added in version 4.11 of Blesta, version 1.4.1 of Pterodactyl |
| {service.server_password} | The password for the Pterodactyl panel. | Added in version 4.11 of Blesta, version 1.4.1 of Pterodactyl |
...
The only thing left to do is to add this Package Group to an order form so clients may place orders for your Pterodactyl servers. See Creating an Order Form for more details.
Common Problems
- There is a conflict in the custom egg for the game OpenRA because of it's use of the variable SERVER_NAME.
- This must be renamed in the egg in order to work with Blesta.
- When creating a Package, the locations dropdown is empty.
- Make sure you have created a location in your Pterodactyl panel at /admin/locations and that you have set a Description. If no description is set, the location will not appear.