From fbf3d77822d7134061d5d4aa403cd9ad0fcfd915 Mon Sep 17 00:00:00 2001 From: "Xinwei Xiong(cubxxw-openim)" <3293172751nss@gmail.com> Date: Thu, 27 Jul 2023 12:26:03 +0800 Subject: [PATCH] fix: config env command Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com> --- config/config.yaml | 18 ++-- install.sh | 216 ++++++++++++++++++++++++++++++++++----------- 2 files changed, 174 insertions(+), 60 deletions(-) diff --git a/config/config.yaml b/config/config.yaml index fa1f922e2..3f43a7a69 100644 --- a/config/config.yaml +++ b/config/config.yaml @@ -24,8 +24,8 @@ zookeeper: mysql: address: [ 127.0.0.1:13306 ] #目前仅支持单机 - username: root #用户名 - password: openIM123 #密码 + username: root + password: openIM123 database: openIM_v3 #不建议修改 maxOpenConn: 1000 #最大连接数 maxIdleConn: 100 #最大空闲连接数 @@ -37,14 +37,14 @@ mongo: uri: #不为空则直接使用该值 address: [ 127.0.0.1:37017 ] #单机时为mongo地址，使用分片集群时，为mongos地址 database: openIM_v3 #mongo db 默认即可 - username: root #用户名 - password: openIM123 #密码 + username: root + password: openIM123 maxPoolSize: 100 redis: address: [ 127.0.0.1:16379 ] # username: #only redis version 6.0+ need username - password: openIM123 #密码 + password: openIM123 kafka: username: #用户名 @@ -77,9 +77,9 @@ object: apiURL: "http://127.0.0.1:10002/object/" #地址需要app能访问到 minio: bucket: "openim" #不建议修改 - endpoint: "http://127.0.0.1:10005" #minio对外服务的ip和端口，app要能访问此ip和端口 - accessKeyID: "root" #ID - secretAccessKey: "openIM123" #秘钥 + endpoint: http://127.0.0.1:10005 #地址需要app能够访问 + accessKeyID: root + secretAccessKey: openIM123 sessionToken: "" #token cos: #tencent cos bucketURL: "https://temp-1252357374.cos.ap-chengdu.myqcloud.com" @@ -167,7 +167,7 @@ retainChatRecords: 365 #mongo保存离线消息 chatRecordsClearTime: "0 2 * * 3" #每周三凌晨2点清理mongo中的过期（超过retainChatRecords时间）消息，这个删除是为了清理满足上个配置retainChatRecords的过期消息，不会发送通知，仅仅作为清理磁盘使用 msgDestructTime: "0 2 * * *" #消息自动删除时间，每天凌晨2点删除过期消息，这个删除是为了删除保留时间超过超过会话字段msg_destruct_time（秒）的消息。 -secret: tuoyun #秘钥，获取token时校验 +secret: openIM123 tokenPolicy: expire: 90 #过期时间（天） diff --git a/install.sh b/install.sh index 4deedc652..0c3a3945e 100755 --- a/install.sh +++ b/install.sh @@ -23,34 +23,60 @@ set -o pipefail ############### OpenIM Github ############### # ... rest of the script ... -# OpenIM Repo -OWNER="OpenIMSDK" -REPO="Open-IM-Server" +# TODO +# You can configure this script in three ways. +# 1. First, set the variables in this column with more comments. +# 2. The second is to pass an environment variable via a flag such as --help. +# 3. The third way is to set the variable externally, or pass it in as an environment variable -# Update your Go version here +# Default configuration for OpenIM Repo +# The OpenIM Repo settings can be customized according to your needs. + +# OpenIM Repo owner, by default it's set to "OpenIMSDK". If you're using a different owner, replace accordingly. +OWNER="OpenIMSDK" + +# The repository name, by default it's "Open-IM-Server". If you're using a different repository, replace accordingly. +REPO="Open-IM-Server" + +# Version of Go you want to use, make sure it is compatible with your OpenIM-Server requirements. +# Default is 1.18, if you want to use a different version, replace accordingly. GO_VERSION="1.18" +# Default HTTP_PORT is 80. If you want to use a different port, uncomment and replace the value. # HTTP_PORT=80 -# CPU core number, concurrent execution +# CPU core number for concurrent execution. By default it's determined automatically. +# Uncomment the next line if you want to set it manually. # CPU=$(grep -c ^processor /proc/cpuinfo) -# default is latest tag: https://github.com/OpenIMSDK/Open-IM-Server/releases +# By default, the script uses the latest tag from OpenIM-Server releases. +# If you want to use a specific tag, uncomment and replace "v3.0.0" with the desired tag. # LATEST_TAG=v3.0.0 -# default OpenIM install directory is /tmp +# Default OpenIM install directory is /tmp. If you want to use a different directory, uncomment and replace "/test". # DOWNLOAD_OPENIM_DIR="/test" -# github proxy -# PROXY="https://ghproxy.com/" +# GitHub proxy settings. If you are using a proxy, uncomment and replace the empty field with your proxy URL. PROXY= + +# If you have a GitHub token, replace the empty field with your token. GITHUB_TOKEN= -USER=root #no need to modify -PASSWORD=openIM123 #A combination of 8 or more numbers and letters, this password applies to redis, mysql, mongo, as well as accessSecret in config/config.yaml -ENDPOINT=http://127.0.0.1:10005 #minio's external service IP and port, or use the domain name storage.xx.xx, the app must be able to access this IP and port or domain, -API_URL=http://127.0.0.1:10002/object/ #the app must be able to access this IP and port or domain, -DATA_DIR=./ #designate large disk directory, default is current directory +# Default user is "root". If you need to modify it, uncomment and replace accordingly. +# USER=root + +# Default password for redis, mysql, mongo, as well as accessSecret in config/config.yaml. +# Remember, it should be a combination of 8 or more numbers and letters. If you want to set a different password, uncomment and replace "openIM123". +# PASSWORD=openIM123 + +# Default endpoint for minio's external service IP and port. If you want to use a different endpoint, uncomment and replace. +# ENDPOINT=http://127.0.0.1:10005 + +# Default API_URL, replace if necessary. +# API_URL=http://127.0.0.1:10002/object/ + +# Default data directory. If you want to specify a different directory, uncomment and replace "./". +# DATA_DIR=./ ############### OpenIM Functions ############### # Install horizon of the script @@ -210,6 +236,7 @@ function download_source_code() { tar -xzvf "${DOWNLOAD_OPENIM_DIR}/${MODIFIED_TAG}.tar.gz" -C "$DOWNLOAD_OPENIM_DIR" cd "$DOWNLOAD_OPENIM_DIR/$REPO-$MODIFIED_TAG" + git init && git add . && git commit -m "init" --no-verify success "Source code downloaded and extracted to $REPO-$MODIFIED_TAG" } @@ -217,9 +244,40 @@ function download_source_code() { function set_openim_env() { warn "This command can only be executed once. It will modify the component passwords in docker-compose based on the PASSWORD variable in .env, and modify the component passwords in config/config.yaml. If the password in .env changes, you need to first execute docker-compose down; rm components -rf and then execute this command." # Set default values for user input - user="root" - password="openIM123" - endpoint="http://" + # If the USER environment variable is not set, it defaults to 'root' + if [ -z "$USER" ]; then + USER="root" + debug "USER is not set. Defaulting to 'root'." + fi + + # If the PASSWORD environment variable is not set, it defaults to 'openIM123' + # This password applies to redis, mysql, mongo, as well as accessSecret in config/config.yaml + if [ -z "$PASSWORD" ]; then + PASSWORD="openIM123" + debug "PASSWORD is not set. Defaulting to 'openIM123'." + fi + + # If the ENDPOINT environment variable is not set, it defaults to 'http://127.0.0.1:10005' + # This is minio's external service IP and port, or it could be a domain like storage.xx.xx + # The app must be able to access this IP and port or domain + if [ -z "$ENDPOINT" ]; then + ENDPOINT="http://127.0.0.1:10005" + debug "ENDPOINT is not set. Defaulting to 'http://127.0.0.1:10005'." + fi + + # If the API_URL environment variable is not set, it defaults to 'http://127.0.0.1:10002/object/' + # The app must be able to access this IP and port or domain + if [ -z "$API_URL" ]; then + API_URL="http://127.0.0.1:10002/object/" + debug "API_URL is not set. Defaulting to 'http://127.0.0.1:10002/object/'." + fi + + # If the DATA_DIR environment variable is not set, it defaults to the current directory './' + # This can be set to a directory with large disk space + if [ -z "$DATA_DIR" ]; then + DATA_DIR="./" + debug "DATA_DIR is not set. Defaulting to './'." + fi } function install_openim() { @@ -235,11 +293,12 @@ function install_openim() { ############### OpenIM Help ############### # Function to display help message -display_help() { +function cmd_help() { openim_color color_echo ${BRIGHT_GREEN_PREFIX} "Usage: $0 [options]" color_echo ${BRIGHT_GREEN_PREFIX} "Options:" echo + color_echo ${BLUE_PREFIX} "-i, --install ${CYAN_PREFIX}Execute the installation logic of the script${COLOR_SUFFIX}" color_echo ${BLUE_PREFIX} "-u, --user ${CYAN_PREFIX}set user (default: root)${COLOR_SUFFIX}" color_echo ${BLUE_PREFIX} "-p, --password ${CYAN_PREFIX}set password (default: openIM123)${COLOR_SUFFIX}" color_echo ${BLUE_PREFIX} "-e, --endpoint ${CYAN_PREFIX}set endpoint (default: http://127.0.0.1:10005)${COLOR_SUFFIX}" @@ -255,42 +314,97 @@ display_help() { color_echo ${BLUE_PREFIX} "--cpu ${CYAN_PREFIX}set the number of concurrent processes${COLOR_SUFFIX}" echo color_echo ${RED_PREFIX} "Note: Only one of the -t/--tag or -r/--release options can be used at a time.${COLOR_SUFFIX}" - color_echo ${RED_PREFIX} "If both are used, the -t/--tag option will be prioritized.${COLOR_SUFFIX}" + color_echo ${RED_PREFIX} "If both are used or none of them are used, the -t/--tag option will be prioritized.${COLOR_SUFFIX}" echo exit 1 } -# Use getopts to parse command line flags -while getopts ":h:u:p:e:a:d:" opt; do - case ${opt} in - h ) - display_help - ;; - u ) - user=$OPTARG - ;; - p ) - password=$OPTARG - ;; - e ) - endpoint=$OPTARG - ;; - a ) - api_url=$OPTARG - ;; - d ) - data_dir=$OPTARG - ;; - \? ) - echo "Invalid Option: -$OPTARG" 1>&2 - exit 1 - ;; - : ) - echo "Invalid Option: -$OPTARG requires an argument" 1>&2 - exit 1 - ;; - esac -done +function parseinput() { + # set default values + # USER=root + # PASSWORD=openIM123 + # ENDPOINT=http://127.0.0.1:10005 + # API=http://127.0.0.1:10002/object/ + # DIRECTORY=./ + # CHINA=false + # TAG=latest + # RELEASE="" + # GO_VERSION=1.18 + # INSTALL_DIR=/tmp + # GITHUB_TOKEN="" + # CPU=$(nproc) + + if [ $# -eq 0 ]; then + cmd_help + exit 1 + fi + + while [ $# -gt 0 ]; do + case $1 in + -h|--help) + cmd_help + exit + ;; + -u|--user) + shift + USER=$1 + ;; + -p|--password) + shift + PASSWORD=$1 + ;; + -e|--endpoint) + shift + ENDPOINT=$1 + ;; + -a|--api) + shift + API=$1 + ;; + -d|--directory) + shift + DIRECTORY=$1 + ;; + -cn|--china) + CHINA=true + ;; + -t|--tag) + shift + TAG=$1 + ;; + -r|--release) + shift + RELEASE=$1 + ;; + -g|--go-version) + shift + GO_VERSION=$1 + ;; + -i|--install-dir) + shift + INSTALL_DIR=$1 + ;; + -gt|--github-token) + shift + GITHUB_TOKEN=$1 + ;; + --cpu) + shift + CPU=$1 + ;; + -i|--install) + openim_main + exit + ;; + *) + echo "Unknown option: $1" + cmd_help + exit 1 + ;; + esac + shift + done +} ############### OpenIM LOGO ############### # Set text color to cyan for header and URL @@ -443,4 +557,4 @@ function openim_main() { } -openim_main "$@" \ No newline at end of file +parseinput "$@" \ No newline at end of file