fix: add openim server deploy (#1036)

* fix: add openim server deploy Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com> * feat: add openim im ctl Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com> * feat: add more deployment docs Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com> * feat: add openim save images and release Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com> * build: set IBM sarama and set k8s deployment helm Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com> * fix: add openim code fix Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com> * fix: add openim code fix Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com> --------- Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com>
2026-05-09 03:25:59 +08:00 · 2023-09-07 17:38:09 +08:00
parent de50331d7a
commit da8912121f
44 changed files with 2970 additions and 282 deletions
@@ -0,0 +1,138 @@
+# OpenIM enviroment
+
+
+## How to change the configuration
+
+
+**Modify the configuration files:**
+
+Three ways to modify the configuration:
+
+#### **1. Recommended using environment variables:**
+
+```bash
+export PASSWORD="openIM123" # Set password
+export USER="root" # Set username
+# Choose chat version and server version https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/images.md, eg: main, release-v*.*
+export CHAT_BRANCH="main"
+export SERVER_BRANCH="main"
+#... Other environment variables
+# MONGO_USERNAME: This sets the MongoDB username
+# MONGO_PASSWORD: Set the MongoDB password
+# MONGO_DATABASE: Sets the MongoDB database name
+# MINIO_ENDPOINT: set the MinIO service address
+# API_URL: under network environment, set OpenIM Server API address
+export API_URL="http://127.0.0.1:10002"
+```
+
+Next, update the configuration using `make init`:
+
+```bash
+make init
+```
+
+#### **2. Modify the automation script:**
+
+```bash
+scripts/install/environment.sh
+```
+
+Next, update the configuration using `make init`:
+
+```bash
+make init
+```
+
+#### 3. Modify `config.yaml` and `.env` files (but will be overwritten when using `make init` again).
+
+The `config/config.yaml` file has detailed configuration instructions for the storage components.
+
+
+The config file is available via [environment.sh](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/scripts/install/environment.sh) configuration [openim.yaml](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/deployments/templates/openim.yaml) template, and then through the `make init` to automatically generate a new configuration.
+
+
+
+
+## Configuration Details
+
+###### Zookeeper
+
+- **Purpose**: Used for RPC service discovery and registration, cluster support.
+  
+    ```bash
+    zookeeper:
+      schema: openim                          # Not recommended to modify
+      address: [ 127.0.0.1:2181 ]            # Address
+      username:                               # Username
+      password:                               # Password
+    ```
+
+###### MySQL
+
+- **Purpose**: Used for storing users, relationships, and groups. Supports master-slave database.
+
+    ```bash
+    mysql:
+      address: [ 127.0.0.1:13306 ]            # Address
+      username: root                          # Username
+      password: openIM123                     # Password
+      database: openIM_v2                     # Not recommended to modify
+      maxOpenConn: 1000                       # Maximum connection
+      maxIdleConn: 100                        # Maximum idle connection
+      maxLifeTime: 60                         # Max time a connection can be reused (seconds)
+      logLevel: 4                             # Log level (1=silent, 2=error, 3=warn, 4=info)
+      slowThreshold: 500                      # Slow statement threshold (milliseconds)
+    ```
+
+###### Mongo
+
+- **Purpose**: Used for storing offline messages. Supports mongo sharded clusters.
+
+    ```bash
+    mongo:
+      uri:                                    # Use this value directly if not empty
+      address: [ 127.0.0.1:37017 ]            # Address
+      database: openIM                        # Default mongo db
+      username: root                          # Username
+      password: openIM123                     # Password
+      maxPoolSize: 100                        # Maximum connections
+    ```
+
+###### Redis
+
+- **Purpose**: Used for storing message sequence numbers, latest messages, user tokens, and MySQL cache. Supports cluster deployment.
+
+    ```bash
+    redis:
+      address: [ 127.0.0.1:16379 ]            # Address
+      username:                               # Username
+      password: openIM123                     # Password
+    ```
+
+###### Kafka
+
+- **Purpose**: Used for message queues for decoupling. Supports cluster deployment.
+
+    ```bash
+    kafka:
+      username:                               # Username
+      password:                               # Password
+      addr: [ 127.0.0.1:9092 ]                # Address
+      topics:
+        latestMsgToRedis: "latestMsgToRedis"
+        offlineMsgToMongo: "offlineMsgToMongoMysql"
+        msgToPush: "msgToPush"
+        msgToModify: "msgToModify"
+      consumerGroupID:
+        msgToRedis: redis
+        msgToMongo: mongo
+        msgToMySql: mysql
+        msgToPush: push
+        msgToModify: modify
+    ```
+
+
+
+## Config options
+
+...
@@ -19,7 +19,7 @@ You can use tools like PuTTY or other SSH clients to log in to your Ubuntu serve
 Generally, a project will involve multiple developers. Instead of provisioning a server for every developer, many organizations share a single development machine among developers. To simulate this real-world scenario, we'll use a standard user for development. To create the `openim` user:

 ```
-bashCopy code# adduser openim # Create the openim user, which developers will use for login and development.
+# adduser openim # Create the openim user, which developers will use for login and development.
 # passwd openim # Set the login password for openim.
 ```

@@ -30,7 +30,7 @@ Working with a non-root user ensures the system's safety and is a good practice.
 Often, even standard users need root privileges. Instead of frequently asking the system administrator for the root password, you can add the standard user to the sudoers. This allows them to temporarily gain root access using the sudo command. To add the `openim` user to sudoers:

 ```
-bashCopy code
+
 # sed -i '/^root.*ALL=(ALL:ALL).*ALL/a\openim\tALL=(ALL) \tALL' /etc/sudoers
 ```

@@ -45,7 +45,7 @@ Assuming we're using the **openim** user, log in using PuTTY or other SSH client
 The first step after logging into a new server is to configure the `$HOME/.bashrc` file. It makes the Linux shell more user-friendly by setting environment variables like `LANG` and `PS1`. Here's how the configuration would look:

 ```
-bashCopy code# .bashrc
+# .bashrc

 # User specific aliases and functions

@@ -82,7 +82,7 @@ The OpenIM project on Ubuntu may have various dependencies. Some are direct, and
 You can use the `apt` command to install the required tools on Ubuntu:

 ```
-bashCopy code$ sudo apt-get update 
+$ sudo apt-get update 
 $ sudo apt-get install build-essential autoconf automake cmake perl libcurl4-gnutls-dev libtool gcc g++ glibc-doc-reference zlib1g-dev git-lfs telnet lrzsz jq libexpat1-dev libssl-dev
 $ sudo apt install libcurl4-openssl-dev
 ```
@@ -92,7 +92,7 @@ $ sudo apt install libcurl4-openssl-dev
 A higher version of Git ensures compatibility with certain commands like `git fetch --unshallow`. To install a recent version:

 ```
-bashCopy code$ cd /tmp
+$ cd /tmp
 $ wget --no-check-certificate https://mirrors.edge.kernel.org/pub/software/scm/git/git-2.36.1.tar.gz
 $ tar -xvzf git-2.36.1.tar.gz
 $ cd git-2.36.1/
@@ -105,7 +105,7 @@ $ git --version
 Then, add Git's binary directory to the `PATH`:

 ```
-bashCopy code
+
 $ echo 'export PATH=/usr/local/libexec/git-core:$PATH' >> $HOME/.bashrc
 ```

@@ -114,7 +114,7 @@ $ echo 'export PATH=/usr/local/libexec/git-core:$PATH' >> $HOME/.bashrc
 To set up Git:

 ```
-bashCopy code$ git config --global user.name "Your Name"
+$ git config --global user.name "Your Name"
 $ git config --global user.email "your_email@example.com"
 $ git config --global credential.helper store
 $ git config --global core.longpaths true
@@ -123,14 +123,14 @@ $ git config --global core.longpaths true
 Other Git configurations include:

 ```
-bashCopy code
+
 $ git config --global core.quotepath off
 ```

 And for handling larger files:

 ```
-bashCopy code
+
 $ git lfs install --skip-repo
 ```

@@ -44,7 +44,7 @@ For Linux:
 The OpenIM Protoc tool provides a multitude of options for parsing `.proto` files and generating output:

 ```
-bashCopy code
+
 ./protoc [OPTION] PROTO_FILES
 ```

@@ -82,7 +82,7 @@ We reinforce our approach to branch management and versioning with stringent tes
 The workflow to address a bug fix might follow these steps:

 ```bash
-bashCopy codebashCopy code# Checkout the branch for the version that needs the bug fix
+# Checkout the branch for the version that needs the bug fix
 git checkout release-v3.1

 # Create a new branch for the bug fix
@@ -121,4 +121,3 @@ Throughout this process, active communication within the team is pivotal to main
 ## Docker Images Version Management

 For more details on managing Docker image versions, visit [OpenIM Docker Images Administration](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/conversions/images.md).
-