Feature: ngrok key is optional now

Author: chunix64

.github/workflows/ssh.yml

@@ -17,7 +17,7 @@ on:
           - '5h45m'
       NGROK_AUTH_TOKEN:
         description: 'ngrok API auth token'
-        required: true
+        required: false
         default: ''
       SWAP_SIZE:
         description: 'add Swap/virtual RAM in GBs'
@@ -43,6 +43,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Prepare variables
+        id: prepare
         env:
           NGROK_TOKEN: ${{ secrets.NGROK_AUTH_TOKEN }}
         run: |
@@ -53,6 +54,12 @@ jobs:
           fi
           echo NGROK_TOKEN=$NGROK_TOKEN >> $GITHUB_ENV
 
+          if [ -n "$NGROK_TOKEN" ] && [ "$NGROK_TOKEN" != "null" ]; then
+            echo "ngrok_token_not_empty=true" >> $GITHUB_OUTPUT
+          else
+            echo "ngrok_token_not_empty=false" >> $GITHUB_OUTPUT
+          fi
+
       - name: Clean-up
         if: ${{ github.event.inputs.START_CLEAN_UP == 'true' }}
         uses: rokibhasansagar/slimhub_actions@main
@@ -64,7 +71,9 @@ jobs:
           swap-size-gb: ${{ github.event.inputs.SWAP_SIZE }}
 
       - name: Install ngrok
+        if: ${{ steps.prepare.outputs.ngrok_token_not_empty == 'true' }}
         run: |
+          echo "test: $NGROK_TOKEN"
           curl -s https://ngrok-agent.s3.amazonaws.com/ngrok.asc | sudo tee /etc/apt/trusted.gpg.d/ngrok.asc >/dev/null
           echo "deb https://ngrok-agent.s3.amazonaws.com buster main" | sudo tee /etc/apt/sources.list.d/ngrok.list
           sudo apt update && sudo apt install -y ngrok
@@ -116,6 +125,7 @@ jobs:
 
 
       - name: Start ngrok
+        if: ${{ steps.prepare.outputs.ngrok_token_not_empty == 'true' }}
         run: |
           chmod +x gen_ngrok_config.sh
           ./gen_ngrok_config.sh "$NGROK_TOKEN"
@@ -146,4 +156,5 @@ jobs:
             5h45m) SLEEP_TIME=$((5 * 3600 + 45 * 60)) ;;
           esac
           echo "⏳ Keeping SSH session alive for $RAW_TIME ($SLEEP_TIME seconds)"
+          echo "🔗 Updates available at: https://github.com/chunix64/github-action-ssh"
           sleep "$SLEEP_TIME" || true

README.md

@@ -1,15 +1,15 @@
 # 🚀 Ubuntu Linux SSH via ngrok GitHub Action
 
-This GitHub Action sets up an Ubuntu Linux environment with SSH access tunneled through **ngrok**, optionally serving files with **miniserve**, cleaning up disk space, and adding swap memory.
+This GitHub Action sets up an Ubuntu Linux environment with SSH access tunneled through **ngrok**, **cloudflared**, serving files with **miniserve**, cleaning up disk space, and adding swap memory.
 
 ---
 
 ## ⚙️ Features
 
-- 🔐 Secure SSH access via ngrok TCP tunnel  
+- 📡 SSH access via ngrok and cloudflared tunnel 
 - 🌐 Optional HTTP file server with miniserve  
 - 🧹 Optional disk cleanup to free up space (~27GB → 68GB)  
-- 💾 Optional swap/virtual RAM extension (default: 4GB → 24GB)  
+- 💾 Optional swap/virtual RAM extension
 - ⏳ SSH session auto-kept alive up to 6 hours  
 
 ---
@@ -22,7 +22,7 @@ This GitHub Action sets up an Ubuntu Linux environment with SSH access tunneled
 | `NGROK_AUTH_TOKEN`  | String  | —       | Your ngrok API auth token (required)            |
 | `START_MINISERVE`   | Boolean | true    | Enable HTTP file server for file sharing        |
 | `START_CLEAN_UP`    | Boolean | true    | Run disk cleanup to free space (~4 min runtime) |
-| `SWAP_SPACE`        | String  | 20      | Add swap space / virtual RAM in GBs             |
+| `SWAP_SPACE`        | String  | 16      | Add swap space / virtual RAM in GBs             |
 
 ---
 
@@ -40,7 +40,7 @@ This GitHub Action sets up an Ubuntu Linux environment with SSH access tunneled
 TUNNEL: <url>
 ```
 
-4. Connect via SSH or use miniserve for file sharing.
+5. Connect via SSH or use miniserve for file sharing.
 
 ---
 
@@ -60,6 +60,8 @@ TUNNEL: <url>
 - You can cancel the workflow anytime, but SSH session ends when the runner stops.  
 - `START_MINISERVE` serves your entire filesystem (beware of sensitive data).  
 - Requires a valid ngrok auth token to create tunnels.  
+- Why 5h45m instead of 6h? 
+  Answer: The server is terminated before GitHub does, ensuring the workflow completes successfully and normalizes GitHub activity.
 
 ---
 
@@ -69,7 +71,7 @@ TUNNEL: <url>
 ---
 
 ## 📝Todos
-- Support Cloudflared and other tunnels
+- Support Cloudflared and other tunnels (Done: 50%)
 - Support terminal/SSH over web, especially mobile
 - Support macOS and Windows SSH
 - Add more documentation