Skip to content
Preview setup

These instructions have been reviewed, but the setup has not yet been tested from start to finish. See compatibility.

ngrok ​

Use ngrok for a public HTTPS MCP address on your account's assigned domain. You need your ngrok agent authtoken and the domain assigned to your account.

Before you start ​

Sign in to your ngrok account. Obtain the account's assigned development domain and an agent authtoken. This flow does not require an ngrok API key as a second credential. The free plan provides an assigned domain and usage quotas; inspect current limits before choosing it. A running route needs a running host and app.

Save and connect ​

  1. Open the local owner interface: Remote access → Set up remote access.
  2. Choose A public MCP endpoint for an AI client, then ngrok — assigned public domain.
  3. Enter Saved HTTPS hostname, for example https://your-assigned-name.ngrok-free.app, with no path, query or token. Paste the agent authtoken into Provider token in this local form.
  4. Leave browser access off for MCP only, then choose Save and connect. For browser access, set the separate owner password first using Phone access.
  5. Copy Saved MCP endpoint; it includes /mcp. Create a separate My WhatsApp credential for each AI client, with the intended chats/dates and expiry.

The provider authtoken is stored privately. On a saved provider, leaving its token field empty retains the current credential. Do not paste either provider or MCP tokens into a URL, command argument or diagnostic report.

Verify both kinds of traffic ​

From another device, check your connection with the AI client you plan to use. Confirm an actual search result, rather than relying on the provider's connection indicator.

ngrok documents an HTML warning page on the free tier and distinguishes API traffic. A browser may show Visit before the app login. Phone behavior has not yet been tested. The warning page does not replace the owner password.

Keep the same volume and saved domain after reconnect, app restart and container recreation. Verify exact URL equality. If the provider reports a different address, the app refuses it; migrate explicitly instead.

Recover and retire ​

Check account quotas, token validity and domain assignment when connection fails. Refresh the provider credential locally if revoked, reconnect to the same domain, and verify that local keyword search still works during the outage. Live-provider recovery tests are still pending.

Choose Disable remote access to stop while preserving setup. For retirement, revoke app client credentials, disable access, confirm Remove saved provider, remove the endpoint/revoke the unused agent authtoken in your ngrok dashboard, and remove client settings. Preserve the archive volume and remote owner password unless you separately intend to change them. Use the explicit migration control for another domain/account.

Save this guide

Download or copy this page as Markdown for offline use.

View MarkdownDownload Markdown

My WhatsApp · Self-hosted WhatsApp archive