Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update App Certificate tip. #386

Merged
merged 1 commit into from
May 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Android/APIExample-Audio/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ To build and run the sample application, get an App Id:
// assign token and certificate to null if you have not enabled app certificate
<string name="agora_app_certificate" translatable="false">YOUR APP CERTIFICATE</string>
// assign token and certificate to null if you have not enabled app certificate or you have set the certificate above.
// PS:It is unsafe to place the App Certificate on the client side, it is recommended to place it on the server side to ensure that the App Certificate is not leaked.
<string name="agora_access_token" translatable="false">YOUR ACCESS TOKEN</string>
```

Expand Down
1 change: 1 addition & 0 deletions Android/APIExample-Audio/README.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
// 如果你没有打开Token功能,certificate可以直接不填
<string name="agora_app_certificate" translatable="false">YOUR APP CERTIFICATE</string>
// 如果你没有打开Token功能或者已经配置了certificate,token可以直接不填
// 注意:App证书放在客户端不安全,推荐放在服务端以确保 App 证书不会泄露。
<string name="agora_access_token" translatable="false">YOUR ACCESS TOKEN</string>

```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,16 @@
or use the console to generate a temporary token.

In order to get the APP ID, you can open the agora console (https://console.agora.io/) to create a project with the App Certificate enabled,
then the APP Certificate can be found in the project detail page.
PS: If the project does not have certificates enabled, leave this field blank.
then the APP Certificate can be found in the project detail page.If the project does not have certificates enabled, leave this field blank.

PS: It is unsafe to place the App Certificate on the client side, it is recommended to place it on the server side to ensure that the App Certificate is not leaked.

声网APP证书
Agora 提供 App certificate 用以生成 Token。您可以在您的服务器部署并生成 Token,或者使用控制台生成临时的 Token。

进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。
注意:如果项目没有开启证书鉴权,这个字段留空。
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。如果项目没有开启证书鉴权,这个字段留空。

注意:App证书放在客户端不安全,推荐放在服务端以确保 App 证书不会泄露。
-->
<string name="agora_app_certificate" translatable="false">YOUR APP CERTIFICATE</string>

Expand Down
1 change: 1 addition & 0 deletions Android/APIExample/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ To build and run the sample application, get an App Id:
// Agora APP ID.
<string name="agora_app_id" translatable="false">YOUR APP ID</string>
// Agora APP Certificate. If the project does not have certificates enabled, leave this field blank.
// PS:It is unsafe to place the App Certificate on the client side, it is recommended to place it on the server side to ensure that the App Certificate is not leaked.
<string name="agora_app_certificate" translatable="false">YOUR APP CERTIFICATE</string>
```

Expand Down
1 change: 1 addition & 0 deletions Android/APIExample/README.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
// 声网APP ID。
<string name="agora_app_id" translatable="false">YOUR APP ID</string>
// 声网APP证书。如果项目没有开启证书鉴权,这个字段留空。
// 注意:App证书放在客户端不安全,推荐放在服务端以确保 App 证书不会泄露。
<string name="agora_app_certificate" translatable="false">YOUR APP CERTIFICATE</string>
```

Expand Down
10 changes: 6 additions & 4 deletions Android/APIExample/app/src/main/res/values/string_configs.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,16 @@
or use the console to generate a temporary token.

In order to get the APP ID, you can open the agora console (https://console.agora.io/) to create a project with the App Certificate enabled,
then the APP Certificate can be found in the project detail page.
PS: If the project does not have certificates enabled, leave this field blank.
then the APP Certificate can be found in the project detail page. If the project does not have certificates enabled, leave this field blank.

PS: It is unsafe to place the App Certificate on the client side, it is recommended to place it on the server side to ensure that the App Certificate is not leaked.

声网APP证书
Agora 提供 App certificate 用以生成 Token。您可以在您的服务器部署并生成 Token,或者使用控制台生成临时的 Token。

进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。
注意:如果项目没有开启证书鉴权,这个字段留空。
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。如果项目没有开启证书鉴权,这个字段留空。

注意:App证书放在客户端不安全,推荐放在服务端以确保 App 证书不会泄露。
-->
<string name="agora_app_certificate" translatable="false">YOUR APP CERTIFICATE</string>

Expand Down
8 changes: 4 additions & 4 deletions iOS/APIExample-Audio/APIExample-Audio/Common/KeyCenter.swift
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@ struct KeyCenter {
Agora provides App certificate to generate Token. You can deploy and generate a token on your server,
or use the console to generate a temporary token.
In order to get the APP ID, you can open the agora console (https://console.agora.io/) to create a project with the App Certificate enabled,
then the APP Certificate can be found in the project detail page.
PS: If the project does not have certificates enabled, leave this field blank.
then the APP Certificate can be found in the project detail page.If the project does not have certificates enabled, leave this field blank.
PS: It is unsafe to place the App Certificate on the client side, it is recommended to place it on the server side to ensure that the App Certificate is not leaked.
声网APP证书
Agora 提供 App certificate 用以生成 Token。您可以在您的服务器部署并生成 Token,或者使用控制台生成临时的 Token。
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。
注意:如果项目没有开启证书鉴权,这个字段留空
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。如果项目没有开启证书鉴权,这个字段留空。
注意:App证书放在客户端不安全,推荐放在服务端以确保 App 证书不会泄露
*/
static let Certificate: String? = <#YOUR Certificate#>
}
4 changes: 2 additions & 2 deletions iOS/APIExample-Audio/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ To build and run the sample application, get an App Id:
Agora provides App certificate to generate Token. You can deploy and generate a token on your server,
or use the console to generate a temporary token.
In order to get the APP ID, you can open the agora console (https://console.agora.io/) to create a project with the App Certificate enabled,
then the APP Certificate can be found in the project detail page.
PS: If the project does not have certificates enabled, leave this field blank.
then the APP Certificate can be found in the project detail page.If the project does not have certificates enabled, leave this field blank.
PS: It is unsafe to place the App Certificate on the client side, it is recommended to place it on the server side to ensure that the App Certificate is not leaked.
*/
static var Certificate: String? = <#YOUR Certificate#>

Expand Down
4 changes: 2 additions & 2 deletions iOS/APIExample-Audio/README.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ pod install

/**
Agora 提供 App certificate 用以生成 Token。您可以在您的服务器部署并生成 Token,或者使用控制台生成临时的 Token。
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。
注意:如果项目没有开启证书鉴权,这个字段留空
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。如果项目没有开启证书鉴权,这个字段留空。
注意:App证书放在客户端不安全,推荐放在服务端以确保 App 证书不会泄露
*/
static var Certificate: String? = <#YOUR Certificate#>
```
Expand Down
8 changes: 4 additions & 4 deletions iOS/APIExample-OC/APIExample-OC/Common/KeyCenter.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,12 @@ NS_ASSUME_NONNULL_BEGIN
Agora provides App certificate to generate Token. You can deploy and generate a token on your server,
or use the console to generate a temporary token.
In order to get the APP ID, you can open the agora console (https://console.agora.io/) to create a project with the App Certificate enabled,
then the APP Certificate can be found in the project detail page.
PS: If the project does not have certificates enabled, leave this field blank.
then the APP Certificate can be found in the project detail page.If the project does not have certificates enabled, leave this field blank.
PS: It is unsafe to place the App Certificate on the client side, it is recommended to place it on the server side to ensure that the App Certificate is not leaked.
声网APP证书
Agora 提供 App certificate 用以生成 Token。您可以在您的服务器部署并生成 Token,或者使用控制台生成临时的 Token。
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。
注意:如果项目没有开启证书鉴权,这个字段留空
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。如果项目没有开启证书鉴权,这个字段留空。
注意:App证书放在客户端不安全,推荐放在服务端以确保 App 证书不会泄露
*/
+ (nullable NSString *)Certificate;

Expand Down
4 changes: 2 additions & 2 deletions iOS/APIExample-OC/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ To build and run the sample application, get an App Id:
Agora provides App certificate to generate Token. You can deploy and generate a token on your server,
or use the console to generate a temporary token.
In order to get the APP ID, you can open the agora console (https://console.agora.io/) to create a project with the App Certificate enabled,
then the APP Certificate can be found in the project detail page.
PS: If the project does not have certificates enabled, leave this field blank.
then the APP Certificate can be found in the project detail page.If the project does not have certificates enabled, leave this field blank.
PS: It is unsafe to place the App Certificate on the client side, it is recommended to place it on the server side to ensure that the App Certificate is not leaked.
*/
static NSString * const Certificate = <#YOUR Certificate#>

Expand Down
4 changes: 2 additions & 2 deletions iOS/APIExample-OC/README.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ pod install

/**
Agora 提供 App certificate 用以生成 Token。您可以在您的服务器部署并生成 Token,或者使用控制台生成临时的 Token。
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。
注意:如果项目没有开启证书鉴权,这个字段留空
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。如果项目没有开启证书鉴权,这个字段留空。
注意:App证书放在客户端不安全,推荐放在服务端以确保 App 证书不会泄露
*/
static NSString * const Certificate = <#YOUR Certificate#>
```
Expand Down
9 changes: 5 additions & 4 deletions iOS/APIExample/APIExample/Common/KeyCenter.swift
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,13 @@ class KeyCenter: NSObject {
Agora provides App certificate to generate Token. You can deploy and generate a token on your server,
or use the console to generate a temporary token.
In order to get the APP ID, you can open the agora console (https://console.agora.io/) to create a project with the App Certificate enabled,
then the APP Certificate can be found in the project detail page.
PS: If the project does not have certificates enabled, leave this field blank.
then the APP Certificate can be found in the project detail page.If the project does not have certificates enabled, leave this field blank.
PS: It is unsafe to place the App Certificate on the client side, it is recommended to place it on the server side to ensure that the App Certificate is not leaked.

声网APP证书
Agora 提供 App certificate 用以生成 Token。您可以在您的服务器部署并生成 Token,或者使用控制台生成临时的 Token。
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。
注意:如果项目没有开启证书鉴权,这个字段留空
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。如果项目没有开启证书鉴权,这个字段留空。
注意:App证书放在客户端不安全,推荐放在服务端以确保 App 证书不会泄露
*/
static let Certificate: String? = nil

Expand Down
4 changes: 2 additions & 2 deletions iOS/APIExample/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ To build and run the sample application, get an App Id:
Agora provides App certificate to generate Token. You can deploy and generate a token on your server,
or use the console to generate a temporary token.
In order to get the APP ID, you can open the agora console (https://console.agora.io/) to create a project with the App Certificate enabled,
then the APP Certificate can be found in the project detail page.
PS: If the project does not have certificates enabled, leave this field blank.
then the APP Certificate can be found in the project detail page.If the project does not have certificates enabled, leave this field blank.
PS: It is unsafe to place the App Certificate on the client side, it is recommended to place it on the server side to ensure that the App Certificate is not leaked.
*/
static var Certificate: String? = <#YOUR Certificate#>

Expand Down
4 changes: 2 additions & 2 deletions iOS/APIExample/README.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ pod install

/**
Agora 提供 App certificate 用以生成 Token。您可以在您的服务器部署并生成 Token,或者使用控制台生成临时的 Token。
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。
注意:如果项目没有开启证书鉴权,这个字段留空
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。如果项目没有开启证书鉴权,这个字段留空。
注意:App证书放在客户端不安全,推荐放在服务端以确保 App 证书不会泄露
*/
static var Certificate: String? = <#YOUR Certificate#>
```
Expand Down
8 changes: 4 additions & 4 deletions macOS/APIExample/Common/KeyCenter.swift
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ struct KeyCenter {
Agora provides App certificate to generate Token. You can deploy and generate a token on your server,
or use the console to generate a temporary token.
In order to get the APP ID, you can open the agora console (https://console.agora.io/) to create a project with the App Certificate enabled,
then the APP Certificate can be found in the project detail page.
PS: If the project does not have certificates enabled, leave this field blank.
then the APP Certificate can be found in the project detail page.If the project does not have certificates enabled, leave this field blank.
PS: It is unsafe to place the App Certificate on the client side, it is recommended to place it on the server side to ensure that the App Certificate is not leaked.
声网APP证书
Agora 提供 App certificate 用以生成 Token。您可以在您的服务器部署并生成 Token,或者使用控制台生成临时的 Token。
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。
注意:如果项目没有开启证书鉴权,这个字段留空
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。如果项目没有开启证书鉴权,这个字段留空。
注意:App证书放在客户端不安全,推荐放在服务端以确保 App 证书不会泄露
*/
static let Certificate: String? = nil

Expand Down
4 changes: 2 additions & 2 deletions macOS/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ To build and run the sample application, get an App Id:
Agora provides App certificate to generate Token. You can deploy and generate a token on your server,
or use the console to generate a temporary token.
In order to get the APP ID, you can open the agora console (https://console.agora.io/) to create a project with the App Certificate enabled,
then the APP Certificate can be found in the project detail page.
PS: If the project does not have certificates enabled, leave this field blank.
then the APP Certificate can be found in the project detail page.If the project does not have certificates enabled, leave this field blank.
PS: It is unsafe to place the App Certificate on the client side, it is recommended to place it on the server side to ensure that the App Certificate is not leaked.
*/
static var Certificate: String? = <#YOUR Certificate#>

Expand Down
4 changes: 2 additions & 2 deletions macOS/README.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ pod install

/**
Agora 提供 App certificate 用以生成 Token。您可以在您的服务器部署并生成 Token,或者使用控制台生成临时的 Token。
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。
注意:如果项目没有开启证书鉴权,这个字段留空
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。如果项目没有开启证书鉴权,这个字段留空。
注意:App证书放在客户端不安全,推荐放在服务端以确保 App 证书不会泄露
*/
static var Certificate: String? = <#YOUR Certificate#>
```
Expand Down