Forem: skiffer-git

# Reflection and Continuous Improvement - Release v3.7 of the Open Source Instant Messaging (IM) Project OpenIM

skiffer-git — Fri, 26 Apr 2024 12:34:58 +0000

Background

In the past, our team had a shallow understanding of open-source projects, overly prioritizing progress while neglecting the quality and standardization of code. This led to several issues, such as poorly designed deployment processes: complex, non-standard processes, and clear defects in Mac and Windows deployments. These issues not only troubled developers but also increased the difficulty of community maintenance.

In response to these challenges, our team has deeply reflected and identified related issues. Currently, we are focusing on improving code quality and standardization, and perfecting our open-source contribution process to attract more contributors. We believe these are key steps to expand the community's influence and develop OpenIM into a top-tier open-source project.

To this end, we have planned the release of version v3.7, which will comprehensively overhaul aspects such as deployment, standardization, and processes, and is fully compatible with version 3.6 data.

What is OpenIM

OpenIM is different from independent chat applications like Telegram, Signal, and Rocket.Chat. These applications provide a complete user interface and backend services, allowing users to download and use directly. Conversely, OpenIM is an open-source instant messaging solution designed for developers, not providing a standalone chat application for direct installation and use.

OpenIM primarily consists of the OpenIM SDK and OpenIM Server, providing developers with a set of tools and services that enable easy integration of instant messaging features into their applications, including sending and receiving messages, user management, group management, etc.

Overall, OpenIM is designed for developers, offering the necessary tools and frameworks to implement efficient instant messaging solutions in their own applications, rather than serving as an independent chat application for general users.

Features of release-v3.7

Here is the information from the table rewritten in a non-tabular format:

Introducing Mage Build - The team has discarded Shell scripts in favor of adopting the Mage build system. This new system supports various operating systems such as Linux, Windows, and Mac, as well as ARM and AMD CPU architectures.
Configuration File Splitting - The global configuration file has been split into modular configurations. This change achieves module isolation and reduces system coupling, streamlining the configuration process.
Unified RPC Entry Functions - RPC entry functions have been standardized. This includes standardizing log records and ensuring that version numbers are clearly displayed, enhancing clarity and maintainability.
Asynchronous Notification and Webhook Handling - Notifications and Webhooks are now handled through an internal asynchronous queue. This approach decouples them from the main process, improving the system's efficiency and responsiveness.
Upgraded Docker Deployment Solution - The Docker deployment solution has undergone a comprehensive upgrade. It now adheres to the principle of image independence, eliminates dependency on external network configurations, and supports multi-platform deployment.
Strict Code Standard Enforcement - There is a strong emphasis on standardized error handling and log recording. The team also strictly adheres to Go programming standards to maintain high code quality.
Common Code Extraction - Common modules from various projects have been extracted into a tools repository. This allows for independent configuration of parameters and easy reuse across different projects, simplifying development.
Replacing protoc with Official Tools - The IM's pb generation tool has been changed from a custom version to the official version. Scripts have been used to address the issue of API response field loss caused by the omitempty setting, ensuring more robust and reliable API interactions.

About Us

Thanks to widespread developer support, OpenIM maintains a leading position in the open-source instant messaging (IM) field, currently exceeding 13k stars on GitHub. In today's era where data and privacy security are increasingly valued, the demand for privately deployed IM is gradually increasing, closely related to the rise of the domestic software industry. Particularly in the government and corporate sectors, as information technology rapidly develops and innovative industries are widely applied, the demand for IM is rapidly growing. Additionally, with the ongoing expansion of the collaborative software market, "secure and controllable" has become one of the most crucial requirements. In the post-AIGC era, IM, as the primary interface for human-machine interaction, will inevitably become increasingly valuable. We look forward to OpenIM playing a greater role in the post-AIGC era, enabling every application to integrate OpenIM to enhance overall efficiency and security.

github: https://github.com/openimsdk
developer: https://docs.openim.io/zh-Hans/

OpenIM （Open-Source Instant Messaging） Mac Deployment Guide

skiffer-git — Fri, 26 Jan 2024 06:11:29 +0000

This guide provides step-by-step instructions for deploying OpenIM on a Mac, including both source code and Docker deployment methods.

Preliminary Environment Setup

Ensure a clean working environment:

Create a New Directory: Start in a new directory to prevent conflicts.
Check for Conflicting Processes: Run these commands:
- ps -ef | grep openim
- ps -ef | grep chat
Check Docker Containers: Use docker ps to confirm no related containers are running.

Source Code Deployment

Deploying openim-server

Deploying from source requires adjusting Docker's network configurations for Mac.

Clone and Prepare the Repository:

   git clone https://github.com/openimsdk/open-im-server
   cd open-im-server
   export OPENIM_IP="[Your External/Internal IP]"
   make init

Configure Kafka in docker-compose.yml:

Replace:

 - KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092,EXTERNAL://${DOCKER_BRIDGE_GATEWAY:-172.28.0.1}:${KAFKA_PORT:-19094}

With:

 - KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092,EXTERNAL://127.0.0.1:${KAFKA_PORT:-19094}

Start the Service:

   docker compose up -d

Final Configurations:

   vim config/config.yaml -c "%s/172\.28\.0\.1/127.0.0.1/g" -c "wq"

Launch openim-server:

   make start

Verification:

   make check

Wait five minutes before checking to ensure accuracy.

Deploying openim-chat

Deploy openim-chat using source code or Docker.

Return to Parent Directory:

   cd ..

Deploy from Source:

   git clone https://github.com/openimsdk/chat
   cd chat
   make init

Set Up MySQL (if not already deployed):

   docker run -d \
     --name mysql \
     -p 13306:3306 \
     -p 23306:33060 \
     -v "$(pwd)/components/mysql/data:/var/lib/mysql" \
     -v "/etc/localtime:/etc/localtime" \
     -e MYSQL_ROOT_PASSWORD="openIM123" \
     --restart always \
     mariadb:10.6

Configure openim-chat:
Modify config/config.yaml, replacing 172.28.0.1 with 127.0.0.1.
Start openim-chat:

   make start

Verification:

   make check

Web Interface Access: Visit http://127.0.0.1:11001. For validation, see this guide.

Docker Deployment

For Docker deployment on Mac, refer to OpenIM Docker Documentation.

About OpenIM

OpenIM is an open-source instant messaging component and solution that specializes in in-app communication. It is one of the most popular open-source IM projects currently. Developers can integrate the OpenIM component and deploy the server privately, quickly incorporating instant and real-time communication capabilities into their applications, ensuring the security and confidentiality of business data.

Repository address: https://github.com/openimsdk

Developer Documentation: https://docs.openim.io/guides/introduction

Nginx Domain Configuration for OpenIM (Open Source Instant Messaging)

skiffer-git — Fri, 19 Jan 2024 07:11:28 +0000

Repository address: https://github.com/openimsdk

Developer Documentation: https://docs.openim.io/guides/introduction

1. Prerequisites

Successful startup of open-im-server and chat (configuration of minio in open-im-server needs to be changed, refer to Step 3)
Successful installation of Nginx (including SSL module)
Successful application for two SSL certificates: test-web.rentsoft.cn, test-admin.rentsoft.cn
Ports 443 and 80 are open

2. Domain Configuration Reference

Taking the Nginx installation directory /usr/local as an example, create a config.conf file in the /usr/local/nginx directory, paste the following template into the /usr/local/nginx/config.conf file, and import the newly created config.conf file into the general configuration file /usr/local/nginx/nginx.conf.

Tips: Pay attention to replacing the domain names, SSL certificate paths, and SSL keys in the domain configuration template.

#open-im-server chat Corresponding deployment address and port
upstream msg_gateway{
    #IM Message server address Multiple can be specified according to the deployment
    server 127.0.0.1:10001;
}
upstream im_api{
    #IM Group user api server address Multiple can be specified according to the deployment
    server 127.0.0.1:10002;
}
upstream im_chat_api{
    #IM Business version login registration server address Multiple can be specified according to the deployment
    server 127.0.0.1:10008;
}
upstream im_admin_api{
    #IM The admin address of the commercial version can specify multiple units according to the deployment situation
    server 127.0.0.1:10009;
}
upstream minio_s3_2{
    #Minio address can be assigned to multiple modules depending on deployment
    server 127.0.0.1:10005;
}
upstream pc_web{
    #PC web address can be validate
    server 127.0.0.1:11001;
}
upstream openim_admin{
    #Admin backend address can be used for validation
    server 127.0.0.1:11002;
}

# Take the domain name "test-web.rentsoft.cn" for example
server {
    listen       443; #Listening on port 443
    server_name  test-web.rentsoft.cn;  #Your domain name
    ssl on;
    #Path of pem file for ssl certificate
    ssl_certificate /usr/local/nginx/conf/ssh/test-web.rentsoft.cn_bundle.pem;
    #Key file path of ssl certificate
    ssl_certificate_key /usr/local/nginx/conf/ssh/test-web.rentsoft.cn.key;

    gzip on;
    gzip_min_length 1k;
    gzip_buffers 4 16k;
    gzip_comp_level 2;
    gzip_types text/plain application/javascript application/x-javascript text/css application/xml text/javascript application/x-httpd-php image/jpeg image/gif image/png application/wasm;
    gzip_vary off;
    gzip_disable "MSIE [1-6]\.";

    default_type application/wasm;

    location / {
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "Upgrade";
        proxy_set_header X-real-ip $remote_addr;
        proxy_set_header X-Forwarded-For $remote_addr;
        proxy_pass http://pc_web/;
    }

    location /msg_gateway{
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "Upgrade";
        proxy_set_header X-real-ip $remote_addr;
        proxy_set_header X-Forwarded-For $remote_addr;
        proxy_pass http://msg_gateway/;
    }

    location ^~/api/{
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "Upgrade";
        proxy_set_header X-real-ip $remote_addr;
        proxy_set_header X-Forwarded-For $remote_addr;
        proxy_pass http://im_api/;
    }

    location ^~/chat/{
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "Upgrade";
        proxy_set_header X-real-ip $remote_addr;
        proxy_set_header X-Forwarded-For $remote_addr;
        proxy_pass http://im_chat_api/;
    }

    location ^~/im-minio-api/ {
        proxy_set_header Host $http_host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_connect_timeout 300;

        proxy_http_version 1.1;
        proxy_set_header Connection "";
        chunked_transfer_encoding off;
        proxy_pass http://minio_s3_2/;
    }
}

# Take the domain name "test-admin.rentsoft.cn" for example
server {
    listen       443; #listening port
    server_name  test-admin.rentsoft.cn; #Your domain server_name
    ssl on;
    #Path of pem file for ssl certificate
    ssl_certificate /usr/local/nginx/conf/ssh/test-admin.rentsoft.cn_bundle.pem;
    #Key file path of ssl certificate
    ssl_certificate_key /usr/local/nginx/conf/ssh/test-admin.rentsoft.cn.key;

    gzip on;
    gzip_min_length 1k;
    gzip_buffers 4 16k;
    gzip_comp_level 2;
    gzip_types text/plain application/javascript application/x-javascript text/css application/xml text/javascript application/x-httpd-php image/jpeg image/gif image/png application/wasm;
    gzip_vary off;
    gzip_disable "MSIE [1-6]\.";

    default_type application/wasm;

    location / {
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "Upgrade";
        proxy_set_header X-real-ip $remote_addr;
        proxy_set_header X-Forwarded-For $remote_addr;
        proxy_pass http://openim_admin/;

    }

    location /msg_gateway{
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "Upgrade";
        proxy_set_header X-real-ip $remote_addr;
        proxy_set_header X-Forwarded-For $remote_addr;
        proxy_pass http://msg_gateway/;
    }

    location ^~/api/{
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "Upgrade";
        proxy_set_header X-real-ip $remote_addr;
        proxy_set_header X-Forwarded-For $remote_addr;
        proxy_pass http://im_api/;
    }

    location ^~/chat/{
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "Upgrade";
        proxy_set_header X-real-ip $remote_addr;
        proxy_set_header X-Forwarded-For $remote_addr;
        proxy_pass http://im_chat_api/;
    }

    location ^~/complete_admin/{
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "Upgrade";
        proxy_set_header X-real-ip $remote_addr;
        proxy_set_header X-Forwarded-For $remote_addr;
        proxy_pass http://im_admin_api/;
    }
}

# Redirection from HTTP to HTTPS
server {
    listen 80;
    server_name test-web.rentsoft.cn;
    rewrite ^(.*)$ https://$host$1 permanent;
}

3. Minio Configuration

Open open-im-server/config/config.yaml, modify the corresponding Minio content, and restart open-im-server.

# YAML configuration here...

4. Starting Nginx

Navigate to the /usr/local/nginx/sbin directory and execute the following command:

./nginx -s reload

5. Using the Corresponding Domain Names for Login Verification

IM: test-web.rentsoft.cn
Admin Backend: test-admin.rentsoft.cn

OpenIMSDK: Universal In-App Communication Solution for All Platforms

skiffer-git — Wed, 17 Jan 2024 03:44:03 +0000

From the day OpenIM was founded, we have always believed in "open source" as the core driving force. This not only reflects the internet's ideals of freedom, equality, and sharing but also addresses global data security challenges.

Issues such as data breaches, ransomware, and privacy invasions constantly remind us of the importance of security. Therefore, we offer a cost-effective and secure IM service to meet the data protection needs of enterprises.

OpenIMSDK

With this SDK, you can add instant messaging capabilities to your application. By connecting to a self-hosted OpenIMServer server, you can easily integrate instant messaging functions into your app with just a few lines of code.

The core functionality of OpenIMSDK is implemented based on open-im-sdk-core. Here are its details on different platforms:

iOS Integration

Tool: gomobile
Output File: XCFramework
Interaction: iOS interacts with the SDK through JSON
API: The SDK offers a re-wrapped API for easier integration
Data Storage: iOS utilizes the SQLite layer provided internally by the SDK

Android Integration

Tool: gomobile
Output File: AAR
Interaction: Android interacts with the SDK through JSON
API: The SDK offers a re-wrapped API for easier integration
Data Storage: Android utilizes the SQLite layer provided internally by the SDK

Web Integration

Language: Go
Features: Uses Go's WebAssembly support to compile into wasm
Interaction: Web pages interact with the SDK via JSON
API: The SDK offers a re-wrapped API for easier integration
Data Storage: JavaScript employs sql.js to virtualize SQLite and store it in IndexedDB to handle SQL logic

Client SDK and Demos

Platform/Language	SDK Resource Link	SDK Description	Demo Resource Link	Description
Golang	open-im-sdk-core	Golang version SDK, implemented with Gomobile/wasm/cgo
iOS	open-im-sdk-ios	iOS version SDK	open-im-ios-demo	iOS Demo
Android	open-im-sdk-android	Android version SDK	open-im-android-demo	Android Demo
Flutter	open-im-sdk-flutter	Flutter version SDK	open-im-flutter-demo	Flutter Demo
uni-app	open-im-sdk-uniapp	uni-app version SDK	open-im-uniapp-demo	uni-app Demo
JS SDK	open-im-sdk-web-wasm	JS SDK version	open-im-pc-web-demo	Electron Demo
React Native	open-im-sdk-reactnative	React Native SDK	open-im-reactnative-demo	React Native Demo

🛠 OpenIM Open Source Instant Messaging Project Docker Compose Deployment Guide

skiffer-git — Tue, 16 Jan 2024 08:09:40 +0000

The deployment of OpenIM involves multiple components and supports various methods including source code, Docker, and Kubernetes. This requires ensuring compatibility between different deployment methods and effectively managing differences between versions. This is undoubtedly a complex task involving technical depth and precise system configuration. We are committed to simplifying the deployment process while ensuring the system's flexibility and stability, to meet the needs of various users. Currently, in version 3.5, we have simplified the deployment process and will provide long-term maintenance for this version, looking forward to your user experience.

1. Environment and Component Requirements

🌐 Environmental Requirements

Note	Detailed Explanation
Operating System	Linux system
Hardware Resources	At least 4GB available memory
Golang	v1.19 or higher
Docker	v24.0.5 or higher
Git	v2.17.1 or higher

💾 Storage Component Requirements

Storage Component	Recommended Version
MongoDB	v6.0.2 or higher
Redis	v7.0.0 or higher
Zookeeper	v3.8
Kafka	v3.5.1
MySQL	v5.7 or higher
MinIO	Latest version

2. Docker Deployment

2.1 Clone Repository and Initialize

git clone https://github.com/openimsdk/openim-docker openim-docker && cd openim-docker && make init

2.2 Set OPENIM_IP

# If the server has an external IP 
export OPENIM_IP="external IP"
# If only providing internal network services
export OPENIM_IP="internal IP"

2.3 Start Services and View Logs

docker compose up -d
docker ps
docker compose logs -f openim-chat
docker compose logs -f openim-server

3. Quick Verification

📡 Open Ports

IM Ports

TCP Port	Description	Action
TCP:10001	ws protocol, message port, for client SDK	Open Port
TCP:10002	api port, such as user, friend, group, message, etc.	Open Port
TCP:10005	Needed when choosing MinIO storage (OpenIM defaults to MinIO storage)	Open Port

Chat Ports

TCP Port	Description	Action
TCP:10008	Business system, such as registration, login, etc.	Open Port
TCP:10009	Management backend, such as statistics, banning, etc.	Open Port

PC Web and Management Backend Frontend Resource Ports

TCP Port	Description	Action
TCP:11001	PC Web frontend resources	Open Port
TCP:11002	Management backend frontend resources	Open Port

Grafana Port

TCP Port	Description	Action
TCP:13000	grafana port	Open Port

4. Verification

PC Web Verification

Note: Enter http://ip:11001 in the browser to access PC Web. This IP should be the server's OPENIM_IP, ensuring browser access. Please register via mobile phone for first-time use, the default verification code is 666666.

Image: PC Web Interface Example

App Verification

Scan the QR code below or click here to download.

Image: App Download QR Code

Note: Double-click on OpenIM and modify the IP to the server's OPENIM_IP, then restart the App. Please ensure relevant ports are open and restart the App after modification. Register via mobile phone for first-time use, the default verification code is 666666.

Image: Server Address Modification - Step 1

![Server Address Modification - Step 2]

Image: Server Address Modification - Step 2

5. About Configuration Item Modifications

This project has complex configuration items, mainly because some configurations involve .env, openim-chat/config/config.yaml, and openim-server/config/config.yaml files. The explanation for modifying configuration items is divided into two parts: modifications for shared configuration items and other configuration items.

5.1 Shared Configuration Items

Shared configuration items in .env, openim-chat/config/config.yaml, and openim-server/config/config.yaml:

Ports and passwords for mysql/mongo/redis/kafka/zookeeper/minio;
SECRET;
API_OPENIM_PORT;
OPENIM_IP;
MINIO_PORT;
GRAFANA_PORT.

5.2 Modification Methods

For the shared configuration items in 5.1, choose one of the following two methods.

Method One: Regenerate All Configurations

If a comprehensive update is needed, follow these steps:

Delete existing configuration files: Remove openim-server/config/config.yaml and openim-chat/config/config.yaml files.
Modify .env file: Update related configuration items in the .env file.
Regenerate configurations and restart services: Execute docker compose down ; docker compose up -d. This will regenerate configuration files based on the new settings in the .env file and restart the services.

Method Two: Modify Multiple Configuration Files Separately

For partial updates, follow these steps:

Modify .env file: Update related configuration items in the .env file.
Manually update configuration files: According to the modifications in the .env file, update the corresponding configuration items in the openim-server/config/config.yaml and openim-chat/config/config.yaml files.
Additional handling for special variables: If OPENIM_IP, API_OPENIM_PORT, MINIO_PORT, GRAFANA_PORT are modified, update the following configuration items in the openim-server/config/config.yaml:

   object:
     apiURL: "http://$OPENIM_IP:$API_OPENIM_PORT"
     minio:
       endpoint: "http://$DOCKER_BRIDGE_GATEWAY:$MINIO_PORT"
       signEndpoint: "http://$OPENIM_IP:$MINIO_PORT"

   grafanaUrl: http://$OPENIM_IP:$GRAFANA_PORT

Restart services: Execute docker compose down ; docker compose up -d to apply changes and restart services.

5.3 Modifying Other Configuration Items

For non-shared variables in .env, openim-chat/config/config.yaml, and openim-server/config/config.yaml, modify these configuration items directly in the respective files. Execute docker compose down ; docker compose up -d to apply changes and restart services.

❓ 6. Frequently Asked Questions 🧐

1. About Docker Version 🐋

Newer versions of Docker have integrated docker-compose. Older versions of Docker may not support the gateway feature❌. We recommend upgrading to a newer version, such as 23.0.1🔝.

7. About OpenIM

Thanks to extensive developer support, OpenIM maintains a leading position in the open-source instant messaging (IM) field, with its GitHub stars surpassing 12,000. In the current context of increasing emphasis on data and privacy security, there is growing demand for IM private deployment, aligning with the rapid development trend of China's software industry. Especially in government and enterprise sectors, with the rapid development of information technology and widespread application of innovative industries, the demand for IM solutions has surged. Furthermore, the continuous expansion of the collaborative office software market has made "security and controllability" a key attribute.

Repository address: https://github.com/openimsdk

🛠 Open Source Instant Messaging (IM) Project OpenIM Source Code Deployment Guide

skiffer-git — Wed, 10 Jan 2024 07:32:23 +0000

Deploying OpenIM involves multiple components and supports various methods, including source code, Docker, and Kubernetes. This requires ensuring compatibility between different deployment methods while effectively managing differences between versions. Indeed, these are complex issues involving in-depth technical details and precise system configurations. Our goal is to simplify the deployment process while maintaining the system's flexibility and stability to suit different users' needs. Currently, version 3.5 has simplified the deployment process, and this version will be maintained for a long time. We welcome everyone to use it.

1. Environment and Component Requirements

🌐 Environmental Requirements

Note	Detailed Description
OS	Linux system
Hardware	At least 4GB of RAM
Golang	v1.19 or higher
Docker	v24.0.5 or higher
Git	v2.17.1 or higher

💾 Storage Component Requirements

Storage Component	Recommended Version
MongoDB	v6.0.2 or higher
Redis	v7.0.0 or higher
Zookeeper	v3.8
Kafka	v3.5.1
MySQL	v5.7 or higher
MinIO	Latest version

2. Deploying OpenIM Server (IM)

2.1 📡 Setting OPENIM_IP

# If the server has an external IP
export OPENIM_IP="external IP"
# If only providing internal network services
export OPENIM_IP="internal IP"

2.2 🏗️ Deploying Components (mongodb/redis/zookeeper/kafka/MinIO, etc.)

git clone https://github.com/OpenIMSDK/open-im-server && cd open-im-server 
# It's recommended to switch to release-v3.5 or later release branches 
make init && docker compose up -d

2.3 🛠️ Compilation

make build

2.4 🚀 Starting/Stopping/Checking

# Start
make start
# Stop
make stop
# Check
make check

3. Deploying App Server (Chat)

3.1 🏗️ Deploying Components (mysql)

# Go back to the previous directory
cd ..
# Clone the repository, recommended to switch to release-v1.5 or later release branches
git clone https://github.com/OpenIMSDK/chat chat && cd chat
# Deploy mysql
docker run -d --name mysql2 -p 13306:3306 -p 33306:33060 -v "$(pwd)/components/mysql/data:/var/lib/mysql" -v "/etc/localtime:/etc/localtime" -e MYSQL_ROOT_PASSWORD="openIM123" --restart always mysql:5.7

3.2 🛠️ Compilation

make init
make build

3.3 🚀 Starting/Stopping/Checking

# Start
make start
# Stop
make stop
# Check
make check

4. Quick Validation

📡 Open Ports

IM Ports

TCP Port	Description	Action
TCP:10001	ws protocol, messaging port, for client SDK	Allow port
TCP:10002	API port, like user, friend, group, message interfaces	Allow port
TCP:10005	Required when choosing MinIO storage (OpenIM defaults to MinIO storage)	Allow port

Chat Ports

TCP Port	Description	Action
TCP:10008	Business system, like registration, login, etc.	Allow port
TCP:10009	Management backend, like statistics, account banning, etc.	Allow port

PC Web and Management Backend Frontend Resource Ports

TCP Port	Description	Action
TCP:11001	PC Web frontend resources	Allow port
TCP:11002	Management backend frontend resources	Allow port

Grafana Port

TCP Port	Description	Action
TCP:13000	Grafana port	Allow port

Verification

PC Web Verification

Note: Enter http://ip:11001 in your browser to access the PC Web. This IP should be the server's OPENIM_IP to ensure browser accessibility. For first-time use, please register using your mobile phone number, with the default verification code being 666666.

Image: PC Web Interface Example

App Verification

Scan the following QR code or click here to download.

Image: App Download QR Code

Note: Double-click on OpenIM and change the IP to the server's OPENIM_IP then restart the App. Please ensure related ports are open, and restart the App after making changes. For first-time use, please register first through your mobile phone number, with the default verification code being 666666.

![Server Address Modification - Step 1]

Image: Server Address Modification - Step 1

![Server Address Modification - Step 2]

Image: Server Address Modification - Step 2

5. Modifying Configuration Items

5.1 🛠️ Modifying Shared Configuration Items

Configuration Item	Files to be Modified	Action
mongo/kafka/minio related	.env, openim-server/config/config.yaml	Restart components and IM
redis/zookeeper related	.env, openim-server/config/config.yaml, chat/config/config.yaml	Restart components, IM, and Chat
SECRET	openim-server/config/config.yaml, chat/config/config.yaml	Restart IM and Chat

5.2 🔄 Modifying Special Configuration Items

Special configuration items: API_OPENIM_PORT/MINIO_PORT/OPENIM_IP/GRAFANA_PORT

Modify the special configuration items in the .env file
Modify the configuration in openim-server/config/config.yaml according to the rules
Modify the configuration in chat/config/config.yaml according to the rules
Restart IM and Chat

5.3 🛠️ Modifying Other Configuration Items

For other configuration items in .env, chat/config/config.yaml, and openim-server/config/config.yaml, you can modify these items directly in the respective files.

5.4 Modifying Ports

Note that for any modification of IM-related ports, it's necessary to synchronize the changes in open-im-server/scripts/install/environment.sh.

6. Frequently Asked Questions

6.1 📜 Viewing Logs

Runtime logs: logs/OpenIM.log.all.*
Startup logs: _output/logs/openim_*.log

6.2 🚀 Startup Order

The startup order is as follows:

Components IM depends on: mongo/redis/kafka/zookeeper/minio, etc.
IM
Components Chat depends on: mysql
Chat

6.3 🐳 Docker Version

The new version of Docker has integrated docker-compose.
Older versions of Docker might not support the gateway feature. It's recommended to upgrade to a newer version, such as 23.0.1.

7. About OpenIM

Thanks to widespread developer support, OpenIM maintains a leading position in the open-source instant messaging (IM) field, with the number of stars on Github exceeding 12,000. In the current context of increasing attention to data and privacy security, the demand for IM private deployment is growing, which aligns with the rapid development trend of China's software industry. Especially in government and enterprise sectors, with the rapid development of information technology and the widespread application of innovative

industries, the demand for IM solutions has surged. Further, the continuous expansion of the collaborative office software market has made "secure and controllable" a key attribute.

Repository address: https://github.com/openimsdk

Deploy OpenIM using Docker

skiffer-git — Thu, 09 Nov 2023 06:48:33 +0000

🌟 Environment Requirements

Considerations	Details
Operating System	Linux, ideally Ubuntu 22.04, root user
Hardware Resources	At least 4GB RAM, for user volume <100,000, single machine deployment: 8C 16G 10Mb 1T regular disk
golang	1.18 and above
docker	Docker version 24.0.5, build ced0996 or newer
git	2.17.1 and above

📦 Storage Component Requirements

Storage Component	Recommended Version
mongodb	6.0.2 and above
redis	7.0.0 and above
zookeeper	latest
kafka	latest
mysql	5.7 and above
minio	latest

🛠 1. Set Common Environment Variables

CHAT_BRANCH
- Description: chat version
- Default: release-v1.3
- Consideration: Supports version 1.3 and above
```
export CHAT_BRANCH="release-v1.3"
```
SERVER_BRANCH
- Description: OpenIMServer version
- Default: release-v3.3
- Consideration: Supports version 3.3 and above
```
export SERVER_BRANCH="release-v3.3"
```
PASSWORD
- Description: Component password (mysql/mongodb/redis/minio)
- Default: openIM123
- Consideration: Password should be ≥8 characters and without special characters
```
export PASSWORD="openIM123"
```
USER
- Description: Component username (mysql/mongodb/redis/minio)
- Default: root
```
export USER="root"
```
API_URL
- Description: API address
- Note: Automatically fetched if there's an external IP; for internal network, set it to the server IP
```
export API_URL="http://ip:10002"
```
DATA_DIR
- Description: Data volume directory
- Default: ./
```
export DATA_DIR="./"
```

🛠 More Environment Variables

🟢 For a detailed understanding of various environment variables, please refer to this document.

⚠️ Note: Variables set using export have higher priority than the ones in the script.

🚀 2. Pull and Launch Image

git clone https://github.com/openim-sigs/openim-docker openim/openim-docker && export openim=$(pwd)/openim && cd $openim/openim-docker && make init && docker compose up -d

🟢 If your docker doesn't support compose, it's recommended to upgrade following this guide.

📜 View Logs

docker compose logs openim-server
docker compose logs openim-chat

🟢 More logs can be found at: openim-server/branch/logs/ and openim-chat/branch/logs

🩺 Check Health Status

docker ps

3. Quick Verification

Please refer to the Quick Verification document.

❓ Frequently Asked Questions 🧐

1. How to modify using external components? 🛠️

Example: Using external mysql🔗:

📝 Edit docker-compose.yaml and comment out mysql configuration and its corresponding depends_on.
📝 Edit scripts/install/environment.sh and change the mysql configuration.
💻 Run the command: make init
🚀 Run the command: docker compose up -d

2. Health status is `starting`? 🟠

Initially, before the health check, Docker's default status is starting⏳. Approximately after 1 minute, the status changes to healthy✅.

3. Port Mapping 🌐

Docker networks allow for user-defined settings🔧. You can map ports as usual🔀.

4. About Docker Version 🐋

The new version of Docker has integrated docker-compose. Older versions of Docker might not support the gateway feature❌. It's recommended to upgrade to a newer version, such as 23.0.1🔝.

About OpenIM

Open source, and universal instant messaging components

OpenIM includes server and client SDKs, achieving high performance, lightweight, and easy-to-extend features. Developers can integrate instant messaging and real-time networking capabilities quickly into their applications by integrating the OpenIM SDK and deploying the server privately, ensuring the security and privacy of business data.

Currently, the github star is over 12,000, including iOS, Android, Flutter, ReactNative, web, pc, and Uniapp platforms.

GitHub: https://github.com/openimsdk/open-im-server
Official Website: https://docs.openim.io/

🚀 OpenIM: An Open-Source Instant Messaging SDK Solution

skiffer-git — Tue, 24 Oct 2023 06:27:16 +0000

🚀 OpenIM: An Open-Source Instant Messaging SDK Solution

OpenIM consists of two main components: OpenIMSDK and OpenIMServer. Their main features are:

📦 OpenIMSDK

Embedded directly into applications as a library.

🖥️ OpenIMServer

Deployed as an independent server-side program.

📢 Note: OpenIMSDK does not integrate a UI interface, and OpenIMServer does not provide user registration and login functions, meaning it's not a complete IM product.

📘 Detailed about OpenIMSDK

OpenIMSDK is the IM SDK designed for OpenIMServer, made specifically for embedding into client applications. Its main features and technical characteristics are:

🌟 Key Features:

📦 Local storage
🔔 Listener callback
🛡️ API encapsulation
🌐 Connection management

📚 Main Modules:

🚀 Initialization and login
👤 User management
👫 Friend management
🤖 Group functions
💬 Conversation handling

🔧 Technical Implementation:

🏗️ Written in Golang
🌉 Cross-platform compilation using Gomobile
🕸️ Web SDK implementation using wasm technology
🌌 C interface export via cgo
🌍 Covers almost all platforms and languages

Platform/Language	SDK Resource Link	SDK Description	Sample Resource Link	Description
Golang	open-im-sdk-core	Golang version SDK using Gomobile/wasm/cgo	-	-
iOS	open-im-sdk-ios	iOS version SDK	open-im-ios-demo	iOS sample
Android	open-im-sdk-android	Android version SDK	open-im-android-demo	Android sample
Flutter	open-im-sdk-flutter	Flutter version SDK	open-im-flutter-demo	Flutter sample
uni-app	open-im-sdk-uniapp	uni-app version SDK	open-im-uniapp-demo	uni-app sample
JS SDK	open-im-sdk-web-wasm	JS SDK version	open-im-pc-web-demo	PC web sample
React Native	open-im-sdk-reactnative	React Native SDK	open-im-reactnative-demo	React Native sample

🔍 Detailed about OpenIMServer

OpenIMServer has the following characteristics:

🧩 Made up of multiple modules, such as the gateway and several rpc services.
🌐 Microservice architecture, supports cluster mode.
🚀 Variety of deployment methods, like from source code, kubernetes or docker deployment.

🔗 OpenIMServer Repository Link

🌐 REST API

OpenIMServer offers a REST API for business systems, aiming to provide more functionalities, like creating groups or sending push notifications via backend interfaces.

📞 Callback

OpenIMServer provides callback capabilities to expand more business forms. In this context, a callback means that OpenIMServer will send a request to the business server either before or after a certain event, such as a callback before or after sending a message.