Added Cloudflared support

Author: Ym0T

Dockerfile

@@ -2,13 +2,27 @@ FROM debian:bookworm-slim
 
 LABEL author="Ym0t" maintainer="[email protected]"
 
-ARG PHP_VERSION="8.3"
+ARG PHP_VERSION
 
-ENV DEBIAN_FRONTEND noninteractive
+ENV DEBIAN_FRONTEND=noninteractive
 
-RUN apt-get update \
-    && apt-get upgrade -y \
-    && apt-get install -y git apt-transport-https lsb-release ca-certificates wget nginx \
+RUN apt-get update && apt-get install -y \
+        git \
+        apt-transport-https \
+        lsb-release \
+        ca-certificates \
+        wget \
+        nginx \
+    && ARCH=$(uname -m) \
+    && if [ "$ARCH" = "x86_64" ]; then \
+        wget -O /tmp/cloudflared.deb https://github.com/cloudflare/cloudflared/releases/latest/download/cloudflared-linux-amd64.deb; \
+    elif [ "$ARCH" = "aarch64" ]; then \
+        wget -O /tmp/cloudflared.deb https://github.com/cloudflare/cloudflared/releases/latest/download/cloudflared-linux-arm64.deb; \
+    else \
+        echo "Unsupported architecture: $ARCH" && exit 1; \
+    fi \
+    && dpkg -i /tmp/cloudflared.deb \
+    && rm /tmp/cloudflared.deb \
     && wget -O /etc/apt/trusted.gpg.d/php.gpg https://packages.sury.org/php/apt.gpg \
     && echo "deb https://packages.sury.org/php/ $(lsb_release -sc) main" | tee /etc/apt/sources.list.d/php.list \
     && apt-get update \
@@ -18,7 +32,7 @@ RUN apt-get update \
         php${PHP_VERSION}-cli \
         php${PHP_VERSION}-common \
         php${PHP_VERSION}-mysqlnd \
-        php${PHP_VERSION}-PDO \
+        php${PHP_VERSION}-pdo \
         php${PHP_VERSION}-sybase \
         php${PHP_VERSION}-psr \
         php${PHP_VERSION}-xml \
@@ -47,13 +61,13 @@ RUN apt-get update \
         php${PHP_VERSION}-odbc \
         php${PHP_VERSION}-pcov \
         php${PHP_VERSION}-pgsql \
-        php${PHP_VERSION}-Phar \
+        php${PHP_VERSION}-phar \
         php${PHP_VERSION}-posix \
         php${PHP_VERSION}-ps \
         php${PHP_VERSION}-pspell \
         php${PHP_VERSION}-readline \
         php${PHP_VERSION}-shmop \
-        php${PHP_VERSION}-SimpleXML \
+        php${PHP_VERSION}-simplexml \
         php${PHP_VERSION}-soap \
         php${PHP_VERSION}-sockets \
         php${PHP_VERSION}-sqlite3 \
@@ -70,18 +84,20 @@ RUN apt-get update \
         php${PHP_VERSION}-inotify \
         php${PHP_VERSION}-maxminddb \
         php${PHP_VERSION}-protobuf \
-        php${PHP_VERSION}-OPcache \
-    && apt-get purge -y --auto-remove \
+        php${PHP_VERSION}-opcache \
     && rm -rf /var/lib/apt/lists/*
 
-RUN useradd -m -d /home/container/ -s /bin/bash container
-ENV USER=container HOME=/home/container
+# Create user and set environment variables
+RUN useradd -m -d /home/container/ -s /bin/bash container \
+    && echo "USER=container" >> /etc/environment \
+    && echo "HOME=/home/container" >> /etc/environment
 
 WORKDIR /home/container
 
 STOPSIGNAL SIGINT
 
+# Copy entrypoint script
 COPY ./entrypoint.sh /entrypoint.sh
 RUN chmod +x /entrypoint.sh
 
-CMD /entrypoint.sh
+CMD ["/entrypoint.sh"]

README.md

@@ -1,10 +1,11 @@
 # Pterodactyl Nginx egg
 
 Nginx web server egg with PHP, optional Wordpress installation and git support.
-
+<br><br>
 ## Features
 
 #### Supports AMD64 & ARM64
+#### Cloudflared Tunnel support
 #### Git support for your webserver
 #### You can select the desired PHP version:
 - ✅ 8.4
@@ -14,7 +15,7 @@ Nginx web server egg with PHP, optional Wordpress installation and git support.
 - ☑️ 8.0 [EOL]
 
 [PHP supported versions](https://www.php.net/supported-versions.php)
-
+<br><br>
 ## How to install
 
 - **Step 1:** Download the egg (json file `egg-nginx.json`)
@@ -23,12 +24,58 @@ Nginx web server egg with PHP, optional Wordpress installation and git support.
 - **Step 4:** Create a new server and select the "Nginx" egg
 - **Step 5:** Select the corresponding Docker image with the desired PHP version
 - **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**.
+<br><br>
+## 🚀 Cloudflared Tunnel Tutorial  
+
+With **Cloudflared**, you can create a secure tunnel to your server, making it accessible over the internet **without** complicated port forwarding!  
+[Cloudflared | Create a remotely-managed tunnel](https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/get-started/create-remote-tunnel/)
+
+### 📌 Requirements  
+- A [Cloudflare](https://dash.cloudflare.com/) account  
+- A domain (optional but recommended)  
+
+---
+
+- 🔹 **Step 1: Log in to Zero Trust ↗ and go to Networks > Tunnel**  
+- 🔹 **Step 2: Select Create a tunnel.**  
+- 🔹 **Step 3: Choose Cloudflared for the connector type and select Next.**  
+- 🔹 **Step 4: Enter a name for your tunnel.**  
+- 🔹 **Step 5: Select Save tunnel.**  
+- 🔹 **Step 6: Save the token. (The token is very long)**
+  
+![grafik](https://github.com/user-attachments/assets/0c0430a5-5cb6-45e4-8b26-1805cddde3cc)
+
+
+---
+
+- 🔹 **Step 7: Activate Cloudflared**
+    
+![grafik](https://github.com/user-attachments/assets/726c5dad-7cb6-4537-a215-6aaec59d827a)
+
+
+---
+
+- 🔹 **Step 8: Add your token.**
+  
+![grafik](https://github.com/user-attachments/assets/46b09f6a-30b0-48aa-9980-53697b1fbcf6)
 
+
+---
+
+- 🔹 **Step 9: Restart your webserver.**
+  
+![grafik](https://github.com/user-attachments/assets/84fb9b6c-10cd-4bd3-86ae-e725e7145e8d)
+
+---
+
+✅ You have successfully set up Cloudflared and connected it to your server!
+<br><br>
 ## FAQ
 
+
 #### In which folder do I upload my files for my site?
 The "www" folder is used as a public folder. There you can add your PHP, HTML, CSS, JS and so on files that are required for the public or for the operation of the site.
-
+<br><br>
 ## How do I use Git support?
 
 #### Instructions for Git support
@@ -83,7 +130,7 @@ Furthermore, if not already done, adjust to your domain:
 ```bash
 server_name www.example.com;
 ```
-
+<br><br>
 ## Change PHP version
 
 Changing the PHP version is currently still somewhat cumbersome. A revised version will be available in the future.
@@ -101,7 +148,7 @@ Changing the PHP version is currently still somewhat cumbersome. A revised versi
 ---
 
 - **Step 3:** Restart your container.
-
+<br><br>
 ## PHP extensions
 
 PHP extensions of PHP version 8.3:
@@ -111,7 +158,7 @@ Core, date, libxml, openssl, pcre, zlib, filter, hash, json, random, Reflection,
 ```
 
 Small differences in the extensions between the PHP versions.
-
+<br><br>
 ## License
 
 [MIT License](https://choosealicense.com/licenses/mit/)

cloudflared.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+
+# [Tunnel] Check if cloudflared_token.txt exists and has content
+if [ -s "/home/container/cloudflared_token.txt" ]; then
+    # If the file has content, start cloudflared using the content as the token
+    echo "[Tunnel] Starting cloudflared tunnel with token"
+    cloudflared tunnel --no-autoupdate run --token "$(cat /home/container/cloudflared_token.txt)" > /dev/null 2>&1 &
+
+    # Wait for the tunnel to start
+    echo "[Tunnel] Waiting for cloudflared tunnel to start..."
+    
+    # Set max number of attempts
+    MAX_ATTEMPTS=10
+    ATTEMPT=0
+
+    # Check if cloudflared is running, repeat every 1 second until it is or max attempts reached
+    while ! pgrep -x "cloudflared" > /dev/null && [ $ATTEMPT -lt $MAX_ATTEMPTS ]; do
+        ATTEMPT=$((ATTEMPT + 1))
+        sleep 1
+    done
+
+    # If cloudflared is running
+    if pgrep -x "cloudflared" > /dev/null; then
+        # Green success message
+        echo -e "[Tunnel]\033[0;32m Cloudflared tunnel is running successfully.\033[0m"
+    else
+        echo -e "[Tunnel]\033[0;31m Failed to start cloudflared tunnel after $MAX_ATTEMPTS attempts. Exiting...\033[0m"
+        exit 1
+    fi
+
+else
+    echo "[Tunnel]\033[0;31m cloudflared_token.txt is empty or does not exist. Skipping cloudflared startup.\033[0m"
+fi