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:
etcdAddr: [ xxx.xxx.xxx.xxx:2379]
etcdAddr: [ 127.0.0.1:2379]
```
```
- Check or modify database(MySQL) connection parameters are correct for your database.
- Check or modify database(MySQL) connection parameters are correct for your database.
```
```
mysql:
mysql:
dbAddress: [ xxx.xxx.xxx.xxx:3306]
dbAddress: [ 127.0.0.1:3306]
dbUserName: xxx
dbUserName: xxx
dbPassword: xxx
dbPassword: xxx
```
```
@ -77,7 +76,7 @@ business data.
```
```
mongo:
mongo:
dbAddress: [xxx.xxx.xxx.xxx:27017 ]
dbAddress: [ 127.0.0.1:27017 ]
dbUserName:
dbUserName:
dbPassword:
dbPassword:
```
```
@ -86,7 +85,7 @@ business data.
```
```
redis:
redis:
dbAddress: [xxx.xxx.xxx.xxx:6379]
dbAddress: [ 127.0.0.1:6379]
dbPassWord:
dbPassWord:
```
```
@ -95,9 +94,9 @@ business data.
```
```
kafka:
kafka:
ws2mschat:
ws2mschat:
addr: [ xxx.xxx.xxx.xxx:9092 ]
addr: [ 127.0.0.1:9092 ]
ms2pschat:
ms2pschat:
addr: [ xxx.xxx.xxx.xxx:9092 ]
addr: [ 127.0.0.1:9092 ]
```
```
5. Build Open-IM server and database initializer:
5. Build Open-IM server and database initializer:
@ -105,13 +104,13 @@ business data.
- **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。
@ -125,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
```
```
@ -164,14 +163,14 @@ All images are available at https://hub.docker.com/r/lyt1123/open_im_server
```
```
etcd:
etcd:
etcdAddr: [ x.x.x.x:2379]
etcdAddr: [ 127.0.0.1:2379]
```
```
- Check or modify database(MySQL) connection parameters are correct for your database.
- Check or modify database(MySQL) connection parameters are correct for your database.
```
```
mysql:
mysql:
dbAddress: [ x.x.x.x:3306]
dbAddress: [ 127.0.0.1:3306]
dbUserName: xxx
dbUserName: xxx
dbPassword: xxx
dbPassword: xxx
```
```
@ -180,7 +179,7 @@ All images are available at https://hub.docker.com/r/lyt1123/open_im_server
```
```
mongo:
mongo:
dbAddress: [ x.x.x.x:27017 ]
dbAddress: [ 127.0.0.1:27017 ]
dbUserName:
dbUserName:
dbPassword:
dbPassword:
```
```
@ -189,7 +188,7 @@ All images are available at https://hub.docker.com/r/lyt1123/open_im_server
```
```
redis:
redis:
dbAddress: [x.x.x.x:6379]
dbAddress: [ 127.0.0.1:6379]
dbPassWord:
dbPassWord:
```
```
@ -198,9 +197,9 @@ All images are available at https://hub.docker.com/r/lyt1123/open_im_server
```
```
kafka:
kafka:
ws2mschat:
ws2mschat:
addr: [ x.x.x.x:9092 ]
addr: [ 127.0.0.1:9092 ]
ms2pschat:
ms2pschat:
addr: [ x.x.x.x:9092 ]
addr: [ 127.0.0.1:9092 ]
```
```
5. Start Open-IM-Server Service
5. Start Open-IM-Server Service
@ -328,8 +327,8 @@ All images are available at https://hub.docker.com/r/lyt1123/open_im_server