Local VR Server Guide

How to host your local VS Code project to external devices (Meta Quest, Mobile) using HTTPS.

01

Installation

A. Install Prerequisites (Homebrew)

We use Homebrew to install tools on Mac. If you don't have it, paste this into Terminal:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

B. Install Ngrok

Once Homebrew is ready, run this command:

brew install ngrok

A. Prerequisites

On Windows 10/11, we can use the built-in Terminal (PowerShell) and Winget.

Search for "Terminal" or "PowerShell" in your Start Menu and open it.

B. Install Ngrok

Paste this command into PowerShell:

winget install Ngrok.Ngrok

Note: If prompted, press 'Y' to agree to terms.

C. Connect Account (Required)

Ngrok requires a free account to work.

  1. Go to dashboard.ngrok.com/signup and sign up.
  2. Verify your email if asked.
  3. In the dashboard sidebar, click Your Authtoken.
  4. Copy the code and run this command in your Terminal:
ngrok config add-authtoken YOUR_TOKEN_HERE
02

The Workflow

Do this every time you want to test on the headset.

💻

1. Start VS Code Server

Open your project and click "Go Live" in the bottom right corner.

👀

2. Check the Port

Look at the bottom right. Usually 5500, but check!

🚀

3. Run the Tunnel

Open Terminal/PowerShell and run:

ngrok http 5500
🔗

4. Get the HTTPS Link

Copy the line ending in .ngrok-free.app.

⚠️ VR Mode ONLY works with the HTTPS link.

03

How to Stop

Stop ngrok

Click inside the Terminal window and press Ctrl + C.

Stop VS Code

Click the "Port: 5500" button in VS Code to turn it off.

?

Troubleshooting

Error: "ERR_NGROK_4018" or "Auth failed"

You missed Step 1C. You must run the `config add-authtoken` command with your unique key from the website.

VR Button doesn't work

You are likely using `http://`. You MUST use `https://`.

Windows: "ngrok is not recognized"

Try restarting your PowerShell window after installing. If that fails, try installing via the ZIP download on the ngrok website.