botbook/book/chapter-07-administration.md

52 lines
3.8 KiB
Markdown
Raw Normal View History

2019-03-01 15:34:29 -03:00
# General Bots Administration
## Commands
General Bot can be controlled by the same chat window people talk to, so
here is a list of admin commands related to deploying .gb* files.
| Command | Description |
|-----------------|-----------------------------------------------------------------------------------------------------------------|
| deployPackage | Deploy a KB package. Usage **deployPackage** [package-name]. Then, you need to run rebuildIndex. |
| undeployPackage | Undeploy a KB. Usage **undeployPackage** [package-name]. |
| redeployPackage | Undeploy and then deploys the KB. Usage **redeployPackage** [package-name]. Then, you need to run rebuildIndex. |
| setupSecurity | Setup connection to user directories. |
2019-07-18 18:30:05 -03:00
| syncBotServer | Updates the cloud with the latest version from GitHub BotServer repository. |
| rebuildIndex | Rebuild Azure Search indexes, must be run after **deployPackage** or **redeployPackage**. | Now it is called automatically |
2020-05-23 10:25:30 -03:00
| /publish [package] | Deploy the package to the bot storage. When ommited, the command will publish the package named <botId>.gbkb by default. |
2019-03-01 15:34:29 -03:00
2019-03-04 13:05:33 -03:00
## Enviroment Variables Reference
| Name | Sample Value | Description |
|------------------------|--------------------------------------------------|-------------|
2020-01-09 15:17:01 -03:00
| ADDITIONAL_DEPLOY_PATH | D:\data\gbai | Deploy folder to look for packages (Just one folder).
2019-03-04 13:05:33 -03:00
| ADMIN_PASS | E732+!#xJ3a_*! | Administration password for the conversational interface.
| CLOUD_SUBSCRIPTIONID | 622e5037-f7f1-49f6-a9c4-28babbb0fs | Cloud subscription ID used to deploy new bots.
| CLOUD_LOCATION | westus | Cloud location used to deploy new bots.
| CLOUD_GROUP | newassistant | Cloud group used to deploy new bots.
| CLOUD_USERNAME | someone@domain | Cloud username used to deploy new bots.
2020-01-09 15:17:01 -03:00
| CLOUD_PASSWORD | <use a password generator> | Cloud password used to deploy new bots.
2019-03-04 13:05:33 -03:00
| MARKETPLACE_ID | 9c90ff1c3-101b-4f0d-85cd-4bada2226fe3 | Martplace identifier associated to the boot bot.
| MARKETPLACE_SECRET | nzrNUUG6214%raqzYWQ8(+% | Martplace password associated to the boot bot.
| NLP_AUTHORING_KEY | 0aa343b06d044b66a2159abf080ff1c3 | The key from NLP service allowing creating of bot NLP libraries.
| STORAGE_DIALECT | mssql | The bot database dialect configuration value. Can be MSSQL or SQLITE.
| STORAGE_SERVER | newassistant-storage-server.database.windows.net | The bot database server name configuration value.
2020-10-24 13:05:19 -03:00
| STORAGE_NAME | newassistant-storage | The bot database name configuration value.
2019-03-04 13:05:33 -03:00
| STORAGE_USERNAME | sahaaksfqiehke | The bot database security username configuration value.
2020-01-09 15:17:01 -03:00
| STORAGE_PASSWORD | <use a password generator> | The bot database security password configuration value.
2019-03-04 13:05:33 -03:00
| STORAGE_SYNC | true | If the bot server should sync database before running.
2020-10-24 13:05:19 -03:00
| PRIVACY MESSAGES | true | If the bot server should store message logs in the database
2019-03-04 13:05:33 -03:00
2019-03-01 15:34:29 -03:00
## How to
### Move to production (Azure)
* Update bot endpoint;
## Bot Analytics
2019-03-04 13:05:33 -03:00
## Cloud Internals