Skip to content

Commit

Permalink
Merge pull request #938 from OfficeDev/xiaofhua/change-ngrok-to-dev-t…
Browse files Browse the repository at this point in the history
…unnel-in-readme

docs: use dev tunnel cli instead of ngrok
  • Loading branch information
XiaofuHuang authored Jul 11, 2023
2 parents fbc9c68 + 2af014b commit e3f5756
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 24 deletions.
15 changes: 9 additions & 6 deletions NPM-search-connector-M365/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,15 @@
```
teamsfx new template npm-search-connector-m365
```
1. For local env, install [ngrok](https://ngrok.com/download) and start your local tunnel service by running the command `ngrok http 3978`.
1. For local env, fill in the values for `BOT_DOMAIN` and `BOT_ENDPOINT` with your ngrok URL in the `env/.env.local` file.
```
BOT_DOMAIN=sample-id.ngrok.io
BOT_ENDPOINT=https://sample-id.ngrok.io
```
1. For local env, start your local tunnel service.
1. Install [dev tunnel cli](https://aka.ms/teamsfx-install-dev-tunnel).
1. Login with your M365 Account using the command `devtunnel user login`.
1. Start your local tunnel service by running the command `devtunnel host -p 3978 --protocol http --allow-anonymous`.
1. In the `env/.env.local` file, fill in the values for `BOT_DOMAIN` and `BOT_ENDPOINT` with your dev tunnel URL.
```
BOT_DOMAIN=sample-id-3978.devtunnels.ms
BOT_ENDPOINT=https://sample-id-3978.devtunnels.ms
```
1. Provision.
```
teamsfx provision --env <env>
Expand Down
16 changes: 8 additions & 8 deletions bot-sso/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@ This is a sample chatbot application demonstrating Single Sign-on using `botbuil
- From VS Code:
1. hit `F5` to start debugging. Alternatively open the `Run and Debug Activity` Panel and select `Debug (Edge)` or `Debug (Chrome)`.
- From TeamsFx CLI:
1. Install [ngrok](https://ngrok.com/download).
1. Sign up an ngrok account in https://dashboard.ngrok.com/signup. Copy your personal ngrok authtoken from https://dashboard.ngrok.com/get-started/your-authtoken.
1. Start your local tunnel service by running the command `ngrok http 3978 --authtoken=<your-personal-ngrok-authtoken>`.
1. In the `env/.env.local` file, fill in the values for `BOT_DOMAIN` and `BOT_ENDPOINT` with your ngrok URL.
```
BOT_DOMAIN=sample-id.ngrok.io
BOT_ENDPOINT=https://sample-id.ngrok.io
```
1. Install [dev tunnel cli](https://aka.ms/teamsfx-install-dev-tunnel).
1. Login with your M365 Account using the command `devtunnel user login`.
1. Start your local tunnel service by running the command `devtunnel host -p 3978 --protocol http --allow-anonymous`.
1. In the `env/.env.local` file, fill in the values for `BOT_DOMAIN` and `BOT_ENDPOINT` with your dev tunnel URL.
```
BOT_DOMAIN=sample-id-3978.devtunnels.ms
BOT_ENDPOINT=https://sample-id-3978.devtunnels.ms
```
1. Run command: `teamsfx provision --env local` .
1. Run command: `teamsfx deploy --env local` .
1. Run command: `teamsfx preview --env local` .
Expand Down
12 changes: 6 additions & 6 deletions command-bot-with-sso/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,13 @@ This is a simple command bot that implements single sign-on feature to retrieve
1. Press "F5" to open a browser window and then select your package to view contact exporter sample app.

- From TeamsFx CLI
1. Install [ngrok](https://ngrok.com/download).
1. Sign up an ngrok account in https://dashboard.ngrok.com/signup. Copy your personal ngrok authtoken from https://dashboard.ngrok.com/get-started/your-authtoken.
1. Start your local tunnel service by running the command `ngrok http 3978 --authtoken=<your-personal-ngrok-authtoken>`.
1. In the `env/.env.local` file, fill in the values for `BOT_DOMAIN` and `BOT_ENDPOINT` with your ngrok URL.
1. Install [dev tunnel cli](https://aka.ms/teamsfx-install-dev-tunnel).
1. Login with your M365 Account using the command `devtunnel user login`.
1. Start your local tunnel service by running the command `devtunnel host -p 3978 --protocol http --allow-anonymous`.
1. In the `env/.env.local` file, fill in the values for `BOT_DOMAIN` and `BOT_ENDPOINT` with your dev tunnel URL.
```
BOT_DOMAIN=sample-id.ngrok.io
BOT_ENDPOINT=https://sample-id.ngrok.io
BOT_DOMAIN=sample-id-3978.devtunnels.ms
BOT_ENDPOINT=https://sample-id-3978.devtunnels.ms
```
1. Run command: `teamsfx provision --env local` .
1. Run command: `teamsfx deploy --env local` .
Expand Down
10 changes: 6 additions & 4 deletions hello-world-bot-with-tab/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,13 @@ This is a simple "Hello World" application that has both Bot and Tab capabilitie
1. hit `F5` to start debugging. Alternatively open the `Run and Debug Activity` Panel and select `Debug (Edge)` or `Debug (Chrome)`.

- From TeamsFx CLI:
1. Install [ngrok](https://ngrok.com/download) and start your local tunnel service by running the command `ngrok http 3978`.
1. In the `env/.env.local` file, fill in the values for `BOT_DOMAIN` and `BOT_ENDPOINT` with your ngrok URL.
1. Install [dev tunnel cli](https://aka.ms/teamsfx-install-dev-tunnel).
1. Login with your M365 Account using the command `devtunnel user login`.
1. Start your local tunnel service by running the command `devtunnel host -p 3978 --protocol http --allow-anonymous`.
1. In the `env/.env.local` file, fill in the values for `BOT_DOMAIN` and `BOT_ENDPOINT` with your dev tunnel URL.
```
BOT_DOMAIN=sample-id.ngrok.io
BOT_ENDPOINT=https://sample-id.ngrok.io
BOT_DOMAIN=sample-id-3978.devtunnels.ms
BOT_ENDPOINT=https://sample-id-3978.devtunnels.ms
```
1. Run command: `teamsfx provision --env local` .
1. Run command: `teamsfx deploy --env local` .
Expand Down

0 comments on commit e3f5756

Please sign in to comment.