Install the Tunneling plugin

Install the Tunneling plugin to add Sitecore CLI commands that let you create a Ngrok tunnel to your local headless application, and register it as the editing host for a website running in a SitecoreAI environment.

Note

If you are using JSS v. 22.1 or higher, and connect to visual editors using the metadata method, you don't need to configure tunneling.

Before you begin the installation, you must meet the following prerequisites:

  • Check you have Sitecore CLI version 5.1.25 or later. If you're using a previous version, upgrade to version 5.1.25 or a later version.

  • Ensure Ngrok agent and the Sitecore CLI are installed on the same local environment.

To install the Tunneling plugin:

  1. In the directory of your Sitecore project, run the following command:

    RequestResponse
    dotnet sitecore plugin add -n Sitecore.DevEx.Extensibility.Tunneling 
  2. When the script completes, run the following command to verify the installation:

    RequestResponse
    dotnet sitecore tunnel -h

    If the installation succeeds, the command displays a list of Tunneling plugin commands.

Do you have some feedback for us?

If you have suggestions for improving this article,