Setup Auto Restart

This guide helps you find the credentials and values needed for setting up the Auto Restart feature correctly, along with tips for proper configuration.

Steps to Setup Nest - Admin Side

Navigate to your Nests page of your Admin section.
Go to the nest where the egg is located at and open it.
Select the Variables page.
For all following steps, press save after you are done.
Set the default value for Auto Restart - Steam API Key to the Steam API Key generated at https://steamcommunity.com/dev/apikey.
Set the default value for Auto Restart - Check Interval to the desired time frequency for server updates. A longer interval is recommended to avoid rate limiting.
Set the default value for Auto Restart - API URL to your Pterodactyl panel URL. Don't include any path at the end. Example: https://panel.your-domain.com
Configure any Auto Restart default setting according to your preferences, as these will apply to all new servers or servers where you change the egg to this.
You can also configure which settings are visible on client side.

Avoid setting a default Auto Restart - User API key value if you're hosting servers for others. This can be extracted! Each user should create their own API token.

Steps to Setup Server - Admin Side

Navigate to your Servers page of your Admin Section.
Go to the desired server you want to modify and open it.
Select the Startup page.
Set the default value for Auto Restart - Steam API Key to the Steam API Key generated at https://steamcommunity.com/dev/apikey.
Set the default value for Auto Restart - Check Interval to the desired time frequency for server updates. A longer interval is recommended to avoid rate limiting.
Set the default value for Auto Restart - API URL to your Pterodactyl panel URL. Don't include any path at the end. Example: https://panel.your-domain.com
Configure any Auto Restart default setting according to your preferences.
Press the Save Modifications button to store your settings.

Steps to Setup Server - Client Side

Access the server where you wish to activate the feature within the Dashboard.
Go to the Startup page.
Activate the AUTO RESTART - ENABLED setting.
Define a JSON structure containing commands and their corresponding timings to execute during the countdown to a restart to AUTO RESTART - COMMANDS. These commands can be used to notify players about the upcoming restart or to perform any other actions. Follow the default format, where the key represents the remaining seconds before the restart, and the value specifies the command to execute.
Set the AUTO RESTART - COUNTDOWN INTERVAL to the number of seconds to wait before restarting the server upon detecting a new version. It's recommended to set this value to a few minutes to allow players to be notified in advance.
Depending on your admin's preferences, you may have the ability to set Auto Restart - Steam API Key to the Steam API Key generated at https://steamcommunity.com/dev/apikey. If you do not see this option in your server, this has not been made available to you. Consult with your server admin for more details.
Press the Save Modifications button to store your settings.
Restart your server, and if everything is set up correctly, you should see a green message at startup indicating that it has successfully started.

Tips and Tricks

If your server uses centralized and symlinked egg modifications, set the AUTO RESTART - COUNTDOWN INTERVAL to at least 5 minutes. This allows the main server time to detect and download updates.
If you host only your own servers, you can configure the Auto Restart settings in the Nests for all servers. Ensure you apply these settings before switching to this egg.
If plugins save database changes inefficiently, consider disconnecting players briefly before a restart to trigger the plugin's save logic and ensure data is saved in time. (Rare scenarios)
Set the Auto Restart - Check Interval to a few minutes in order to avoid being rate limited by Steam.

PreviousReport Issues

Last updated 2 months ago

Was this helpful?

Steps to Setup Nest - Admin Side

Navigate to your Nests page of your Admin section.

Go to the nest where the egg is located at and open it.

Select the Variables page.

For all following steps, press save after you are done.

Set the default value for Auto Restart - Steam API Key to the Steam API Key generated at https://steamcommunity.com/dev/apikey.

Set the default value for Auto Restart - Check Interval to the desired time frequency for server updates. A longer interval is recommended to avoid rate limiting.

Set the default value for Auto Restart - API URL to your Pterodactyl panel URL. Don't include any path at the end. Example: https://panel.your-domain.com

Configure any Auto Restart default setting according to your preferences, as these will apply to all new servers or servers where you change the egg to this.

You can also configure which settings are visible on client side.

Avoid setting a default Auto Restart - User API key value if you're hosting servers for others. This can be extracted! Each user should create their own API token.

Steps to Setup Server - Admin Side

Navigate to your Servers page of your Admin Section.

Go to the desired server you want to modify and open it.

Select the Startup page.

Set the default value for Auto Restart - Steam API Key to the Steam API Key generated at https://steamcommunity.com/dev/apikey.

Set the default value for Auto Restart - Check Interval to the desired time frequency for server updates. A longer interval is recommended to avoid rate limiting.

Set the default value for Auto Restart - API URL to your Pterodactyl panel URL. Don't include any path at the end. Example: https://panel.your-domain.com

Configure any Auto Restart default setting according to your preferences.

Press the Save Modifications button to store your settings.

Steps to Setup Server - Client Side

Access the server where you wish to activate the feature within the Dashboard.

Go to the Startup page.

Activate the AUTO RESTART - ENABLED setting.

To add your API key, navigate to the AUTO RESTART - USER API KEY section. You can generate this key by clicking your profile picture in the top right corner, selecting API Credentials, or visiting . Create a new key and copy it immediately after generation, as it is only visible once. The key is typically 48 characters long.

Define a JSON structure containing commands and their corresponding timings to execute during the countdown to a restart to AUTO RESTART - COMMANDS. These commands can be used to notify players about the upcoming restart or to perform any other actions. Follow the default format, where the key represents the remaining seconds before the restart, and the value specifies the command to execute.

Set the AUTO RESTART - COUNTDOWN INTERVAL to the number of seconds to wait before restarting the server upon detecting a new version. It's recommended to set this value to a few minutes to allow players to be notified in advance.

Depending on your admin's preferences, you may have the ability to set Auto Restart - Steam API Key to the Steam API Key generated at https://steamcommunity.com/dev/apikey. If you do not see this option in your server, this has not been made available to you. Consult with your server admin for more details.

Press the Save Modifications button to store your settings.

Restart your server, and if everything is set up correctly, you should see a green message at startup indicating that it has successfully started.

Tips and Tricks

If your server uses centralized and symlinked egg modifications, set the AUTO RESTART - COUNTDOWN INTERVAL to at least 5 minutes. This allows the main server time to detect and download updates.

If you host only your own servers, you can configure the Auto Restart settings in the Nests for all servers. Ensure you apply these settings before switching to this egg.

If plugins save database changes inefficiently, consider disconnecting players briefly before a restart to trigger the plugin's save logic and ensure data is saved in time. (Rare scenarios)

Set the Auto Restart - Check Interval to a few minutes in order to avoid being rate limited by Steam.