blackteay/open-im-server
1
0
Fork 0
mirror of https://github.com/openimsdk/open-im-server.git synced 2025-04-26 03:26:57 +08:00
Code Issues Packages Projects Releases Wiki Activity

update readme.md

Browse Source
This commit is contained in:
away 2021-05-26 20:50:33 +08:00
parent 0f3098d9e0
commit d419983a36
1 changed files with 109 additions and 104 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -44,19 +44,19 @@ business data.
#### Building from Source #### Building from Source
1. Install [Go environment](https://golang.org/doc/install). Make sure Go version is at least 1.15. > Open-IM relies on five open source high-performance components: **ETCD**, **MySQL**, **MongoDB**, **Redis**, **Kafka**. Before you deploy Open-IM-Server privately, please make sure that you have installed the above five components and **check the component connection parameters ** in the configuration file. you must install the missing components first,If your server does not have the above components. **It is recommended to use it directly, if you have the above components, if not, Docker installation is recommended, which is faster and more convenient**.
2. Open-IM relies on five open source high-performance components: **Etcd**, **MySQL**, **MongoDB**, **Redis**, **Kafka**. Before you deploy Open-IM privately, please make sure that you have installed the above five components and **check the component parameters ** in the configuration file. If your server does not have the above components, you must install the missing components first. **If you have the above components, it is recommended to use them directly, if not, Docker installation is recommended, which is faster and more convenient**. 1. Install [Go environment](https://golang.org/doc/install). Make sure Go version is at least 1.15.
3. Git clone Open-IM project 3. Git clone Open-IM project
``` ```
git clone https://github.com/tinode/chat https://github.com/OpenIMSDK/Open-IM-Server.git
``` ```
4. Open [config.yaml](https://github.com/Open-IM-IM/opim_admin/blob/main/config/config.yaml),then modify the following parameters. 4. Open [config.yaml](https://github.com/Open-IM-IM/opim_admin/blob/main/config/config.yaml),then modify the following parameters.
- Check that the Etcd connection parameters. - Check that the ETCD connection parameters.
``` ```
etcd: etcd:
@ -102,12 +102,17 @@ business data.
5. Build Open-IM server and database initializer: 5. Build Open-IM server and database initializer:
- **MySQL** - **MySQL**
``` ```
need to add
``` ```
- **MongoDB** - **MongoDB**
``` ```
... need to add
``` ```
6. Enter the script directory and execute the script according to the steps。 6. Enter the script directory and execute the script according to the steps。
1. Shell authorization 1. Shell authorization
@ -119,23 +124,23 @@ business data.
2. Execute build shell 2. Execute build shell
``` ```
./auto_build_service_file.sh ./build_all_service.sh
``` ```
3. Start service 3. Start service
``` ```
./auto_start_service.sh ./start_all.sh
``` ```
#### Using Docker to run Open-IM-Server #### Using Docker to run Open-IM-Server
> Open-IM relies on five open source high-performance components: **ETCD**, **MySQL**, **MongoDB**, **Redis**, **Kafka**. Before you deploy Open-IM-Server privately, please make sure that you have installed the above five components and **check the component connection parameters ** in the configuration file. you must install the missing components first,If your server does not have the above components. **It is recommended to use it directly, if you have the above components, if not, Docker installation is recommended, which is faster and more convenient**.
All images are available at https://hub.docker.com/r/lyt1123/open_im_server All images are available at https://hub.docker.com/r/lyt1123/open_im_server
1. [Install Docker](https://docs.docker.com/install/) 1.13 or above. 1. [Install Docker](https://docs.docker.com/install/) 1.13 or above.
2. Open-IM relies on five open source high-performance components: **Etcd**, **MySQL**, **MongoDB**, **Redis**, **Kafka**. Before you deploy Open-IM privately, please make sure that you have installed the above five components and **check the component parameters ** in the configuration file. If your server does not have the above components, you must install the missing components first. **If you have the above components, it is recommended to use them directly, if not, Docker installation is recommended, which is faster and more convenient**.
3. Pull Open_IM_Server Image from docker 3. Pull Open_IM_Server Image from docker
``` ```