add node allocations and SSL certificate warning

This commit is contained in:
Softwarenoob 2021-05-02 15:47:24 +03:00
parent 1c2ab185f1
commit bcccd5ece6
2 changed files with 48 additions and 24 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 126 KiB

View File

@ -1,4 +1,5 @@
# 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.
@ -8,8 +9,9 @@ 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: | |
@ -18,6 +20,7 @@ for previous versions of Pterodactyl.
| | 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.
@ -44,11 +47,14 @@ VMware, Inc.
```
## Dependencies
* curl
* Docker
- curl
- Docker
### Installing Docker
For a quick install of Docker CE, you can execute the command below:
```bash
curl -sSL https://get.docker.com/ | CHANNEL=stable bash
```
@ -56,9 +62,9 @@ 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,6 +73,7 @@ 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
@ -74,6 +81,7 @@ 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.
@ -90,6 +98,7 @@ 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.
@ -106,6 +115,7 @@ 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.
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,7 +124,12 @@ 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
@ -124,6 +139,7 @@ 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.
@ -152,3 +168,11 @@ Then, run the commands below to reload systemd and start Wings.
```bash
systemctl enable --now wings
```
### Node Allocations
Allocation is a combination of IP and Port that can be assigned 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. 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 find all your available interfaces and IP addresses. Do not use 127.0.0.1 for allocations.