#!/usr/bin/env bash # Copyright © 2023 OpenIM. All rights reserved. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # 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. # This is a file that initializes variables for the automation script that initializes the config file # You need to supplement the script according to the specification. # Read: https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/contrib/init_config.md OPENIM_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd -P)" # 生成文件存放目录 LOCAL_OUTPUT_ROOT="${OPENIM_ROOT}/${OUT_DIR:-_output}" source "${OPENIM_ROOT}/scripts/lib/util.sh" IP=$(openim::util::get_server_ip) function def() { local var_name="$1" local default_value="${2:-}" eval "readonly $var_name=\"\${$var_name:-$(printf '%q' "$default_value")}\"" } # app要能访问到此ip和端口或域名 def "API_URL" "http://${IP}:10002/object/" def "DATA_DIR" "${OPENIM_ROOT}" # 设置统一的用户名，方便记忆 def "USER" "root" # 设置统一的密码，方便记忆 def "PASSWORD" "openIM123" # 设置统一的数据库名称，方便管理 def "DATABASE_NAME" "openIM_v3" # Linux系统 openim 用户 def "LINUX_USERNAME" "openim" def "LINUX_PASSWORD" "${PASSWORD}" # 设置安装目录 def "INSTALL_DIR" "${LOCAL_OUTPUT_ROOT}/installs" mkdir -p ${INSTALL_DIR} def "ENV_FILE" "${OPENIM_ROOT}/scripts/install/environment.sh" # TODO 注意： 一般的配置都可以使用 def 函数来定义，如果是包含特殊字符，比如说: # TODO readonly MSG_DESTRUCT_TIME=${MSG_DESTRUCT_TIME:-'0 2 * * *'} # TODO 使用 readonly 来定义合适，负责无法正常解析 ###################### Zookeeper 配置信息 ###################### def "ZOOKEEPER_SCHEMA" "openim" # Zookeeper的模式 def "ZOOKEEPER_ADDRESS" "127.0.0.1:2181" # Zookeeper的地址 def "ZOOKEEPER_USERNAME" # Zookeeper的用户名 def "ZOOKEEPER_PASSWORD" # Zookeeper的密码 ###################### MySQL 配置信息 ###################### def "MYSQL_ADDRESS" "127.0.0.1:13306" # MySQL的地址 def "MYSQL_USERNAME" "${USER}" # MySQL的用户名 def "MYSQL_PASSWORD" "${PASSWORD}" # MySQL的密码 def "MYSQL_DATABASE" "${DATABASE_NAME}" # MySQL的数据库名 def "MYSQL_MAX_OPEN_CONN" "1000" # 最大打开的连接数 def "MYSQL_MAX_IDLE_CONN" "100" # 最大空闲连接数 def "MYSQL_MAX_LIFETIME" "60" # 连接可以重用的最大生命周期（秒） def "MYSQL_LOG_LEVEL" "4" # 日志级别 def "MYSQL_SLOW_THRESHOLD" "500" # 慢查询阈值（毫秒） ###################### MongoDB 配置信息 ###################### def "MONGO_URI" # MongoDB的URI def "MONGO_ADDRESS" "127.0.0.1:37017" # MongoDB的地址 def "MONGO_DATABASE" "${DATABASE_NAME}" # MongoDB的数据库名 def "MONGO_USERNAME" "${USER}" # MongoDB的用户名 def "MONGO_PASSWORD" "${PASSWORD}" # MongoDB的密码 def "MONGO_MAX_POOL_SIZE" "100" # 最大连接池大小 ###################### Object 配置信息 ###################### def "OBJECT_ENABLE" "minio" # 对象是否启用 def "OBJECT_APIURL" "http://127.0.0.1:10002/object/" # 对象的API地址 def "MINIO_BUCKET" "openim" # MinIO的存储桶名称 def "MINIO_ENDPOINT" "http://${IP}:10005" # MinIO的端点URL def "MINIO_ACCESS_KEY" "${USER}" # MinIO的访问密钥ID def "MINIO_SECRET_KEY" "${PASSWORD}" # MinIO的密钥 def "MINIO_SESSION_TOKEN" # MinIO的会话令牌 def "COS_BUCKET_URL" "https://temp-1252357374.cos.ap-chengdu.myqcloud.com" # 腾讯云COS的存储桶URL def "COS_SECRET_ID" # 腾讯云COS的密钥ID def "COS_SECRET_KEY" # 腾讯云COS的密钥 def "COS_SESSION_TOKEN" # 腾讯云COS的会话令牌 def "OSS_ENDPOINT" "https://oss-cn-chengdu.aliyuncs.com" # 阿里云OSS的端点URL def "OSS_BUCKET" "demo-9999999" # 阿里云OSS的存储桶名称 def "OSS_BUCKET_URL" "https://demo-9999999.oss-cn-chengdu.aliyuncs.com" # 阿里云OSS的存储桶URL def "OSS_ACCESS_KEY_ID" "${USER}" # 阿里云OSS的访问密钥ID def "OSS_ACCESS_KEY_SECRET" # 阿里云OSS的密钥 def "OSS_SESSION_TOKEN" # 阿里云OSS的会话令牌 ###################### Redis 配置信息 ###################### def "REDIS_ADDRESS" "127.0.0.1:16379" # Redis的地址 def "REDIS_USERNAME" # Redis的用户名 def "REDIS_PASSWORD" "${PASSWORD}" # Redis的密码 ###################### Kafka 配置信息 ###################### def "KAFKA_USERNAME" # Kafka的用户名 def "KAFKA_PASSWORD" # Kafka的密码 def "KAFKA_ADDR" "127.0.0.1:9092" # Kafka的地址 def "KAFKA_LATESTMSG_REDIS_TOPIC" "latestMsgToRedis" # Kafka的最新消息到Redis的主题 def "KAFKA_OFFLINEMSG_MONGO_TOPIC" "offlineMsgToMongoMysql" # Kafka的离线消息到Mongo的主题 def "KAFKA_MSG_PUSH_TOPIC" "msgToPush" # Kafka的消息到推送的主题 def "KAFKA_CONSUMERGROUPID_REDIS" "redis" # Kafka的消费组ID到Redis def "KAFKA_CONSUMERGROUPID_MONGO" "mongo" # Kafka的消费组ID到Mongo def "KAFKA_CONSUMERGROUPID_MYSQL" "mysql" # Kafka的消费组ID到MySql def "KAFKA_CONSUMERGROUPID_PUSH" "push" # Kafka的消费组ID到推送 ###################### RPC 配置信息 ###################### def "RPC_REGISTER_IP" # RPC的注册IP def "RPC_LISTEN_IP" "0.0.0.0" # RPC的监听IP ###################### API 配置信息 ###################### def "API_OPENIM_PORT" "10002" # API的开放端口 def "API_LISTEN_IP" "0.0.0.0" # API的监听IP ###################### RPC Port Configuration Variables ###################### def "OPENIM_USER_PORT" "10110" # OpenIM用户服务端口 def "OPENIM_FRIEND_PORT" "10120" # OpenIM朋友服务端口 def "OPENIM_MESSAGE_PORT" "10130" # OpenIM消息服务端口 def "OPENIM_MESSAGE_GATEWAY_PORT" "10140" # OpenIM消息网关服务端口 def "OPENIM_GROUP_PORT" "10150" # OpenIM组服务端口 def "OPENIM_AUTH_PORT" "10160" # OpenIM授权服务端口 def "OPENIM_PUSH_PORT" "10170" # OpenIM推送服务端口 def "OPENIM_CONVERSATION_PORT" "10180" # OpenIM对话服务端口 def "OPENIM_THIRD_PORT" "10190" # OpenIM第三方服务端口 ###################### RPC Register Name Variables ###################### def "OPENIM_USER_NAME" "User" # OpenIM用户服务名称 def "OPENIM_FRIEND_NAME" "Friend" # OpenIM朋友服务名称 def "OPENIM_MSG_NAME" "Msg" # OpenIM消息服务名称 def "OPENIM_PUSH_NAME" "Push" # OpenIM推送服务名称 def "OPENIM_MESSAGE_GATEWAY_NAME" "MessageGateway" # OpenIM消息网关服务名称 def "OPENIM_GROUP_NAME" "Group" # OpenIM组服务名称 def "OPENIM_AUTH_NAME" "Auth" # OpenIM授权服务名称 def "OPENIM_CONVERSATION_NAME" "Conversation" # OpenIM对话服务名称 def "OPENIM_THIRD_NAME" "Third" # OpenIM第三方服务名称 ###################### Log Configuration Variables ###################### def "LOG_STORAGE_LOCATION" "${OPENIM_ROOT}/log/" # 日志存储位置 def "LOG_ROTATION_TIME" "24" # 日志轮替时间 def "LOG_REMAIN_ROTATION_COUNT" "2" # 保留的日志轮替数量 def "LOG_REMAIN_LOG_LEVEL" "6" # 保留的日志级别 def "LOG_IS_STDOUT" "false" # 是否将日志输出到标准输出 def "LOG_IS_JSON" "false" # 日志是否为JSON格式 def "LOG_WITH_STACK" "false" # 日志是否带有堆栈信息 ###################### Variables definition ###################### def "OPENIM_WS_PORT" "10001" # OpenIM WS端口 def "WEBSOCKET_MAX_CONN_NUM" "100000" # Websocket最大连接数 def "WEBSOCKET_MAX_MSG_LEN" "4096" # Websocket最大消息长度 def "WEBSOCKET_TIMEOUT" "10" # Websocket超时 def "PUSH_ENABLE" "getui" # 推送是否启用 def "GETUI_PUSH_URL" "https://restapi.getui.com/v2/$appId" # GeTui推送URL def "FCM_SERVICE_ACCOUNT" "x.json" # FCM服务账户 def "JPNS_APP_KEY" # JPNS应用密钥 def "JPNS_MASTER_SECRET" # JPNS主密钥 def "JPNS_PUSH_URL" # JPNS推送URL def "JPNS_PUSH_INTENT" # JPNS推送意图 def "MANAGER_USERID_1" "openIM123456" # 管理员ID 1 def "MANAGER_USERID_2" "openIM654321" # 管理员ID 2 def "MANAGER_USERID_3" "openIMAdmin" # 管理员ID 3 def "NICKNAME_1" "system1" # 昵称1 def "NICKNAME_2" "system2" # 昵称2 def "NICKNAME_3" "system3" # 昵称3 def "MULTILOGIN_POLICY" "1" # 多登录策略 def "CHAT_PERSISTENCE_MYSQL" "true" # 聊天持久化MySQL def "MSG_CACHE_TIMEOUT" "86400" # 消息缓存超时 def "GROUP_MSG_READ_RECEIPT" "true" # 群消息已读回执启用 def "SINGLE_MSG_READ_RECEIPT" "true" # 单一消息已读回执启用 def "RETAIN_CHAT_RECORDS" "365" # 保留聊天记录 # 聊天记录清理时间 readonly CHAT_RECORDS_CLEAR_TIME=${CHAT_RECORDS_CLEAR_TIME:-'0 2 * * *'} # 消息销毁时间 readonly MSG_DESTRUCT_TIME=${MSG_DESTRUCT_TIME:-'0 2 * * *'} def "SECRET" "${PASSWORD}" # 密钥 def "TOKEN_EXPIRE" "90" # Token到期时间 def "FRIEND_VERIFY" "false" # 朋友验证 def "IOS_PUSH_SOUND" "xxx" # IOS推送声音 def "IOS_BADGE_COUNT" "true" # IOS徽章计数 def "IOS_PRODUCTION" "false" # IOS生产 ###################### Prometheus 配置信息 ###################### def "PROMETHEUS_ENABLE" "false" # 是否启用 Prometheus def "USER_PROM_PORT" "20110" # User 服务的 Prometheus 端口 def "FRIEND_PROM_PORT" "20120" # Friend 服务的 Prometheus 端口 def "MESSAGE_PROM_PORT" "20130" # Message 服务的 Prometheus 端口 def "MSG_GATEWAY_PROM_PORT" "20140" # Message Gateway 服务的 Prometheus 端口 def "GROUP_PROM_PORT" "20150" # Group 服务的 Prometheus 端口 def "AUTH_PROM_PORT" "20160" # Auth 服务的 Prometheus 端口 def "PUSH_PROM_PORT" "20170" # Push 服务的 Prometheus 端口 def "CONVERSATION_PROM_PORT" "20230" # Conversation 服务的 Prometheus 端口 def "RTC_PROM_PORT" "21300" # RTC 服务的 Prometheus 端口 def "THIRD_PROM_PORT" "21301" # Third 服务的 Prometheus 端口 # Message Transfer 服务的 Prometheus 端口列表 readonly MSG_TRANSFER_PROM_PORTS=${MSG_TRANSFER_PROM_PORTS:-'21400, 21401, 21402, 21403'} ###################### 设计中...暂时不需要###################################### # openim 配置 def "OPENIM_DATA_DIR" "/data/openim" def "OPENIM_INSTALL_DIR" "/opt/openim" def "OPENIM_CONFIG_DIR" "/etc/openim" def "OPENIM_LOG_DIR" "/var/log/openim" def "CA_FILE" "${OPENIM_CONFIG_DIR}/cert/ca.pem" # openim-api 配置 def "OPENIM_APISERVER_HOST" "127.0.0.1" def "OPENIM_APISERVER_GRPC_BIND_ADDRESS" "0.0.0.0" def "OPENIM_APISERVER_GRPC_BIND_PORT" "8081" def "OPENIM_APISERVER_INSECURE_BIND_ADDRESS" "127.0.0.1" def "OPENIM_APISERVER_INSECURE_BIND_PORT" "8080" def "OPENIM_APISERVER_SECURE_BIND_ADDRESS" "0.0.0.0" def "OPENIM_APISERVER_SECURE_BIND_PORT" "8443" def "OPENIM_APISERVER_SECURE_TLS_CERT_KEY_CERT_FILE" "${OPENIM_CONFIG_DIR}/cert/openim-apiserver.pem" def "OPENIM_APISERVER_SECURE_TLS_CERT_KEY_PRIVATE_KEY_FILE" "${OPENIM_CONFIG_DIR}/cert/openim-apiserver-key.pem" # openimctl 配置 def "CONFIG_USER_USERNAME" "admin" def "CONFIG_USER_PASSWORD" "Admin@2021" def "CONFIG_USER_CLIENT_CERTIFICATE" "${HOME}/.openim/cert/admin.pem" def "CONFIG_USER_CLIENT_KEY" "${HOME}/.openim/cert/admin-key.pem" def "CONFIG_SERVER_ADDRESS" "${OPENIM_APISERVER_HOST}:${OPENIM_APISERVER_SECURE_BIND_PORT}" def "CONFIG_SERVER_CERTIFICATE_AUTHORITY" "${CA_FILE}"