SSO Setup

Enable seamless SSO between PteroCA and Pterodactyl, allowing users to access their server management panel without re-authentication.

Pterodactyl SSO Login (Single Sign-On) is a method that transfers a user session from the PteroCA panel directly to Pterodactyl. In practice, this means the user does not have to log in again to their Pterodactyl account after being redirected from PteroCA. This functionality is especially useful when you want to manage servers directly through the Pterodactyl panel rather than via PteroCA.

This option is disabled by default, and enabling it requires the following additional steps described below.

---

1. Navigate to the Pterodactyl root directory

cd /var/www/pterodactyl # Or set your pterodactyl directory path

---

2. Ensure the PteroCA Pterodactyl Addon is installed

composer require pteroca-com/pterodactyl-addon

---

3. Generate a secret key for session sharing between instances

php artisan pteroca:generate-secret-key

This command will generate the required secret key, insert it into the .env configuration file in the Pterodactyl root directory, and display it on the screen. Copy this key.

---

4. Save the secret key in the PteroCA panel settings

Log in to the PteroCA panel, expand the Settings menu on the left-hand side, and navigate to the Pterodactyl tab. In the Pterodactyl SSO Login Secret Key (pterodactyl_sso_secret) field, paste the copied secret key, then save the setting.

---

5. Enable SSO login in the PteroCA panel settings

Navigate to the Enable Single Sign-On Login with Pterodactyl Panel (pterodactyl_sso_enabled) setting and ensure it is set to Yes.

Likewise, set pterodactyl_use_as_client_panel to yes if you want your users to manage their purchased servers using Pterodactyl.

---

Now, when you go to the Servers tab and click Manage Server for an existing server, you will be redirected to the Pterodactyl panel and automatically logged into your Pterodactyl account.