mirror of
				https://github.com/openimsdk/open-im-server.git
				synced 2025-10-31 16:32:12 +08:00 
			
		
		
		
	
		
			
				
	
	
		
			250 lines
		
	
	
		
			7.1 KiB
		
	
	
	
		
			Plaintext
		
	
	
	
	
	
			
		
		
	
	
			250 lines
		
	
	
		
			7.1 KiB
		
	
	
	
		
			Plaintext
		
	
	
	
	
	
| # ======================================
 | |
| # ========= Basic Configuration ========
 | |
| # ======================================
 | |
| 
 | |
| # The user for authentication or system operations.
 | |
| # Default: OPENIM_USER=root
 | |
| USER=root
 | |
| 
 | |
| # Password associated with the specified user for authentication.
 | |
| # Default: PASSWORD=openIM123
 | |
| PASSWORD=openIM123
 | |
| 
 | |
| # Endpoint for the MinIO object storage service.
 | |
| # Default: MINIO_ENDPOINT=http://172.28.0.1:10005
 | |
| MINIO_ENDPOINT=http://172.28.0.1:10005
 | |
| 
 | |
| # Base URL for the application programming interface (API).
 | |
| # Default: API_URL=http://172.28.0.1:10002
 | |
| API_URL=http://172.28.0.1:10002
 | |
| 
 | |
| # Directory path for storing data files or related information.
 | |
| # Default: DATA_DIR=./
 | |
| DATA_DIR=./
 | |
| 
 | |
| # 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 ======
 | |
| # ======================================
 | |
| 
 | |
| # Subnet for the Docker network.
 | |
| # Default: DOCKER_BRIDGE_SUBNET=172.28.0.0/16
 | |
| DOCKER_BRIDGE_SUBNET=172.28.0.0/16
 | |
| 
 | |
| # Gateway for the Docker network.
 | |
| # Default: DOCKER_BRIDGE_GATEWAY=172.28.0.1
 | |
| DOCKER_BRIDGE_GATEWAY=172.28.0.1
 | |
| 
 | |
| MONGO_NETWORK_ADDRESS=172.28.0.2
 | |
| REDIS_NETWORK_ADDRESS=172.28.0.3
 | |
| KAFKA_NETWORK_ADDRESS=172.28.0.4
 | |
| ZOOKEEPER_NETWORK_ADDRESS=172.28.0.5
 | |
| MINIO_NETWORK_ADDRESS=172.28.0.6
 | |
| OPENIM_WEB_NETWORK_ADDRESS=172.28.0.7
 | |
| OPENIM_SERVER_NETWORK_ADDRESS=172.28.0.8
 | |
| OPENIM_CHAT_NETWORK_ADDRESS=172.28.0.9
 | |
| PROMETHEUS_NETWORK_ADDRESS=172.28.0.10
 | |
| GRAFANA_NETWORK_ADDRESS=172.28.0.11
 | |
| NODE_EXPORTER_NETWORK_ADDRESS=172.28.0.12
 | |
| OPENIM_ADMIN_FRONT_NETWORK_ADDRESS=172.28.0.13
 | |
| ALERT_MANAGER_NETWORK_ADDRESS=172.28.0.14
 | |
| 
 | |
| # ===============================================
 | |
| # = Component Extension Configuration =
 | |
| # ===============================================
 | |
| 
 | |
| # ============ Component Extension Configuration ==========
 | |
| # ----- 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=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=37017
 | |
| 
 | |
| # Username to authenticate with the MongoDB service.
 | |
| # Default: MONGO_USERNAME=root
 | |
| # MONGO_USERNAME=root
 | |
| 
 | |
| # Password to authenticate with the MongoDB service.
 | |
| # Default: MONGO_PASSWORD=openIM123
 | |
| MONGO_PASSWORD=openIM123
 | |
| 
 | |
| # Name of the database in MongoDB to be used.
 | |
| # Default: MONGO_DATABASE=openIM_v3
 | |
| 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=16379
 | |
| 
 | |
| # Password to authenticate with the Redis service.
 | |
| # Default: REDIS_PASSWORD=openIM123
 | |
| 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=''
 | |
| 
 | |
| # Port on which Kafka distributed streaming platform is running.
 | |
| # Default: KAFKA_PORT=19092
 | |
| KAFKA_PORT=19094
 | |
| 
 | |
| # Topic in Kafka for storing the latest messages in Redis.
 | |
| # Default: KAFKA_LATESTMSG_REDIS_TOPIC=latestMsgToRedis
 | |
| KAFKA_LATESTMSG_REDIS_TOPIC=latestMsgToRedis
 | |
| 
 | |
| # Topic in Kafka for pushing messages (e.g. notifications or updates).
 | |
| # Default: KAFKA_MSG_PUSH_TOPIC=msgToPush
 | |
| KAFKA_MSG_PUSH_TOPIC=msgToPush
 | |
| 
 | |
| # Topic in Kafka for storing offline messages in MongoDB.
 | |
| # 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=10005
 | |
| 
 | |
| # Access key to authenticate with the MinIO service.
 | |
| # Default: MINIO_ACCESS_KEY=root
 | |
| # MINIO_ACCESS_KEY=root
 | |
| 
 | |
| # Secret key corresponding to the access key for MinIO authentication.
 | |
| # Default: MINIO_SECRET_KEY=openIM123
 | |
| 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=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=13000
 | |
| 
 | |
| # ======================================
 | |
| # ============ OpenIM Web ===============
 | |
| # ======================================
 | |
| 
 | |
| # Path to the OpenIM web distribution.
 | |
| # Default: OPENIM_WEB_DIST_PATH=/app/dist
 | |
| OPENIM_WEB_DIST_PATH=/app/dist
 | |
| 
 | |
| # Port on which OpenIM web service is running.
 | |
| # Default: OPENIM_WEB_PORT=11001
 | |
| 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=10001
 | |
| 
 | |
| # Port for the OpenIM API.
 | |
| # Default: API_OPENIM_PORT=10002
 | |
| API_OPENIM_PORT=10002
 | |
| 
 | |
| 
 | |
| # ======================================
 | |
| # ========== OpenIM Chat ===============
 | |
| # ======================================
 | |
| 
 | |
| # Branch name for OpenIM chat.
 | |
| # Default: CHAT_BRANCH=main
 | |
| CHAT_BRANCH=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=10008
 | |
| 
 | |
| # 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/main
 | |
| 
 | |
| 
 | |
| # ======================================
 | |
| # ========== OpenIM Admin ==============
 | |
| # ======================================
 | |
| 
 | |
| # Branch name for OpenIM server.
 | |
| # Default: SERVER_BRANCH=main
 | |
| SERVER_BRANCH=main
 | |
| 
 | |
| # Port for the OpenIM admin API.
 | |
| # Default: OPENIM_ADMIN_API_PORT=10009
 | |
| OPENIM_ADMIN_API_PORT=10009
 | |
|   
 | |
| # Port for the node exporter.
 | |
| # Default: NODE_EXPORTER_PORT=19100
 | |
| NODE_EXPORTER_PORT=19100
 | |
|   
 | |
| # Port for the prometheus.
 | |
| # Default: PROMETHEUS_PORT=19090
 | |
| PROMETHEUS_PORT=19090
 | |
|   
 | |
| # Port for the grafana.
 | |
| # Default: GRAFANA_PORT=13000
 | |
| GRAFANA_PORT=13000
 | |
|   
 | |
| # Port for the admin front.
 | |
| # Default: OPENIM_ADMIN_FRONT_PORT=11002
 | |
| OPENIM_ADMIN_FRONT_PORT=11002
 | |
| 
 | |
| # Port for the alertmanager.
 | |
| # Default: ALERT_MANAGER_PORT=19093
 | |
| ALERT_MANAGER_PORT=19093
 |