Merge branch 'master' of https://github.com/pterodactyl/documentation

2025-12-10 10:44:43 -06:00 · 2019-06-17 21:21:30 -07:00 · 2019-06-17 21:21:30 -07:00 · fb0ae156fc
commit fb0ae156fc
parent 6a3bae281c 4b4e0a7b4e
12 changed files with 80 additions and 22 deletions
--- a/.vuepress/config.js
+++ b/.vuepress/config.js
@ -90,6 +90,13 @@ module.exports = {
                        '/community/games/minecraft.md',
                    ],
                },
+                {
+                    title: 'Tutorials',
+                    collapsable: false,
+                    children: [
+                        '/community/tutorials/creating_ssl_certificates.md',
+                    ],
+                },
            ],
            '/': [
                {
@ -99,7 +106,7 @@ module.exports = {
                        '/project/introduction.md',
                        '/project/about.md',
                        '/project/terms.md',
-                        '/project/discord.md',
+                        '/project/community.md',
                    ]
                },
                {
--- a/community/installation-guides/daemon/debian9.md
+++ b/community/installation-guides/daemon/debian9.md
@ -13,7 +13,7 @@ We will first begin by installing all of the Daemon's [required](/daemon/install

 ### General Requirements
 ```bash
-apt install -y zip unzip tar make gcc g++ python curl gnupg
+apt install -y zip unzip tar make gcc g++ python python-dev curl gnupg
 ```

 ### Docker
--- a/community/installation-guides/panel/centos7.md
+++ b/community/installation-guides/panel/centos7.md
@ -68,13 +68,9 @@ systemctl enable redis

 ### Additional Utilities

-#### Certbot
-```bash
-yum install -y certbot
-```
-
 #### Composer
 ```bash
+yum install -y unzip # Required for Composer
 curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
 ```

@ -133,4 +129,4 @@ The default Redis install is perfectly fine for the panel. If you have Redis alr
 [running another Redis instance](https://community.pivotal.io/s/article/How-to-setup-and-run-multiple-Redis-server-instances-on-a-Linux-host).

 ## Installing the Panel
-Excellent, we now have all of the required dependencies installed and configured. From here, follow the [official Panel installation documentation](/panel/getting_started.md#installation).
+Excellent, we now have all of the required dependencies installed and configured. From here, follow the [official Panel installation documentation](/panel/getting_started.md#download-files).
--- a/community/tutorials/creating_ssl_certificates.md
+++ b/community/tutorials/creating_ssl_certificates.md
@ -0,0 +1,43 @@
+# Creating SSL Certificates
+These are community manages tutorials on how to generate an ssl cert.
+
+
+## Cloudflare
+This tutorial briefly covers creating new SSL certificates for your panel and daemon using Cloudflare
+
+### Using acme.sh
+This is for advanced users, of which their server systems do not have access to port 80. The command below is for Ubuntu distributions and CloudFlare API (you may google for other APIs for other DNS providers), but you can always check [acme.sh's official site](https://github.com/Neilpang/acme.sh) for installation instructions.
+
+``` bash
+curl https://get.acme.sh | sh
+```
+
+### Obtaining CloudFlare API Key
+After installing acme.sh, we need to fetch a CloudFlare API key. Please make sure that a DNS record (A or CNAME record) is pointing to your target node, and set the cloud to grey (bypassing CloudFlare proxy). Then go to My Profile > API keys and on Glocal API Key subtab, click on "view", enter your CloudFlare password, and copy the API key to clipboard.
+
+### Creating a Certificate
+Since the configuration file is based on Certbot, we need to create the folder manually.
+
+```bash
+sudo mkdir /etc/letsencrypt/live/example.com
+```
+
+After installing certbot and obtaining CloudFlare API key, we need to then generate a certificate. First input the CloudFlare API credentials.
+
+```bash
+export CF_Key="Your_CloudFlare_API_Key"
+export CF_Email="Your_CloudFlare_Account@example.com"
+```
+Then create the certificate.
+
+```bash
+acme.sh --issue --standalone -d "example.com" --dns dns_cf \
+--key-file /etc/letsencrypt/live/example.com/privkey.pem \
+--fullchain-file /etc/letsencrypt/live/example.com/fullchain.pem 
+```
+### Auto Renewal
+After running the script for the first time, it will be added to the crontab automatically. You may edit the auto renewal interval by editing the crontab.
+
+```bash
+sudo crontab -e
+```
--- a/daemon/installing.md
+++ b/daemon/installing.md
@ -7,7 +7,6 @@
 | ---------------- | ------- | :-------: | ----- |
 | **Ubuntu** | 14.04 | :warning: | Approaching EOL, not recommended for new installations. |
 | | 16.04 | :white_check_mark: | |
-| | 18.04 | :white_check_mark: | |
 | **CentOS** | 6 | :no_entry_sign: | Does not support all of the required packages. |
 | | 7 | :white_check_mark: | |
 | **Debian** | 8 | :warning: | Requires [kernel modifications](debian_8_docker.md) to run Docker. |
@ -15,6 +14,7 @@
 | **Alpine Linux** | 3.4+ | :warning: | Not officially supported, but reportedly works. |
 | **RHEL** | 7 | :warning: | Not officially supported, should work. |
 | **Fedora** | 28 | :warning: | Not officially supported, should work. |
+| | 29 | :warning: | Not officially supported, should work. |

 ## System Requirements
 In order to run the Daemon you will need a system capable of running Docker containers. Most VPS and almost all
--- a/daemon/standalone_sftp.md
+++ b/daemon/standalone_sftp.md
@ -4,7 +4,7 @@
 Standalone SFTP support was introduced in `Panel@v0.7.11` and `Daemon@v0.6.8` and will not work with prior versions.
 :::

-Pterodactyl now ships with the option to use a [standlone SFTP server](https://github.com/pterodactyl/sftp-server)
+Pterodactyl now ships with the option to use a [standalone SFTP server](https://github.com/pterodactyl/sftp-server)
 rather than using the one that was built into the Daemon. This provides better compatability with SFTP clients, improved
 transfer speeds, and a more native approach to file handling and server operation.

--- a/panel/getting_started.md
+++ b/panel/getting_started.md
@ -25,12 +25,12 @@ this software on an OpenVZ based system you will &mdash; most likely &mdash; not
 | | 18.04 | :white_check_mark: | |
 | **CentOS** | 6 | :no_entry_sign: | Does not support all of the required packages. |
 | | 7 | :white_check_mark: | |
-| **Debian** | 8 | :white_check_mark: | |
+| **Debian** | 8 | :warning: | Debian 8 may need modifications to work with the latest docker and other requirements for the panel/daemon |
 | | 9 | :white_check_mark: | |

 ## Dependencies
 * PHP `7.2` with the following extensions: `cli`, `openssl`, `gd`, `mysql`, `PDO`, `mbstring`, `tokenizer`, `bcmath`, `xml` or `dom`, `curl`, `zip`
-* MySQL `5.7` or higher **or** MariaDB `10.1.3` or higher
+* MySQL `5.7` **or** MariaDB `10.1.3` or higher
 * Redis (`redis-server`)
 * A webserver (Apache, NGINX, Caddy, etc.)
 * `curl`
@ -137,6 +137,7 @@ command will setup the database tables and then add all of the Nests & Eggs that
 php artisan migrate --seed
 ```

+### 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.
 At this time passwords **must** meet the following requirements: 8 characters, mixed case, at least one number.

@ -211,6 +212,11 @@ If you are not using `redis` for anything you should remove the `After=` line, o
 when the service starts.
 :::

+If you are 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
+sudo systemctl enable redis-server
+```
+
 Finally, enable the service and set it to boot on machine start.

 ``` bash
--- a/panel/upgrading.md
+++ b/panel/upgrading.md
@ -24,6 +24,6 @@ php artisan queue:restart

 ## Version Specific Guides

-* [0.6.X to 0.7.12](/panel/upgrade/0.6_to_0.7.md)
+* [0.6.X to 0.7.13](/panel/upgrade/0.6_to_0.7.md)
 * [0.7.X series](/panel/upgrade/0.7.md) <Badge text="current" vertical="middle"/>
 <!--* [0.7.X to 0.8.0](#) <Badge text="beta" type="warn" vertical="middle"/>-->
--- a/panel/webserver_configuration.md
+++ b/panel/webserver_configuration.md
@ -38,6 +38,8 @@ systemctl restart nginx
 You should paste the contents of the file below, replacing `<domain>` with your domain name being used in a file called
 `pterodactyl.conf` and place it in `/etc/apache2/sites-available`, or &mdash; if on CentOS, `/etc/httpd/conf.d/`.

+Note: When using Apache, make sure you have the `libapache2-mod-php` package installed or else PHP will not display on your webserver.
+
 ### Apache With SSL
 Like the nginx configuration, this assumes you will be using SSL on both the Panel and Daemons for improved security. You will need to visit our [Creating SSL Certificates](/tutorials/creating_ssl_certificates.html) documentation page on how to create these certificates.

--- a/project/about.md
+++ b/project/about.md
@ -5,9 +5,10 @@
 | Name | Discord Name | Primary Role |
 | ---- | ------------ | ---- |
 | [Dane Everitt](https://daneeveritt.com/) | `Tactical Fish#8008` | Project Maintainer |
+| [Anand Capur](https://anand.io/) | `Arcdigital#1337` | Mobile/Cloud Project Lead |
 | Michael Parker | `parkervcp#6789` | Egg Developer, Docker Integration |
 | [Jakob Schrettenbrunner](https://schrej.net/) | `schrej#1337` | Golang Daemon Lead, Developer |
-| [Anand Capur](https://anand.io/) | `Arcdigital#1337` | Developer |
+| Stepan Fedotov | `Trixter#0001` | WHMCS Module Maintainer |
 | [Lance Pioch](https://lancepioch.com/) | `ShadowLancer#5209` | Developer |

 ## Community Team
@ -16,7 +17,7 @@ members can be found in our Discord channel and are distinguished with a yellow

 ## License
 ``` text
-Copyright (c) 2015 - 2018 Dane Everitt <dane@daneeveritt.com>.
+Copyright (c) 2015 - 2019 Dane Everitt <dane@daneeveritt.com>.

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
--- a/project/community.md
+++ b/project/community.md
@ -2,7 +2,8 @@
    Sorry, but this file is off limits to additions or deletions that are not the result of fixing
    grammar or spelling mistakes.
 -->
-# Discord Community Standards
+
+# Community Standards
 Pterodactyl prides itself on providing a warm and welcoming community for all of our members. However, due to the
 sheer size of our community, we have a few rules that we expect all individuals to follow at all times.

@ -71,7 +72,7 @@ allow any random hosting company to partner with us and then go under, or, be su

 Please review the requirements below to see if you might qualify to become a partner with us. If you believe
 you meet these requirements, please send an email to dane@[this domain].io. Please refrain from contacting any
-of the Project Team directly on Discord, it is disruptive and rather annoying.
+of the Project Team directly about this, it is disruptive and rather annoying.

 1. *MUST* be able to show proof of business registration in your country.
 2. *MUST* be able to show an easily found page on your company website that lists at least two (2) sources for contact
--- a/tutorials/creating_ssl_certificates.md
+++ b/tutorials/creating_ssl_certificates.md
@ -1,6 +1,8 @@
 # Creating SSL Certificates
-This tutorial briefly covers creating new SSL certificates for your panel and daemon using LetsEncrypt&trade;. To
-begin, we will be installing certbot, a simple script that will automatically renew our certificates and allow much
+This tutorial briefly covers creating new SSL certificates for your panel and daemon using LetsEncrypt&trade;. 
+
+## Method 1: Using Certbot
+To begin, we will be installing certbot, a simple script that will automatically renew our certificates and allow much
 cleaner creation of them. The command below is for Ubuntu distributions, but you can always check [Certbot's official
 site](https://certbot.eff.org/) for installation instructions.
                                                                                                               
@ -10,7 +12,7 @@ sudo apt update
 sudo apt install certbot
 ```

-## Creating a Certificate
+### Creating a Certificate
 After installing certbot, we need to then generate a certificate. There are a couple ways to do that, but the
 easiest is to have letsencrypt spin-up a temporary web-server to do this. In order for this to work, you will
 first need to stop NGINX or Apache.
@ -26,10 +28,10 @@ that you've already configured the webservers to use SSL).
 certbot certonly -d example.com
 ```

-## Auto Renewal
+### Auto Renewal
 You'll also probably want to configure automatic renewal by adding the command below to a cronjob that runs daily.
 You can add the command below to that crontab. For advanced users, we suggest installing and using [acme.sh](https://acme.sh)
-which provides more options, and is much more powerful than certbot.
+which provides more options (see below), and is much more powerful than certbot.

 ``` text
 certbot renew