Merge pull request #1511 from haoxiuwen/doc-v2

Add IP Addr/Domain Name Config for Private Cloud SDK

Author: haoxiuwen

docs/.vuepress/sidebar/document.ts

@@ -179,6 +179,7 @@ const documentSidebar = [
   { text: '常见问题', link: 'faq.html', only: ['react-native'] },
   { text: '苹果隐私策略', link: 'privacy_policy.html', only: ['ios'] },
   { text: '精简版 SDK', link: 'elite_sdk.html', only: ['android', 'ios']},
+  { text: '私有云 SDK IP 地址/域名配置', link: 'private_ip_domain.html', only: ['android', 'ios', 'web', 'harmonyos']},
   { text: '概述', link: 'overview.html', only: ['applet'] },
   {
         text: '集成介绍',

docs/document/android/initialization.md

@@ -22,3 +22,5 @@ options.setAppKey("Your appkey");
 ......// 其他 EMOptions 配置。
 EMClient.getInstance().init(context, options);
 ```
+
+关于私有云 SDK 的 IP 地址/域名配置，详见 [配置文档](private_ip_domain.html)。

docs/document/android/private_ip_domain.md

@@ -0,0 +1,52 @@
+# 私有云 SDK IP 地址/域名配置
+
+<Toc />
+
+## 静态配置 IP 地址/域名
+
+SDK 默认指向公有云地址。部署私有云后，需要将地址重新指向新的地址，以下是地址修改方法：
+
+### 方式一：TCP 连接
+
+```java
+EMOptions emOptions = new EMOptions();//实例化 EMOptions 对象
+emOptions.setRestServer("10.10.10.10:00");//设置私有云 REST 地址（IP/域名：port）
+emOptions.setIMServer("10.10.10.10");//设置私有云 IM 地址
+emOptions.setImPort(00);//设置私有云 IM 端口号
+emOptions.setEnableTLSConnection(true);//设置是否开启加密，TCP 连接为 TLS 加密
+
+emOptions.enableDNSConfig(false);//默认是 true，在私有云下，需要关闭（设置成 false）
+EMClient.getInstance().init(context,emOptions);//最后初始化 SDK
+```
+
+### 方式二：WebSocket 连接
+
+```java
+EMOptions emOptions = new EMOptions();//实例化 EMOptions 对象
+emOptions.setRestServer("https://restaddress");//设置私有云 REST 地址（IP/域名：port）
+emOptions.setWebSocketServer("im-api-wechat.easemob.com");//设置 WebSocket 服务器地址
+emOptions.setWebSocketPort(443);//设置 WebSocket 服务器端口号
+emOptions.setEnableTLSConnection(true);//设置是否开启加密，WebSocket为 WSS 协议
+
+emOptions.enableDNSConfig(false);//默认是 true，在私有云下，需要关闭（设置成 false）
+EMClient.getInstance().init(context,emOptions);//最后初始化 SDK
+```
+
+:::tip
+如果需要配置 HTTPS，只需在 REST 地址前加一个前缀。
+:::
+
+```java
+emOptions.setRestServer("https://10.10.10.10:00");//设置私有云 REST 地址（ip：port）
+```
+
+## 动态配置地址
+
+1. 服务器端配置 DNS 地址表。
+2. 从服务器端动态获取地址。
+
+```java
+EMOptions emOptions = new EMOptions();
+emOptions.setDnsUrl("url");//从服务器端动态获取地址
+EMClient.getInstance().init(context,emOptions);//初始化 SDK
+```

docs/document/harmonyos/initialization.md

@@ -32,3 +32,5 @@ ChatClient.getInstance().init(this.context, {
   // 其他更多设置
 });
 ```
+
+关于私有云 SDK 的 IP 地址/域名配置，详见 [配置文档](private_ip_domain.html)。

docs/document/harmonyos/private_ip_domain.md

@@ -0,0 +1,39 @@
+# 私有云 SDK IP 地址/域名配置
+
+<Toc />
+
+## 静态配置 IP 地址/域名
+
+SDK 默认指向公有云地址。部署私有云后，需要将地址重新指向新的地址，以下是地址修改方法：
+
+```typescript
+let options = new ChatOptions({
+  appKey: "您的AppKey"
+});//实例化 ChatOptions 对象
+options.setRestServer("10.10.10.10:00");//设置私有云 REST 地址（IP/域名：port）
+options.setIMServer("10.10.10.10");//设置私有云 IM 地址
+options.setImPort(100);//设置私有云 IM 端口号
+
+ChatClient.getInstance().init(options);//最后初始化 SDK
+```
+
+:::tip
+如果需要配置 HTTPS 只需在 REST 地址前加一个前缀。
+:::
+
+```typescript
+options.setRestServer("https://10.10.10.10:00");//设置私有云 REST 地址（IP：port）
+```
+
+## 动态配置地址
+
+1. 服务器端配置 DNS 地址表。
+2. 从服务器端动态获取地址。
+
+```typescript
+let options = new ChatOptions({
+  appKey: "您的AppKey"
+});
+options.setDnsURL("url");//从服务器端动态获取地址
+ChatClient.getInstance().init(options);//初始化 SDK
+```

docs/document/ios/initialization.md

@@ -17,3 +17,5 @@ let options = EMOptions(appkey: "Your appkey")
 ......// 其他 EMOptions 配置。
 EMClient.shared().initializeSDK(with: options)
 ```
+
+关于私有云 SDK 的 IP 地址/域名配置，详见 [配置文档](private_ip_domain.html)。

docs/document/ios/private_ip_domain.md

@@ -0,0 +1,46 @@
+# 私有云 SDK IP 地址/域名配置
+
+<Toc />
+
+## 静态配置 IP 地址/域名
+
+SDK 默认指向公有云地址，在部署私有云后，需要将地址重新指向到新的地址，以下是地址修改方法：
+
+### 方式一：TCP 连接
+
+```objectivec
+EMOptions *options = [EMOptions optionsWithAppkey:appkey];
+options.enableDnsConfig = NO;
+options.chatPort = 8080;//设置端口号
+options.chatServer = @"xxx.xxx.xxx.xxx";//设置 IP 地址
+options.restServer = @"xxx.xxx.xxx.xxx:8080";//设置ip:port
+options.enableTLSConnection = YES;// 是否使用加密连接。TCP 连接为 TLS 加密
+[[EMClient sharedClient] initializeSDKWithOptions:options];
+```
+### 方式二：WebSocket 连接
+
+```objectivec
+EMOptions* options = [EMOptions optionsWithAppkey:@"Your appkey"];
+options.enableDnsConfig = NO;
+options.restServer = @"https://restaddress";
+options.webSocketServer = @"im-api-wechat.easemob.com";
+options.webSocketPort = 443;
+options.enableTLSConnection = YES;// 是否使用加密连接。webSocket 为 WSS 协议。
+```
+
+:::tip
+如果需要配置 HTTPS 只需加一个属性即可。
+:::
+
+```objectivec
+options.usingHttpsOnly = YES;
+```
+
+## 动态配置地址
+
+1. 服务器端配置 DNS 地址表。
+2. 设置服务器端配置的 URL 地址。
+
+```objectivec
+options.dnsURL = @"xxxx";//设置服务器端配置的 URL 地址
+```

docs/document/web/private_ip_domain.md

@@ -0,0 +1,31 @@
+# 私有云 SDK IP 地址/域名配置
+
+## Web Vue 3 Demo
+
+对于 Web Vue 3 Demo，进行私有化配置需在 [Vue 3 Demo 源代码](https://github.com/easemob/webim-vue-demo/tree/vue3-miniCore) 中进行修改。
+
+在 `src/IM/config/index.js` 文件中，修改环境配置：
+
+```javascript
+//环信appKey默认配置项
+export const DEFAULT_EASEMOB_APPKEY = 'easemob#easeim';// 私有化的 App Key
+export const DEFAULT_EASEMOB_SOCKET_URL = 'http://im-api-v2.easemob.com/ws';//私有化的 WebSocket 地址
+export const DEFAULT_EASEMOB_REST_URL = 'ws://a1.easemob.com';//私有化的 RESTful 服务器地址
+```
+
+## Web React Demo
+
+对于 Web React Demo，进行私有化配置需在 [React Demo 源代码](https://github.com/easemob/easemob-demo-react/tree/dev_4.0)中进行修改。
+
+在 `easemob-demo-react/src/App.tsx` 中修改配置信息，如下所示：
+
+```javascript
+		initConfig={{
+  		  appKey: 'easemob#easeim',// 私有化的 App Key
+        isHttpDNS: false,//固定为 false
+        restUrl:'http://a1.easemob.com',//私有化的 RESTful 服务器地址
+        msyncUrl: 'ws://im-api-v2.easemob.com/ws',//私有化的 WebSocket 地址
+		    useUserInfo: true,
+        translationTargetLanguage: state.translationTargetLanguage,
+      }}
+```