kalmenn/pterodactyl-nix
1
0
Fork 0
Code Issues Pull requests Activity

Compare commits

base: kalmenn:test
Branches Tags
kalmenn:main
kalmenn:test
..
compare: kalmenn:main
Branches Tags
kalmenn:test
kalmenn:main

No commits in common. "test" and "main" have entirely different histories.
test ... main

6 changed files with 76 additions and 290 deletions
Download patch file Download diff file Expand all files Collapse all files

1
.gitignore vendored
View file

@ -1 +0,0 @@
/result

12
flake.nix
View file

@ -11,13 +11,9 @@
); );
packages = nixpkgs.lib.genAttrs [ "x86_64-linux" ] ( packages = nixpkgs.lib.genAttrs [ "x86_64-linux" ] (
system: let system: nixpkgs.lib.genAttrs [ "pterodactyl" "php" "wings" ] (
pkgs = import nixpkgs { inherit system; }; package: import ./packages/${package}.nix { pkgs = import nixpkgs { inherit system; }; };
in rec { )
php = import ./packages/php.nix { inherit pkgs; }; });
pterodactyl = import ./packages/pterodactyl.nix { inherit pkgs php; };
wings = import ./packages/wings.nix { inherit pkgs; };
}
);
}; };
} }

320
modules/pterodactyl.nix
View file

@ -2,36 +2,20 @@
{ lib, config, pkgs, ... }: { lib, config, pkgs, ... }:
let let
thisConfig = config.services.pterodactyl; cfg = config.services.pterodactyl;
flakePkgs = flake.outputs.packages.${pkgs.system};
defaultUser = "pterodactyl"; defaultUser = "pterodactyl";
in { in {
options.services.pterodactyl = { options.services.pterodactyl = {
enable = lib.mkEnableOption "Enable the pterodacytl game server panel"; enable = lib.mkEnableOption "Enable the pterodacytl game server panel";
pkg = lib.mkOption { proxy = {
type = lib.types.package; enable = lib.mkEnableOption "Automatically configure Nginx to serve the panel";
description = "The package in which to source the php files used by pterodactyl"; serverName = lib.mkOption {
default = flake.outputs.packages.${pkgs.system}.pterodactyl;
};
dataDir = lib.mkOption {
type = lib.types.str;
description = "The directory in which to store stateful data";
default = "/data/services/pterodactyl";
};
server = {
enable = lib.mkEnableOption ''
Automatically configure Nginx to serve the panel
If you need more control over the nginx proxy, for now you must leave this option disabled
and write your own nginx configuration. Feel free to copy ours as a starting point.
'';
name = lib.mkOption {
type = lib.types.str; type = lib.types.str;
description = "The canonical domain name on which the panel will be hosted"; description = "The canonical domain on which the panel will be hosted";
default = "localhost"; default = "localhost";
example = "pterodactyl.example.com"; example = "pterodactyl.example.com";
}; };
@ -43,46 +27,27 @@ in {
}; };
}; };
php = { user = lib.mkOption {
socket = lib.mkOption { type = lib.types.str;
type = lib.types.path; description = ''
description = "The location of the unix socket used by php-fpm"; The user that owns the files managed by the panel.
default = config.services.phpfpm.pools.pterodactyl.socket; If you change this, make sure their files are accessible by your www user
}; (probably "nginx").
'';
default = defaultUser;
example = defaultUser;
};
user = lib.mkOption { pkg = lib.mkOption {
type = lib.types.str; type = lib.types.package;
description = '' description = "The package in which to source the php files used by pterodactyl";
The user that the php-fpm processes will run under. See also the `group` option. default = flakePkgs.pterodactyl;
};
If you change this, make sure the unix socket is accessible by your www user dataDir = lib.mkOption {
(probably "nginx"). type = lib.types.str;
''; description = "The directory in which to store stateful data";
default = defaultUser; default = "/var/lib/pterodactyl";
};
group = lib.mkOption {
type = lib.types.str;
description = ''
The group that the php-fpm processes will run under. See also the `user` option.
If you change this, make sure the unix socket is accessible by your www user
(probably "nginx").
'';
default = defaultUser;
};
root = lib.mkOption {
type = lib.types.path;
description = "The main application directory";
default = "/srv/pterodactyl";
};
pkg = lib.mkOption {
type = lib.types.package;
description = "The php package to use";
default = flake.outputs.packages.${pkgs.system}.php;
};
}; };
redis = { redis = {
@ -90,107 +55,42 @@ in {
name = lib.mkOption { name = lib.mkOption {
type = lib.types.str; type = lib.types.str;
description = "The Redis server name. Used when configuring locally"; description = "The Redis server name.";
default = "redis-pterodactyl"; default = "redis-pterodactyl";
}; };
port = lib.mkOption { port = lib.mkOption {
type = lib.types.port; type = lib.types.port;
description = "The port Redis listens on"; description = "The port the redis server listens on";
default = 6379; default = 6379;
}; };
host = lib.mkOption {
type = lib.types.str;
description = "The address with which to reach Redis";
default = "127.0.0.1";
};
};
database = {
configureLocally = lib.mkEnableOption "Configure a local MariaDB instance";
type = lib.mkOption {
type = lib.types.str;
description = ''
The type of database pterodactyl should connect to (supports "mariadb" and "mysql")
'';
default = "mariadb";
};
host = lib.mkOption {
type = lib.types.str;
description = "The address with which to reach the database";
default = "127.0.0.1";
};
port = lib.mkOption {
type = lib.types.port;
description = "The port the database listens on";
default = 3336;
};
name = lib.mkOption {
type = lib.types.str;
description = "The name of the database that you've created in mysql / mariadb";
default = "pterodactyl";
};
username = lib.mkOption {
type = lib.types.str;
description = "The name of the user that you've created in mysql / mariadb";
default = thisConfig.php.user;
};
}; };
}; };
config = lib.mkIf thisConfig.enable { config = lib.mkIf cfg.enable {
users = { users = lib.mkIf (cfg.user == defaultUser) {
users = { users.${cfg.user} = {
${thisConfig.php.user} = lib.mkIf (thisConfig.php.user == defaultUser) { isSystemUser = true;
isSystemUser = true; createHome = true;
createHome = true; home = cfg.dataDir;
home = "/var/lib/pterodactyl"; group = cfg.user;
group = thisConfig.php.group;
};
${config.services.nginx.user} = lib.mkIf (thisConfig.php.group == defaultUser) {
extraGroups = [ thisConfig.php.group ];
};
}; };
groups = { groups.${cfg.user} = { };
${thisConfig.php.group} = lib.mkIf (thisConfig.php.group == defaultUser) {};
}; users.${config.services.nginx.user}.extraGroups = [ cfg.user ];
}; };
services.redis.servers.${thisConfig.redis.name} = lib.mkIf thisConfig.redis.configureLocally { services.redis.servers.${cfg.redis.name} = lib.mkIf cfg.redis.configureLocally {
enable = true; enable = true;
port = thisConfig.redis.port; port = cfg.redis.port;
}; };
services.mysql = lib.mkIf thisConfig.database.configureLocally { services.nginx = lib.mkIf cfg.proxy.enable {
enable = true;
package = pkgs.mariadb;
ensureDatabases = [ thisConfig.database.name ];
ensureUsers = [
{
name = thisConfig.database.name;
ensurePermissions = {
"${thisConfig.database.name}.*" = "ALL PRIVILEGES";
};
}
];
};
services.nginx = lib.mkIf thisConfig.server.enable {
enable = true; enable = true;
virtualHosts."pterodactyl" = { virtualHosts."${cfg.serverName}" = {
serverName = thisConfig.server.name; root = "${config.services.pterodactyl.pkg}/public";
root = "${thisConfig.php.root}/public";
extraConfig = '' extraConfig = ''
index index.html index.htm index.php; index index.html index.htm index.php;
@ -201,7 +101,7 @@ in {
include ${pkgs.nginx}/conf/fastcgi_params; include ${pkgs.nginx}/conf/fastcgi_params;
fastcgi_split_path_info ^(.+\.php)(/.+)$; fastcgi_split_path_info ^(.+\.php)(/.+)$;
fastcgi_pass unix:${thisConfig.php.socket}; fastcgi_pass unix:${config.services.phpfpm.pools.pterodactyl.socket};
fastcgi_index index.php; fastcgi_index index.php;
@ -227,7 +127,7 @@ in {
}; };
services.phpfpm.pools.pterodactyl = { services.phpfpm.pools.pterodactyl = {
user = thisConfig.php.user; user = cfg.user;
settings = { settings = {
"listen.owner" = config.services.nginx.user; "listen.owner" = config.services.nginx.user;
"pm" = "dynamic"; "pm" = "dynamic";
@ -243,125 +143,23 @@ in {
"php_admin_value[error_log]" = "stderr"; "php_admin_value[error_log]" = "stderr";
"php_admin_flag[daemonize]" = "false"; "php_admin_flag[daemonize]" = "false";
}; };
phpEnv = {
APP_ENV = "production";
APP_DEBUG = "false";
# APP_KEY = ""; # TODO: Figure how to make this persistent but automatically generated
APP_THEME = "pterodactyl"; # TODO: Configure
APP_TIMEZONE = "Europe/Paris"; # TODO: Configure
APP_URL = "https://${thisConfig.server.name}"; # TODO: create another config option for this
APP_LOCALE = "en"; # TODO: Configure
APP_ENVIRONMENT_ONLY = "true";
LOG_CHANNEL = "daily";
LOG_DEPRECATIONS_CHANNEL = "null";
LOG_LEVEL = "debug";
DB_CONNECTION = thisConfig.database.type;
DB_HOST = thisConfig.database.host;
DB_PORT = builtins.toString thisConfig.database.port;
DB_DATABASE = thisConfig.database.name;
DB_USERNAME = thisConfig.database.username;
# DB_PASSWORD = ""; # TODO: allow a password
REDIS_HOST = thisConfig.redis.host;
# REDIS_PASSWORD = ""; # TODO: allow a password
REDIS_PORT = builtins.toString thisConfig.redis.port;
# TODO: Configure
CACHE_DRIVER = "redis";
QUEUE_CONNECTION = "redis";
SESSION_DRIVER = "redis";
HASHIDS_SALT = "Tbl~GYn;t6s'iKCDMe7u"; # TODO: configure
HASHIDS_LENGTH = "8";
# MAIL_MAILER = "smtp";
# MAIL_HOST = "smtp.example.com";
# MAIL_PORT = "25";
# MAIL_USERNAME = "";
# MAIL_PASSWORD = "";
# MAIL_ENCRYPTION = "tls";
# MAIL_FROM_ADDRESS = "no-reply@example.com";
# MAIL_FROM_NAME="Pterodactyl Panel"
# You should set this to your domain to prevent it defaulting to 'localhost', causing
# mail servers such as Gmail to reject your mail.
#
# @see: https://github.com/pterodactyl/panel/pull/3110
# MAIL_EHLO_DOMAIN=panel.example.com
};
}; };
systemd = { systemd.services.pteroq = {
tmpfiles.settings."10-pterodactyl" = let enable = true;
user = thisConfig.php.user; description = "Pterodactyl Queue Worker";
group = thisConfig.php.group; after = [ "redis-${cfg.redis.name}.service" ];
in { unitConfig = { StartLimitInterval = 180; };
"${thisConfig.dataDir}/cache" = { "d" = { inherit group user; mode = "750"; }; }; serviceConfig = {
"${thisConfig.dataDir}/storage" = { "d" = { inherit group user; mode = "750"; }; }; User = cfg.user;
"${thisConfig.php.root}" = { "d" = { inherit group user; mode = "750"; }; }; Group = cfg.user;
}; Restart = "always";
ExecStart =
services = { "${flakePkgs.php}/bin/php ${cfg.pkg}/artisan queue:work --queue=high,standard,low --sleep=3 --tries=3";
pterodactyl-setup = { StartLimitBurst = 30;
description = "Setup the necessary files for the pterodactyl panel to work"; RestartSec = "5s";
before = [ "pteroq.service" ]
++ (if thisConfig.server.enable then [ "nginx.service" ] else []);
wantedBy = [ "multi-user.target" "pteroq.service" ]
++ (if thisConfig.server.enable then [ "nginx.service" ] else []);
serviceConfig = {
Type = "oneshot";
User = thisConfig.php.user;
Group = thisConfig.php.group;
ExecStart = pkgs.writeShellScript "pterodactyl-setup.sh" ''
SRC="${thisConfig.pkg}/share/php/pterodactyl-panel/";
DEST="${thisConfig.php.root}";
USER="${thisConfig.php.user}";
GROUP="${thisConfig.php.group}";
rm $DEST/* -r;
for file in app config database public resources routes vendor artisan; do
cp -r "$SRC/$file" "$DEST"
chmod -R 0550 "$DEST/$file"
done;
mkdir -p -m 0750 "$DEST/bootstrap"
cp "$SRC/bootstrap/app.php" "$DEST/bootstrap/app.php";
chmod 0550 "$DEST/bootstrap/app.php";
ln -s "${thisConfig.dataDir}/cache" "$DEST/bootstrap/cache";
ln -s "${thisConfig.dataDir}/storage" "$DEST/storage";
'';
};
};
pteroq = {
enable = true;
description = "Pterodactyl Queue Worker";
after = [ "redis-${thisConfig.redis.name}.service" ];
unitConfig = { StartLimitInterval = 180; };
serviceConfig = {
User = thisConfig.php.user;
Group = thisConfig.php.group;
WorkingDirectory = thisConfig.php.root;
ExecStart = "${thisConfig.php.pkg}/bin/php ${thisConfig.php.root}/artisan queue:work --queue=high,standard,low --sleep=3 --tries=3";
Restart = "always";
RestartSec = "5s";
StartLimitBurst = 30;
};
wantedBy = [ "multi-user.target" ];
};
}; };
wantedBy = [ "multi-user.target" ];
}; };
}; };
} }

10
packages/php.nix
View file

@ -1,12 +1,12 @@
{ pkgs ? import <nixpkgs> }: { pkgs }:
pkgs.php83.buildEnv { pkgs.php83.buildEnv {
extensions = { enabled, all, }: enabled ++ (with all; [ extensions = { enabled, all, }: enabled ++ (with all; [
redis redis
xdebug # xdebug
]); ]);
extraConfig = '' # extraConfig = ''
xdebug.mode=debug # xdebug.mode=debug
''; # '';
} }

21
packages/pterodactyl.nix
View file

@ -1,16 +1,9 @@
{ pkgs ? import <nixpkgs>, php ? pkgs.php }: { pkgs }:
php.buildComposerProject2 (finalAttrs: { let
pname = "pterodactyl-panel";
version = "1.11.11"; version = "1.11.11";
in pkgs.fetchzip {
src = pkgs.fetchzip { url = "https://github.com/pterodactyl/panel/releases/download/v${ version }/panel.tar.gz";
url = "https://github.com/pterodactyl/panel/releases/download/v${finalAttrs.version}/panel.tar.gz"; hash = "sha256-0nOHtReVUVXYQY/glS4x0gkbhetoXSWg4rRwOJlkcM8=";
hash = "sha256-0nOHtReVUVXYQY/glS4x0gkbhetoXSWg4rRwOJlkcM8="; stripRoot = false;
stripRoot = false; }
};
vendorHash = "sha256-WBzGGWCWNqvU4Ws7wBh8Ads7RBawBaxN1QNIUI4ivOQ=";
inherit php;
})

2
packages/wings.nix
View file

@ -1,4 +1,4 @@
{ pkgs ? import <nixpkgs> }: { pkgs }:
let let
version = "1.11.13"; version = "1.11.13";