Skip to content

Commit bbf6d5f

Browse files
authored
Update App Certificate tip. (#386)
1 parent b7ac81b commit bbf6d5f

File tree

18 files changed

+49
-40
lines changed

18 files changed

+49
-40
lines changed

Android/APIExample-Audio/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ To build and run the sample application, get an App Id:
3131
// assign token and certificate to null if you have not enabled app certificate
3232
<string name="agora_app_certificate" translatable="false">YOUR APP CERTIFICATE</string>
3333
// assign token and certificate to null if you have not enabled app certificate or you have set the certificate above.
34+
// 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.
3435
<string name="agora_access_token" translatable="false">YOUR ACCESS TOKEN</string>
3536
```
3637

Android/APIExample-Audio/README.zh.md

+1
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
// 如果你没有打开Token功能,certificate可以直接不填
3232
<string name="agora_app_certificate" translatable="false">YOUR APP CERTIFICATE</string>
3333
// 如果你没有打开Token功能或者已经配置了certificate,token可以直接不填
34+
// 注意:App证书放在客户端不安全,推荐放在服务端以确保 App 证书不会泄露。
3435
<string name="agora_access_token" translatable="false">YOUR ACCESS TOKEN</string>
3536
3637
```

Android/APIExample-Audio/app/src/main/res/values/string_configs.xml

+6-4
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,16 @@
2525
or use the console to generate a temporary token.
2626
2727
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,
28-
then the APP Certificate can be found in the project detail page.
29-
PS: If the project does not have certificates enabled, leave this field blank.
28+
then the APP Certificate can be found in the project detail page.If the project does not have certificates enabled, leave this field blank.
29+
30+
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.
3031
3132
声网APP证书
3233
Agora 提供 App certificate 用以生成 Token。您可以在您的服务器部署并生成 Token,或者使用控制台生成临时的 Token。
3334
34-
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。
35-
注意:如果项目没有开启证书鉴权,这个字段留空。
35+
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。如果项目没有开启证书鉴权,这个字段留空。
36+
37+
注意:App证书放在客户端不安全,推荐放在服务端以确保 App 证书不会泄露。
3638
-->
3739
<string name="agora_app_certificate" translatable="false">YOUR APP CERTIFICATE</string>
3840

Android/APIExample/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ To build and run the sample application, get an App Id:
2929
// Agora APP ID.
3030
<string name="agora_app_id" translatable="false">YOUR APP ID</string>
3131
// Agora APP Certificate. If the project does not have certificates enabled, leave this field blank.
32+
// 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.
3233
<string name="agora_app_certificate" translatable="false">YOUR APP CERTIFICATE</string>
3334
```
3435

Android/APIExample/README.zh.md

+1
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
// 声网APP ID。
3030
<string name="agora_app_id" translatable="false">YOUR APP ID</string>
3131
// 声网APP证书。如果项目没有开启证书鉴权,这个字段留空。
32+
// 注意:App证书放在客户端不安全,推荐放在服务端以确保 App 证书不会泄露。
3233
<string name="agora_app_certificate" translatable="false">YOUR APP CERTIFICATE</string>
3334
```
3435

Android/APIExample/app/src/main/res/values/string_configs.xml

+6-4
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,16 @@
2525
or use the console to generate a temporary token.
2626
2727
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,
28-
then the APP Certificate can be found in the project detail page.
29-
PS: If the project does not have certificates enabled, leave this field blank.
28+
then the APP Certificate can be found in the project detail page. If the project does not have certificates enabled, leave this field blank.
29+
30+
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.
3031
3132
声网APP证书
3233
Agora 提供 App certificate 用以生成 Token。您可以在您的服务器部署并生成 Token,或者使用控制台生成临时的 Token。
3334
34-
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。
35-
注意:如果项目没有开启证书鉴权,这个字段留空。
35+
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。如果项目没有开启证书鉴权,这个字段留空。
36+
37+
注意:App证书放在客户端不安全,推荐放在服务端以确保 App 证书不会泄露。
3638
-->
3739
<string name="agora_app_certificate" translatable="false">YOUR APP CERTIFICATE</string>
3840

iOS/APIExample-Audio/APIExample-Audio/Common/KeyCenter.swift

+4-4
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ struct KeyCenter {
2929
Agora provides App certificate to generate Token. You can deploy and generate a token on your server,
3030
or use the console to generate a temporary token.
3131
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,
32-
then the APP Certificate can be found in the project detail page.
33-
PS: If the project does not have certificates enabled, leave this field blank.
32+
then the APP Certificate can be found in the project detail page.If the project does not have certificates enabled, leave this field blank.
33+
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.
3434
声网APP证书
3535
Agora 提供 App certificate 用以生成 Token。您可以在您的服务器部署并生成 Token,或者使用控制台生成临时的 Token。
36-
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。
37-
注意:如果项目没有开启证书鉴权,这个字段留空
36+
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。如果项目没有开启证书鉴权,这个字段留空。
37+
注意:App证书放在客户端不安全,推荐放在服务端以确保 App 证书不会泄露
3838
*/
3939
static let Certificate: String? = <#YOUR Certificate#>
4040
}

iOS/APIExample-Audio/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ To build and run the sample application, get an App Id:
6262
Agora provides App certificate to generate Token. You can deploy and generate a token on your server,
6363
or use the console to generate a temporary token.
6464
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,
65-
then the APP Certificate can be found in the project detail page.
66-
PS: If the project does not have certificates enabled, leave this field blank.
65+
then the APP Certificate can be found in the project detail page.If the project does not have certificates enabled, leave this field blank.
66+
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.
6767
*/
6868
static var Certificate: String? = <#YOUR Certificate#>
6969

iOS/APIExample-Audio/README.zh.md

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

iOS/APIExample-OC/APIExample-OC/Common/KeyCenter.h

+4-4
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@ NS_ASSUME_NONNULL_BEGIN
3131
Agora provides App certificate to generate Token. You can deploy and generate a token on your server,
3232
or use the console to generate a temporary token.
3333
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,
34-
then the APP Certificate can be found in the project detail page.
35-
PS: If the project does not have certificates enabled, leave this field blank.
34+
then the APP Certificate can be found in the project detail page.If the project does not have certificates enabled, leave this field blank.
35+
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.
3636
声网APP证书
3737
Agora 提供 App certificate 用以生成 Token。您可以在您的服务器部署并生成 Token,或者使用控制台生成临时的 Token。
38-
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。
39-
注意:如果项目没有开启证书鉴权,这个字段留空
38+
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。如果项目没有开启证书鉴权,这个字段留空。
39+
注意:App证书放在客户端不安全,推荐放在服务端以确保 App 证书不会泄露
4040
*/
4141
+ (nullable NSString *)Certificate;
4242

iOS/APIExample-OC/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ To build and run the sample application, get an App Id:
6262
Agora provides App certificate to generate Token. You can deploy and generate a token on your server,
6363
or use the console to generate a temporary token.
6464
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,
65-
then the APP Certificate can be found in the project detail page.
66-
PS: If the project does not have certificates enabled, leave this field blank.
65+
then the APP Certificate can be found in the project detail page.If the project does not have certificates enabled, leave this field blank.
66+
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.
6767
*/
6868
static NSString * const Certificate = <#YOUR Certificate#>
6969

iOS/APIExample-OC/README.zh.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ pod install
5656
5757
/**
5858
Agora 提供 App certificate 用以生成 Token。您可以在您的服务器部署并生成 Token,或者使用控制台生成临时的 Token。
59-
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。
60-
注意:如果项目没有开启证书鉴权,这个字段留空
59+
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。如果项目没有开启证书鉴权,这个字段留空。
60+
注意:App证书放在客户端不安全,推荐放在服务端以确保 App 证书不会泄露
6161
*/
6262
static NSString * const Certificate = <#YOUR Certificate#>
6363
```

iOS/APIExample/APIExample/Common/KeyCenter.swift

+5-4
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,13 @@ class KeyCenter: NSObject {
3232
Agora provides App certificate to generate Token. You can deploy and generate a token on your server,
3333
or use the console to generate a temporary token.
3434
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,
35-
then the APP Certificate can be found in the project detail page.
36-
PS: If the project does not have certificates enabled, leave this field blank.
35+
then the APP Certificate can be found in the project detail page.If the project does not have certificates enabled, leave this field blank.
36+
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.
37+
3738
声网APP证书
3839
Agora 提供 App certificate 用以生成 Token。您可以在您的服务器部署并生成 Token,或者使用控制台生成临时的 Token。
39-
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。
40-
注意:如果项目没有开启证书鉴权,这个字段留空
40+
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。如果项目没有开启证书鉴权,这个字段留空。
41+
注意:App证书放在客户端不安全,推荐放在服务端以确保 App 证书不会泄露
4142
*/
4243
static let Certificate: String? = nil
4344

iOS/APIExample/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ To build and run the sample application, get an App Id:
6262
Agora provides App certificate to generate Token. You can deploy and generate a token on your server,
6363
or use the console to generate a temporary token.
6464
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,
65-
then the APP Certificate can be found in the project detail page.
66-
PS: If the project does not have certificates enabled, leave this field blank.
65+
then the APP Certificate can be found in the project detail page.If the project does not have certificates enabled, leave this field blank.
66+
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.
6767
*/
6868
static var Certificate: String? = <#YOUR Certificate#>
6969

iOS/APIExample/README.zh.md

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

macOS/APIExample/Common/KeyCenter.swift

+4-4
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ struct KeyCenter {
3030
Agora provides App certificate to generate Token. You can deploy and generate a token on your server,
3131
or use the console to generate a temporary token.
3232
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,
33-
then the APP Certificate can be found in the project detail page.
34-
PS: If the project does not have certificates enabled, leave this field blank.
33+
then the APP Certificate can be found in the project detail page.If the project does not have certificates enabled, leave this field blank.
34+
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.
3535
声网APP证书
3636
Agora 提供 App certificate 用以生成 Token。您可以在您的服务器部署并生成 Token,或者使用控制台生成临时的 Token。
37-
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。
38-
注意:如果项目没有开启证书鉴权,这个字段留空
37+
进入声网控制台(https://console.agora.io/),创建一个带证书鉴权的项目,进入项目配置页,即可看到APP证书。如果项目没有开启证书鉴权,这个字段留空。
38+
注意:App证书放在客户端不安全,推荐放在服务端以确保 App 证书不会泄露
3939
*/
4040
static let Certificate: String? = nil
4141

macOS/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ To build and run the sample application, get an App Id:
5454
Agora provides App certificate to generate Token. You can deploy and generate a token on your server,
5555
or use the console to generate a temporary token.
5656
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,
57-
then the APP Certificate can be found in the project detail page.
58-
PS: If the project does not have certificates enabled, leave this field blank.
57+
then the APP Certificate can be found in the project detail page.If the project does not have certificates enabled, leave this field blank.
58+
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.
5959
*/
6060
static var Certificate: String? = <#YOUR Certificate#>
6161

macOS/README.zh.md

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

0 commit comments

Comments
 (0)