mirror of
				https://github.com/openimsdk/open-im-server.git
				synced 2025-10-31 16:32:12 +08:00 
			
		
		
		
	feat: add all options
Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com>
This commit is contained in:
		
							parent
							
								
									84c7cc1801
								
							
						
					
					
						commit
						f0ad869d29
					
				| @ -1,6 +1,6 @@ | |||||||
| # Copyright © 2023 OpenIM. All rights reserved. | # Copyright © 2023 OpenIM. All rights reserved. | ||||||
| # | # | ||||||
| # Licensed under the Apache License, Version 2.0 (the License); | # Licensed under the Apache License, Version 2.0 (the "License"); | ||||||
| # you may not use this file except in compliance with the License. | # you may not use this file except in compliance with the License. | ||||||
| # You may obtain a copy of the License at | # You may obtain a copy of the License at | ||||||
| # | # | ||||||
| @ -13,10 +13,7 @@ | |||||||
| # limitations under the License. | # limitations under the License. | ||||||
| 
 | 
 | ||||||
| # ----------------------------------------------------------------- | # ----------------------------------------------------------------- | ||||||
| # TODO: This config file is the template file | # Infrastructural configurations, please modify based on your setup | ||||||
| # --| source: deployments/templates/openim.yaml |  | ||||||
| # --| env: scripts/install/environment |  | ||||||
| # --| target: config/config.yaml |  | ||||||
| # ----------------------------------------------------------------- | # ----------------------------------------------------------------- | ||||||
| 
 | 
 | ||||||
| ###################### Zookeeper ###################### | ###################### Zookeeper ###################### | ||||||
| @ -29,8 +26,8 @@ | |||||||
| zookeeper: | zookeeper: | ||||||
|   schema: openim |   schema: openim | ||||||
|   address: [ 127.0.0.1:2181 ] |   address: [ 127.0.0.1:2181 ] | ||||||
|   username: '' |   username: | ||||||
|   password: '' |   password: | ||||||
| 
 | 
 | ||||||
| ###################### Mysql ###################### | ###################### Mysql ###################### | ||||||
| # MySQL configuration | # MySQL configuration | ||||||
| @ -60,23 +57,23 @@ mysql: | |||||||
| # Default MongoDB database name | # Default MongoDB database name | ||||||
| # Maximum connection pool size | # Maximum connection pool size | ||||||
| mongo: | mongo: | ||||||
|   uri: '' |   uri: | ||||||
|   address: [ 127.0.0.1:37017 ] |   address: [ 127.0.0.1:37017 ] | ||||||
|   database: openIM_v3 |   database: openIM_v3 | ||||||
|   username: root |   username: root | ||||||
|   password: openIM123 |   password: openIM123 | ||||||
|   maxPoolSize: 100 |   maxPoolSize: 100 | ||||||
| 
 | 
 | ||||||
| ###################### Redis configuration information ###################### | ###################### Redis ###################### | ||||||
| # Redis configuration | # Redis configuration | ||||||
| # | # | ||||||
| # Username is required only for Redis version 6.0+ | # Username is required only for Redis version 6.0+ | ||||||
| redis: | redis: | ||||||
|   address: [ 127.0.0.1:16379 ] |   address: [ 127.0.0.1:16379 ] | ||||||
|   username: '' |   username: | ||||||
|   password: openIM123 |   password: openIM123 | ||||||
| 
 | 
 | ||||||
| ###################### Kafka configuration information ###################### | ###################### Kafka ###################### | ||||||
| # Kafka configuration | # Kafka configuration | ||||||
| # | # | ||||||
| # Kafka username | # Kafka username | ||||||
| @ -84,8 +81,8 @@ redis: | |||||||
| # It's not recommended to modify this topic name | # It's not recommended to modify this topic name | ||||||
| # Consumer group ID, it's not recommended to modify | # Consumer group ID, it's not recommended to modify | ||||||
| kafka: | kafka: | ||||||
|   username: '' |   username: | ||||||
|   password: '' |   password: | ||||||
|   addr: [ 127.0.0.1:9092 ] |   addr: [ 127.0.0.1:9092 ] | ||||||
|   latestMsgToRedis: |   latestMsgToRedis: | ||||||
|     topic: "latestMsgToRedis" |     topic: "latestMsgToRedis" | ||||||
| @ -99,16 +96,16 @@ kafka: | |||||||
|     msgToMySql: mysql |     msgToMySql: mysql | ||||||
|     msgToPush: push |     msgToPush: push | ||||||
| 
 | 
 | ||||||
| ###################### RPC configuration information ###################### | ###################### RPC ###################### | ||||||
| # RPC configuration | # RPC configuration | ||||||
| # | # | ||||||
| # IP address to register with zookeeper when starting RPC, the IP and corresponding rpcPort should be accessible by api/gateway | # IP address to register with zookeeper when starting RPC, the IP and corresponding rpcPort should be accessible by api/gateway | ||||||
| # Default listen IP is 0.0.0.0 | # Default listen IP is 0.0.0.0 | ||||||
| rpc: | rpc: | ||||||
|   registerIP: '' |   registerIP: | ||||||
|   listenIP: 0.0.0.0 |   listenIP: 0.0.0.0 | ||||||
| 
 | 
 | ||||||
| ###################### API configuration information ###################### | ###################### API ###################### | ||||||
| # API configuration | # API configuration | ||||||
| # | # | ||||||
| # API service port | # API service port | ||||||
| @ -117,7 +114,7 @@ api: | |||||||
|   openImApiPort: [ 10002 ] |   openImApiPort: [ 10002 ] | ||||||
|   listenIP: 0.0.0.0 |   listenIP: 0.0.0.0 | ||||||
| 
 | 
 | ||||||
| ###################### Object configuration information ###################### | ###################### Gateway ###################### | ||||||
| # Object storage configuration | # Object storage configuration | ||||||
| # | # | ||||||
| # Use minio for object storage | # Use minio for object storage | ||||||
| @ -132,29 +129,27 @@ api: | |||||||
| # minio.signEndpoint is minio public network address | # minio.signEndpoint is minio public network address | ||||||
| object: | object: | ||||||
|   enable: "minio" |   enable: "minio" | ||||||
|   apiURL: "http://127.0.0.1:10002/object/" |   apiURL: "http://127.0.0.1:10002" | ||||||
|   minio: |   minio: | ||||||
|     bucket: "openim" |     bucket: "openim" | ||||||
|     endpoint: "http://14.155.127.181:10005" |     endpoint: "http://127.0.0.1:10005" | ||||||
|     accessKeyID: "root" |     accessKeyID: "root" | ||||||
|     secretAccessKey: "openIM123" |     secretAccessKey: "openIM123" | ||||||
|     sessionToken: '' |     sessionToken: "" | ||||||
|     signEndpoint: "http://14.155.127.181:10005" |     signEndpoint: "http://127.0.0.1:10005" | ||||||
|   cos: |   cos: | ||||||
|     bucketURL: https://temp-1252357374.cos.ap-chengdu.myqcloud.com |     bucketURL: "https://temp-1252357374.cos.ap-chengdu.myqcloud.com" | ||||||
|     secretID: '' |     secretID: "" | ||||||
|     secretKey: '' |     secretKey: "" | ||||||
|     sessionToken: '' |     sessionToken: "" | ||||||
|   oss: |   oss: | ||||||
|     endpoint: "https://oss-cn-chengdu.aliyuncs.com" |     endpoint: "https://oss-cn-chengdu.aliyuncs.com" | ||||||
|     bucket: "demo-9999999" |     bucket: "demo-9999999" | ||||||
|     bucketURL: "https://demo-9999999.oss-cn-chengdu.aliyuncs.com" |     bucketURL: "https://demo-9999999.oss-cn-chengdu.aliyuncs.com" | ||||||
|     accessKeyID: '' |     accessKeyID: "" | ||||||
|     accessKeySecret: '' |     accessKeySecret: "" | ||||||
|     sessionToken: '' |     sessionToken: "" | ||||||
| 
 | 
 | ||||||
| 
 |  | ||||||
| ###################### RPC Port Configuration ###################### |  | ||||||
| # RPC service ports | # RPC service ports | ||||||
| # These ports are passed into the program by the script and are not recommended to modify | # These ports are passed into the program by the script and are not recommended to modify | ||||||
| # For launching multiple programs, just fill in multiple ports separated by commas | # For launching multiple programs, just fill in multiple ports separated by commas | ||||||
| @ -170,7 +165,6 @@ rpcPort: | |||||||
|   openImConversationPort: [ 10180 ] |   openImConversationPort: [ 10180 ] | ||||||
|   openImThirdPort: [ 10190 ] |   openImThirdPort: [ 10190 ] | ||||||
| 
 | 
 | ||||||
| ###################### RPC Register Name Configuration ###################### |  | ||||||
| # RPC service names for registration, it's not recommended to modify these | # RPC service names for registration, it's not recommended to modify these | ||||||
| rpcRegisterName: | rpcRegisterName: | ||||||
|   openImUserName: User |   openImUserName: User | ||||||
| @ -183,7 +177,6 @@ rpcRegisterName: | |||||||
|   openImConversationName: Conversation |   openImConversationName: Conversation | ||||||
|   openImThirdName: Third |   openImThirdName: Third | ||||||
| 
 | 
 | ||||||
| ###################### Log Configuration ###################### |  | ||||||
| # Log configuration | # Log configuration | ||||||
| # | # | ||||||
| # Storage directory | # Storage directory | ||||||
| @ -194,7 +187,7 @@ rpcRegisterName: | |||||||
| # Whether to output in json format | # Whether to output in json format | ||||||
| # Whether to include stack trace in logs | # Whether to include stack trace in logs | ||||||
| log: | log: | ||||||
|   storageLocation: /root/workspaces/openim/openim-server/logs/ |   storageLocation: ../../../../../logs/ | ||||||
|   rotationTime: 24 |   rotationTime: 24 | ||||||
|   remainRotationCount: 2 |   remainRotationCount: 2 | ||||||
|   remainLogLevel: 6 |   remainLogLevel: 6 | ||||||
| @ -202,7 +195,6 @@ log: | |||||||
|   isJson: false |   isJson: false | ||||||
|   withStack: false |   withStack: false | ||||||
| 
 | 
 | ||||||
| ###################### Variables definition ###################### |  | ||||||
| # Long connection server configuration | # Long connection server configuration | ||||||
| # | # | ||||||
| # Websocket port for msg_gateway | # Websocket port for msg_gateway | ||||||
| @ -232,7 +224,7 @@ push: | |||||||
|     channelID: "" |     channelID: "" | ||||||
|     channelName: "" |     channelName: "" | ||||||
|   fcm: |   fcm: | ||||||
|     serviceAccount: x.json |     serviceAccount: "x.json" | ||||||
|   jpns: |   jpns: | ||||||
|     appKey: |     appKey: | ||||||
|     masterSecret: |     masterSecret: | ||||||
| @ -244,8 +236,8 @@ push: | |||||||
| # Built-in app manager user IDs | # Built-in app manager user IDs | ||||||
| # Built-in app manager nicknames | # Built-in app manager nicknames | ||||||
| manager: | manager: | ||||||
|   userID: [ "openIM123456", "openIM654321", "openIMAdmin" ] |   userID: [ "openIM123456","openIM654321","openIMAdmin" ] | ||||||
|   nickname: [ "system1", "system2", "system3" ] |   nickname: [ "system1","system2", "system3" ] | ||||||
| 
 | 
 | ||||||
| # Multi-platform login policy | # Multi-platform login policy | ||||||
| # For each platform(Android, iOS, Windows, Mac, web), only one can be online at a time | # For each platform(Android, iOS, Windows, Mac, web), only one can be online at a time | ||||||
| @ -299,7 +291,6 @@ iosPush: | |||||||
|   badgeCount: true |   badgeCount: true | ||||||
|   production: false |   production: false | ||||||
| 
 | 
 | ||||||
| ###################### Third-party service configuration ###################### |  | ||||||
| # Callback configuration | # Callback configuration | ||||||
| # | # | ||||||
| # Callback URL | # Callback URL | ||||||
| @ -369,7 +360,7 @@ callback: | |||||||
|     failedContinue: true |     failedContinue: true | ||||||
| 
 | 
 | ||||||
| ###################### Prometheus ###################### | ###################### Prometheus ###################### | ||||||
| # Prometheus configuration for various services | # Prometheus configuration | ||||||
| # The number of Prometheus ports per service needs to correspond to rpcPort | # The number of Prometheus ports per service needs to correspond to rpcPort | ||||||
| # The number of ports needs to be consistent with msg_transfer_service_num in script/path_info.sh | # The number of ports needs to be consistent with msg_transfer_service_num in script/path_info.sh | ||||||
| prometheus: | prometheus: | ||||||
| @ -384,4 +375,4 @@ prometheus: | |||||||
|   conversationPrometheusPort: [ 20230 ] |   conversationPrometheusPort: [ 20230 ] | ||||||
|   rtcPrometheusPort: [ 21300 ] |   rtcPrometheusPort: [ 21300 ] | ||||||
|   thirdPrometheusPort: [ 21301 ] |   thirdPrometheusPort: [ 21301 ] | ||||||
|   messageTransferPrometheusPort: [ 21400, 21401, 21402, 21403 ] # List of ports |   messageTransferPrometheusPort: [ 21400, 21401, 21402, 21403 ] | ||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user