ADP-Chat-Client
Deploy

CVM

Learn how to deploy and run adp-chat-client on Tencent Cloud CVM (Cloud Virtual Machine).

Tencent Cloud CVM (Cloud Virtual Machine) is an efficient and scalable cloud server service provided by Tencent Cloud, designed to help users quickly build, deploy, and manage cloud applications. With Tencent Cloud CVM, you can easily create and manage virtual machine instances and deploy web services.

This guide demonstrates how to deploy adp-chat-client to the cloud, allowing others to access and interact with your intelligent agent application via URL.

English

Prerequisites

Before you begin, make sure you have:

Steps

Initialize CVM Service

1. Purchase and Configure CVM Instance

Go to the Cloud Server purchase page to purchase a CVM. On the Custom Configuration page, select the following options based on your needs:

  • Billing Mode (Monthly subscription, pay-as-you-go, or spot instances)
  • Region (Choose the data center location)
  • Instance Configuration (e.g., Standard, Memory-optimized)
  • Image (Choose your operating system, such as Windows or TencentOS)

For detailed configuration options, refer to:

2. Log in to CVM Instance

After the CVM instance is successfully created, log in using an SSH connection tool.

Tip: For Linux users, we recommend using SSH to access the CVM instance. For Windows users, you can use Remote Desktop Protocol (RDP) or PowerShell to log in to the CVM instance.

After logging in, you can install dependencies and deploy adp-chat-client just like on a local machine.

Deploy Service

Once your CVM is up and running, refer to Quick Start to initialize the environment, configure the .env file, and deploy and run adp-chat-client.

Follow these steps to deploy and run adp-chat-client. For detailed instructions, refer to Quick Start.

1. Clone the Repository

git clone https://github.com/TencentCloudADP/adp-chat-client.git
cd adp-chat-client

2. Initialize API Key

cp server/.env.example deploy/default/.env

Modify the configuration items in the deploy/default/.env file:

# Tencent Cloud account credentials: https://console.cloud.tencent.com/cam/capi
TC_SECRET_APPID=
TC_SECRET_ID=
TC_SECRET_KEY=

# Agent application key obtained from ADP platform: https://adp.cloud.tencent.com/
APP_CONFIGS='[
    {
        "Vendor":"Tencent",
        "ApplicationId":"Unique ID for the conversation application, uniquely identifies a conversation application in this system. Recommended to use appid, or use uuidgen command to generate a random uuid",
        "Comment": "Comment",
        "AppKey": "",
        "International": false
    }
]'

# JWT secret key, a random string, can be generated using the uuidgen command
SECRET_KEY=

3. Build Image and Start Service

# Build image (need to re-run after modifying code, no need to re-pack if only modifying .env file)
sudo make pack

# Start service
sudo make deploy

# Login
sudo make url

Need Help?

For more resources and troubleshooting support, visit:


On this page