feat: replace mongo database openIM_v3 to openim_v3

config/templates/config.yaml.template

@@ -52,7 +52,7 @@ mongo:
 # Default MongoDB database name
 # Maximum connection pool size
   address: [ 172.28.0.1:37017 ]
-  database: openIM_v3
+  database: openim_v3
   username: root
   password: openIM123
   maxPoolSize: 100

config/templates/env.template

@@ -97,8 +97,8 @@ MONGO_ADDRESS=172.28.0.2
 MONGO_PASSWORD=openIM123
 
 # Name of the database in MongoDB to be used.
-# Default: MONGO_DATABASE=openIM_v3
-MONGO_DATABASE=openIM_v3
+# Default: MONGO_DATABASE=openim_v3
+MONGO_DATABASE=openim_v3
 
 # ----- Redis Configuration -----
 # Address or hostname for the Redis service.

deployments/templates/env-template.yaml

@@ -115,7 +115,7 @@ MONGO_OPENIM_USERNAME=${MONGO_OPENIM_USERNAME}
 MONGO_OPENIM_PASSWORD=${MONGO_OPENIM_PASSWORD}
 
 # Specifies the database name to be used within MongoDB.
-# Default: MONGO_DATABASE=openIM_v3
+# Default: MONGO_DATABASE=openim_v3
 MONGO_DATABASE=${MONGO_DATABASE}
 
 # ----- Redis Configuration -----

docker-compose.yml

@@ -27,7 +27,7 @@ services:
       - wiredTigerCacheSizeGB=1
       - MONGO_INITDB_ROOT_USERNAME=${MONGO_USERNAME:-root}
       - MONGO_INITDB_ROOT_PASSWORD=${MONGO_PASSWORD:-openIM123}
-      - MONGO_INITDB_DATABASE=${MONGO_DATABASE:-openIM_v3}
+      - MONGO_INITDB_DATABASE=${MONGO_DATABASE:-openim_v3}
       - MONGO_OPENIM_USERNAME=${MONGO_OPENIM_USERNAME:-openIM} # Non-root username
       - MONGO_OPENIM_PASSWORD=${MONGO_OPENIM_PASSWORD:-openIM123456} # Non-root password
     restart: always
@@ -87,6 +87,7 @@ services:
        - KAFKA_CFG_CONTROLLER_QUORUM_VOTERS=0@<your_host>:9093
        - KAFKA_CFG_LISTENERS=PLAINTEXT://:9092,CONTROLLER://:9093,EXTERNAL://:9094
        - KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092,EXTERNAL://${DOCKER_BRIDGE_GATEWAY:-172.28.0.1}:${KAFKA_PORT:-19094}
+      #  - KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092,EXTERNAL://127.0.0.1:${KAFKA_PORT:-19094} # Mac Deployment
        - KAFKA_CFG_LISTENER_SECURITY_PROTOCOL_MAP=CONTROLLER:PLAINTEXT,EXTERNAL:PLAINTEXT,PLAINTEXT:PLAINTEXT
        - KAFKA_CFG_CONTROLLER_LISTENER_NAMES=CONTROLLER
     networks:

docs/contrib/mac-developer-deployment-guide.md

@@ -45,60 +45,6 @@ Homebrew is an essential package manager for macOS. Install it using:
    git config --global user.email "your.email@example.com"
    ```
 
-### Forking and Cloning the Repository
-
-To optimize and add logic to your instructions, particularly regarding deploying on a Mac, you can modify them as follows:
-
-1. **Fork the OpenIM Repository**: Fork the OpenIM repository on GitHub to your account.
-
-2. **Clone Your Fork to Your Local Machine**:
-   Open your terminal and execute the following commands:
-
-   ```sh
-   # Clone the repository
-   git clone https://github.com/<your-username>/open-im-server.git
-
-   # Set Docker bridging network mode for Mac
-   export DOCKER_BRIDGE_SUBNET=127.0.0.0/16
-
-   # Set OpenIM IP
-   export OPENIM_IP=<your-ip>
-
-   # Initialize configuration
-   make init
-
-   # Start components using Docker
-   docker compose up -d
-
-   # Start OpenIM Server
-   make start
-   ```
-
-3. **Additional Steps for Mac Deployment**:
-   If you are deploying on a Mac and wish to use the chat feature, you need to modify the `docker-compose` file. Specifically, you'll need to uncomment the sections related to `openim-chat` and `mysql`. 
-
-   Here's how to do it:
-
-   - Open the `docker-compose.yml` file in a text editor.
-   - Find the sections for `openim-chat` and `mysql`.
-   - Remove the comment marks (`#`) at the beginning of the lines in these sections to enable them.
-   - Save the file after making these changes.
-
-4. **Update and Restart Services**:
-   After modifying the `docker-compose` file, you need to update and restart the services to apply these changes. Run the following command in your terminal:
-
-   ```sh
-   # Update and restart services
-   docker compose up -d
-
-   # Check openim-chat start
-   docker compose logs openim-chat
-   ```
-
-   This command will re-read the `docker-compose.yml` file, apply the new configuration, and restart the necessary containers.
-
-Remember, replacing `<your-username>` and `<your-ip>` with your actual GitHub username and desired IP address for OpenIM is crucial. These steps should streamline the setup process, particularly for Mac users wishing to use the chat feature.
-
 ### Setting Up the Devcontainer
 
 `Devcontainers` provide a Docker-based isolated development environment. 
@@ -126,6 +72,139 @@ Ensure the version of Go is compatible with the version required by OpenIM (refe
 
 Install other required tools like Docker, Vagrant, and necessary GNU utils as described in the main documentation.
 
+## Mac Deployment openim-chat and openim-server
+
+To integrate the Chinese document into an English document for Linux deployment, we will first translate the content and then adapt it to suit the Linux environment. Here's how the translated and adapted content might look:
+
+### Ensure a Clean Environment
+
+- It's recommended to execute in a new directory.
+- Run `ps -ef | grep openim` to ensure no OpenIM processes are running.
+- Run `ps -ef | grep chat` to check for absence of chat-related processes.
+- Execute `docker ps` to verify there are no related containers running.
+
+### Source Code Deployment
+
+#### Deploying openim-server
+
+Source code deployment is slightly more complex because Docker's networking on Linux differs from Mac.
+
+```bash
+git clone https://github.com/openimsdk/open-im-server
+cd open-im-server
+
+export OPENIM_IP="Your IP" # If it's a cloud server, setting might not be needed
+make init # Generates configuration files
+```
+
+Before deploying openim-server, modify the Kafka logic in the docker-compose.yml file. Replace:
+
+```yaml
+- KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092,EXTERNAL://${DOCKER_BRIDGE_GATEWAY:-172.28.0.1}:${KAFKA_PORT:-19094}
+```
+
+With:
+
+```yaml
+- KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092,EXTERNAL://127.0.0.1:${KAFKA_PORT:-19094}
+```
+
+Then start the service:
+
+```bash
+docker compose up -d
+```
+
+Before starting the openim-server source, set `config/config.yaml` by replacing all instances of `172.28.0.1` with `127.0.0.1`:
+
+```bash
+vim config/config.yaml -c "%s/172\.28\.0\.1/127.0.0.1/g" -c "wq"
+```
+
+Then start openim-server:
+
+```bash
+make start
+```
+
+To check the startup:
+
+```bash
+make check
+```
+
+<aside>
+🚧 To avoid mishaps, it's best to wait five minutes before running `make check` again.
+
+</aside>
+
+#### Deploying openim-chat
+
+There are several ways to deploy openim-chat, either by source code or using Docker.
+
+Navigate back to the parent directory:
+
+```bash
+cd ..
+```
+
+First, let's look at deploying chat from source:
+
+```bash
+git clone https://github.com/openimsdk/chat
+cd chat
+make init # Generates configuration files
+```
+
+If openim-chat has not deployed MySQL, you will need to deploy it. Note that the official Docker Hub for MySQL does not support architectures like ARM, so you can use the newer version of the open-source edition:
+
+```bash
+docker run -d \
+  --name mysql \
+  -p 13306:3306 \
+  -p 3306:33060 \
+  -v "$(pwd)/components/mysql/data:/var/lib/mysql" \
+  -v "/etc/localtime:/etc/localtime" \
+  -e MYSQL_ROOT_PASSWORD="openIM123" \
+  --restart always \
+  mariadb:10.6
+```
+
+Before starting the source code of openim-chat, set `config/config.yaml` by replacing all instances of `172.28.0.1` with `127.0.0.1`:
+
+```bash
+vim config/config.yaml -c "%s/172\.28\.0\.1/127.0.0.1/g" -c "wq"
+```
+
+Then start openim-chat from source:
+
+```bash
+make start
+```
+
+To check, ensure the following four processes start successfully:
+
+```bash
+➜  chat git:(main) ✗ ps -ef | grep chat      
+# [Output showing four running chat processes]
+```
+
+Access the web interface: http://ip:11001
+
+### Docker Deployment
+
+Refer to https://github.com/openimsdk/openim-docker for Docker deployment instructions, which can be followed similarly on Linux.
+
+```bash
+git clone https://github.com/openimsdk/openim-docker
+cd openim-docker
+export OPENIM_IP="Your IP"
+make init
+docker compose up -d 
+docker compose logs -f openim-server
+docker compose logs -f openim-chat
+```
+
 ## GitHub Development Workflow
 
 ### Creating a New Branch

pkg/common/db/controller/msg_test.go

@@ -146,7 +146,7 @@ func Test_BatchInsertChat2DB(t *testing.T) {
 func GetDB() *commonMsgDatabase {
 	config.Config.Mongo.Address = []string{"203.56.175.233:37017"}
 	// config.Config.Mongo.Timeout = 60
-	config.Config.Mongo.Database = "openIM_v3"
+	config.Config.Mongo.Database = "openim_v3"
 	// config.Config.Mongo.Source = "admin"
 	config.Config.Mongo.Username = "root"
 	config.Config.Mongo.Password = "openIM123"

scripts/install/dependency.sh

@@ -34,7 +34,7 @@ docker run -d \
     -e wiredTigerCacheSizeGB=1 \
     -e MONGO_INITDB_ROOT_USERNAME=${OPENIM_USER} \
     -e MONGO_INITDB_ROOT_PASSWORD=${PASSWORD} \
-    -e MONGO_INITDB_DATABASE=openIM \
+    -e MONGO_INITDB_DATABASE=openim_v3 \
     -e MONGO_OPENIM_USERNAME=${OPENIM_USER} \
     -e MONGO_OPENIM_PASSWORD=${PASSWORD} \
     --restart always \

scripts/install/environment.sh

@@ -52,7 +52,7 @@ def "OPENIM_USER" "root"
 readonly PASSWORD=${PASSWORD:-'openIM123'}
 
 # 设置统一的数据库名称，方便管理
-def "DATABASE_NAME" "openIM_v3"
+def "DATABASE_NAME" "openim_v3"
 
 # Linux系统 openim 用户
 def "LINUX_USERNAME" "openim"

tools/data-conversion/README.md

@@ -31,7 +31,7 @@ var (
     usernameV3 = "root"
     passwordV3 = "openIM123"
     addrV3     = "127.0.0.1:13306"
-    databaseV3 = "openIM_v3"
+    databaseV3 = "openim_v3"
 )
 ```
 

tools/data-conversion/openim/cmd/conversion-mysql/conversion-mysql.go

@@ -38,7 +38,7 @@ func main() {
 		usernameV3 = "root"            // v3版本mysql用户名
 		passwordV3 = "openIM123"       // v3版本mysql密码
 		addrV3     = "127.0.0.1:13306" // v3版本mysql地址
-		databaseV3 = "openIM_v3"       // v3版本mysql数据库名字
+		databaseV3 = "openim_v3"       // v3版本mysql数据库名字
 	)
 
 	var concurrency = 1 // 并发数量

tools/data-conversion/openim/common/config.go

@@ -44,7 +44,7 @@ const (
 	UsernameV3 = "root"
 	PasswordV3 = "openIM123"
 	IpV3       = "43.134.63.160:13306"
-	DatabaseV3 = "openIM_v3"
+	DatabaseV3 = "openim_v3"
 )
 
 // V3 chat.

tools/data-conversion/openim/mysql/cmd.go

@@ -38,7 +38,7 @@ func Cmd() {
 		usernameV3 = "root"
 		passwordV3 = "openIM123"
 		addrV3     = "203.56.175.233:13306"
-		databaseV3 = "openIM_v3"
+		databaseV3 = "openim_v3"
 	)
 	log.SetFlags(log.LstdFlags | log.Llongfile)
 	dsnV2 := fmt.Sprintf("%s:%s@tcp(%s)/%s?charset=utf8mb4&parseTime=True&loc=Local", usernameV2, passwordV2, addrV2, databaseV2)