docs: 更新README并添加华为云认证凭证文件
添加华为云AK/SK获取指南到README文档 新增credentials.csv文件用于存储认证信息
This commit is contained in:
43
README.md
43
README.md
@@ -32,7 +32,42 @@ antiwear-web/
|
|||||||
- 支持 WebRTC 和 WebSocket
|
- 支持 WebRTC 和 WebSocket
|
||||||
- 需要麦克风权限(用于语音交互)
|
- 需要麦克风权限(用于语音交互)
|
||||||
|
|
||||||
### 2. 后端服务配置
|
### 2. 获取华为云 AK/SK
|
||||||
|
|
||||||
|
访问密钥(AK/SK,Access Key ID/Secret Access Key)是您在华为云的长期身份凭证,用于 API 请求签名认证。
|
||||||
|
|
||||||
|
#### 获取步骤
|
||||||
|
|
||||||
|
1. 登录 [华为云控制台](https://console.huaweicloud.com)
|
||||||
|
2. 将鼠标移至右上角用户名处,在下拉列表中单击 **"我的凭证"**
|
||||||
|
3. 单击 **"访问密钥"** 区域
|
||||||
|
4. 单击 **"新增访问密钥"**
|
||||||
|
5. 输入描述信息后单击 **"确定"**
|
||||||
|
6. 单击 **"立即下载"** 下载密钥文件(credentials.csv)
|
||||||
|
|
||||||
|
> **注意**:
|
||||||
|
> - 每个用户最多可创建 **2个** 访问密钥
|
||||||
|
> - 每个访问密钥仅能下载 **一次**,请妥善保管
|
||||||
|
> - 访问密钥永久有效,建议定期更换
|
||||||
|
|
||||||
|
下载的 CSV 文件内容示例:
|
||||||
|
```
|
||||||
|
username,user_id,access_key,secret_access_key
|
||||||
|
username@example.com,xxxxxxx,AKXXXXXXXXXX,skXXXXXXXXXX...
|
||||||
|
```
|
||||||
|
|
||||||
|
其中:
|
||||||
|
- **AK**(Access Key):对应环境变量 `HUAWEI_AK`
|
||||||
|
- **SK**(Secret Access Key):对应环境变量 `HUAWEI_SK`
|
||||||
|
|
||||||
|
#### 获取项目 ID(Project ID)
|
||||||
|
|
||||||
|
项目 ID 获取方式:
|
||||||
|
1. 登录华为云控制台
|
||||||
|
2. 进入 "我的凭证" > "项目 ID"
|
||||||
|
3. 或访问 [获取项目ID](https://support.huaweicloud.com/api-metastudio/metastudio_02_0006.html)
|
||||||
|
|
||||||
|
### 3. 后端服务配置
|
||||||
|
|
||||||
#### 方式一:使用 AK/SK 认证(推荐)
|
#### 方式一:使用 AK/SK 认证(推荐)
|
||||||
|
|
||||||
@@ -69,7 +104,7 @@ export HUAWEI_DOMAIN_NAME=your_domain_name
|
|||||||
export HUAWEI_PROJECT_ID=your_project_id
|
export HUAWEI_PROJECT_ID=your_project_id
|
||||||
```
|
```
|
||||||
|
|
||||||
### 3. 启动服务
|
### 4. 启动服务
|
||||||
|
|
||||||
#### 启动后端服务
|
#### 启动后端服务
|
||||||
|
|
||||||
@@ -97,7 +132,7 @@ npx http-server -p 8080
|
|||||||
|
|
||||||
然后在浏览器中访问 `http://localhost:8080`
|
然后在浏览器中访问 `http://localhost:8080`
|
||||||
|
|
||||||
### 4. 配置参数
|
### 5. 配置参数
|
||||||
|
|
||||||
#### 默认参数(已预填)
|
#### 默认参数(已预填)
|
||||||
| 参数 | 默认值 |
|
| 参数 | 默认值 |
|
||||||
@@ -106,7 +141,7 @@ npx http-server -p 8080
|
|||||||
| 机器人ID | `2c9084bf9c9cc1c0019db2c4ca2a5c89` |
|
| 机器人ID | `2c9084bf9c9cc1c0019db2c4ca2a5c89` |
|
||||||
| 项目ID | `c67bf5e7d1f84d20a6eefff2c1ee9cd4` |
|
| 项目ID | `c67bf5e7d1f84d20a6eefff2c1ee9cd4` |
|
||||||
|
|
||||||
### 5. 使用流程
|
### 6. 使用流程
|
||||||
|
|
||||||
1. **启动后端服务**:`cd server && npm start`
|
1. **启动后端服务**:`cd server && npm start`
|
||||||
2. **启动前端服务器**:`python -m http.server 8080`
|
2. **启动前端服务器**:`python -m http.server 8080`
|
||||||
|
|||||||
2
server/cert/credentials.csv
Normal file
2
server/cert/credentials.csv
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
User Name,Access Key Id,Secret Access Key
|
||||||
|
"hid_4g9ydbgkwc1r19-",HPUAA6YLJPZRJC3H5GWM,QOM4wMxZavQZXCzOlWibwue8t9nNX0yHPkutlaLn
|
||||||
|
@@ -1,3 +1,5 @@
|
|||||||
|
require('dotenv').config();
|
||||||
|
|
||||||
const express = require('express');
|
const express = require('express');
|
||||||
const cors = require('cors');
|
const cors = require('cors');
|
||||||
const crypto = require('crypto');
|
const crypto = require('crypto');
|
||||||
|
|||||||
@@ -8,6 +8,7 @@
|
|||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"express": "^4.18.2",
|
"express": "^4.18.2",
|
||||||
"cors": "^2.8.5"
|
"cors": "^2.8.5",
|
||||||
|
"dotenv": "^16.3.1"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user