README.md

OpenIM Docker Usage Instructions 📘

Documentation Resources 📚

• Official Deployment Guide

👥 Community

• 💬 Follow us on Twitter
• 🚀 Join our Slack channel
• 👀 Join our WeChat Group

Environment Preparation 🌍

• Install Docker with the Compose plugin or docker-compose on your server. For installation details, visit Docker Compose Installation Guide.

Repository Cloning 🗂️

git clone https://github.com/openimsdk/openim-docker

Configuration Modification 🔧

• Modify the .env file to configure the external IP. If using a domain name, Nginx configuration is required.

  # Set the external access address (IP or domain) for MinIO service
  MINIO_EXTERNAL_ADDRESS="http://external_ip:10005"
  

• For other configurations, please refer to the comments in the .env file

Service Launch 🚀

• To start the service:

docker compose up -d

• To stop the service:

docker compose down

• To view logs:

docker logs -f openim-server
docker logs -f openim-chat

Quick Experience ⚡

For a quick experience with OpenIM services, please visit the Quick Test Server Guide.