diff --git a/.dev/vagrant/.env.vagrant b/.dev/vagrant/.env.vagrant new file mode 100644 index 000000000..2427ec04e --- /dev/null +++ b/.dev/vagrant/.env.vagrant @@ -0,0 +1,39 @@ +APP_ENV=develop +APP_DEBUG=true +APP_KEY=SomeRandomString3232RandomString +APP_THEME=pterodactyl +APP_TIMEZONE=UTC +APP_CLEAR_TASKLOG=720 +APP_DELETE_MINUTES=10 +APP_URL=http://192.168.50.2/ + +DB_HOST=localhost +DB_PORT=3306 +DB_DATABASE=panel +DB_USERNAME=pterodactyl +DB_PASSWORD=pterodactyl + +CACHE_DRIVER=memcached +MEMCACHED_HOST=127.0.0.1 +SESSION_DRIVER=database + +MAIL_DRIVER=smtp +MAIL_HOST=127.0.0.1 +MAIL_PORT=1025 +MAIL_USERNAME= +MAIL_PASSWORD= +MAIL_ENCRYPTION= +MAIL_FROM=support@pterodactyl.io + +API_PREFIX=api +API_VERSION=v1 +API_DEBUG=true + +QUEUE_DRIVER=database +QUEUE_HIGH=high +QUEUE_STANDARD=standard +QUEUE_LOW=low + +SQS_KEY=aws-public +SQS_SECRET=aws-secret +SQS_QUEUE_PREFIX=aws-queue-prefix diff --git a/.dev/vagrant/mailhog.service b/.dev/vagrant/mailhog.service new file mode 100644 index 000000000..01334183d --- /dev/null +++ b/.dev/vagrant/mailhog.service @@ -0,0 +1,13 @@ +[Unit] +Description=Mailhog + +[Service] +# On some systems the user and group might be different. +# Some systems use `apache` as the user and group. +User=www-data +Group=www-data +Restart=on-failure +ExecStart=/usr/bin/mailhog + +[Install] +WantedBy=multi-user.target diff --git a/.dev/vagrant/mariadb.cnf b/.dev/vagrant/mariadb.cnf new file mode 100644 index 000000000..48b31ed8b --- /dev/null +++ b/.dev/vagrant/mariadb.cnf @@ -0,0 +1,189 @@ +# MariaDB database server configuration file. +# +# You can copy this file to one of: +# - "/etc/mysql/my.cnf" to set global options, +# - "~/.my.cnf" to set user-specific options. +# +# One can use all long options that the program supports. +# Run program with --help to get a list of available options and with +# --print-defaults to see which it would actually understand and use. +# +# For explanations see +# http://dev.mysql.com/doc/mysql/en/server-system-variables.html + +# This will be passed to all mysql clients +# It has been reported that passwords should be enclosed with ticks/quotes +# escpecially if they contain "#" chars... +# Remember to edit /etc/mysql/debian.cnf when changing the socket location. +[client] +port = 3306 +socket = /var/run/mysqld/mysqld.sock + +# Here is entries for some specific programs +# The following values assume you have at least 32M ram + +# This was formally known as [safe_mysqld]. Both versions are currently parsed. +[mysqld_safe] +socket = /var/run/mysqld/mysqld.sock +nice = 0 + +[mysqld] +# +# * Basic Settings +# +user = mysql +pid-file = /var/run/mysqld/mysqld.pid +socket = /var/run/mysqld/mysqld.sock +port = 3306 +basedir = /usr +datadir = /var/lib/mysql +tmpdir = /tmp +lc_messages_dir = /usr/share/mysql +lc_messages = en_US +skip-external-locking +# +# Instead of skip-networking the default is now to listen only on +# localhost which is more compatible and is not less secure. +bind-address = 0.0.0.0 +# +# * Fine Tuning +# +max_connections = 100 +connect_timeout = 5 +wait_timeout = 600 +max_allowed_packet = 16M +thread_cache_size = 128 +sort_buffer_size = 4M +bulk_insert_buffer_size = 16M +tmp_table_size = 32M +max_heap_table_size = 32M +# +# * MyISAM +# +# This replaces the startup script and checks MyISAM tables if needed +# the first time they are touched. On error, make copy and try a repair. +myisam_recover_options = BACKUP +key_buffer_size = 128M +#open-files-limit = 2000 +table_open_cache = 400 +myisam_sort_buffer_size = 512M +concurrent_insert = 2 +read_buffer_size = 2M +read_rnd_buffer_size = 1M +# +# * Query Cache Configuration +# +# Cache only tiny result sets, so we can fit more in the query cache. +query_cache_limit = 128K +query_cache_size = 64M +# for more write intensive setups, set to DEMAND or OFF +#query_cache_type = DEMAND +# +# * Logging and Replication +# +# Both location gets rotated by the cronjob. +# Be aware that this log type is a performance killer. +# As of 5.1 you can enable the log at runtime! +#general_log_file = /var/log/mysql/mysql.log +#general_log = 1 +# +# Error logging goes to syslog due to /etc/mysql/conf.d/mysqld_safe_syslog.cnf. +# +# we do want to know about network errors and such +log_warnings = 2 +# +# Enable the slow query log to see queries with especially long duration +#slow_query_log[={0|1}] +slow_query_log_file = /var/log/mysql/mariadb-slow.log +long_query_time = 10 +#log_slow_rate_limit = 1000 +log_slow_verbosity = query_plan + +#log-queries-not-using-indexes +#log_slow_admin_statements +# +# The following can be used as easy to replay backup logs or for replication. +# note: if you are setting up a replication slave, see README.Debian about +# other settings you may need to change. +#server-id = 1 +#report_host = master1 +#auto_increment_increment = 2 +#auto_increment_offset = 1 +log_bin = /var/log/mysql/mariadb-bin +log_bin_index = /var/log/mysql/mariadb-bin.index +# not fab for performance, but safer +#sync_binlog = 1 +expire_logs_days = 10 +max_binlog_size = 100M +# slaves +#relay_log = /var/log/mysql/relay-bin +#relay_log_index = /var/log/mysql/relay-bin.index +#relay_log_info_file = /var/log/mysql/relay-bin.info +#log_slave_updates +#read_only +# +# If applications support it, this stricter sql_mode prevents some +# mistakes like inserting invalid dates etc. +#sql_mode = NO_ENGINE_SUBSTITUTION,TRADITIONAL +# +# * InnoDB +# +# InnoDB is enabled by default with a 10MB datafile in /var/lib/mysql/. +# Read the manual for more InnoDB related options. There are many! +default_storage_engine = InnoDB +# you can't just change log file size, requires special procedure +#innodb_log_file_size = 50M +innodb_buffer_pool_size = 256M +innodb_log_buffer_size = 8M +innodb_file_per_table = 1 +innodb_open_files = 400 +innodb_io_capacity = 400 +innodb_flush_method = O_DIRECT +# +# * Security Features +# +# Read the manual, too, if you want chroot! +# chroot = /var/lib/mysql/ +# +# For generating SSL certificates I recommend the OpenSSL GUI "tinyca". +# +# ssl-ca=/etc/mysql/cacert.pem +# ssl-cert=/etc/mysql/server-cert.pem +# ssl-key=/etc/mysql/server-key.pem + +# +# * Galera-related settings +# +[galera] +# Mandatory settings +#wsrep_on=ON +#wsrep_provider= +#wsrep_cluster_address= +#binlog_format=row +#default_storage_engine=InnoDB +#innodb_autoinc_lock_mode=2 +# +# Allow server to accept connections on all interfaces. +# +#bind-address=0.0.0.0 +# +# Optional setting +#wsrep_slave_threads=1 +#innodb_flush_log_at_trx_commit=0 + +[mysqldump] +quick +quote-names +max_allowed_packet = 16M + +[mysql] +#no-auto-rehash # faster start of mysql but no tab completion + +[isamchk] +key_buffer = 16M + +# +# * IMPORTANT: Additional settings that can override those from this file! +# The files must end with '.cnf', otherwise they'll be ignored. +# +!includedir /etc/mysql/conf.d/ diff --git a/.dev/vagrant/motd.txt b/.dev/vagrant/motd.txt new file mode 100644 index 000000000..823172e45 --- /dev/null +++ b/.dev/vagrant/motd.txt @@ -0,0 +1,17 @@ +##################################################### + Pterodactyl Panel Vagrant VM + +Install: /var/www/html/pterodactyl +Ports: + Panel: 80 (50080 on host) + MailHog: 8025 (58025 on host) + MySQL: 3306 (53306 on host) + +Default panel users: + user: admin passwd: Ptero123 (admin user) + user: user passwd: Ptero123 (standard user) + +MySQL is accessible using root/pterodactyl or pterodactyl/pterodactyl + +Services for pteroq and mailhog are running +##################################################### diff --git a/.dev/vagrant/provision.sh b/.dev/vagrant/provision.sh new file mode 100644 index 000000000..f5a35a0f2 --- /dev/null +++ b/.dev/vagrant/provision.sh @@ -0,0 +1,84 @@ +#!/bin/bash + +echo "Provisioning development environment for Pterodactyl Panel." +cp /var/www/html/pterodactyl/.dev/vagrant/motd.txt /etc/motd +chmod -x /etc/update-motd.d/10-help-text /etc/update-motd.d/51-cloudguest + +apt-get install -y software-properties-common > /dev/null + +echo "Add the ondrej/php ppa repository" +add-apt-repository -y ppa:ondrej/php > /dev/null +echo "Add the mariadb repository" +curl -sS https://downloads.mariadb.com/MariaDB/mariadb_repo_setup | bash > /dev/null + +apt-get update > /dev/null + +echo "Install the dependencies" +export DEBIAN_FRONTEND=noninteractive +# set the mariadb root password because mariadb asks for it +debconf-set-selections <<< 'mariadb-server-5.5 mysql-server/root_password password pterodactyl' +debconf-set-selections <<< 'mariadb-server-5.5 mysql-server/root_password_again password pterodactyl' +# actually install +apt-get install -y php7.1 php7.1-cli php7.1-gd php7.1-mysql php7.1-pdo php7.1-mbstring php7.1-tokenizer php7.1-bcmath php7.1-xml php7.1-fpm php7.1-memcached php7.1-curl php7.1-zip php-xdebug mariadb-server nginx curl tar unzip git memcached > /dev/null + +echo "Install composer" +curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer + +echo "Install and run mailhog" +curl -sL -o /usr/bin/mailhog https://github.com/mailhog/MailHog/releases/download/v1.0.0/MailHog_linux_amd64 +chmod +x /usr/bin/mailhog +cp /var/www/html/pterodactyl/.dev/vagrant/mailhog.service /etc/systemd/system/ +systemctl enable mailhog.service +systemctl start mailhog + +echo "Configure xDebug" +cp /var/www/html/pterodactyl/.dev/vagrant/xdebug.ini /etc/php/7.1/mods-available/ +systemctl restart php7.1-fpm + +echo "Configure nginx" +cp /var/www/html/pterodactyl/.dev/vagrant/pterodactyl.conf /etc/nginx/sites-available/ +rm /etc/nginx/sites-available/default +ln -s /etc/nginx/sites-available/pterodactyl.conf /etc/nginx/sites-enabled/pterodactyl.conf +systemctl restart nginx + +echo "Setup database" +# Replace default config with custom one to bind mysql to 0.0.0.0 to make it accessible from the host +cp /var/www/html/pterodactyl/.dev/vagrant/mariadb.cnf /etc/mysql/my.cnf +systemctl restart mariadb +mysql -u root -ppterodactyl << SQL +CREATE DATABASE panel; +GRANT ALL PRIVILEGES ON panel.* TO 'pterodactyl'@'%' IDENTIFIED BY 'pterodactyl' WITH GRANT OPTION; +GRANT ALL PRIVILEGES ON *.* TO 'root'@'%' IDENTIFIED BY 'pterodactyl' WITH GRANT OPTION; +FLUSH PRIVILEGES; +SQL + +echo "Setup pterodactyl queue worker service" +cp /var/www/html/pterodactyl/.dev/vagrant/pteroq.service /etc/systemd/system/ +systemctl enable pteroq.service + + +echo "Setup panel with base settings" +cp /var/www/html/pterodactyl/.dev/vagrant/.env.vagrant /var/www/html/pterodactyl/.env +cd /var/www/html/pterodactyl +chmod -R 755 storage/* bootstrap/cache +composer install --no-progress +php artisan key:generate --force +php artisan migrate +php artisan db:seed +php artisan pterodactyl:user --firstname Test --lastname Admin --username admin --email testadmin@pterodactyl.io --password Ptero123 --admin 1 +php artisan pterodactyl:user --firstname Test --lastname User --username user --email testuser@pterodactyl.io --password Ptero123 --admin 0 + +echo "Add queue cronjob and start queue worker" +(crontab -l 2>/dev/null; echo "* * * * * php /var/www/html/pterodactyl/artisan schedule:run >> /dev/null 2>&1") | crontab - +systemctl start pteroq + +echo " ----------------" +echo "Provisioning is completed." +echo "The panel should be available at http://localhost:50080/" +echo "You may use the default admin user to login: admin/Ptero123" +echo "A normal user has also been created: user/Ptero123" +echo "MailHog is available at http://localhost:58025/" +echo "Connect to the database using root/pterodactyl or pterodactyl/pterodactyl on localhost:53306" +echo "If you want to access the panel using http://pterodactyl.app you can use the vagrant-dns plugin" +echo "Install it with 'vagrant plugin install vagrant-dns', then run 'vagrant dns --install' once" +echo "On first use you'll have to manually start vagrant-dns with 'vagrant dns --start'" diff --git a/.dev/vagrant/pterodactyl.conf b/.dev/vagrant/pterodactyl.conf new file mode 100644 index 000000000..d83849a97 --- /dev/null +++ b/.dev/vagrant/pterodactyl.conf @@ -0,0 +1,51 @@ +# If using Ubuntu this file should be placed in: +# /etc/nginx/sites-available/ +# +# If using CentOS this file should be placed in: +# /etc/nginx/conf.d/ +# +server { + listen 80; + server_name 0.0.0.0; + + root /var/www/html/pterodactyl/public; + index index.html index.htm index.php; + charset utf-8; + + location / { + try_files $uri $uri/ /index.php?$query_string; + } + + location = /favicon.ico { access_log off; log_not_found off; } + location = /robots.txt { access_log off; log_not_found off; } + + access_log off; + error_log /var/log/nginx/pterodactyl.app-error.log error; + + # allow larger file uploads and longer script runtimes + client_max_body_size 100m; + client_body_timeout 120s; + + sendfile off; + + location ~ \.php$ { + fastcgi_split_path_info ^(.+\.php)(/.+)$; + # the fastcgi_pass path needs to be changed accordingly when using CentOS + fastcgi_pass unix:/var/run/php/php7.1-fpm.sock; + fastcgi_index index.php; + include fastcgi_params; + fastcgi_param PHP_VALUE "upload_max_filesize = 100M \n post_max_size=100M"; + fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; + fastcgi_param HTTP_PROXY ""; + fastcgi_intercept_errors off; + fastcgi_buffer_size 16k; + fastcgi_buffers 4 16k; + fastcgi_connect_timeout 300; + fastcgi_send_timeout 300; + fastcgi_read_timeout 300; + } + + location ~ /\.ht { + deny all; + } +} diff --git a/.dev/vagrant/pteroq.service b/.dev/vagrant/pteroq.service new file mode 100644 index 000000000..7828ee91b --- /dev/null +++ b/.dev/vagrant/pteroq.service @@ -0,0 +1,20 @@ +# Pterodactyl Queue Worker File +# ---------------------------------- +# File should be placed in: +# /etc/systemd/system +# +# nano /etc/systemd/system/pteroq.service + +[Unit] +Description=Pterodactyl Queue Worker + +[Service] +# On some systems the user and group might be different. +# Some systems use `apache` as the user and group. +User=www-data +Group=www-data +Restart=on-failure +ExecStart=/usr/bin/php /var/www/html/pterodactyl/artisan queue:work database --queue=high,standard,low --sleep=3 --tries=3 + +[Install] +WantedBy=multi-user.target diff --git a/.dev/vagrant/xdebug.ini b/.dev/vagrant/xdebug.ini new file mode 100644 index 000000000..1725b8e84 --- /dev/null +++ b/.dev/vagrant/xdebug.ini @@ -0,0 +1,10 @@ +zend_extension=xdebug.so + +xdebug.remote_enable=1 +xdebug.remote_connect_back=1 +xdebug.remote_port=9000 +xdebug.scream=0 +xdebug.show_local_vars=1 +xdebug.idekey=PHPSTORM + +xdebug.remote_log=/tmp/xdebug.log \ No newline at end of file diff --git a/Vagrantfile b/Vagrantfile new file mode 100644 index 000000000..ed4b5bd4c --- /dev/null +++ b/Vagrantfile @@ -0,0 +1,21 @@ +Vagrant.configure("2") do |config| + config.vm.box = "ubuntu/xenial64" + + config.vm.synced_folder "./", "/var/www/html/pterodactyl", + owner: "www-data", group: "www-data" + + #config.vm.provision :file, source: ".dev/vagrant/pterdactyl.conf", destination: "/etc/nginx/sites-available/pterodactyl.conf" + #config.vm.provision :file, source: ".dev/vagrant/pteroq.service", destination: "/etc/systemd/system/pteroq.service" + #config.vm.provision :file, source: ".dev/vagrant/mailhog.service", destination: "/etc/systemd/system/mailhog.service" + #config.vm.provision :file, source: ".dev/vagrant/.env", destination: "/var/www/html/pterodactyl/.env" + config.vm.provision :shell, path: ".dev/vagrant/provision.sh" + + config.vm.network :private_network, ip: "192.168.50.2" + config.vm.network :forwarded_port, guest: 80, host: 50080 + config.vm.network :forwarded_port, guest: 8025, host: 58025 + config.vm.network :forwarded_port, guest: 3306, host: 53306 + + # Config for the vagrant-dns plugin (https://github.com/BerlinVagrant/vagrant-dns) + config.dns.tld = "app" + config.dns.patterns = [/^pterodactyl.app$/] +end