docs: update openim images docs deployment aliyun (openimsdk#2154)

S-pyder · Mar 31, 2024 · 48df76f · 48df76f
1 parent 71f6208
commit 48df76f
Showing 1 changed file with 18 additions and 1 deletion.
diff --git a/docs/contrib/images.md b/docs/contrib/images.md
@@ -96,4 +96,21 @@ When pulling OpenIM's Docker images, you can choose the most suitable source bas
 
 3. Run the `docker images` command to confirm that the image has been successfully pulled.
 
-This concludes OpenIM's image management strategy and the steps for pulling images. If you have any questions, please feel free to ask.
+### Accelerating Deployment for Users in China with Aliyun Mirror or Alternative Image Addresses
+
+For users in China looking to speed up the deployment process of OpenIM, leveraging a mirror image address is a highly recommended practice. After executing the `make init` command, a `.env` file is generated, which you'll need to edit to configure the image registry source. This configuration is crucial for optimizing download speeds and ensuring a smoother setup process.
+
+Within the generated `.env` file, you'll find a section dedicated to choosing the image address. It includes options for GitHub (`ghcr.io/openimsdk`), Docker Hub (`openim`), and Ali Cloud (`registry.cn-hangzhou.aliyuncs.com/openimsdk`). To achieve the best performance within China, it is advised to use the Aliyun image address. 
+
+To do this, you need to comment out the current `IMAGE_REGISTRY` setting and uncomment the Aliyun option. Here is how you can adjust it for Aliyun:
+
+```bash
+# Choose the image address: GitHub (ghcr.io/openimsdk), Docker Hub (openim), 
+# or Ali Cloud (registry.cn-hangzhou.aliyuncs.com/openimsdk).
+# Uncomment one of the following three options. Aliyun is recommended for users in China.
+# IMAGE_REGISTRY="ghcr.io/openimsdk"
+# IMAGE_REGISTRY="openim"
+IMAGE_REGISTRY="registry.cn-hangzhou.aliyuncs.com/openimsdk"
+```
+
+This change directs the deployment process to fetch the required images from the Aliyun registry, significantly improving download and installation speeds due to the geographical and network advantages within China. If, for any reason, you prefer not to use Aliyun or encounter issues, consider switching to another mirror address listed in the `.env` file by following the same uncommenting process. This flexibility ensures that users can select the most suitable image source for their specific situation, leading to a more efficient deployment of OpenIM.