OpenIM Open Source Instant Messaging Project Docker Compose Deployment Guide

The deployment of OpenIM involves multiple components and supports various methods including source code, Docker, and Kubernetes. This requires ensuring compatibility between different deployment methods and effectively managing differences between versions. This is undoubtedly a complex task involving technical depth and precise system configuration. We are committed to simplifying the deployment process while ensuring the system’s flexibility and stability, to meet the needs of various users. Currently, in version 3.5, we have simplified the deployment process and will provide long-term maintenance for this version, looking forward to your user experience.

1. Environment and Component Requirements

🌐 Environmental Requirements

| Note | Detailed Explanation |

| ------------------ | ----------------------------- |

| Operating System | Linux system |

| Hardware Resources | At least 4GB available memory |

| Golang | v1.19 or higher |

| Docker | v24.0.5 or higher |

| Git | v2.17.1 or higher |

Storage Component Requirements

| Storage Component | Recommended Version |

| ----------------- | ------------------- |

| MongoDB | v6.0.2 or higher |

| Redis | v7.0.0 or higher |

| Zookeeper | v3.8 |

| Kafka | v3.5.1 |

| MySQL | v5.7 or higher |

| MinIO | Latest version |

2. Docker Deployment

2.1 Clone Repository and Initialize

git clone https://github.com/openimsdk/openim-docker openim-docker && cd openim-docker && make init

2.2 Set OPENIM_IP

# If the server has an external IP

export OPENIM_IP="external IP"

# If only providing internal network services

export OPENIM_IP="internal IP"

2.3 Start Services and View Logs