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 branch 'master' of github.com:pterodactyl/documentation

Browse Source
This commit is contained in:
Dane Everitt 2021-06-05 09:11:18 -07:00
commit 54e873bb9c
5 changed files with 54 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.vuepress/config.js
View File

@ -145,7 +145,7 @@ module.exports = {
currentVersion: '1.0',
versions: [
{
title: '1.3',
title: '1.4',
name: '1.0',
status: 'stable',
children: [
@ -166,7 +166,7 @@ module.exports = {
currentVersion: '1.0',
versions: [
{
title: '1.3',
title: '1.4',
name: '1.0',
status: 'stable',
children: [

BIN
.vuepress/public/node_allocations.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 126 KiB

2
panel/1.0/updating.md
View File

@ -68,7 +68,7 @@ If you've already performed the self-upgrade successfully you do not need to do
#### Enter Maintenance Mode
Whenever you are performing an update you should be sure to place your Panel into maintenance mode. This will prevent
users from encountering unexpected errors and ensure everything can be updated before users encounter
potentially new features. Now is a good time to ensure that you're in the `/var/www/pterodactyl` directory.
potentially new features.
``` bash
php artisan down

3
wings/1.0/configuration.md
View File

@ -97,4 +97,5 @@ More commonly discussed values. View all Wings config values and explanations in
| websocket_log_count | 150 | The number of lines to display in the console |
| detect_clean_exit_as_crash | true | Mark server as crashed if it's stopped without user interaction, e.g., not pressing stop button |
| (crash detection) timeout | 60 | Timeout between server crashes that will not cause the server to be automatically restarted |
| app_name | "Pterodactyl" | Changes the name of the daemon, shown in the panel's game console |
| app_name | "Pterodactyl" | Changes the name of the daemon, shown in the panel's game console |
| check_permissions_on_boot | true | Check all file permissions on each boot. Disable this when you have a very large amount of files and the server startup is hanging on checking permissions|

74
wings/1.0/installing.md
View File

@ -1,23 +1,26 @@
# Installing Wings
Wings is the next generation server control plane from Pterodactyl. It has been rebuilt from the
ground up using Go and lessons learned from our first Nodejs Daemon.
::: warning
You should only install Wings if you are running **Pterodactyl 1.0**. Do not install this software
You should only install Wings if you are running **Pterodactyl 1.x**. Do not install this software
for previous versions of Pterodactyl.
:::
## Supported Systems
| Operating System | Version | Supported | Notes |
| ---------------- | ------- | :-------: | ----- |
| **Ubuntu** | 18.04 | :white_check_mark: | Documentation written assuming Ubuntu 18.04 as the base OS. |
| | 20.04 | :white_check_mark: | |
| **CentOS** | 7 | :white_check_mark: | |
| | 8 | :white_check_mark: | |
| **Debian** | 9 | :white_check_mark: | |
| | 10 | :white_check_mark: | |
| Operating System | Version | Supported | Notes |
| ---------------- | ------- | :----------------: | ----------------------------------------------------------- |
| **Ubuntu** | 18.04 | :white_check_mark: | Documentation written assuming Ubuntu 18.04 as the base OS. |
| | 20.04 | :white_check_mark: | |
| **CentOS** | 7 | :white_check_mark: | |
| | 8 | :white_check_mark: | |
| **Debian** | 9 | :white_check_mark: | |
| | 10 | :white_check_mark: | |
## System Requirements
In order to run Wings you will need a system capable of running Docker containers. Most VPS and almost all
dedicated servers should be capable of running Docker, but there are edge cases.
@ -29,36 +32,39 @@ If you want to take a different approach, try using `lscpu` and checking what th
example of this is shown below which shows my hypervisor running with full virtualization — this means it will
support Docker without issues. If you see `KVM` for the vendor, chances are you're fine as well.
``` bash
```bash
dane@pterodactyl:~$ lscpu | grep 'vendor\|type'
Hypervisor vendor: VMware
Virtualization type: full
```
If that doesn't work for some reason, or you're still unsure, you can also run the command below and as long as it
If that doesn't work for some reason, or you're still unsure, you can also run the command below and as long as it
doesn't report `Xen` or `LXC` you're probably okay to continue.
``` bash
```bash
dane@pterodactyl:~$ sudo dmidecode -s system-manufacturer
VMware, Inc.
```
## Dependencies
* curl
* Docker
- curl
- Docker
### Installing Docker
For a quick install of Docker CE, you can execute the command below:
``` bash
```bash
curl -sSL https://get.docker.com/ | CHANNEL=stable bash
```
If you would rather do a manual installation, please reference the official Docker documentation for how to install Docker CE on your server. Some quick links
are listed below for commonly supported systems.
* [Ubuntu](https://docs.docker.com/install/linux/docker-ce/ubuntu/#install-docker-ce)
* [CentOS](https://docs.docker.com/install/linux/docker-ce/centos/#install-docker-ce)
* [Debian](https://docs.docker.com/install/linux/docker-ce/debian/#install-docker-ce)
- [Ubuntu](https://docs.docker.com/install/linux/docker-ce/ubuntu/#install-docker-ce)
- [CentOS](https://docs.docker.com/install/linux/docker-ce/centos/#install-docker-ce)
- [Debian](https://docs.docker.com/install/linux/docker-ce/debian/#install-docker-ce)
::: warning Check your Kernel
Please be aware that some hosts install a modified kernel that does not support important docker features. Please
@ -67,13 +73,15 @@ probably using a non-supported kernel. Check our [Kernel Modifications](kernel_m
:::
#### Start Docker on Boot
If you are on an operating system with systemd (Ubuntu 16+, Debian 8+, CentOS 7+) run the command below to have Docker start when you boot your machine.
``` bash
```bash
systemctl enable --now docker
```
#### Enabling Swap
On most systems, docker will be unable to setup swap space, you can check if this is the case by running `docker info`.
If it outputs `WARNING: No swap limit support` near the bottom, this is the case. Enabling swap is completely optional,
but we recommended doing it if you will be hosting for others, and to prevent OOM errors.
@ -85,15 +93,16 @@ After doing that, simply run `sudo update-grub` followed by `sudo reboot` to res
Below is an example of what the line should look like, _do not copy this line verbatium, it often has additional
OS specific parameters._
``` text
```text
GRUB_CMDLINE_LINUX_DEFAULT="swapaccount=1"
```
## Installing Wings
The first step for installing Wings is to make sure we have the required directory structure setup. To do so,
run the commands below which will create the base directory and download the wings executable.
``` bash
```bash
mkdir -p /etc/pterodactyl
curl -L -o /usr/local/bin/wings https://github.com/pterodactyl/wings/releases/latest/download/wings_linux_amd64
chmod u+x /usr/local/bin/wings
@ -106,7 +115,8 @@ set when creating the node.
:::
## Configure
Once you have installed Wings and the required components, the next step is to create a node on your installed Panel. Go to your Panel administrative view, select Nodes from the sidebar, and on the right side click Create New button.
Once you have installed Wings and the required components, the next step is to create a node on your installed Panel. Go to your Panel administrative view, select Nodes from the sidebar, and on the right side click Create New button.
After you have created a node, click on it and there will be a tab called Configuration. Copy the code block content, paste it into a new file called `config.yml` in `/etc/pterodactyl` and save it.
@ -114,20 +124,26 @@ Alternatively, you can click on the Generate Token button, copy the bash command
![](./../../.vuepress/public/wings_configuration_example.png)
::: warning
When your Panel is using SSL, the Wings must also have one created for its FQDN. See [Creating SSL Certificates](/tutorials/creating_ssl_certificates.html) documentation page for how to create these certificates before continuing.
:::
### Starting Wings
To start Wings, simply run the command below, which will start it in a debug mode. Once you confirmed that it is running without errors, use `CTRL+C` to terminate the process and daemonize it by following the instructions below. Depending on your server's internet connection pulling and starting Wings for the first time may take a few minutes.
``` bash
```bash
sudo wings --debug
```
You may optionally add the `--debug` flag to run Wings in debug mode.
### Daemonizing (using systemd)
Running Wings in the background is a simple task, just make sure that it runs without errors before doing
this. Place the contents below in a file called `wings.service` in the `/etc/systemd/system` directory.
``` text
```text
[Unit]
Description=Pterodactyl Wings Daemon
After=docker.service
@ -149,6 +165,14 @@ WantedBy=multi-user.target
Then, run the commands below to reload systemd and start Wings.
``` bash
```bash
systemctl enable --now wings
```
### Node Allocations
Allocation is a combination of IP and Port that you can assign to a server. Each created server must have at least one allocation. The allocation would be the IP address of your network interface. In some cases, such as when behind NAT, it would be the internal IP. To create new allocations go to Nodes > your node > Allocation.
![](../../.vuepress/public/node_allocations.png)
Type `hostname -I | awk '{print $1}'` to find the IP to be used for the allocation. Alternatively, you can type `ip addr | grep "inet "` to see all your available interfaces and IP addresses. Do not use 127.0.0.1 for allocations.