pterodactyl / documentation Goto Github PK

I wasn't sure to propose doco update or raise issue. The certbot PPA Repo doesn't work on Debian 9 stretch. Perhaps this should be somehow documented? Does it definitely work for Ubuntu?

I can't see the API Docs here. will you add them in the future? I am very looking forward to seeing it.

On the page https://pterodactyl.io/community/installation-guides/panel/centos7.html#php-7-2 it says to install php with the follwoing command:
yum install -y php72u-php php72u-common php72u-fpm php72u-cli php72u-json php72u-mysqlnd php72u-mcrypt php72u-gd php72u-mbstring php72u-pdo php72u-zip php72u-bcmath php72u-dom php72u-opcache

However there is no php72u-mcrypt package for php v7.2. Mcrypt has been removed from php 7.2.
The php72u-php package is also not available.
See https://dl.iuscommunity.org/pub/ius/stable/CentOS/7/x86_64/repoview/letter_p.group.html

Please fix the documentation if possible. How do I replace these packages?

i noticed that at wings/1.0/installing.md the screenshot is still of the 0.7 panel and needs updating. i'd make a PR, but i dont have v1 installed atm, and i dont yet know how to properly use github anyway.

include running command

rm -rf /srv/daemon/config/.sftp
systemctl restart wings

to fix

1.5947576801594493e+09  info    sftp-server/main.go:47  reading configuration from path {"config-path": "./config/core.json"}
1.5947576801595345e+09  info    sftp-server/main.go:60  using system daemon user        {"username": "pterodactyl"}
1.5947576801595764e+09  info    sftp-server/main.go:77  using config daemon port        {"port": 2022}
1.5947576801596472e+09  fatal   sftp-server/main.go:103 could not start SFTP server     {"error": "asn1: structure error: integer not minimally-encoded"}
main.main
        sftp-server/main.go:103
runtime.main
        /usr/local/Cellar/go/1.14.2_1/libexec/src/runtime/proc.go:203

inside the standalone sftp instruction
https://pterodactyl.io/daemon/0.6/standalone_sftp.html
it probably would save most people a few clicks and a few questions

I noticed on this page Wings- installing of the documentation, there is a section that says;

To run Wings, you will need a Linux system capable of running Docker containers. Most VPS and almost all dedicated servers should be capable of running Docker, but there are edge cases.

When your provider uses Virtuozzo, OpenVZ (or OVZ), or LXC virtualization, you will most likely be unable to run Wings. Some providers have made the necessary changes for nested virtualization to support Docker. Ask your provider's support team to make sure. KVM is guaranteed to work.

The easiest way to check is to type systemd-detect-virt. If the result doesn't contain OpenVZ orLXC, it should be fine. The result of none will appear when running dedicated hardware without any virtualization.

This turned me away from using pterodactyl all together, for about a year, until I learned elsewhere that docker IS in fact compatible with LXC, IF you enable nesting. [and got the courage together to learn how to install pterodactyl which seems like a common problem among beginners looking for a panel as well]

My example is using Proxmox, where you can enable nesting via the features menu item, though I understand this is impossible for many using VPS, etc. but there could be a clarification to be added here that, you can use it you just have to ensure nesting is available.

This is my first issue, please let me know if I was correct in placing this here.

https://pterodactyl.io/tutorials/mysql_setup.html#allowing-external-database-access

make clear where exactly those files are.

Adding docker-compose as a method of installation to the documentation could be a great way to install the panel for the less technically inclined people, who would otherwise use scripts and clog up the support channels.

Currently, only people who know what they are looking for would use the images, and they are people who could install the panel normally anyway, which isn't really taking full advantage of the utility of docker containers

• Panel or Daemon: Daemon
• Version of Panel/Daemon: 0.7.17 / 0.6.13
• Server's OS: CentOS 8 Minimal
• Your Computer's OS & Browser: Windows 10 Pro & Google Chrome

Describe the bug
When installing a server on a Daemon without the "Skip Egg Install Script" checkbox checked, it doesn't work, with that box checked, it works.

Install.log: https://hastebin.com/dupasuvixe
As you see, curl and jq seem to be missing. Seems like that's not included with alpine 3.9 so it probably needs to be installed in the java container.

To Reproduce
Steps to reproduce the behavior:

1. Install the panel and daemon by the guides on CentOS 8 Minimal installs.
2. Try to create a Minecraft server.

Expected behavior
The install script should run succesfully so the daemon software can be used.

For CentOS Installation might want to add a few things:

Uninstall Old versions of Docker.
sudo yum remove docker-ce docker-ce-cli containerd.io

Install new version of Containerd.io
yum install -y https://download.docker.com/linux/centos/7/x86_64/stable/Packages/containerd.io-1.2.6-3.3.el7.x86_64.rpm

Setup New Docker Repository
sudo yum-config-manager
--add-repo
https://download.docker.com/linux/centos/docker-ce.repo

Install new versions of Docker:
sudo yum install docker-ce docker-ce-cli

This solves the issue with Docker API being To New on CentOS preventing Wings from Starting

Hi all,

Took me a bit to figure it out, but I believe the PHP version has changed since the Debian tutorial was created.

https://pterodactyl.io/community/installation-guides/panel/debian10.html

The tutorial states to install PHP 8.0 which results in a 502 Bad Gateway. Installing PHP 8.1 fixes the issue and allows everything to work properly (at least thus far in my setup process, lol).

If this is something I did wrong, maybe we can outline whatever I did in the tutorial for others? Otherwise, changing the version should be an easy fix.

Thanks for a great product! I've had this running on another server for a long time and it works well. Looking forward to using it on this one.

My .env file is not being generated after i type:
cp .env.example .env
Then when i type:
composer install --no-dev --optimize-autoloader
everything seems fine but when i type:
php artisan key:generate --force
No key shows up. it just says:

Application key set succesfully.

but no key is given and there also is not an .env file in /var/www/pterodactyl
Iam on Debian 9

The section at https://pterodactyl.io/daemon/configuration.html#private-registries should also document the usage of the images array required for the authentication config to be used.

Relevant lines from the daemon: https://github.com/pterodactyl/daemon/blob/v0.6.12/src/helpers/image.js#L75-L85

Hello, I could read in your git, that you are planning in 2017 the possibility of managing an arma 3 or DayZ server. When is he this day?

Regards

I am not sure what you are trying to achieve here. It actually does not work from my testing so the changes you suggested makes no sense.

root@panel:/var/www/pterodactyl# tzzone -I | awk '{print $1}'
145.239.115.75
root@panel:/var/www/pterodactyl# tzzone -I | awk '{print $1}'
-bash: tzzone: command not found

Originally posted by @JackW6809 in #373 (comment)

Check https://github.com/pterodactyl/documentation/commits/gh-pages, you find that GitHub Pages build event did not start.

Please do not use GITHUB_TOKEN, use ACTIONS_DEPLOY_KEY or PERSONAL_TOKEN

cf. peaceiris/actions-gh-pages#9

I live in Russia and know Russian language. Panel is not fully translated and i can help with translating Pterodactyl Panel. How to help with translating?

On Ubuntu 18.04 Apache2 following the documentation's instructions to the dot, I ran into an error just after configuring the sites-available portion of Pterodactyl. More specifically...

# You do not need to run any of these commands on CentOS
sudo ln -s /etc/apache2/sites-available/pterodactyl.conf /etc/apache2/sites-enabled/pterodactyl.conf
sudo a2enmod rewrite
systemctl restart apache2

Here's the error:
https://i.imgur.com/iFdn8eu.png

To repair, I visited https://serverfault.com/questions/515417/error-start-apache-php-value and https://stackoverflow.com/questions/36057615/ubuntu-apache-module-php7-does-not-exist and found the following solution. Run the commands:

sudo apt-get install libapache2-mod-php7.2
sudo a2enmod php7.2
sudo systemctl restart apache2

Then I was able to continue following the guide without error.

I am leaving this here for future reference.

Update example screenshots
Provide examples on how to use custom variables for the config parser {{server.build.env.VARIABLENAME}}
Remove deprecated userInteraction
Display the ability to use arrays and regex in the start configuration
Provide information regarding egg-features

i was having a problem with the copy-pasted configuration caused by a missing Listen [::]:...

Hey, from what I can see this is a fairly common issue, but I cannot create a user, and also when I ran "php artisan migrate --seed" I got this error. I could delete my VM and make another one, but that is kind of a pain since I am using Microsoft Azure, and it would be easier for me if I could just change my host, (since what I see, I'm not supposed to use localhost, and that is why this is happening).

Some system dependencies, like mariadb, might require upgrades for 1.0 to work.

Improvement on https://pterodactyl.io/tutorials/mysql_setup.html#allowing-external-database-access

For Ubuntu 18.04, It has been founded that the "bind-address=" option does not exist in "my.cnf".
To find the "bind-address=" option you go to 50-server.cnf.

A member of the Discord is who had this answer, I will share a link to that individual's answer/convo.
https://discordapp.com/channels/122900397965705216/272796619592695808/730897830155124888

Hope it helps improve some of y'alls Documentation. 👍

with beta 6 the command tar --strip-components=1 -xzvf panel.tar.gz when decompressing the panel zip to install it does not extra the right files and stops you from being able to run the following commands removing --strip-components=1 fixes this and allows the right files to be accessed afterwards.

Explanation

In the panel tutorial, but specifically in the "Getting Started" tab, change the following information:

php artisan p:environment:setup
php artisan p:environment:database

# To use PHP's internal mail sending (not recommended), select "mail". To use a
# custom SMTP server, select "smtp".
php artisan p:environment:mail

To:

php artisan p:environment:setup
php artisan p:environment:database

# To use PHP's internal mail sending (not recommended), select "mail". To use a
# custom SMTP server, select "smtp".
# If you don't need mail sending right now, ignore this command.
php artisan p:environment:mail

Why this change?

This will prevent people from running this command without even needing to send mail, and most importantly, it will prevent these kinds of problems in discord:

[2021-12-10 17:22:35] production.ERROR: Connection could not be established with host smtp.example.com :stream_socket_client(): php_network_getaddresses: getaddrinfo failed: Name or service not known

Where am I supposed to find this? It's very vague to me. Just "a file"? No location or anything? Is it supposed to be obvious because I wasn't able to find it in any of the obvious directories being "pterodactyl/" "pterodactyl/config/" and even in "pterodactyl/config/pterodactyl.php" I did a file search and only found the ngix config thats already in the docs.

Hi,
First of all: Thank you for that piece of software, it's great!!
I think you should mention what .env files are and where they are stored.
Regards,
Dorian

I tried cloning this github and running deploy.sh and it works, but it says

'[email protected]: Permission denied (publickey).
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.'

Do you know how to fix this?

I've seen this issue frequently in support channels, and I think that at least under setup conditions users are running into MySQL permission issues because of conflicts in the setup instructions.

MySQL grants are instructed to be set at https://pterodactyl.io/tutorials/mysql_setup.html#creating-a-user as:
CREATE USER 'pterodactyl'@'127.0.0.1' IDENTIFIED BY 'somePassword';

It's common for users to show up with this error in their logs:
[2019-08-27 17:31:36] production.ERROR: QueryException: SQLSTATE[HY000] [1698] Access denied for user 'pterodactyl'@'localhost' (SQL: select * from information_schema.tables where table_schema = panel and table_name = migrations) in /var/www/pterodactyl/vendor/laravel/framework/src/Illuminate/Database/Connection.php:664

I believe this is because 'pterodactyl'@'127.0.0.1' is not equivalent to 'pterodactyl'@'localhost'. I think this can be resolved with documentation once I better understand the set of instructions people follow to end up in this situation.

Every time you want to swipe right (for example while reading a code block), the side bar will pop up which makes it annoying and forces you to dismiss the side bar and continue reading through the docs.
I have no idea if this can be reproduced in iOS since I have an android phone, but it would be beneficial if this function could be disabled.

https://pterodactyl.io/panel/0.7/getting_started.html

Someone in support said "I followed this page top to bottom" and still got the default NGINX page. Sure enough, they had never created the webserver config, because nothing on that page told them to, and it did not include any links to the next steps directly on the page.

You can tell looking at the sidebar there are more docs, but there should be next page links to indicate to users that there are still additional steps required.

We should have a section in the documentation with GDPR related information for people hosting the panel.
The panel is using ReCAPTCHA by default for example, and that requires to be mentioned in the Privacy Policy. We can then also include information on what kind of information the panel collects (cookies, ips?, email) so people know what they have to mention in their Privacy Policy.

This should not be a full privacy policy, just information on what to include/mention in it.

• Cookies
• IP logging
• LocalStorage?
• ReCAPTCHA
• Gravatar (E-Mail Address!!)

certbot -d example.com --manual --preferred-challenges dns certonly

Is very useful when you for example want a Cert for a Node since else you would need to setup an nginx server on port 80 first and thats nnecessary, when you could just do this.

I can't find any "list servers by user" in the docs even though I've been told that it exists, does it exist or not? If so can the documentation be updated?

I noticed PHP 7.2 was listed as dependency on the official 'Getting Started' guide (Getting Started). Should this be replaced with PHP 7.3 instead as PHP 7.2 is soon reaching end of 'active support' (see supported versions).

Cheers

● pteroq.service - Pterodactyl Queue Worker
Loaded: loaded (/etc/systemd/system/pteroq.service; enabled; vendor preset: disabled)
Active: failed (Result: start-limit) since Mon 2019-10-28 17:23:19 UTC; 1s ago
Process: 5069 ExecStart=/usr/bin/php /var/www/pterodactyl/artisan queue:work --queue=high,standard,low --sleep=3 --tries=3 (code=exited, status=217/USER)
Main PID: 5069 (code=exited, status=217/USER)

Oct 28 17:23:19 720.my.cloudef.com systemd[1]: Unit pteroq.service entered failed state.
Oct 28 17:23:19 720.my.cloudef.com systemd[1]: pteroq.service failed.
Oct 28 17:23:19 720.my.cloudef.com systemd[1]: pteroq.service holdoff time over, scheduling restart.
Oct 28 17:23:19 720.my.cloudef.com systemd[1]: Stopped Pterodactyl Queue Worker.
Oct 28 17:23:19 720.my.cloudef.com systemd[1]: start request repeated too quickly for pteroq.service
Oct 28 17:23:19 720.my.cloudef.com systemd[1]: Failed to start Pterodactyl Queue Worker.
Oct 28 17:23:19 720.my.cloudef.com systemd[1]: Unit pteroq.service entered failed state.
Oct 28 17:23:19 720.my.cloudef.com systemd[1]: pteroq.service failed.

pls help

What do I do after I have generated SSL with certbot / nginx? Your instruction only shows some config file with the header SSL Configuration but it doesn't tell you if it's an example or where you can find your config or if you need to edit your config and where it could be located. Do I just ignore the random config?

I eventually just copied the config and pasted it in my /etc/nginx/nginx.conf and edited the higlighted parts but I am unsure if this is how I should have used the config .

This is the part I am completely confused about I think it could use some edits to make it more clear why there's a random ssl config.
https://pterodactyl.io/community/installation-guides/panel/ubuntu2004.html#ssl-configuration

I was dismayed when I was told on the Discord server that there is no official documentation for the application programming interface. I have tried to utilise https://dashflo.net/docs/api/pterodactyl/v0.7/, but it extremely undescriptive and lacking crucial information, covering barely 20% of the functionality.
Of all features of Pterodactyl, the API is the one that MUST have proper documentation (or any at all!!). Why program an API that nobody has any idea how to utilise?
I was told to write my own documentation for the API, and I would, had I all the time to go through the entire code.

I do not mean to be offensive or demanding, but this is exceptionally essential.

If you follow the instructions from top to bottom you will install both 0.6 and 0.7 daemon. I think these two sections should be combined in a single dropdown rather than separate items.

People are doing this, e.g.:

KanameToday at 1:43 PM
Daemon work but wings dont want start
i've Daemon 0.6
and wings 1.0

The documentation covers pretty much most of the required setup for the pterodactyl panel. However it is still missing a basic guidance/best practice how to set up the database backend for creating database hosts and databases. Even though those database functions are available in the GUI, there is no documentation on how to make them work in the background.

If somebody has had no or little experience with mysql this can be very daunting. Especially from a security perspective I guess one could do many things wrong, like opening ports to the whole www, assigning to wrong permissions to mysql users and so on. Also I think the installation of pterodactyl is simply incomplete without setting this up.

I would do this myself but I don't think I have sufficient understanding for this.

@:/var/www/pterodactyl$ sudo systemctl enable --now redis-server
Synchronizing state of redis-server.service with SysV init with /lib/systemd/systemd-sysv-install...
Executing /lib/systemd/systemd-sysv-install enable redis-server
ezermoz@:/var/www/pterodactyl$ sudo systemctl enable --now pteroq.service
Failed to execute operation: No such file or directory
ezermoz@i:/var/www/pterodactyl$

Hello, where I can find directory which contains backups?

Hey,

for some distributions like Arch(which i use) you need for stop the wings service in order to override the execution file because curl doesn´t override busy files.

So it should be:

1. Stop Wings
2. Download new Wings Execution File
3. Set permissions
4. Start Wings

Wich makes also more sense to avoid errors that may occur while the service is still running

LG

Everything is in the title,

I use Debian 8.11

Some machines (presumably depending on provider) don't use GRUB_CMDLINE_LINUX_DEFAULT and instead only use GRUB_CMDLINE_LINUX. This happend to me. I use OVH and even though I have GRUB_CMDLINE_LINUX_DEFAULT in grub config, my machine ignores it.

To figure out what arguments does our machine uses we can type cat /proc/cmdline in console and compare it to /etc/default/grub. So if we see cmdline arguments from GRUB_CMDLINE_LINUX but not from GRUB_CMDLINE_LINUX_DEFAULT it's more appropriate to put swapaccount=1 to GRUB_CMDLINE_LINUX.

I had WARNING: No swap limit support on six of my OVH machines (not sure if it's just OVH bare-metal quirk or not). I think this info needs to be included in docs in some way.

Hi,

Can you add a tutorial for installing Pterodactyl Panel on CPanel?

It would be very useful.

Thank you in advance.

ABOUT THE PROJECT | DISCORD

You have to highlight them to see them:

Here I have a collection of images that will fit better on the front of the home page. (they are up to date)
I tried to put them in order of what people would want to see and the order they would visit them on the panel.

Admin node list:

Admin in node view:

Admin in server view:

Admin in startup view:

Admin in eggs/scripts view:

Client in server view:

Client in file manager view:

Client in file editor view:

Client in backups view:

Client in network view:

Client in API keys view: