pterodactyl/documentation
1
0
Fork 0
mirror of https://github.com/pterodactyl/documentation.git synced 2025-12-10 10:44:43 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #423 from pterodactyl/update/server-os

Browse Source
This commit is contained in:
Dane Everitt 2021-12-23 05:16:29 -08:00 committed by GitHub
commit a2e5c7cfb9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 26 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
panel/1.0/getting_started.md
View File

@ -15,23 +15,26 @@ of basic linux system administration you should stop and turn around now.**
::: :::
## Picking a Server OS ## Picking a Server OS
Pterodactyl runs on a wide range of operating systems, so pick whichever you are most comfortable using. Pterodactyl runs on a wide range of operating systems, so pick whichever you are most comfortable using.
::: warning ::: warning
Pterodactyl does not support most OpenVZ systems due to incompatabilities with Docker. If you are planning on running Pterodactyl does not support most OpenVZ systems due to incompatibilities with Docker. If you are planning on running
this software on an OpenVZ based system you will — most likely — not be successful. this software on an OpenVZ based system you will — most likely — not be successful.
::: :::
| Operating System | Version | Supported | Notes | | Operating System | Version | Supported | Notes |
| ---------------- | ------- | :-------: | ----- | | ---------------- | ------- | :----------------: | ----------------------------------------------------------- |
| **Ubuntu** | 18.04 | :white_check_mark: | Documentation written assuming Ubuntu 18.04 as the base OS. | | **Ubuntu** | 18.04 | :white_check_mark: | Documentation written assuming Ubuntu 18.04 as the base OS. |
| | 20.04 | :white_check_mark: | | | | 20.04 | :white_check_mark: | |
| **CentOS** | 7 | :white_check_mark: | Extra repos are required. | | **CentOS** | 7 | :white_check_mark: | Extra repos are required. |
| | 8 | :white_check_mark: | | | | 8 | :white_check_mark: | |
| **Debian** | 9 | :white_check_mark: | Extra repos are required. | | **Debian** | 9 | :white_check_mark: | Extra repos are required. |
| | 10 | :white_check_mark: | | | | 10 | :white_check_mark: | |
| | 11 | :white_check_mark: | |
## Dependencies ## Dependencies
* PHP `7.4` or `8.0` (recommended) with the following extensions: `cli`, `openssl`, `gd`, `mysql`, `PDO`, `mbstring`, `tokenizer`, `bcmath`, `xml` or `dom`, `curl`, `zip`, and `fpm` if you are planning to use NGINX. * PHP `7.4` or `8.0` (recommended) with the following extensions: `cli`, `openssl`, `gd`, `mysql`, `PDO`, `mbstring`, `tokenizer`, `bcmath`, `xml` or `dom`, `curl`, `zip`, and `fpm` if you are planning to use NGINX.
* MySQL `5.7.22` or higher (MySQL `8` recommended) **or** MariaDB `10.2` or higher. * MySQL `5.7.22` or higher (MySQL `8` recommended) **or** MariaDB `10.2` or higher.
* Redis (`redis-server`) * Redis (`redis-server`)
@ -43,6 +46,7 @@ this software on an OpenVZ based system you will — most likely — not
* `composer` v2 * `composer` v2
### Example Dependency Installation ### Example Dependency Installation
The commands below are simply an example of how you might install these dependencies. Please consult with your The commands below are simply an example of how you might install these dependencies. Please consult with your
operating system's package manager to determine the correct packages to install. operating system's package manager to determine the correct packages to install.
@ -66,6 +70,7 @@ apt -y install php8.0 php8.0-{cli,gd,mysql,pdo,mbstring,tokenizer,bcmath,xml,fpm
``` ```
### Installing Composer ### Installing Composer
Composer is a dependency manager for PHP that allows us to ship everything you'll need code wise to operate the Panel. You'll Composer is a dependency manager for PHP that allows us to ship everything you'll need code wise to operate the Panel. You'll
need composer installed before continuing in this process. need composer installed before continuing in this process.
@ -74,6 +79,7 @@ curl -sS https://getcomposer.org/installer | sudo php -- --install-dir=/usr/loca
``` ```
## Download Files ## Download Files
The first step in this process is to create the folder where the panel will live and then move ourselves into that The first step in this process is to create the folder where the panel will live and then move ourselves into that
newly created folder. Below is an example of how to perform this operation. newly created folder. Below is an example of how to perform this operation.
@ -132,6 +138,7 @@ Store it somewhere safe - not just on your server. If you lose it all encrypted
::: :::
### Environment Configuration ### Environment Configuration
Pterodactyl's core environment is easily configured using a few different CLI commands built into the app. This step Pterodactyl's core environment is easily configured using a few different CLI commands built into the app. This step
will cover setting up things such as sessions, caching, database credentials, and email sending. will cover setting up things such as sessions, caching, database credentials, and email sending.
@ -145,6 +152,7 @@ php artisan p:environment:mail
``` ```
### Database Setup ### Database Setup
Now we need to setup all of the base data for the Panel in the database you created earlier. **The command below Now we need to setup all of the base data for the Panel in the database you created earlier. **The command below
may take some time to run depending on your machine. Please _DO NOT_ exit the process until it is completed!** This may take some time to run depending on your machine. Please _DO NOT_ exit the process until it is completed!** This
command will setup the database tables and then add all of the Nests & Eggs that power Pterodactyl. command will setup the database tables and then add all of the Nests & Eggs that power Pterodactyl.
@ -154,6 +162,7 @@ php artisan migrate --seed --force
``` ```
### Add The First User ### Add The First User
You'll then need to create an administrative user so that you can log into the panel. To do so, run the command below. You'll then need to create an administrative user so that you can log into the panel. To do so, run the command below.
At this time passwords **must** meet the following requirements: 8 characters, mixed case, at least one number. At this time passwords **must** meet the following requirements: 8 characters, mixed case, at least one number.
@ -162,6 +171,7 @@ php artisan p:user:make
``` ```
### Set Permissions ### Set Permissions
The last step in the installation process is to set the correct permissions on the Panel files so that the webserver can The last step in the installation process is to set the correct permissions on the Panel files so that the webserver can
use them correctly. use them correctly.
@ -177,10 +187,12 @@ chown -R apache:apache /var/www/pterodactyl/*
``` ```
## Queue Listeners ## Queue Listeners
We make use of queues to make the application faster and handle sending emails and other actions in the background. We make use of queues to make the application faster and handle sending emails and other actions in the background.
You will need to setup the queue worker for these actions to be processed. You will need to setup the queue worker for these actions to be processed.
### Crontab Configuration ### Crontab Configuration
The first thing we need to do is create a new cronjob that runs every minute to process specific Pterodactyl tasks, such The first thing we need to do is create a new cronjob that runs every minute to process specific Pterodactyl tasks, such
as session cleanup and sending scheduled tasks to daemons. You'll want to open your crontab using `sudo crontab -e` and as session cleanup and sending scheduled tasks to daemons. You'll want to open your crontab using `sudo crontab -e` and
then paste the line below. then paste the line below.
@ -190,10 +202,12 @@ then paste the line below.
``` ```
### Create Queue Worker ### Create Queue Worker
Next you need to create a new systemd worker to keep our queue process running in the background. This queue is responsible Next you need to create a new systemd worker to keep our queue process running in the background. This queue is responsible
for sending emails and handling many other background tasks for Pterodactyl. for sending emails and handling many other background tasks for Pterodactyl.
Create a file called `pteroq.service` in `/etc/systemd/system` with the contents below. Create a file called `pteroq.service` in `/etc/systemd/system` with the contents below.
``` text ``` text
# Pterodactyl Queue Worker File # Pterodactyl Queue Worker File
# ---------------------------------- # ----------------------------------
@ -227,6 +241,7 @@ when the service starts.
::: :::
If you are using redis for your system, you will want to make sure to enable that it will start on boot. You can do that by running the following command: If you are using redis for your system, you will want to make sure to enable that it will start on boot. You can do that by running the following command:
```bash ```bash
sudo systemctl enable --now redis-server sudo systemctl enable --now redis-server
``` ```

3
wings/1.0/installing.md
View File

@ -24,7 +24,8 @@ only the versions listed below.
| | 8 | :white_check_mark: | | | | 8 | :white_check_mark: | |
| **Debian** | 9 | :white_check_mark: | | | **Debian** | 9 | :white_check_mark: | |
| | 10 | :white_check_mark: | | | | 10 | :white_check_mark: | |
| **Windows** | All | :x: | This software will not run in Windows environments. | | | 11 | :white_check_mark: | |
| **Windows** | All | :x: | This software will not run in Windows environments. |
## System Requirements ## System Requirements