Merge branch 'openimsdk:main' into add_set_ex_friend

.github/workflows/openimci.yml

@@ -201,7 +201,6 @@ jobs:
     - name: Build, Start, Check Services and Print Logs for Ubuntu
       if: runner.os == 'Linux'
       run: |
-        sudo make init && \
         sudo make build && \
         sudo make start && \
         sudo make check || \

config/templates/config.yaml.template

@@ -506,7 +506,7 @@ callback:
 # The number of ports needs to be consistent with msg_transfer_service_num in script/path_info.sh
 prometheus:
   enable: false
-  prometheusUrl: 172.28.0.1:13000
+  grafanaUrl: 172.28.0.1:13000
   apiPrometheusPort: [20100]
   userPrometheusPort: [ 20110 ]
   friendPrometheusPort: [ 20120 ]

deployments/templates/env-template.yaml

@@ -1,42 +1,23 @@
-# Copyright © 2023 OpenIM. All rights reserved.
+# -----------------------------------------------------------------------------
-#
+# General Configuration
-# Licensed under the Apache License, Version 2.0 (the "License");
+# This section contains general configuration options for the entire environment.
-# you may not use this file except in compliance with the License.
+# These options can be set via environment variables. If both environment variables 
-# You may obtain a copy of the License at
+# and settings in this .env file exist, the environment variables take precedence.
-#
+# -----------------------------------------------------------------------------
-#     http://www.apache.org/licenses/LICENSE-2.0
+# ==========================
-#
+# General Configuration
-# Unless required by applicable law or agreed to in writing, software
+# ==========================
-# distributed under the License is distributed on an "AS IS" BASIS,
+# These settings apply to the overall environment.
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
 
-# ======================================
+# Data storage directory for persistent data.
-# ========= Basic Configuration ========
+# Example: DATA_DIR=/path/to/data
-# ======================================
-
-# The user for authentication or system operations.
-# Default: OPENIM_USER=root
-USER=${OPENIM_USER}
-
-# Password associated with the specified user for authentication.
-# Default: PASSWORD=openIM123
-PASSWORD=${PASSWORD}
-
-# Base URL for the application programming interface (API).
-# Default: API_URL=http://172.28.0.1:10002
-API_URL=${API_URL}
-
-# Directory path for storing data files or related information.
-# Default: DATA_DIR=./
 DATA_DIR=${DATA_DIR}
 
-# Choose the appropriate image address, the default is GITHUB image, 
+# Docker image registry. Uncomment the preferred one.
-# you can choose docker hub, for Chinese users can choose Ali Cloud
+# Options: ghcr.io/openimsdk, openim, registry.cn-hangzhou.aliyuncs.com/openimsdk
-# export IMAGE_REGISTRY="ghcr.io/openimsdk"
+# IMAGE_REGISTRY="ghcr.io/openimsdk"
-# export IMAGE_REGISTRY="openim"
+# IMAGE_REGISTRY="openim"
-# export IMAGE_REGISTRY="registry.cn-hangzhou.aliyuncs.com/openimsdk"
+# IMAGE_REGISTRY="registry.cn-hangzhou.aliyuncs.com/openimsdk"
 IMAGE_REGISTRY=${IMAGE_REGISTRY}
 
 # ======================================
@@ -47,10 +28,9 @@ IMAGE_REGISTRY=${IMAGE_REGISTRY}
 # Default: DOCKER_BRIDGE_SUBNET=172.28.0.0/16
 DOCKER_BRIDGE_SUBNET=${DOCKER_BRIDGE_SUBNET}
 
-# Gateway for the Docker network.
+# Set and specify the IP addresses of some containers. Generally speaking, 
-# Default: DOCKER_BRIDGE_GATEWAY=172.28.0.1
+# you do not need to modify these configurations to facilitate debugging
 DOCKER_BRIDGE_GATEWAY=${DOCKER_BRIDGE_GATEWAY}
-
 MONGO_NETWORK_ADDRESS=${MONGO_NETWORK_ADDRESS}
 REDIS_NETWORK_ADDRESS=${REDIS_NETWORK_ADDRESS}
 KAFKA_NETWORK_ADDRESS=${KAFKA_NETWORK_ADDRESS}
@@ -65,25 +45,45 @@ NODE_EXPORTER_NETWORK_ADDRESS=${NODE_EXPORTER_NETWORK_ADDRESS}
 OPENIM_ADMIN_FRONT_NETWORK_ADDRESS=${OPENIM_ADMIN_FRONT_NETWORK_ADDRESS}
 ALERT_MANAGER_NETWORK_ADDRESS=${ALERT_MANAGER_NETWORK_ADDRESS}
 
-# ===============================================
+# ==============================================================================
-# = Component Extension Configuration =
+# Configuration Update Instructions
-# ===============================================
+# ==============================================================================
+# This header outlines the methods to update common variables in config.yaml and .env files.
+# These instructions are vital for maintaining the OpenIM environment's configuration.
+#
+# METHOD 1: Regenerate All Configurations
+# ----------------------------------------
+# Use this method to regenerate all configurations.
+# Steps:
+#   1. Delete existing config files:
+#      - openim-server/config/config.yaml
+#      - openim-chat/config/config.yaml
+#   2. Modify the .env file as required.
+#   3. Run 'docker compose up -d'. This will regenerate:
+#       - config/config.yaml
+#
+# METHOD 2: Modify Individual Configuration Files
+# -----------------------------------------------
+# Use this method to update specific configuration files.
+# Steps:
+#   1. Modify the .env file as necessary.
+#   2. Update the corresponding entries in:
+#      - config/config.yaml
+#   3. Restart the services with 'docker compose up -d'.
+#   4. Special Note: If you modify OPENIM_IP, API_OPENIM_PORT, or MINIO_PORT in .env,
+#      ensure to update the corresponding services and configurations accordingly.
+#
+# It is essential to follow these methods to ensure consistent and correct application behavior.
+# ==============================================================================
+# Local IP address of the service. Modify if necessary.
+# Example: OPENIM_IP=172.28.0.1，
+OPENIM_IP=${OPENIM_IP}
 
-# ============ Component Extension Configuration ==========
 # ----- ZooKeeper Configuration -----
-# Address or hostname for the ZooKeeper service.
-# Default: ZOOKEEPER_ADDRESS=172.28.0.1
-ZOOKEEPER_ADDRESS=${ZOOKEEPER_NETWORK_ADDRESS}
-
 # Port for ZooKeeper service.
 # Default: ZOOKEEPER_PORT=12181
 ZOOKEEPER_PORT=${ZOOKEEPER_PORT}
 
-# ----- MongoDB Configuration -----
-# Address or hostname for the MongoDB service.
-# Default: MONGO_ADDRESS=172.28.0.1
-MONGO_ADDRESS=${MONGO_NETWORK_ADDRESS}
-
 # Port on which MongoDB service is running.
 # Default: MONGO_PORT=37017
 # MONGO_PORT=${MONGO_PORT}
@@ -101,9 +101,6 @@ MONGO_PASSWORD=${MONGO_PASSWORD}
 MONGO_DATABASE=${MONGO_DATABASE}
 
 # ----- Redis Configuration -----
-# Address or hostname for the Redis service.
-# Default: REDIS_ADDRESS=172.28.0.1
-REDIS_ADDRESS=${REDIS_NETWORK_ADDRESS}
 
 # Port on which Redis in-memory data structure store is running.
 # Default: REDIS_PORT=16379
@@ -113,11 +110,6 @@ REDIS_PORT=${REDIS_PORT}
 # Default: REDIS_PASSWORD=openIM123
 REDIS_PASSWORD=${REDIS_PASSWORD}
 
-# ----- Kafka Configuration -----
-# Address or hostname for the Kafka service.
-# Default: KAFKA_ADDRESS=172.28.0.1
-KAFKA_ADDRESS=${KAFKA_NETWORK_ADDRESS}
-
 # Kakfa username to authenticate with the Kafka service.
 # KAFKA_USERNAME=${KAFKA_USERNAME}
 
@@ -129,20 +121,13 @@ KAFKA_PORT=${KAFKA_PORT}
 # Default: KAFKA_LATESTMSG_REDIS_TOPIC=latestMsgToRedis
 KAFKA_LATESTMSG_REDIS_TOPIC=${KAFKA_LATESTMSG_REDIS_TOPIC}
 
-# Topic in Kafka for pushing messages (e.g. notifications or updates).
+# MINIO_PORT
-# Default: KAFKA_MSG_PUSH_TOPIC=msgToPush
+# ----------
-KAFKA_MSG_PUSH_TOPIC=${KAFKA_MSG_PUSH_TOPIC}
+# MINIO_PORT sets the port for the MinIO object storage service.
-
+# Upon changing this port, the MinIO endpoint URLs in the `config/config.yaml` file must be updated
-# Topic in Kafka for storing offline messages in MongoDB.
+# to reflect this change. The endpoints include both the 'endpoint' and 'signEndpoint' 
-# Default: KAFKA_OFFLINEMSG_MONGO_TOPIC=offlineMsgToMongoMysql
+# under the MinIO configuration.
-KAFKA_OFFLINEMSG_MONGO_TOPIC=${KAFKA_OFFLINEMSG_MONGO_TOPIC}
+#
-
-# ----- MinIO Configuration ----
-# Address or hostname for the MinIO object storage service.
-# Default: MINIO_ADDRESS=172.28.0.1
-MINIO_ADDRESS=${MINIO_NETWORK_ADDRESS}
-
-# Port on which MinIO object storage service is running.
 # Default: MINIO_PORT=10005
 MINIO_PORT=${MINIO_PORT}
 
@@ -155,19 +140,11 @@ MINIO_PORT=${MINIO_PORT}
 MINIO_SECRET_KEY=${MINIO_SECRET_KEY}
 
 # ----- Prometheus Configuration -----
-# Address or hostname for the Prometheus service.
-# Default: PROMETHEUS_ADDRESS=172.28.0.1
-PROMETHEUS_ADDRESS=${PROMETHEUS_NETWORK_ADDRESS}
-
 # Port on which Prometheus service is running.
 # Default: PROMETHEUS_PORT=19090
 PROMETHEUS_PORT=${PROMETHEUS_PORT}
 
 # ----- Grafana Configuration -----
-# Address or hostname for the Grafana service.
-# Default: GRAFANA_ADDRESS=172.28.0.1
-GRAFANA_ADDRESS=${GRAFANA_NETWORK_ADDRESS}
-
 # Port on which Grafana service is running.
 # Default: GRAFANA_PORT=13000
 GRAFANA_PORT=${GRAFANA_PORT}
@@ -184,23 +161,19 @@ OPENIM_WEB_DIST_PATH=${OPENIM_WEB_DIST_PATH}
 # Default: OPENIM_WEB_PORT=11001
 OPENIM_WEB_PORT=${OPENIM_WEB_PORT}
 
-# Address or hostname for the OpenIM web service.
-# Default: OPENIM_WEB_ADDRESS=172.28.0.1
-OPENIM_WEB_ADDRESS=${OPENIM_WEB_NETWORK_ADDRESS}
-
 # ======================================
 # ========= OpenIM Server ==============
 # ======================================
-
-# Address or hostname for the OpenIM server.
-# Default: OPENIM_SERVER_ADDRESS=172.28.0.1
-OPENIM_SERVER_ADDRESS=${OPENIM_SERVER_NETWORK_ADDRESS}
-
 # Port for the OpenIM WebSockets.
 # Default: OPENIM_WS_PORT=10001
 OPENIM_WS_PORT=${OPENIM_WS_PORT}
 
-# Port for the OpenIM API.
+# API_OPENIM_PORT
+# ---------------
+# This variable defines the port on which the OpenIM API service will listen.
+# When changing this port, it's essential to update the apiURL in the config.yaml file
+# to ensure the API service is accessible at the new port.
+#
 # Default: API_OPENIM_PORT=10002
 API_OPENIM_PORT=${API_OPENIM_PORT}
 
@@ -213,10 +186,6 @@ API_OPENIM_PORT=${API_OPENIM_PORT}
 # Default: CHAT_IMAGE_VERSION=main
 CHAT_IMAGE_VERSION=${CHAT_IMAGE_VERSION}
 
-# Address or hostname for the OpenIM chat service.
-# Default: OPENIM_CHAT_ADDRESS=172.28.0.1
-OPENIM_CHAT_ADDRESS=${OPENIM_CHAT_NETWORK_ADDRESS}
-
 # Port for the OpenIM chat API.
 # Default: OPENIM_CHAT_API_PORT=10008
 OPENIM_CHAT_API_PORT=${OPENIM_CHAT_API_PORT}
@@ -225,7 +194,6 @@ OPENIM_CHAT_API_PORT=${OPENIM_CHAT_API_PORT}
 # Default: OPENIM_CHAT_DATA_DIR=./openim-chat/main
 OPENIM_CHAT_DATA_DIR=${OPENIM_CHAT_DATA_DIR}
 
-
 # ======================================
 # ========== OpenIM Admin ==============
 # ======================================

deployments/templates/openim.yaml

@@ -506,7 +506,7 @@ callback:
 # The number of ports needs to be consistent with msg_transfer_service_num in script/path_info.sh
 prometheus:
   enable: ${PROMETHEUS_ENABLE}
-  prometheusUrl: ${PROMETHEUS_URL}
+  grafanaUrl: ${GRAFANA_URL}
   apiPrometheusPort: [${API_PROM_PORT}]
   userPrometheusPort: [ ${USER_PROM_PORT} ]
   friendPrometheusPort: [ ${FRIEND_PROM_PORT} ]

docker-compose.yml

@@ -122,9 +122,9 @@ services:
       server:
         ipv4_address: ${OPENIM_WEB_NETWORK_ADDRESS:-172.28.0.7}
 
-  # Uncomment and configure the following services as needed
+  ## Uncomment and configure the following services as needed
   # openim-admin:
-  #   image: ${IMAGE_REGISTRY:-ghcr.io/openimsdk}/openim-admin-front:v3.4.0
+  #   image: ${IMAGE_REGISTRY:-ghcr.io/openimsdk}/openim-admin:toc-base-open-docker.35
   #   container_name: openim-admin
   #   restart: always
   #   ports:
@@ -167,6 +167,12 @@ services:
   #   hostname: grafana
   #   user: root
   #   restart: always
+  #   environment:
+  #     - GF_SECURITY_ALLOW_EMBEDDING=true
+  #     - GF_SESSION_COOKIE_SAMESITE=none
+  #     - GF_SESSION_COOKIE_SECURE=true
+  #     - GF_AUTH_ANONYMOUS_ENABLED=true
+  #     - GF_AUTH_ANONYMOUS_ORG_ROLE=Admin
   #   ports:
   #     - "${GRAFANA_PORT:-13000}:3000"
   #   volumes:

internal/api/third.go

@@ -130,5 +130,5 @@ func (o *ThirdApi) SearchLogs(c *gin.Context) {
 }
 
 func GetPrometheus(c *gin.Context) {
-	c.Redirect(http.StatusFound, config2.Config.Prometheus.PrometheusUrl)
+	c.Redirect(http.StatusFound, config2.Config.Prometheus.GrafanaUrl)
 }

pkg/common/config/config.go

@@ -314,7 +314,7 @@ type configStruct struct {
 
 	Prometheus struct {
 		Enable                        bool   `yaml:"enable"`
-		PrometheusUrl                 string `yaml:"prometheusUrl"`
+		GrafanaUrl                    string `yaml:"grafanaUrl"`
 		ApiPrometheusPort             []int  `yaml:"apiPrometheusPort"`
 		UserPrometheusPort            []int  `yaml:"userPrometheusPort"`
 		FriendPrometheusPort          []int  `yaml:"friendPrometheusPort"`

pkg/common/discoveryregister/kubernetes/kubernetes.go

@@ -55,14 +55,17 @@ func (cli *K8sDR) Register(serviceName, host string, port int, opts ...grpc.Dial
 
 	return nil
 }
+
 func (cli *K8sDR) UnRegister() error {
 
 	return nil
 }
+
 func (cli *K8sDR) CreateRpcRootNodes(serviceNames []string) error {
 
 	return nil
 }
+
 func (cli *K8sDR) RegisterConf2Registry(key string, conf []byte) error {
 
 	return nil
@@ -123,6 +126,8 @@ func getMsgGatewayHost(ctx context.Context) []string {
 	log.ZInfo(ctx, "getMsgGatewayHost", "instance", instance, "selfPodName", selfPodName, "replicas", replicas, "ns", ns, "ret", ret)
 	return ret
 }
+
+// GetConns returns the gRPC client connections to the specified service.
 func (cli *K8sDR) GetConns(ctx context.Context, serviceName string, opts ...grpc.DialOption) ([]*grpc.ClientConn, error) {
 
 	if serviceName != config.Config.RpcRegisterName.OpenImMessageGatewayName {
@@ -142,6 +147,7 @@ func (cli *K8sDR) GetConns(ctx context.Context, serviceName string, opts ...grpc
 		return ret, nil
 	}
 }
+
 func (cli *K8sDR) GetConn(ctx context.Context, serviceName string, opts ...grpc.DialOption) (*grpc.ClientConn, error) {
 
 	return grpc.DialContext(ctx, serviceName, append(cli.options, opts...)...)
@@ -151,9 +157,11 @@ func (cli *K8sDR) GetSelfConnTarget() string {
 
 	return cli.rpcRegisterAddr
 }
+
 func (cli *K8sDR) AddOption(opts ...grpc.DialOption) {
 	cli.options = append(cli.options, opts...)
 }
+
 func (cli *K8sDR) CloseConn(conn *grpc.ClientConn) {
 	conn.Close()
 }

scripts/check-all.sh

@@ -30,29 +30,32 @@ OPENIM_VERBOSE=4
 
 openim::log::info "\n# Begin to check all openim service"
 
-# OpenIM status
+# Elegant printing function
 # Elegant printing function
 print_services_and_ports() {
-    service_names=("$1[@]")
+    local service_names=("$@")
-    service_ports=("$2[@]")
+    local half_length=$((${#service_names[@]} / 2))
+    local service_ports=("${service_names[@]:half_length}")
 
     echo "+-------------------------+----------+"
     echo "| Service Name            | Port     |"
     echo "+-------------------------+----------+"
 
-    for index in "${!service_names}"; do
+    for ((index=0; index < half_length; index++)); do
-        printf "| %-23s | %-8s |\n" "${!service_names[$index]}" "${!service_ports[$index]}"
+        printf "| %-23s | %-8s |\n" "${service_names[$index]}" "${service_ports[$index]}"
     done
 
     echo "+-------------------------+----------+"
 }
 
+# Assuming OPENIM_SERVER_NAME_TARGETS and OPENIM_SERVER_PORT_TARGETS are defined
+# Similarly for OPENIM_DEPENDENCY_TARGETS and OPENIM_DEPENDENCY_PORT_TARGETS
+
 # Print out services and their ports
-print_services_and_ports OPENIM_SERVER_NAME_TARGETS OPENIM_SERVER_PORT_TARGETS
+print_services_and_ports "${OPENIM_SERVER_NAME_TARGETS[@]}" "${OPENIM_SERVER_PORT_TARGETS[@]}"
 
 # Print out dependencies and their ports
-print_services_and_ports OPENIM_DEPENDENCY_TARGETS OPENIM_DEPENDENCY_PORT_TARGETS
+print_services_and_ports "${OPENIM_DEPENDENCY_TARGETS[@]}" "${OPENIM_DEPENDENCY_PORT_TARGETS[@]}"
-
 
 # OpenIM check
 echo "++ The port being checked: ${OPENIM_SERVER_PORT_LISTARIES[@]}"
@@ -89,4 +92,4 @@ else
   echo "++++ Check all openim service ports successfully !"
 fi
 
-set -e
+set -e

scripts/install/environment.sh

@@ -285,7 +285,6 @@ readonly ALERTMANAGER_SEND_RESOLVED=${ALERTMANAGER_SEND_RESOLVED:-"{SEND_RESOLVE
 ###################### Grafana 配置信息 ######################
 def "GRAFANA_PORT" "13000"                        # Grafana的端口
 def "GRAFANA_ADDRESS" "${DOCKER_BRIDGE_GATEWAY}" # Grafana的地址
-
 ###################### RPC Port Configuration Variables ######################
 # For launching multiple programs, just fill in multiple ports separated by commas
 # For example:
@@ -378,8 +377,8 @@ def "CALLBACK_TIMEOUT" "5"            # 最长超时时间
 def "CALLBACK_FAILED_CONTINUE" "true" # 失败后是否继续
 ###################### Prometheus 配置信息 ######################
 # 是否启用 Prometheus
-readonly PROMETHEUS_ENABLE=${PROMETHEUS_ENABLE:-'false'}
+readonly PROMETHEUS_ENABLE=${PROMETHEUS_ENABLE:-'true'}
-def "PROMETHEUS_URL" "${GRAFANA_ADDRESS}:${GRAFANA_PORT}"
+readonly GRAFANA_URL=${GRAFANA_URL:-"http://${OPENIM_IP}:${GRAFANA_PORT}/"}
 # Api 服务的 Prometheus 端口
 readonly API_PROM_PORT=${API_PROM_PORT:-'20100'}
 # User 服务的 Prometheus 端口

tools/component/component.go

@@ -223,8 +223,8 @@ func checkMinio() (string, error) {
 	defer cancel()
 
 	if minioClient.IsOffline() {
-		str := fmt.Sprintf("Minio server is offline;%s", str)
+		// str := fmt.Sprintf("Minio server is offline;%s", str)
-		return "", ErrComponentStart.Wrap(str)
+		// return "", ErrComponentStart.Wrap(str)
 	}
 
 	// Check for localhost in API URL and Minio SignEndpoint