You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
260 lines
8.4 KiB
260 lines
8.4 KiB
# 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.
|
|
|
|
# ======================================
|
|
# ========= Basic Configuration ========
|
|
# ======================================
|
|
|
|
# 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}
|
|
|
|
# Endpoint for the MinIO object storage service.
|
|
# Default: MINIO_ENDPOINT=http://172.28.0.1:10005
|
|
MINIO_ENDPOINT=${MINIO_ENDPOINT}
|
|
|
|
# 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,
|
|
# 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=${IMAGE_REGISTRY}
|
|
|
|
# ======================================
|
|
# ========= Network Configuration ======
|
|
# ======================================
|
|
|
|
# Subnet for the Docker network.
|
|
# Default: DOCKER_BRIDGE_SUBNET=172.28.0.0/16
|
|
DOCKER_BRIDGE_SUBNET=${DOCKER_BRIDGE_SUBNET}
|
|
|
|
# Gateway for the Docker network.
|
|
# Default: DOCKER_BRIDGE_GATEWAY=172.28.0.1
|
|
DOCKER_BRIDGE_GATEWAY=${DOCKER_BRIDGE_GATEWAY}
|
|
|
|
MONGO_NETWORK_ADDRESS=${MONGO_NETWORK_ADDRESS}
|
|
REDIS_NETWORK_ADDRESS=${REDIS_NETWORK_ADDRESS}
|
|
KAFKA_NETWORK_ADDRESS=${KAFKA_NETWORK_ADDRESS}
|
|
ZOOKEEPER_NETWORK_ADDRESS=${ZOOKEEPER_NETWORK_ADDRESS}
|
|
MINIO_NETWORK_ADDRESS=${MINIO_NETWORK_ADDRESS}
|
|
OPENIM_WEB_NETWORK_ADDRESS=${OPENIM_WEB_NETWORK_ADDRESS}
|
|
OPENIM_SERVER_NETWORK_ADDRESS=${OPENIM_SERVER_NETWORK_ADDRESS}
|
|
OPENIM_CHAT_NETWORK_ADDRESS=${OPENIM_CHAT_NETWORK_ADDRESS}
|
|
PROMETHEUS_NETWORK_ADDRESS=${PROMETHEUS_NETWORK_ADDRESS}
|
|
GRAFANA_NETWORK_ADDRESS=${GRAFANA_NETWORK_ADDRESS}
|
|
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 =
|
|
# ===============================================
|
|
|
|
# ============ 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}
|
|
|
|
# Username to authenticate with the MongoDB service.
|
|
# Default: MONGO_USERNAME=root
|
|
MONGO_USERNAME=${MONGO_USERNAME}
|
|
|
|
# Password to authenticate with the MongoDB service.
|
|
# Default: MONGO_PASSWORD=openIM123
|
|
MONGO_PASSWORD=${MONGO_PASSWORD}
|
|
|
|
# Name of the database in MongoDB to be used.
|
|
# Default: MONGO_DATABASE=openIM_v3
|
|
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
|
|
REDIS_PORT=${REDIS_PORT}
|
|
|
|
# Password to authenticate with the Redis service.
|
|
# 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}
|
|
|
|
# Port on which Kafka distributed streaming platform is running.
|
|
# Default: KAFKA_PORT=19092
|
|
KAFKA_PORT=${KAFKA_PORT}
|
|
|
|
# Topic in Kafka for storing the latest messages in Redis.
|
|
# 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).
|
|
# Default: KAFKA_MSG_PUSH_TOPIC=msgToPush
|
|
KAFKA_MSG_PUSH_TOPIC=${KAFKA_MSG_PUSH_TOPIC}
|
|
|
|
# Topic in Kafka for storing offline messages in MongoDB.
|
|
# Default: KAFKA_OFFLINEMSG_MONGO_TOPIC=offlineMsgToMongoMysql
|
|
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}
|
|
|
|
# Access key to authenticate with the MinIO service.
|
|
# Default: MINIO_ACCESS_KEY=root
|
|
MINIO_ACCESS_KEY=${MINIO_ACCESS_KEY}
|
|
|
|
# Secret key corresponding to the access key for MinIO authentication.
|
|
# Default: MINIO_SECRET_KEY=openIM123
|
|
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}
|
|
|
|
# ======================================
|
|
# ============ OpenIM Web ===============
|
|
# ======================================
|
|
|
|
# Path to the OpenIM web distribution.
|
|
# Default: OPENIM_WEB_DIST_PATH=/app/dist
|
|
OPENIM_WEB_DIST_PATH=${OPENIM_WEB_DIST_PATH}
|
|
|
|
# Port on which OpenIM web service is running.
|
|
# 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.
|
|
# Default: API_OPENIM_PORT=10002
|
|
API_OPENIM_PORT=${API_OPENIM_PORT}
|
|
|
|
|
|
# ======================================
|
|
# ========== OpenIM Chat ===============
|
|
# ======================================
|
|
|
|
# Branch name for OpenIM chat.
|
|
# Default: CHAT_BRANCH=main
|
|
CHAT_BRANCH=${CHAT_BRANCH}
|
|
|
|
# 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}
|
|
|
|
# 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 Admin ==============
|
|
# ======================================
|
|
|
|
# Branch name for OpenIM server.
|
|
# Default: SERVER_BRANCH=main
|
|
SERVER_BRANCH=${SERVER_BRANCH}
|
|
|
|
# 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}
|
|
|
|
# Port for the prometheus.
|
|
# Default: PROMETHEUS_PORT=19090
|
|
PROMETHEUS_PORT=${PROMETHEUS_PORT}
|
|
|
|
# Port for the grafana.
|
|
# Default: GRAFANA_PORT=13000
|
|
GRAFANA_PORT=${GRAFANA_PORT}
|
|
|
|
# Port for the admin front.
|
|
# Default: OPENIM_ADMIN_FRONT_PORT=11002
|
|
OPENIM_ADMIN_FRONT_PORT=${OPENIM_ADMIN_FRONT_PORT}
|
|
|
|
# Port for the alertmanager.
|
|
# Default: ALERT_MANAGER_PORT=19093
|
|
ALERT_MANAGER_PORT=${ALERT_MANAGER_PORT} |