Echo bot template

Background

This echo bot is for development purpose only. Please review the architecture and code before moving to production, some areas:

• Token server should be isolated, secured, and throttled appropriately
• trustedOrigin.js is set up to enable multiple sandbox domains
• Direct Line token generated have limited trusted origin and may not work in your OAuth scenario

Setup

1. Create a new Azure Web App
2. Generate a new repository
3. Testing the bot

Azure Web Apps

Create a new Azure Web Apps

Navigate to https://ms.portal.azure.com/#create/Microsoft.WebSite and start creating a new Azure Web App.

• Publish: Code
• Runtime stack: Node.js 18
• Operating System: Windows

Update general settings

• Stack: Node
• Basic Auth Publishing Credentials: On (for publishing via GitHub Actions)
• Web sockets: On
• (Optional) FTP state: Disabled
• (Optional) Platform: 64 Bit
• (Optional) Session affinity: Off

Merge application settings

Update the application settings JSON below and merge it into your Azure Web App.

Required

[
  {
    "name": "DIRECTLINE_EXTENSION_VERSION",
    "value": "latest",
    "slotSetting": false
  },
  {
    "name": "DirectLineExtensionKey",
    "value": "",
    "slotSetting": false
  },
  {
    "name": "MicrosoftAppId",
    "value": "",
    "slotSetting": false
  },
  {
    "name": "MicrosoftAppPassword",
    "value": "",
    "slotSetting": false
  },
  {
    "name": "WEBSITE_RUN_FROM_PACKAGE",
    "value": "1",
    "slotSetting": false
  }
]

Optional

[
  {
    "name": "DIRECT_LINE_SECRET",
    "value": "",
    "slotSetting": false
  },
  {
    "name": "SPEECH_SERVICES_REGION",
    "value": "",
    "slotSetting": false
  }
]

Generate a new GitHub repository

If you already deployed your Azure Web App before merging application settings, you will need to deploy from GitHub Actions again.

Build a new repository by navigate to https://github.com/compulim/botframework-echobot-template/generate.

Add new secret PUBLISH_PROFILE

Go to Settings > Secrets and variables > Actions, add a new secret PUBLISH_PROFILE and paste the content of the publish profile XML. Also, add a new variable AZURE_WEB_APP_NAME and put the web app name (without .azurewebsites.net).

The content is from the *.PublishSettings file from your Azure Web App. Steps at https://docs.microsoft.com/en-us/visualstudio/deployment/tutorial-import-publish-settings-azure?view=vs-2019#create-the-publish-settings-file-in-azure-app-service.

Restart the first GitHub Actions workflow

Shortly after you generated the repository, a workflow named "Initial commit" will be started.

Since the PUBLISH_PROFILE was not set when the workflow is started, the deploy step will fail.

After you added PUBLISH_PROFILE, please re-run the "Initial commit" workflow and it should succeed.

Testing the bot

Test the Direct Line App Service Extension endpoint

Navigate to https://yourbot.azurewebsites.net/.bot/ (with trailing slash). It should return a JSON with ib, k, and ob set to true.

Test via Direct Line

Navigate to https://compulim.github.io/webchat-loader.

1. Protocol: Direct Line via Web Socket
2. Secret: https://yourbot.azurewebsites.net/api/token/directline
3. Click "Fetch token"
4. Click "Open Web Chat in a new window"

Test via Direct Line App Service Extension

Navigate to https://compulim.github.io/webchat-loader.

1. Protocol: Direct Line App Service Extension
2. In the box below protocol: yourbot.azurewebsites.net
3. Secret: https://yourbot.azurewebsites.net/api/token/directlinease
4. Click "Fetch token"
5. Click "Open Web Chat in a new window"