Skip to content

Commit 4c1dec4

Browse files
authored
Update README.md
[+] Added Git support [+] Added new tutorial for version change [-] Removed 7.3 version [~] Fixed images
1 parent 034524d commit 4c1dec4

File tree

1 file changed

+56
-25
lines changed

1 file changed

+56
-25
lines changed

README.md

+56-25
Original file line numberDiff line numberDiff line change
@@ -1,87 +1,118 @@
1-
21
# Pterodactyl Nginx egg
32

4-
Nginx web server egg with PHP and optional Wordpress installation.
5-
3+
Nginx web server egg with PHP, optional Wordpress installation and git support.
64

75
## Features
8-
You can select the desired PHP version.
6+
7+
#### Git support for your webserver
8+
#### You can select the desired PHP version.
99
- ✅ 8.3
1010
- ✅ 8.2
1111
- ✅ 8.1 [Only critical security updates]
12-
- ✅ 8.0 [EOL]
13-
- ✅ 7.3 [EOL]
12+
- ☑️ 8.0 [EOL]
1413

15-
https://www.php.net/supported-versions.php
14+
[PHP supported versions](https://www.php.net/supported-versions.php)
1615

1716
## How to install
18-
- **Step 1:** Download the egg (json file egg-nginx.json)
17+
18+
- **Step 1:** Download the egg (json file `egg-nginx.json`)
1919
- **Step 2:** In your panel, go to the "Nests" category in the sidebar
2020
- **Step 3:** Import the egg under "Import egg" and then press "save" at the bottom right
2121
- **Step 4:** Create a new server and select the "Nginx" egg
2222
- **Step 5:** Select the corresponding Docker image with the desired PHP version
2323
- **Step 6:** Fill in the text fields. Whether Wordpress is desired or not. It is important to **enter the selected PHP version in the PHP version field**.
2424

25-
2625
## FAQ
2726

2827
#### In which folder do I upload my files for my site?
2928
Here the "www" folder is used as a public folder, which can be accessed by everyone. Added files can be accessed in this folder.
3029

30+
## How do I use Git support?
31+
32+
#### Instructions for Git support
33+
Git support allows you to automatically clone a Git repository into the www folder of your web server and apply the latest changes every time you restart (git pull). This is how it works:
34+
Prerequisites:
3135

36+
#### Prerequisites:
37+
- Git Status must be enabled to use Git.
38+
- GIT_ADDRESS must contain a valid Git repository that you want to clon
39+
40+
#### Steps to set up (Specify GIT_ADDRESS):
41+
- When creating the web server, you can specify a Git repository URL in the GIT_ADDRESS field.
42+
- Example: https://github.com/username/repository.git
43+
44+
#### Activate Git status:
45+
- Make sure that the Git status is set to ‘active’ (1 or true) so that the repository is managed automatically.
46+
47+
#### Automatic installation:
48+
- When the server is first created, the specified repository is automatically cloned into the www folder of your server.
49+
50+
#### Automatic updates:
51+
- After each restart of the web server, the repository in the www folder is automatically updated to the latest version (git pull).
3252

3353
## How to use https://
34-
Go to the file:
54+
55+
Go to the file:
56+
3557
```bash
3658
/home/container/nginx/conf.d/default.conf
3759
```
3860

61+
Change "listen" to:
3962

40-
Change "listen" to:
4163
```bash
4264
listen <YOUR_PORT> ssl;
4365
```
66+
4467
Please also change the spacer distance. Otherwise the "listen" will be overwritten each time the egg is restarted.
4568

4669
Add the following lines:
70+
4771
```bash
48-
ssl_certificate /home/container/your_cert.crt;
49-
ssl_certificate_key /home/container/your_cert_key.key;
50-
ssl_protocols TLSv1.2 TLSv1.3;
51-
ssl_ciphers HIGH:!aNULL:!MD5;
72+
ssl_certificate /home/container/your_cert.crt;
73+
ssl_certificate_key /home/container/your_cert_key.key;
74+
ssl_protocols TLSv1.2 TLSv1.3;
75+
ssl_ciphers HIGH:!aNULL:!MD5;
5276
```
5377

5478
Adjust the lines accordingly.
55-
Furthermore, if not already done, adjust to your domain:
79+
80+
Furthermore, if not already done, adjust to your domain:
81+
5682
```bash
5783
server_name www.example.com;
5884
```
5985

6086
## Change PHP version
87+
6188
Changing the PHP version is currently still somewhat cumbersome. A revised version will be available in the future.
6289

63-
- **Step 1:** Change the content of the file "php_version.txt" in "/home/container" to the version you want e.g. "8.3"
64-
![txt_file](https://github.com/Ym0T/pterodactyl-nginx-egg/assets/104158130/525c5681-8a3b-423e-a987-3668e8ceb4e3)
90+
- **Step 1:** In your Pterodactyl panel, go to the "Startup" tab on your web server. Change the variable "PHP VERSION" to the desired version.
6591

66-
- **Step 2:** In your Pterodactyl panel, go to the "Startup" tab on your web server. Change the variable "PHP VERSION" to the desired version.
67-
![variable](https://github.com/Ym0T/pterodactyl-nginx-egg/assets/104158130/84bbbf16-0c1d-4c4b-bac7-c84fb4550afa)
92+
![php_version](https://github.com/Ym0T/pterodactyl-nginx-egg/assets/104158130/cf76cf05-a3df-464a-8f86-77a69101bfc4)
6893

69-
- **Step 3:** Finally, you need to customise the Docker image. Select the appropriate Docker image to match the version.
70-
![docker_image](https://github.com/Ym0T/pterodactyl-nginx-egg/assets/104158130/cf76cf05-a3df-464a-8f86-77a69101bfc4)
94+
---
7195

96+
- **Step 2:** Finally, you need to customise the Docker image. Select the appropriate Docker image to match the version.
7297

98+
![docker_image](https://github.com/Ym0T/pterodactyl-nginx-egg/assets/104158130/cf76cf05-a3df-464a-8f86-77a69101bfc4)
7399

74-
- **Step 4:** Restart your container
100+
---
75101

102+
- **Step 3:** Restart your container.
76103

77104
## PHP extensions
105+
78106
PHP extensions of PHP version 8.3:
107+
79108
```bash
80109
Core, date, libxml, openssl, pcre, zlib, filter, hash, json, random, Reflection, SPL, session, standard, sodium, cgi-fcgi, mysqlnd, PDO, psr, xml, bcmath, calendar, ctype, curl, dom, mbstring, FFI, fileinfo, ftp, gd, gettext, gmp, iconv, igbinary, imagick, imap, intl, ldap, exif, memcache, mongodb, msgpack, mysqli, odbc, pcov, pdo_mysql, PDO_ODBC, pdo_pgsql, pdo_sqlite, pgsql, Phar, posix, ps, pspell, readline, shmop, SimpleXML, soap, sockets, sqlite3, sysvmsg, sysvsem, sysvshm, tokenizer, xmlreader, xmlwriter, xsl, zip, mailparse, memcached, inotify, maxminddb, protobuf, Zend OPcache
81110
```
82-
Small differences in the extensions between the PHP versions
111+
112+
Small differences in the extensions between the PHP versions.
83113

84114
## License
85-
[MIT](https://choosealicense.com/licenses/mit/)
115+
116+
[MIT License](https://choosealicense.com/licenses/mit/)
86117

87118
Originally forked and edited from https://gitlab.com/tenten8401/pterodactyl-nginx

0 commit comments

Comments
 (0)