Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
bupt_rain committed Dec 13, 2024
1 parent 5c4f759 commit 25e6d5b
Show file tree
Hide file tree
Showing 2 changed files with 128 additions and 0 deletions.
65 changes: 65 additions & 0 deletions docs/index-en.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Typebot Community Edition Quick Deployment

> **Disclaimer:** This service is provided by a third party. We strive to ensure its safety, accuracy, and reliability, but cannot guarantee it is entirely free of faults, interruptions, errors, or attacks. Therefore, our company hereby states that we make no representations, warranties, or commitments regarding the content, accuracy, completeness, reliability, applicability, or timeliness of this service, and shall not be liable for any direct or indirect loss or damage arising from your use of this service; regarding third-party websites, applications, products, and services accessed through this service, we are not responsible for their content, accuracy, completeness, reliability, applicability, or timeliness, and you should bear the risks and responsibilities resulting from the use; we will not be liable for any losses or damages arising from your use of this service, including but not limited to direct losses, indirect losses, loss of profits, loss of goodwill, loss of data, or other economic losses, even if the company was previously notified of the possibility of such losses or damages; we reserve the right to modify this disclaimer from time to time, so please check this disclaimer regularly before using this service. If you have any questions or concerns about this disclaimer or this service, please contact us.

## Overview

Typebot is an fair source chatbot builder. It allows you to create conversational apps/forms (Lead qualification, Customer support, Product launch, User onboarding, AI chats), deploy it on your website or WhatsApp number, and collect results in real-time.You can create your own customized chatbot by configuring OpenAI's API key.



## Prerequisites

Deploying the Maybe community edition service instance requires access to and the creation of certain Alibaba Cloud resources. Therefore, your account needs to contain permissions for the following resources.
**Note:** This permission is only required when your account is a RAM account.

| Permission Policy Name | Remarks |
|-----------------------------------------------|-----------------------------------------------------|
| AliyunECSFullAccess | Permission to manage cloud server services (ECS) |
| AliyunVPCFullAccess | Permission to manage Virtual Private Cloud (VPC) |
| AliyunROSFullAccess | Permission to manage Resource Orchestration Service (ROS) |
| AliyunComputeNestUserFullAccess | Permission to manage the user side of ComputeNest |

## Billing Instructions

The costs associated with deploying the community edition in ComputeNest mainly involve:
+ The selected vCPU and memory specifications
+ The type and capacity of the system disk
+ Public network bandwidth

## Deployment Architecture

![](./img-en/deploy.png)

## Parameter Description

| Parameter Group | Parameter Item | Description |
|-----------------------------------------------|---------------------------------------------------|-----------------------------------------------------|
| Service Instance | Service Instance Name | Length not exceeding 64 characters, must start with a letter, can contain numbers, letters, hyphens (-), and underscores (_) |
| | Region | The region in which the service instance is deployed |
| | Payment Type | The billing type of the resource: pay-as-you-go or subscription |
| ECS Instance Configuration | Instance Type | Instance specifications available in the availability zone |
| | Instance Password | Length 8-30, must include three items (uppercase letters, lowercase letters, numbers, or special symbols from the set ()`~!@#$%^&*-+=|{}[]:;'<>,.?/) |
| Network Configuration | Availability Zone | The availability zone where the ECS instance is located |
| | VPC ID | The VPC where the resource is located |
| | Switch ID | The switch where the resource is located |

## Deployment Process

1. Visit Compute Nest [Deployment Link](https://computenest.console.aliyun.com/service/instance/create/default?type=user&ServiceName=Typebot%E7%A4%BE%E5%8C%BA%E7%89%88) and fill in the deployment parameters as prompted.
2. Fill in the instance parameters ![](./img-en/param1.png)
3. Choose to create a new dedicated network or directly use an existing dedicated network based on your needs. Fill in the availability zone and network parameters,
4. If you need to use GitHub OAuth login, you can enter your Client ID and Secret here![](./img-en/param3.png). For more detailed information, please refer to the [GitHub Developer Documentation](https://github.com/settings/developers)
. Then click "Next: Confirm Order"![](./img-en/param2.png)
5. Click "Create Now" and wait for the service instance to be deployed![](./img-en/param4.png)
6. Once the service instance is deployed, click on the instance ID to access the details page![](./img-en/serviceInstance2.png)
7. Access the service instance's usage URL![](./img-en/serviceInstance3.png)
8. The application provides two ports: one for the chatbot usage interface (ending with port 8081) and one for the chatbot building interface (ending with port 8080).
9. Let's first enter the building interface to start creating your chatbot. Log in with your Alibaba Cloud account![](./img-en/app1.png)
10. After logging in, you can create a chatbot![](./img-en/app2.png)
11. You can create a chatbot using one of these three methods. Here, we select the first template to create one. ![](./img-en/app3.png)
12. Then, select the first sample template![](./img-en/app4.png)
13. Click the "Publish" button in the upper right corner to publish. ![](./img-en/app5.png)
14. Copy the access link for the chatbot and paste it into your browser to access it. ![](./img-en/app6.png)
15. You can now chat with your chatbot! ![](./img-en/app7.png)

63 changes: 63 additions & 0 deletions docs/index.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Typebot计算巢快速部署

>**免责声明：**本服务由第三方提供，我们尽力确保其安全性、准确性和可靠性，但无法保证其完全免于故障、中断、错误或攻击。因此，本公司在此声明：对于本服务的内容、准确性、完整性、可靠性、适用性以及及时性不作任何陈述、保证或承诺，不对您使用本服务所产生的任何直接或间接的损失或损害承担任何责任；对于您通过本服务访问的第三方网站、应用程序、产品和服务，不对其内容、准确性、完整性、可靠性、适用性以及及时性承担任何责任，您应自行承担使用后果产生的风险和责任；对于因您使用本服务而产生的任何损失、损害，包括但不限于直接损失、间接损失、利润损失、商誉损失、数据损失或其他经济损失，不承担任何责任，即使本公司事先已被告知可能存在此类损失或损害的可能性；我们保留不时修改本声明的权利，因此请您在使用本服务前定期检查本声明。如果您对本声明或本服务存在任何问题或疑问，请联系我们。

## 概述
Typebot：Typebot 是一个公平开源的聊天机器人构建器。它允许您创建对话式应用/表单（如潜在客户资格认证、客户支持、产品发布、用户引导、AI 聊天），并将其部署到您的网站或 WhatsApp 号码上，同时实时收集结果。
可在几分钟内快速创建出一个你的Gpt助手



## 前提条件
<font style="color:rgb(51, 51, 51);">部署Typebot社区版服务实例，需要对部分阿里云资源进行访问和创建操作。因此您的账号需要包含如下资源的权限。</font><font style="color:rgb(51, 51, 51);"> </font>**<font style="color:rgb(51, 51, 51);">说明</font>**<font style="color:rgb(51, 51, 51);">：当您的账号是RAM账号时，才需要添加此权限。</font>

| <font style="color:rgb(51, 51, 51);">权限策略名称</font> | <font style="color:rgb(51, 51, 51);">备注</font> |
| --- | --- |
| <font style="color:rgb(51, 51, 51);">AliyunECSFullAccess</font> | <font style="color:rgb(51, 51, 51);">管理云服务器服务（ECS）的权限</font> |
| <font style="color:rgb(51, 51, 51);">AliyunVPCFullAccess</font> | <font style="color:rgb(51, 51, 51);">管理专有网络（VPC）的权限</font> |
| <font style="color:rgb(51, 51, 51);">AliyunROSFullAccess</font> | <font style="color:rgb(51, 51, 51);">管理资源编排服务（ROS）的权限</font> |
| <font style="color:rgb(51, 51, 51);">AliyunComputeNestUserFullAccess</font> | <font style="color:rgb(51, 51, 51);">管理计算巢服务（ComputeNest）的用户侧权限</font> |


## 计费说明
<font style="color:rgb(51, 51, 51);"> 社区版在计算巢部署的费用主要涉及：</font>

+ <font style="color:rgb(51, 51, 51);">所选vCPU与内存规格</font>
+ <font style="color:rgb(51, 51, 51);">系统盘类型及容量</font>
+ <font style="color:rgb(51, 51, 51);">公网带宽</font>

## 部署架构
![](./img/deploy.png)



## 参数说明
| <font style="color:rgb(51, 51, 51);">参数组</font> | <font style="color:rgb(51, 51, 51);">参数项</font> | <font style="color:rgb(51, 51, 51);">说明</font> |
| --- | --- | --- |
| <font style="color:rgb(51, 51, 51);">服务实例</font> | <font style="color:rgb(51, 51, 51);">服务实例名称</font> | <font style="color:rgb(51, 51, 51);">长度不超过64个字符，必须以英文字母开头，可包含数字、英文字母、短划线（-）和下划线（_）</font> |
| | <font style="color:rgb(51, 51, 51);">地域</font> | <font style="color:rgb(51, 51, 51);">服务实例部署的地域</font> |
| | <font style="color:rgb(51, 51, 51);">付费类型</font> | <font style="color:rgb(51, 51, 51);">资源的计费类型：按量付费和包年包月</font> |
| <font style="color:rgb(51, 51, 51);">ECS实例配置</font> | <font style="color:rgb(51, 51, 51);">实例类型</font> | <font style="color:rgb(51, 51, 51);">可用区下可以使用的实例规格</font> |
| | <font style="color:rgb(51, 51, 51);">实例密码</font> | <font style="color:rgb(51, 51, 51);">长度8-30，必须包含三项（大写字母、小写字母、数字、 ()`~!@#$%^&*-+=|{}[]:;'<>,.?/ 中的特殊符号）</font> |
| <font style="color:rgb(51, 51, 51);">网络配置</font> | <font style="color:rgb(51, 51, 51);">可用区</font> | <font style="color:rgb(51, 51, 51);">ECS实例所在可用区</font> |
| | <font style="color:rgb(51, 51, 51);">VPC ID</font> | <font style="color:rgb(51, 51, 51);">资源所在VPC</font> |
| | <font style="color:rgb(51, 51, 51);">交换机ID</font> | <font style="color:rgb(51, 51, 51);">资源所在交换机</font> |


## 部署流程
1. 访问计算巢 [部署链接](https://computenest.console.aliyun.com/service/instance/create/default?type=user&ServiceName=Typebot%E7%A4%BE%E5%8C%BA%E7%89%88)，按提示填写部署参数
2. 填写实例参数![](./img/param1.png)
3. 根据需求选择新建专用网络或直接使用已有的专有网络。填写可用区和网络参数![](./img/param2.png)
4. 如果你需要使用GitHub的OAuth登录，则可以在此处填写你的Client和Secret，更多详细信息可以查阅GitHub的[开发者设置](https://github.com/settings/developers)![](./img/param3.png)。点击“下一步：确认订单”
4. 点击立即创建，等待服务实例部署完成![](./img/param4.png)
5. 服务实例部署完成后，点击实例ID进入到详情界面![](./img/serviceInstance2.png)
6. 访问服务实例的使用URL![](./img/serviceInstance3.png)
7. 该应用提供了两个端口一个是机器人使用界面-以8081端口结尾，一个是机器人构建界面，以8080端口结尾。
8. 让我们先进入到构建界面，开始创建你的机器人吧，首先通过阿里云账号登录![](./img/app1.png)
9. 登录进来后可以创建机器人![](./img/app2.png)
10. 我们可以通过这三种方式创建机器人，这里选择第一个模版创建。![](./img/app3.png)
11. 然后选择第一个示例模版![](./img/app4.png)
12. 点击右上角的Publish按钮发布。![](./img/app5.png)
13. 复制该机器人的访问链接并粘贴到浏览器中访问。![](./img/app6.png)
13. 就可以和你的机器人对话了。![](./img/app7.png)

0 comments on commit 25e6d5b

Please sign in to comment.