MoxieDOCS
INSPECTOR
moxie/unmoxed

Unmoxed & tunnels

Unmoxed exposes your local Moxie instance through a public URL so mobile apps, webhooks, or partners can hit your machine without deploying.

When you need it

  • Testing integrations that require a public HTTPS URL.
  • Sharing a branch with QA or product before merge.
  • Pointing clients at local behavior while still using dev/stage/prod data (yarn dev, yarn dev:stage, etc.).

fn-moxie-api side

Variable Purpose
UNMOXED Enable unmoxed / tunnel behavior in local dev.
UNMOXED_SERVER Tunnel broker URL. Default is the shared dev host; set to http://localhost:3099 (or your server) to use a local unmoxed-server.
UNMOXED_TOKEN Bearer token when the server enforces JWT (optional for local servers without JWT_SECRET).

Run with tunnel:

yarn dev:tunnel

Requires a valid .env (see repo .env.example) with unmoxed_token when the remote server requires it.

unmoxed-server

The tunnel broker is a separate Node service (e.g. repo unmoxed-server). Typical local flow:

  1. Start unmoxed-server on a port (e.g. 3099).
  2. Set UNMOXED_SERVER=http://localhost:3099 (and UNMOXED, token if needed).
  3. Start Moxie with yarn dev:tunnel.

Documentation URL

These docs live at moxiedocs.foxnews.com, on the Fox custom domain (Okta-gated for the Fox network) and deployed with GitHub Actions from the static output under docs/dist (not a separate gh-pages build step).

CI on the pages branch runs bash build.sh (Astro/Starlight site plus Inspector merged into docs/dist/) and publishes with actions/deploy-pages — see .github/workflows/github-pages.yaml. The repo’s Settings → Pages source should be GitHub Actions if a maintainer has enabled it.

edit this page