You may use the OpenIM source code to create compiled versions not originally produced by OpenIM under one of the following two licensing options:
- This option is governed by the Free Software Foundation's GPL v3.0.
- Usage is subject to certain exceptions as outlined in this policy.
- Obtain a commercial license by contacting OpenIM.
- For more details and licensing inquiries, please email 📧 contact@openim.io.
- This repository implements a business system, which consists of two parts: User System and Backend Management System.
- The system relies on the open-im-server repository and implements various business functions by calling the APIs of the instant messaging system.
- The User System includes regular functions such as user login, user registration, user information update, etc.
- The Backend Management System includes APIs for managing users, groups, and messages.
⚠️ Note: This project works on Linux/Windows/Mac platforms and both ARM and AMD architectures.
git clone https://github.com/openimsdk/chat openim-chat
cd openim-chat
💻 Before the first compilation, execute on Linux/Mac platforms:
sh bootstrap.sh
💻 On Windows execute:
bootstrap.bat
mage
mage start
nohup mage start >> _output/logs/chat.log 2>&1 &
mage check
mage stop
- Successfully start open-im-server.
- Compile chat
mage
. - Start chat
mage start
.
🔗 Please refer to "How to set up LiveKit server".
❤️ Contributions to this project are welcome! Please see CONTRIBUTING.md for details.
📜 chat is licensed under the GPL-3.0 license. See the LICENSE for the full license text.