pterodactyl-panel: init at 1.15.1, pterodactyl-wings: init at 1.13.3, nixos/pterodactyl-{panel, wings}: init by PadowYT2 · Pull Request #456521 · NixOS/nixpkgs

PadowYT2 · 2025-10-28T18:25:34Z

Added Pterodactyl Panel and Pterodactyl Wings modules with their packages.

Homepage: https://pterodactyl.io

Things done

Add a 👍 reaction to pull requests you find important.

PadowYT2 · 2025-10-28T18:45:46Z

`nixpkgs-review` result

Generated using nixpkgs-review.

Command: nixpkgs-review pr 456521
Commit: baf1adb8d96992cf24fa4ffc0e4daf032f1361a3

`x86_64-linux`

⏩ 2 packages blacklisted:

nixos-install-tools
tests.nixos-functions.nixos-test

✅ 2 packages built:

pterodactyl-panel
pterodactyl-wings

qweered · 2025-10-28T20:19:34Z

Pr title should be "nixos/pterodactyl-{panel, wings}: init"

acid-bong · 2025-10-29T08:09:13Z

Since you're introducing both packages and modules, separate each into its own commit, with package init ones preceding the respective module init ones

keenanweaver

Amazing work! Thanks for making this. I'm not a Pterodactyl user, but these modules will make me one.

Some observations/questions:

Can you change the wings module to enable virtualisation.docker conditionally with it? Shouldn't be any harm in doing this instead of an assertion.
I know it's annoying, but each config option in both modules should have a description explaining what they're for.
Are you able to nix-ify a full Pterodactyl setup with these modules? Can I programmatically configure eggs, etc. (I am ignorant of the software)
May want to consider looking into service hardening

Also have some non-blocking nits:

PadowYT2 · 2025-10-29T14:05:19Z

Amazing work! Thanks for making this. I'm not a Pterodactyl user, but these modules will make me one.

🔥

I know it's annoying, but each config option in both modules should have a description explaining what they're for.

Some of them aren't documented officially, will come up with something I guess.

Are you able to nix-ify a full Pterodactyl setup with these modules? Can I programmatically configure eggs, etc. (I am ignorant of the software)

I wish you could. There are no commands within Pterodactyl (php artisan ...) which allows you to create servers/users/etc. If appropriate for nixpkgs, I could add these commands via patches (or other ways) while of course making a PR upstream.

Will check out and apply changes you have suggested. As a first time contribution, honestly thanks for checking out the changes

keenanweaver · 2025-10-29T14:21:55Z

If appropriate for nixpkgs, I could add these commands via patches (or other ways) while of course making a PR upstream.

It's generally preferred to do everything possible upstream before doing patches and a lot of nix-specific fixes here. It all depends on how receptive upstream is to changes, especially if those changes are for Nix specifically.

As a first time contribution, honestly thanks for checking out the changes

You're welcome! I haven't tested them out on my own stuff yet, but I'm planning to deep dive with them and learn Pterodactyl at the same time.

PadowYT2 · 2025-10-29T14:36:29Z

It's generally preferred to do everything possible upstream before doing patches and a lot of nix-specific fixes here. It all depends on how receptive upstream is to changes, especially if those changes are for Nix specifically.

They wouldn't be nix-specific but will benefit the nix configuration more (and maybe some other setups, like install scripts)

PadowYT2 · 2025-10-29T18:45:16Z

Are you able to nix-ify a full Pterodactyl setup with these modules? Can I programmatically configure eggs, etc. (I am ignorant of the software)

I will not do it for this PR, maybe some time in the future as it will take some time

May want to consider looking into service hardening

The module is already way too complex for me and I have no clue what should I add. If you want to suggest something, please do

keenanweaver

The module is already way too complex for me and I have no clue what should I add. If you want to suggest something, please do

Nothing in particular. Thanks for considering!

Some more changes to consider:

PadowYT2 · 2025-10-30T13:21:24Z

+    phpPackage = lib.mkOption {
+      type = lib.types.package;
+      readOnly = true;
+      default = php;
+      description = "The PHP package to use";
+    };


Should this option also be using lib.mkPackageOption?

I believe so. I just looked through the tree and found a couple of examples that do it for additional packages.

nixpkgs/nixos/modules/services/misc/ananicy.nix

Line 29 in 08dacfc

rulesProvider = lib.mkPackageOption pkgs "ananicy" { example = "ananicy-cpp"; } // {

nixpkgs/nixos/modules/services/networking/ncps.nix

Line 68 in 08dacfc

dbmatePackage = lib.mkPackageOption pkgs "dbmate" { };

Just tried, you can't use just lib.mkPackageOption "php" { } as the second option is supposed to be an object. So I guess just leave it like that?

Probably want to leave it as it is now and we'll see if someone else chimes in.

PadowYT2 · 2026-05-26T22:03:00Z

`nixpkgs-review` result

Generated using nixpkgs-review.

Command: nixpkgs-review pr 456521
Commit: d9cf5b158469c5f7967ac021abcdb518cc824afc

`x86_64-linux`

⏩ 2 packages blacklisted:

nixos-install-tools
tests.nixos-functions.nixos-test

✅ 2 packages built:

pterodactyl-panel
pterodactyl-wings

I'm not sure why CI fails saying strictDeps = false even though it is set to true. Same question goes to docs...

PadowYT2 · 2026-06-12T13:32:12Z

`nixpkgs-review` result

Generated using nixpkgs-review.

Command: nixpkgs-review pr 456521
Commit: bac727284ec39189e9c773412a2cac8fe1187f62

`x86_64-linux`

⏩ 2 packages blacklisted:

nixos-install-tools
tests.nixos-functions.nixos-test

✅ 2 packages built:

pterodactyl-panel
pterodactyl-wings

GetPsyched

Approving redirects

PadowYT2 · 2026-06-25T17:10:25Z

`nixpkgs-review` result

Generated using nixpkgs-review.

Command: nixpkgs-review pr 456521
Commit: dd8bf49a9402a0c2f5a48bd5f84dd59e64c1a40b

`x86_64-linux`

⏩ 2 packages blacklisted:

nixos-install-tools
tests.nixos-functions.nixos-test

✅ 2 packages built:

pterodactyl-panel
pterodactyl-wings

Svenum · 2026-07-02T18:38:35Z

I am waiting for this. Is there a reason why this isn't merged yet? Am I able to help?

PadowYT2 · 2026-07-02T18:50:57Z

Am I able to help?

👀
Perhaps testing it and approving if everything works correctly...? There's a standalone version as a flake (which is a clone of the add-pterodactyl branch) - PadowYT2/pterodactyl.nix

PadowYT2 · 2026-07-02T18:59:48Z

`nixpkgs-review` result

Generated using nixpkgs-review.

Command: nixpkgs-review pr 456521
Commit: a89d461d0f86802fdf33d2df7fe924627a503160

`x86_64-linux`

⏩ 2 packages blacklisted:

nixos-install-tools
tests.nixos-functions.nixos-test

✅ 2 packages built:

pterodactyl-panel
pterodactyl-wings

PadowYT2 · 2026-08-07T11:19:48Z

`nixpkgs-review` result

Generated using nixpkgs-review.

Command: nixpkgs-review pr 456521
Commit: 15b5e27d31106e3bafd782b45b624269e4561850

`x86_64-linux`

⏩ 2 packages blacklisted:

nixos-install-tools
tests.nixos-functions.nixos-test

✅ 3 packages built:

pterodactyl-panel
pterodactyl-wings
tests.config-nix-unit

PadowYT2 · 2026-08-14T22:21:16Z

`nixpkgs-review` result

Generated using nixpkgs-review.

Command: nixpkgs-review pr 456521
Commit: bdebe06ccb1d711fc3bc9a04ab71b9a8f067a7ad

`x86_64-linux`

⏩ 2 packages blacklisted:

nixos-install-tools
tests.nixos-functions.nixos-test

✅ 2 packages built:

pterodactyl-panel
pterodactyl-wings

06kellyjac

Hey, great to see this. I look forward to trying it

Currently CI is failing due to the manual adjustments:

 error: Cannot build '/nix/store/fb9n5wprzfs6wi250s08v242rc5wyglp-nixos-manual-html.drv'.
       Reason: builder failed with exit code 1.
       Output paths:
         /nix/store/y1scwmg6bi4hrqnn6p5n7jwfwpp4nrgd-nixos-manual-html
       Last 25 log lines:
       >     - module-services-pterodactyl-basic-usage
       >
       > This can happen when an identifier was added, renamed, or removed.
       >
       >     Added new content?
       >         $ redirects add-content <identifier> <path>
       >     often:
       >         $ redirects add-content <identifier> index.html
       >
       >     Moved existing content to a different output path?
       >         $ redirects move-content <identifier> <path>
       >
       >     Renamed existing identifiers?
       >         $ redirects rename-identifier <old-identifier> <new-identifier>
       >
       >     Removed content? Redirect to alternatives or relevant release notes.
       >         $ redirects remove-and-redirect <identifier> <target-identifier>
       >
       >     NOTE: Run the right nix-shell to make this command available.
       >         Nixpkgs:
       >         $ nix-shell doc
       >         NixOS:
       >         $ nix-shell nixos/doc/manual
       >
       > NOTE: If your build passes locally and you see this message in CI, you probably need a rebase.

And some other changes raised

06kellyjac · 2026-08-18T16:09:41Z

+    services.mysql = lib.optionalAttrs cfg.database.createLocally {
+      enable = true;
+      package = pkgs.mariadb;
+      ensureDatabases = [ cfg.database.name ];
+      ensureUsers = [
+        {
+          name = cfg.database.user;
+          ensurePermissions."${cfg.database.name}.*" = "ALL PRIVILEGES";
+        }
+      ];
+    };


Considering we default to mariadb shouldn't our DB_CONNECTION = "mysql"; at the top actually be DB_CONNECTION = "mariadb"; (or better we derive it from the mysql package)

https://github.com/pterodactyl/panel/blob/113ea43d0d48f48d567c9d91e4a7d5b5bb8876e3/config/database.php#L63-L86

The default provider is mysql and it works fine with a MariaDB server, but sure for pushing to just change the provider. Will do some testing before changing

The mariadb provider has not been tested by the Pterodactyl team and doesn't work due to having strict GROUP BY rules, resulting in errors

ok, weird they have a whole separate provider block that doesn't work with the db it's intended for lol.
Can we make sure there's a comment explaining this

06kellyjac · 2026-08-18T16:39:09Z

+  setupScript = pkgs.writeShellApplication {
+    name = "pterodactyl-wings-setup";
+    runtimeInputs = with pkgs; [
+      coreutils
+      replace-secret
+    ];
+    text = ''
+      install -Dm640 -o ${cfg.user} -g ${cfg.group} ${
+        (pkgs.formats.yaml { }).generate "config.yml" (lib.recursiveUpdate mainConfig cfg.extraConfig)
+      } ${cfg.rootDir}/config.yml
+
+      ${lib.optionalString (cfg.tokenIdFile != null) ''
+        replace-secret '@TOKEN_ID@' ${lib.escapeShellArg cfg.tokenIdFile} ${cfg.rootDir}/config.yml
+      ''}
+
+      ${lib.optionalString (cfg.tokenFile != null) ''
+        replace-secret '@TOKEN@' ${lib.escapeShellArg cfg.tokenFile} ${cfg.rootDir}/config.yml
+      ''}
+    '';
+  };


I dont think the secret replace is necessary

https://github.com/pterodactyl/wings/blob/d6116827313dae176ddf4741e233554392993398/config/config_token_test.go#L45-L46

_test.go files are test files, which are just unit tests. The actual logic for these specific secrets are here:
https://github.com/pterodactyl/wings/blob/d6116827313dae176ddf4741e233554392993398/config/config.go#L444-L449

The test files are testing specific functionality. The tests were just the clearest usage/example I could link you

Here's a link for the ResolveToken method on the Configuration struct inside the working code. The godoc comment helps explain what it does.
https://github.com/pterodactyl/wings/blob/d6116827313dae176ddf4741e233554392993398/config/config.go#L414-L422

As long as you set the env var to file:///the/path/to/secret or nix level "file://${theNixVar}"; it'll read it, we don't need to template raw values into the config.

We should also use systemd's LoadCredential feature to ensure the service has access to the secret files.

We can define a services.pterodactyl.wings.secrets.tokenIDFile and services.pterodactyl.wings.secrets.tokenFile etc and when those are set we can auto define services.pterodactyl.wings.settings.token_id = "file://${cfg.secrets.tokenIDFile}"; etc.

@PadowYT2 LMK when this adjustment is made or if you need help 🙂

@PadowYT2 LMK when this adjustment is made or if you need help 🙂

This is done with the freeform options, which I kinda need help with (see your other comment about it)

06kellyjac · 2026-08-18T16:49:14Z

Oh and since it's been added since you started the PR if you could please review the https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md#automationai-policy and note if you're following the process in the PR body

PadowYT2 · 2026-08-18T17:12:23Z

Hey, great to see this. I look forward to trying it

Thanks for a thorough review of the PR. I will try to solve/explain most of the things you commented on (been kinda a while since massive nix changes for me).

Currently CI is failing due to the manual adjustments:
NOTE: If your build passes locally and you see this message in CI, you probably need a rebase.

I'm unsure what to do, as everything has been done properly, with builds (nixpkgs-review) passing and GetPsyched has left his comment saying the redirects are fine. So I guess the note attached is what should be followed?

06kellyjac · 2026-08-19T08:25:21Z

Running nix-build ci -A manual-nixos fails on your branch

You're missing some redirect identifiers for some of your anchors or it used to be module-services-pterodactyl-basic-usage and now it's module-services-pterodactyl-panel-basic-usage etc

PadowYT2 changed the title ~~init: pterodactyl~~ pterodactyl: init Oct 28, 2025

PadowYT2 changed the title ~~pterodactyl: init~~ nixos/pterodactyl-{panel, wings}: init Oct 28, 2025

This comment was marked as outdated.

Sign in to view

h7x4 added the 8.has: module (new) This PR adds a module in `nixos/` label Oct 29, 2025

h7x4 reviewed Oct 29, 2025

View reviewed changes

Comment thread nixos/modules/services/misc/pterodactyl-wings.nix

nixpkgs-ci Bot removed the 9.needs: reviewer This PR currently has no reviewers requested and needs attention. label Oct 29, 2025

PadowYT2 force-pushed the add-pterodactyl branch from baf1adb to edc4460 Compare October 29, 2025 10:22

keenanweaver reviewed Oct 29, 2025

View reviewed changes

PadowYT2 force-pushed the add-pterodactyl branch from edc4460 to a488dda Compare October 29, 2025 18:42

keenanweaver reviewed Oct 29, 2025

View reviewed changes

PadowYT2 force-pushed the add-pterodactyl branch from a488dda to c057681 Compare October 30, 2025 13:20

PadowYT2 commented Oct 30, 2025

View reviewed changes

PadowYT2 force-pushed the add-pterodactyl branch 3 times, most recently from 4f8cf94 to 286d3cb Compare October 30, 2025 13:34

nixpkgs-ci Bot requested a review from GetPsyched May 26, 2026 22:01

nixpkgs-ci Bot added the 2.status: merge conflict This PR has merge conflicts with the target branch label Jun 5, 2026

axis-esto approved these changes Jun 8, 2026

View reviewed changes

nixpkgs-ci Bot added 12.approvals: 3+ This PR was reviewed and approved by three or more persons. and removed 12.approvals: 2 This PR was reviewed and approved by two persons. labels Jun 8, 2026

PadowYT2 force-pushed the add-pterodactyl branch from d9cf5b1 to 41e1971 Compare June 12, 2026 13:02

nixpkgs-ci Bot removed the 2.status: merge conflict This PR has merge conflicts with the target branch label Jun 12, 2026

PadowYT2 force-pushed the add-pterodactyl branch from 41e1971 to 9c584cf Compare June 12, 2026 13:15

PadowYT2 changed the title ~~pterodactyl-panel: init at 1.12.3, pterodactyl-wings: init at 1.12.2, nixos/pterodactyl-{panel, wings}: init~~ pterodactyl-panel: init at 1.12.4, pterodactyl-wings: init at 1.12.3, nixos/pterodactyl-{panel, wings}: init Jun 12, 2026

PadowYT2 force-pushed the add-pterodactyl branch from 9c584cf to bac7272 Compare June 12, 2026 13:21

GetPsyched approved these changes Jun 13, 2026

View reviewed changes

PadowYT2 force-pushed the add-pterodactyl branch from bac7272 to 64fa293 Compare June 25, 2026 16:58

PadowYT2 changed the title ~~pterodactyl-panel: init at 1.12.4, pterodactyl-wings: init at 1.12.3, nixos/pterodactyl-{panel, wings}: init~~ pterodactyl-panel: init at 1.14.0, pterodactyl-wings: init at 1.13.0, nixos/pterodactyl-{panel, wings}: init Jun 25, 2026

06kellyjac requested changes Aug 18, 2026

View reviewed changes

PadowYT2 added 2 commits August 18, 2026 23:59

maintainers: add padowyt2

911efbc

pterodactyl-panel: init at 1.15.1

db9804c

PadowYT2 added 3 commits August 19, 2026 18:36

nixos/pterodactyl-panel: init

a3ed0d3

pterodactyl-wings: init at 1.13.3

a385d25

nixos/pterodactyl-wings: init

e6c66a4

Uh oh!

Uh oh!

Conversation

PadowYT2 commented Oct 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Things done

Uh oh!

PadowYT2 commented Oct 28, 2025

nixpkgs-review result

x86_64-linux

Uh oh!

qweered commented Oct 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

acid-bong commented Oct 29, 2025

Uh oh!

keenanweaver left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

PadowYT2 commented Oct 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

keenanweaver commented Oct 29, 2025

Uh oh!

PadowYT2 commented Oct 29, 2025

Uh oh!

PadowYT2 commented Oct 29, 2025

Uh oh!

keenanweaver left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PadowYT2 commented May 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

nixpkgs-review result

x86_64-linux

Uh oh!

PadowYT2 commented Jun 12, 2026

nixpkgs-review result

x86_64-linux

Uh oh!

GetPsyched left a comment

Choose a reason for hiding this comment

Uh oh!

PadowYT2 commented Jun 25, 2026

nixpkgs-review result

x86_64-linux

Uh oh!

Svenum commented Jul 2, 2026

Uh oh!

PadowYT2 commented Jul 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

PadowYT2 commented Jul 2, 2026

nixpkgs-review result

x86_64-linux

Uh oh!

PadowYT2 commented Aug 7, 2026

PadowYT2 commented Oct 28, 2025 •

edited

Loading

`nixpkgs-review` result

`x86_64-linux`

qweered commented Oct 28, 2025 •

edited

Loading

PadowYT2 commented Oct 29, 2025 •

edited

Loading

PadowYT2 commented May 26, 2026 •

edited

Loading

`nixpkgs-review` result

`x86_64-linux`

`nixpkgs-review` result

`x86_64-linux`

`nixpkgs-review` result

`x86_64-linux`

PadowYT2 commented Jul 2, 2026 •

edited

Loading

`nixpkgs-review` result

`x86_64-linux`

`nixpkgs-review` result

`x86_64-linux`

`nixpkgs-review` result

`x86_64-linux`

PadowYT2 Aug 19, 2026 •

edited

Loading

06kellyjac Aug 19, 2026 •

edited

Loading