Update env-template.yaml

deployments/templates/env-template.yaml

@@ -1,24 +1,43 @@
-# -----------------------------------------------------------------------------
+# Copyright © 2023 OpenIM. All rights reserved.
-# General Configuration
+#
-# This section contains general configuration options for the entire environment.
+# Licensed under the Apache License, Version 2.0 (the "License");
-# These options can be set via environment variables. If both environment variables 
+# you may not use this file except in compliance with the License.
-# and settings in this .env file exist, the environment variables take precedence.
+# You may obtain a copy of the License at
-# -----------------------------------------------------------------------------
+#
-# ==========================
+#     http://www.apache.org/licenses/LICENSE-2.0
-# General Configuration
+#
-# ==========================
+# Unless required by applicable law or agreed to in writing, software
-# These settings apply to the overall environment.
+# distributed under the License is distributed on an "AS IS" BASIS,
-
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# Data storage directory for persistent data.
+# See the License for the specific language governing permissions and
-# Example: DATA_DIR=/path/to/data
+# limitations under the License.
-DATA_DIR=${DATA_DIR}
+
-
+# ======================================
-# Docker image registry. Uncomment the preferred one.
+# ========= Basic Configuration ========
-# Options: ghcr.io/openimsdk, openim, registry.cn-hangzhou.aliyuncs.com/openimsdk
+# ======================================
-# IMAGE_REGISTRY="ghcr.io/openimsdk"
+
-# IMAGE_REGISTRY="openim"
+# The user for authentication or system operations.
-# IMAGE_REGISTRY="registry.cn-hangzhou.aliyuncs.com/openimsdk"
+# Default: OPENIM_USER=root
-IMAGE_REGISTRY=${IMAGE_REGISTRY}
+USER=root
+
+# Password associated with the specified user for authentication.
+# Default: PASSWORD=openIM123
+PASSWORD=openIM123
+
+# Base URL for the application programming interface (API).
+# Default: API_URL=http://172.28.0.1:10002
+API_URL=http://14.155.64.202:10002
+
+# Directory path for storing data files or related information.
+# Default: DATA_DIR=./
+DATA_DIR=/data/workspaces/open-im-server
+
+# Choose the appropriate image address, the default is GITHUB image, 
+# you can choose docker hub, for Chinese users can choose Ali Cloud
+# export IMAGE_REGISTRY="ghcr.io/openimsdk"
+# export IMAGE_REGISTRY="openim"
+# export IMAGE_REGISTRY="registry.cn-hangzhou.aliyuncs.com/openimsdk"
+IMAGE_REGISTRY=ghcr.io/openimsdk
 
 # ======================================
 # ========= Network Configuration ======
@@ -26,128 +45,132 @@ IMAGE_REGISTRY=${IMAGE_REGISTRY}
 
 # Subnet for the Docker network.
 # Default: DOCKER_BRIDGE_SUBNET=172.28.0.0/16
-DOCKER_BRIDGE_SUBNET=${DOCKER_BRIDGE_SUBNET}
+DOCKER_BRIDGE_SUBNET=172.28.0.0/16
-
+
-# Set and specify the IP addresses of some containers. Generally speaking, 
+# Gateway for the Docker network.
-# you do not need to modify these configurations to facilitate debugging
+# Default: DOCKER_BRIDGE_GATEWAY=172.28.0.1
-DOCKER_BRIDGE_GATEWAY=${DOCKER_BRIDGE_GATEWAY}
+DOCKER_BRIDGE_GATEWAY=172.28.0.1
-MONGO_NETWORK_ADDRESS=${MONGO_NETWORK_ADDRESS}
+
-REDIS_NETWORK_ADDRESS=${REDIS_NETWORK_ADDRESS}
+MONGO_NETWORK_ADDRESS=172.28.0.2
-KAFKA_NETWORK_ADDRESS=${KAFKA_NETWORK_ADDRESS}
+REDIS_NETWORK_ADDRESS=172.28.0.3
-ZOOKEEPER_NETWORK_ADDRESS=${ZOOKEEPER_NETWORK_ADDRESS}
+KAFKA_NETWORK_ADDRESS=172.28.0.4
-MINIO_NETWORK_ADDRESS=${MINIO_NETWORK_ADDRESS}
+ZOOKEEPER_NETWORK_ADDRESS=172.28.0.5
-OPENIM_WEB_NETWORK_ADDRESS=${OPENIM_WEB_NETWORK_ADDRESS}
+MINIO_NETWORK_ADDRESS=172.28.0.6
-OPENIM_SERVER_NETWORK_ADDRESS=${OPENIM_SERVER_NETWORK_ADDRESS}
+OPENIM_WEB_NETWORK_ADDRESS=172.28.0.7
-OPENIM_CHAT_NETWORK_ADDRESS=${OPENIM_CHAT_NETWORK_ADDRESS}
+OPENIM_SERVER_NETWORK_ADDRESS=172.28.0.8
-PROMETHEUS_NETWORK_ADDRESS=${PROMETHEUS_NETWORK_ADDRESS}
+OPENIM_CHAT_NETWORK_ADDRESS=172.28.0.9
-GRAFANA_NETWORK_ADDRESS=${GRAFANA_NETWORK_ADDRESS}
+PROMETHEUS_NETWORK_ADDRESS=172.28.0.10
-NODE_EXPORTER_NETWORK_ADDRESS=${NODE_EXPORTER_NETWORK_ADDRESS}
+GRAFANA_NETWORK_ADDRESS=172.28.0.11
-OPENIM_ADMIN_FRONT_NETWORK_ADDRESS=${OPENIM_ADMIN_FRONT_NETWORK_ADDRESS}
+NODE_EXPORTER_NETWORK_ADDRESS=172.28.0.12
-ALERT_MANAGER_NETWORK_ADDRESS=${ALERT_MANAGER_NETWORK_ADDRESS}
+OPENIM_ADMIN_FRONT_NETWORK_ADDRESS=172.28.0.13
-
+ALERT_MANAGER_NETWORK_ADDRESS=172.28.0.14
-# ==============================================================================
+
-# Configuration Update Instructions
+# ===============================================
-# ==============================================================================
+# = Component Extension Configuration =
-# 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.
+
-#
+# ============ Component Extension 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}
-
 # ----- ZooKeeper Configuration -----
+# Address or hostname for the ZooKeeper service.
+# Default: ZOOKEEPER_ADDRESS=172.28.0.1
+ZOOKEEPER_ADDRESS=172.28.0.5
+
 # Port for ZooKeeper service.
 # Default: ZOOKEEPER_PORT=12181
-ZOOKEEPER_PORT=${ZOOKEEPER_PORT}
+ZOOKEEPER_PORT=12181
+
+# ----- MongoDB Configuration -----
+# Address or hostname for the MongoDB service.
+# Default: MONGO_ADDRESS=172.28.0.1
+MONGO_ADDRESS=172.28.0.2
 
 # Port on which MongoDB service is running.
 # Default: MONGO_PORT=37017
-# MONGO_PORT=${MONGO_PORT}
+# MONGO_PORT=37017
 
 # Username to authenticate with the MongoDB service.
 # Default: MONGO_USERNAME=root
-# MONGO_USERNAME=${MONGO_USERNAME}
+# MONGO_USERNAME=root
 
 # Password to authenticate with the MongoDB service.
 # Default: MONGO_PASSWORD=openIM123
-MONGO_PASSWORD=${MONGO_PASSWORD}
+MONGO_PASSWORD=openIM123
 
 # Name of the database in MongoDB to be used.
 # Default: MONGO_DATABASE=openIM_v3
-MONGO_DATABASE=${MONGO_DATABASE}
+MONGO_DATABASE=openIM_v3
 
 # ----- Redis Configuration -----
+# Address or hostname for the Redis service.
+# Default: REDIS_ADDRESS=172.28.0.1
+REDIS_ADDRESS=172.28.0.3
 
 # Port on which Redis in-memory data structure store is running.
 # Default: REDIS_PORT=16379
-REDIS_PORT=${REDIS_PORT}
+REDIS_PORT=16379
 
 # Password to authenticate with the Redis service.
 # Default: REDIS_PASSWORD=openIM123
-REDIS_PASSWORD=${REDIS_PASSWORD}
+REDIS_PASSWORD=openIM123
+
+# ----- Kafka Configuration -----
+# Address or hostname for the Kafka service.
+# Default: KAFKA_ADDRESS=172.28.0.1
+KAFKA_ADDRESS=172.28.0.4
 
 # Kakfa username to authenticate with the Kafka service.
-# KAFKA_USERNAME=${KAFKA_USERNAME}
+# KAFKA_USERNAME=''
 
 # Port on which Kafka distributed streaming platform is running.
 # Default: KAFKA_PORT=19092
-KAFKA_PORT=${KAFKA_PORT}
+KAFKA_PORT=19094
 
 # Topic in Kafka for storing the latest messages in Redis.
 # Default: KAFKA_LATESTMSG_REDIS_TOPIC=latestMsgToRedis
-KAFKA_LATESTMSG_REDIS_TOPIC=${KAFKA_LATESTMSG_REDIS_TOPIC}
+KAFKA_LATESTMSG_REDIS_TOPIC=latestMsgToRedis
-
+
-# MINIO_PORT
+# Topic in Kafka for pushing messages (e.g. notifications or updates).
-# ----------
+# Default: KAFKA_MSG_PUSH_TOPIC=msgToPush
-# MINIO_PORT sets the port for the MinIO object storage service.
+KAFKA_MSG_PUSH_TOPIC=msgToPush
-# Upon changing this port, the MinIO endpoint URLs in the `config/config.yaml` file must be updated
+
-# to reflect this change. The endpoints include both the 'endpoint' and 'signEndpoint' 
+# Topic in Kafka for storing offline messages in MongoDB.
-# under the MinIO configuration.
+# Default: KAFKA_OFFLINEMSG_MONGO_TOPIC=offlineMsgToMongoMysql
-#
+KAFKA_OFFLINEMSG_MONGO_TOPIC=offlineMsgToMongoMysql
+
+# ----- MinIO Configuration ----
+# Address or hostname for the MinIO object storage service.
+# Default: MINIO_ADDRESS=172.28.0.1
+MINIO_ADDRESS=172.28.0.6
+
+# Port on which MinIO object storage service is running.
 # Default: MINIO_PORT=10005
-MINIO_PORT=${MINIO_PORT}
+MINIO_PORT=10005
 
 # Access key to authenticate with the MinIO service.
 # Default: MINIO_ACCESS_KEY=root
-# MINIO_ACCESS_KEY=${MINIO_ACCESS_KEY}
+# MINIO_ACCESS_KEY=root
 
 # Secret key corresponding to the access key for MinIO authentication.
 # Default: MINIO_SECRET_KEY=openIM123
-MINIO_SECRET_KEY=${MINIO_SECRET_KEY}
+MINIO_SECRET_KEY=openIM123
 
 # ----- Prometheus Configuration -----
+# Address or hostname for the Prometheus service.
+# Default: PROMETHEUS_ADDRESS=172.28.0.1
+PROMETHEUS_ADDRESS=172.28.0.10
+
 # Port on which Prometheus service is running.
 # Default: PROMETHEUS_PORT=19090
-PROMETHEUS_PORT=${PROMETHEUS_PORT}
+PROMETHEUS_PORT=19090
 
 # ----- Grafana Configuration -----
+# Address or hostname for the Grafana service.
+# Default: GRAFANA_ADDRESS=172.28.0.1
+GRAFANA_ADDRESS=172.28.0.11
+
 # Port on which Grafana service is running.
 # Default: GRAFANA_PORT=13000
-GRAFANA_PORT=${GRAFANA_PORT}
+GRAFANA_PORT=13000
 
 # ======================================
 # ============ OpenIM Web ===============
@@ -155,27 +178,31 @@ GRAFANA_PORT=${GRAFANA_PORT}
 
 # Path to the OpenIM web distribution.
 # Default: OPENIM_WEB_DIST_PATH=/app/dist
-OPENIM_WEB_DIST_PATH=${OPENIM_WEB_DIST_PATH}
+OPENIM_WEB_DIST_PATH=/app/dist
 
 # Port on which OpenIM web service is running.
 # Default: OPENIM_WEB_PORT=11001
-OPENIM_WEB_PORT=${OPENIM_WEB_PORT}
+OPENIM_WEB_PORT=11001
+
+# Address or hostname for the OpenIM web service.
+# Default: OPENIM_WEB_ADDRESS=172.28.0.1
+OPENIM_WEB_ADDRESS=172.28.0.7
 
 # ======================================
 # ========= OpenIM Server ==============
 # ======================================
+
+# Address or hostname for the OpenIM server.
+# Default: OPENIM_SERVER_ADDRESS=172.28.0.1
+OPENIM_SERVER_ADDRESS=172.28.0.8
+
 # Port for the OpenIM WebSockets.
 # Default: OPENIM_WS_PORT=10001
-OPENIM_WS_PORT=${OPENIM_WS_PORT}
+OPENIM_WS_PORT=10001
 
-# API_OPENIM_PORT
+# Port for the OpenIM API.
-# ---------------
-# 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}
+API_OPENIM_PORT=10002
 
 
 # ======================================
@@ -184,15 +211,26 @@ API_OPENIM_PORT=${API_OPENIM_PORT}
 
 # Branch name for OpenIM chat.
 # Default: CHAT_IMAGE_VERSION=main
-CHAT_IMAGE_VERSION=${CHAT_IMAGE_VERSION}
+# https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/version.md
+CHAT_IMAGE_VERSION=main
+
+# Address or hostname for the OpenIM chat service.
+# Default: OPENIM_CHAT_ADDRESS=172.28.0.1
+OPENIM_CHAT_ADDRESS=172.28.0.9
 
 # Port for the OpenIM chat API.
 # Default: OPENIM_CHAT_API_PORT=10008
-OPENIM_CHAT_API_PORT=${OPENIM_CHAT_API_PORT}
+# ！！！ TODO: Do not change the chat port https://github.com/openimsdk/chat/issues/365
+# OPENIM_CHAT_API_PORT=10008
+
+# Port for the OpenIM Chat admin API.
+# Default: OPENIM_ADMIN_API_PORT=10009
+# ！！！ TODO: Do not change the chat port https://github.com/openimsdk/chat/issues/365
+# OPENIM_ADMIN_API_PORT=10009
 
 # Directory path for storing data files or related information for OpenIM chat.
 # Default: OPENIM_CHAT_DATA_DIR=./openim-chat/main
-OPENIM_CHAT_DATA_DIR=${OPENIM_CHAT_DATA_DIR}
+OPENIM_CHAT_DATA_DIR=./openim-chat/main
 
 # ======================================
 # ========== OpenIM Admin ==============
@@ -200,28 +238,24 @@ OPENIM_CHAT_DATA_DIR=${OPENIM_CHAT_DATA_DIR}
 
 # Branch name for OpenIM server.
 # Default: SERVER_IMAGE_VERSION=main
-SERVER_IMAGE_VERSION=${SERVER_IMAGE_VERSION}
+SERVER_IMAGE_VERSION=main
-
-# Port for the OpenIM admin API.
-# Default: OPENIM_ADMIN_API_PORT=10009
-OPENIM_ADMIN_API_PORT=${OPENIM_ADMIN_API_PORT}
   
 # Port for the node exporter.
 # Default: NODE_EXPORTER_PORT=19100
-NODE_EXPORTER_PORT=${NODE_EXPORTER_PORT}
+NODE_EXPORTER_PORT=19100
   
 # Port for the prometheus.
 # Default: PROMETHEUS_PORT=19090
-PROMETHEUS_PORT=${PROMETHEUS_PORT}
+PROMETHEUS_PORT=19090
   
 # Port for the grafana.
 # Default: GRAFANA_PORT=13000
-GRAFANA_PORT=${GRAFANA_PORT}
+GRAFANA_PORT=13000
   
 # Port for the admin front.
 # Default: OPENIM_ADMIN_FRONT_PORT=11002
-OPENIM_ADMIN_FRONT_PORT=${OPENIM_ADMIN_FRONT_PORT}
+OPENIM_ADMIN_FRONT_PORT=11002
 
 # Port for the alertmanager.
 # Default: ALERT_MANAGER_PORT=19093
-ALERT_MANAGER_PORT=${ALERT_MANAGER_PORT}
+ALERT_MANAGER_PORT=19093