feat: add openim config docs

Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com>

.env

@@ -30,11 +30,11 @@ 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://14.155.86.214:10002
+API_URL=http://172.28.0.1:10002
 
 # Directory path for storing data files or related information.
 # Default: DATA_DIR=./
-DATA_DIR=/root/workspaces/openim/Open-IM-Server
+DATA_DIR=./
 
 # Choose the appropriate image address, the default is GITHUB image, 
 # you can choose docker hub, for Chinese users can choose Ali Cloud

config/config.yaml

@@ -135,14 +135,14 @@ api:
 # minio.signEndpoint is minio public network address
 object:
   enable: "minio"
-  apiURL: "http://14.155.86.214:10002"
+  apiURL: "http://127.0.0.1:10002"
   minio:
     bucket: "openim"
     endpoint: "http://172.28.0.1:10005"
     accessKeyID: "root"
     secretAccessKey: "openIM123"
     sessionToken: ''
-    signEndpoint: "http://14.155.86.214:10005"
+    signEndpoint: "http://127.0.0.1:10005"
     publicRead: false
   cos:
     bucketURL: https://temp-1252357374.cos.ap-chengdu.myqcloud.com
@@ -198,7 +198,7 @@ rpcRegisterName:
 # Whether to output in json format
 # Whether to include stack trace in logs
 log:
-  storageLocation: /root/workspaces/openim/Open-IM-Server/logs/
+  storageLocation: ../logs/
   rotationTime: 24
   remainRotationCount: 2
   remainLogLevel: 6

deployments/README.md

@@ -121,6 +121,8 @@ $ make image
 Explore our Helm-Charts repository and read through: [Helm-Charts Repository](https://github.com/openimsdk/helm-charts)
 
 
+Using the helm charts repository, you can ignore the following configuration, but if you want to just use the server and scale on top of it, you can go ahead:
+
 **Use Helmfile:**
 
 ```bash
@@ -128,6 +130,18 @@ GO111MODULE=on go get github.com/roboll/helmfile@latest
 ```
 
 ```bash
+export MYSQL_ADDRESS=im-mysql
+export MYSQL_PORT=3306
+export MONGO_ADDRESS=im-mongo
+export MONGO_PORT=27017
+export REDIS_ADDRESS=im-redis-master
+export REDIS_PORT=6379
+export KAFKA_ADDRESS=im-kafka
+export KAFKA_PORT=9092
+export OBJECT_APIURL="https://openim.server.com/api"
+export MINIO_ENDPOINT="http://im-minio:9000"
+export MINIO_SIGN_ENDPOINT="https://openim.server.com/im-minio-api"
+
 mkdir ./charts/generated-configs
 ../scripts/genconfig.sh ../scripts/install/environment.sh ./templates/openim.yaml > ./charts/generated-configs/config.yaml
 cp ../config/notification.yaml ./charts/generated-configs/notification.yaml

pkg/common/version/types.go

@@ -7,6 +7,7 @@ type Info struct {
 	Major      string `json:"major,omitempty"`
 	Minor      string `json:"minor,omitempty"`
 	GitVersion string `json:"gitVersion"`
+	GitTreeState string `json:"gitTreeState,omitempty"`
 	GitCommit  string `json:"gitCommit,omitempty"`
 	BuildDate  string `json:"buildDate"`
 	GoVersion  string `json:"goVersion"`

pkg/common/version/version.go

@@ -16,6 +16,7 @@ func Get() Info {
 		Major:      gitMajor,
 		Minor:      gitMinor,
 		GitVersion: gitVersion,
+		GitTreeState: gitTreeState,
 		GitCommit:  gitCommit,
 		BuildDate:  buildDate,
 		GoVersion:  runtime.Version(),