AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

IM开源项目OpenIM部署文档-从准备工作到nginx配置

2022-11-15 770
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
本文涉及的产品
.cn 域名，1个 12个月
简介： IM开源项目OpenIM部署文档-从准备工作到nginx配置2022-11-14 22:27·OpenIM一、准备工作运行环境linux系统即可， Ubuntu 7.5.0-3ubuntu1~18.04最优图片视频文件存储支持cos/MinIOhttps/wss协议1. 需申请域名或者子域名（web im端登录注册及im 服务端使用）建议：web.xx.xx 2. 若使用MinIO作为对象存储，建议：storage.xx.xx 3. 管理后台子域名，建议：admin.xx.xx 4. 部署nginx，并配置证书。离线推送（app被杀死或未启动时推送）国内申请

一、准备工作
运行环境

linux系统即可， Ubuntu 7.5.0-3ubuntu1~18.04最优

图片视频文件存储

支持cos/MinIO

https/wss协议

  1. 需申请域名或者子域名（web im端登录注册及im 服务端使用）建议：web.xx.xx 2. 若使用MinIO作为对象存储，建议：storage.xx.xx 3. 管理后台子域名，建议：admin.xx.xx 4. 部署nginx，并配置证书。

离线推送（app被杀死或未启动时推送）

国内申请申请厂商通道以及个推，建议提前申请；海外申请firebase；

苹果开发者账号

如需打包、上架，请自行申请账号

手机验证码服务

请自行申请阿里云，建议提前申请

消息加密存储

需购买消息加密插件

组织架构

需购买组织架构模块

机器资源

如果用户量小于10万，可用单机部署，8C 16G 5Mb 1T普通磁盘即可

logo

1024 x 1024png

软著

如需上架国内市场，提前准备软著

管理后台

需购买

二、docker-compose一键部署
先准备
go/git/docker/docker-compose，具体参考：https://doc.rentsoft.cn/#/component/docker

单机环境下的组件部署，可以通过docker-compose一键部署，先选择某个大磁盘目录，然后依次输入如下命令：

git clone https://github.com/OpenIMSDK/Open-IM-Server.git --recursive;
进入项目后

1.修改.env

USER=root #不用修改
PASSWORD=openIM123 #建议修改复杂密码 不能包括 @#之类特殊符号 且至少要8位
ENDPOINT=http://127.0.0.1:10005 #使用minio发图片视频文件需要填写 外网ip:port或者用域名
DATA_DIR=./ #指定大磁盘目录
2.初始化部署

chmod +x install_im_server.sh
./install_im_server.sh
具体组件包括：

ETCD 2. MySQL 3. MongoDB 4. Redis 5. Kafka 6. Minio（注：如果使用三方云服务器存储媒体文件可不搭建）
3.修改配置

如果已经执行过install_im_server.sh，则config/usualConfig.yaml根据.env的配置已经修改完成了，且组件也安装完毕，则根据需求修改如下字段

tokenpolicy:
accessSecret: "open_im_server" #token生成相关 建议修改
accessExpire: 90 #token过期时间（天） 默认即可

messageverify:
friendVerify: false #发送消息是否验证好友关系 false表示不验证好友关系

push:
getui:

pushUrl: "https://restapi.getui.com/v2/$appId"
masterSecret: ""  #需添加
appKey: ""  #需添加
enable: false  #true启动个推推送

可能存在的问题：如果非首次安装，可能env密码不能生效，如果数据不重要，先docker-compose down ; rm components -rf再执行以上步骤，需要注意的是app需要重新安装。

4.重启

docker-compose down; docker-compose up -d;
三、开源版Open-IM-Server 源码编译
安装Go环境。确保Go版本至少为1.15。
下载源码到服务器
git clone https://github.com/OpenIMSDK/Open-IM-Server.git --recursive
cd cmd/Open-IM-SDK-Core
设置脚本权限
cd ../../script/
chmod +x *.sh
编译源码
./batch_build_all_service.sh
出现all services build success表示编译成功

四、Open-IM-Server修改配置&启动服务
修改配置
如果组件未自行安装，则先执行（二）的1-3步骤、如果要修改ip port等非常用信息，需要在config.yaml中修改。

启动服务
cd script
./start_all.sh
检查服务
./check_all.sh
启动服务
./start_all.sh
检查服务

出现all services launch success表示服务启动成功

./check_all.sh
（二）和（四）操作完成后，实际上完成了混合部署模式，即docker部署组件，IM源码部署。

五、nginx配置参考
用业务申请的
web.xx.xx/storage.xx.xx/admin.xx.xx分别替换open-im-ng-example.conf中web.rentsoft.cn /storage.rentsoft.cn/admin.rentsoft.cn三个域名及对应的证书

upstream im_msg_gateway{

        server 127.0.0.1:10001;        #IM消息服务器地址 根据部署情况可指定多台
        }

upstream im_api{

        server 127.0.0.1:10002;        #IM群组用户api服务器地址 根据部署情况可指定多台
        }

upstream im_jssdk_gateway{

        server 127.0.0.1:10003;        #IM jssdk服务器地址 根据部署情况可指定多台
        }

upstream im_demo{

        server 127.0.0.1:10004;        #IM demo登录注册服务器地址 根据部署情况可指定多台
        }

upstream storage {

        server 127.0.0.1:10005;                #MinIO服务器地址 暂时支持1台
        }

upstream im_admin{

        server 127.0.0.1:10006;        #IM admin服务器地址 根据部署情况可指定多台
        }

upstream im_grafana{

        server 127.0.0.1:10007;        #IM 统计服务器地址 docker-compose启动所在机器
        }

upstream im_chat{

        server 127.0.0.1:10008;        #IM 商业版登录注册服务器地址 根据部署情况可指定多台
        }

upstream im_complete_admin{

        server 127.0.0.1:10009;         #IM 商业版admin地址 根据部署情况可指定多台
        }

upstream im_organization{

        server 127.0.0.1:10010;        #IM 商业版组织架构服务器地址 根据部署情况可指定多台
        }

upstream im_open_rtc{

        server 127.0.0.1:7880;        #rtc 音视频通话 服务器地址 根据部署情况可指定多台
        }

server {

    listen 443;
    server_name web.rentsoft.cn;   #1 web im 端 域名

    ssl on;
    ssl_certificate /etc/nginx/conf.d/ssl/web.rentsoft.cn.crt; #2 证书
    ssl_certificate_key /etc/nginx/conf.d/ssl/web.rentsoft.cn.key; #3 证书
    ssl_session_timeout 5m;
    gzip on;
    gzip_min_length 1k;
    gzip_buffers 4 16k;
    gzip_comp_level 2;
    gzip_types text/plain application/javascript application/x-javascript text/css application/xml text/javascript application/x-httpd-php image/jpeg image/gif image/png application/wasm;
    gzip_vary off;
    gzip_disable "MSIE [1-6]\.";
    error_page 405 =200 $uri;

default_type application/wasm;
    location /{ #web demo
            proxy_set_header Host $host;
            proxy_set_header X-Real-Ip $remote_addr;
            proxy_set_header X-Forwarded-For $remote_addr;
            proxy_set_header X-NginX-Proxy true;
            root /data1/online/Pc-Web-Demo/build/; # web im静态资源存放路径
            index index.html;
            try_files $uri $uri/ /index.html;
    }
    location /msg_gateway { #10001 ws
            proxy_http_version 1.1;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection "Upgrade";
            proxy_set_header X-real-ip $remote_addr;
            proxy_set_header X-Forwarded-For $remote_addr;
            proxy_pass http://im_msg_gateway/;
    }
    location ^~/api/ { #10002 api
            proxy_http_version 1.1;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection "Upgrade";
            proxy_set_header X-real-ip $remote_addr;
            proxy_set_header X-Forwarded-For $remote_addr;
            proxy_pass http://im_api/;
           }
    location /jssdk_gateway { #10003 jssdk
            proxy_http_version 1.1;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection "Upgrade";
            proxy_set_header X-real-ip $remote_addr;
            proxy_set_header X-Forwarded-For $remote_addr;
            proxy_pass http://im_jssdk_gateway/;
           }
    location ^~/demo/ { # 10004 demo
            proxy_http_version 1.1;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection "Upgrade";
            proxy_set_header X-real-ip $remote_addr;
            proxy_set_header X-Forwarded-For $remote_addr;
            proxy_pass http://im_demo/;
           }
    location ^~/admin/ { #10006 admin
            proxy_http_version 1.1;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection "Upgrade";
            proxy_set_header X-real-ip $remote_addr;
            proxy_set_header X-Forwarded-For $remote_addr;
            proxy_pass http://im_admin/;
           }
    location ^~/grafana/ { #10007  prometheus
            proxy_http_version 1.1;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection "Upgrade";
            proxy_set_header X-real-ip $remote_addr;
            proxy_set_header X-Forwarded-For $remote_addr;
            proxy_pass http://im_grafana/;
           }
    location ^~/chat/ { #10008 chat login
            proxy_http_version 1.1;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection "Upgrade";
            proxy_set_header X-real-ip $remote_addr;
            proxy_set_header X-Forwarded-For $remote_addr;
            proxy_pass http://im_chat/;
           }
    location ^~/complete_admin/ { #10009  admin
            proxy_http_version 1.1;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection "Upgrade";
            proxy_set_header X-real-ip $remote_addr;
            proxy_set_header X-Forwarded-For $remote_addr;
            proxy_pass http://im_complete_admin/;
           }
    location ^~/organization/ { #10010 organization
            proxy_http_version 1.1;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection "Upgrade";
            proxy_set_header X-real-ip $remote_addr;
            proxy_set_header X-Forwarded-For $remote_addr;
            proxy_pass http://im_organization/;
           }
    location ^~/open_rtc/ {  #7880 rtc
            proxy_http_version 1.1;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection "Upgrade";
            proxy_set_header X-real-ip $remote_addr;
            proxy_set_header X-Forwarded-For $remote_addr;
            proxy_pass http://im_open_rtc/;
          }

}

server {

    listen 80;
    server_name web.rentsoft.cn ; #1 web im 端 域名
    rewrite ^(.*)$ https://${server_name}$1 permanent;

}

server {

    ssl_session_timeout 5m;
listen 443;
    server_name storage.rentsoft.cn; #1 MinIO存储域名
    ssl on;
    ssl_certificate /etc/nginx/conf.d/ssl/storage.rentsoft.cn.crt; #证书
    ssl_certificate_key /etc/nginx/conf.d/ssl/storage.rentsoft.cn.key;    #证书
    gzip on;
    gzip_min_length 1k;
    gzip_buffers 4 16k;
    gzip_comp_level 2;
    gzip_types text/plain application/javascript application/x-javascript text/css application/xml text/javascript application/x-httpd-php image/jpeg image/gif image/png;
    gzip_vary off;
    gzip_disable "MSIE [1-6]\.";
location / {
        proxy_pass http://storage;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header Host $http_host;
        proxy_http_version 1.1;
        client_max_body_size 8000M;
}

}

server {

    listen 443;
    server_name admin.rentsoft.cn; #后台管理域名
    ssl on;
    ssl_certificate /etc/nginx/conf.d/ssl/admin.rentsoft.cn.crt; # 证书
    ssl_certificate_key /etc/nginx/conf.d/ssl/admin.rentsoft.cn.key; #证书
    ssl_session_timeout 5m;
    gzip on;
    gzip_min_length 1k;
    gzip_buffers 4 16k;
    gzip_comp_level 2;
    gzip_types text/plain application/javascript application/x-javascript text/css application/xml text/javascript application/x-httpd-php image/jpeg image/gif image/png;
    gzip_vary off;
    gzip_disable "MSIE [1-6]\.";
    location / {
            proxy_set_header Host $host;
            proxy_set_header X-Real-Ip $remote_addr;
            proxy_set_header X-Forwarded-For $remote_addr;
            proxy_set_header X-NginX-Proxy true;
            root /data1/online/Open-IM-Admin/dist/; #管理后台web静态资源存放路径
            index index.html;
            try_files $uri $uri/ /index.html;
    }

}

server {

    listen 80;
    server_name admin.rentsoft.cn; #管理后台 域名
    rewrite ^(.*)$ https://${server_name}$1 permanent;

}

六、端口开放及访问路由
IM
如果按照（七）做了nginx配置，仅开放443和80端口即可。

IM端口

说明

访问说明

对应关系

TCP:10001

IM ws消息

在域名和路由之间增加msg_gateway

wss://test.xx.xx/msg_gateway->ws://ip:10001

TCP:10002

IM api

在域名和路由之间增加api

https://test.xx.xx/api->http://ip:10002

TCP:10003

ws端口 jssdk的专用

在域名和路由之间增加jssdk_gateway

wss://test.xx.xx/jssdk_gateway->ws://ip:10003

TCP:10004

demo注册登录

在域名和路由之间增加demo

https://test.xx.xx/demo->http://ip:10004

TCP:10005

minio存储时

TCP:10006

IM 后台管理

在域名和路由之间增加admin

https://test.xx.xx/admin->http://ip:10006

TCP:10007

数据统计

TCP:10008

商业版业务

在域名和路由之间增加chat

https://test.xx.xx/chat->http://ip:10008

TCP:10009

商业版管理后台

在域名和路由之间增加complete_admin

https://test.xx.xx/complete_admin->http://ip:10009

TCP:10010

商业版组织架构

在域名和路由之间增加organization

https://test.xx.xx/organization->http://ip:10006

音视频通话
RTC端口

说明

操作

TCP: 7881

音视频通话

直接开通端口，不走nginx反向代理

UDP: 7882

音视频通话

直接开通端口，不走nginx反向代理

关于OpenIM
OpenIM是由IM技术专家打造开源即时通讯组件，也是目前最受欢迎的开源IM项目之一，开发者通过集成OpenIM组件，并私有化部署服务端，可以将即时通讯、实时通讯能力快速集成到自身应用中，并确保业务数据的安全性和私密性。github社区活跃，star近万，排名遥遥领先，开发者万人，OpenM力争开源IM项目No1，打造开源IM第一社区。OpenIM是也是目前非常受欢迎的开源IM项目，广泛用于政企协同办公场景。

微信图片_20221115191504.jpg

github地址：
https://github.com/OpenIMSDK/Open-IM-Server

开发者中心：https://doc.rentsoft.cn/#/

平台支持：Android iOS Uniapp Flutter Electron Web reactNative等几乎所有平台

web端基于wasm的sdk即将发布

pc支持信创环境：银河麒麟 UOS等；

群组支持：十万群成员的超级大群

安卓基于自启动-保活机制，确保消息实时触达；

文章标签：
客服工作台
域名
开发工具
容器
应用服务中间件
Windows
数据安全/隐私保护
网络协议
Docker
nginx
git
开发者
关键词：
开源Nginx配置
Nginx配置
开源Nginx
部署Nginx
Nginx部署
OpenIM
目录
相关文章
游客62mqllx53nctc
|
14天前
|
应用服务中间件 BI nginx
Nginx的location配置详解
【10月更文挑战第16天】Nginx的location配置详解
游客62mqllx53nctc
70 4
技能实验室
|
7天前
|
应用服务中间件 API nginx
nginx配置反向代理404问题
【10月更文挑战第18天】本文介绍了使用Nginx进行反向代理的配置方法，解决了404错误、跨域问题和302重定向问题。关键配置包括代理路径、请求头设置、跨域头添加以及端口转发设置。通过调整`proxy_set_header`和添加必要的HTTP头，实现了稳定的服务代理和跨域访问。
技能实验室
45 1
nginx配置反向代理404问题
一名技术开发者
|
1天前
|
应用服务中间件 网络安全 PHP
八个免费开源 Nginx 管理系统，轻松管理 Nginx 站点配置
Nginx 是一个高效的 HTTP 服务器和反向代理，擅长处理静态资源、负载均衡和网关代理等任务。其配置主要通过 `nginx.conf` 文件完成，但复杂设置可能导致错误。本文介绍了几个开源的 Nginx 可视化配置系统，如 Nginx UI、VeryNginx、OpenPanel、Ajenti、Schenkd nginx-ui、EasyEngine、CapRover 和 NGINX Agent，帮助简化和安全地管理 Nginx 实例。
一名技术开发者
13 2
mao29955
|
11天前
|
缓存 负载均衡 应用服务中间件
Nginx配置
【10月更文挑战第22天】在实际配置 Nginx 时，需要根据具体的需求和环境进行调整和优化。同时，还需要注意配置文件的语法正确性和安全性。
mao29955
30 7
jsjsjjs
|
14天前
|
移动开发 网络协议 小程序
基于开源IM即时通讯框架MobileIMSDK：RainbowChat-iOS端v9.1版已发布
RainbowChat是一套基于开源IM聊天框架 MobileIMSDK 的产品级移动端IM系统。RainbowChat源于真实运营的产品，解决了大量的屏幕适配、细节优化、机器兼容问题
jsjsjjs
46 5
游客yruxkrkc2uipi
|
20天前
|
前端开发 JavaScript 应用服务中间件
终极 Nginx 配置指南
本文介绍了Nginx的基本配置及其优化方法。首先，通过删除注释简化了Nginx的默认配置文件，使其更易于理解。接着，文章将Nginx配置文件分为全局块、events块和http块三部分进行详细解释。此外，还提供了如何快速上线网站、解决前端history模式404问题、配置反向代理、开启gzip压缩、设置维护页面、在同一IP上部署多个网站以及实现动静分离的具体配置示例。最后，附上了Nginx的基础命令，包括安装、启动、重启和关闭等操作。
游客yruxkrkc2uipi
63 3
邹荣乐
|
21天前
|
缓存 负载均衡 安全
Nginx常用基本配置总结：从入门到实战的全方位指南
Nginx常用基本配置总结：从入门到实战的全方位指南
邹荣乐
201 0
zzy的aly
|
26天前
|
应用服务中间件 Linux nginx
Jetson 环境安装(四):jetson nano配置ffmpeg和nginx(亲测)之编译错误汇总
这篇文章是关于在Jetson Nano上配置FFmpeg和Nginx时遇到的编译错误及其解决方案的汇总。
zzy的aly
70 4
zzy的aly
|
26天前
|
编解码 Ubuntu 应用服务中间件
Jetson 环境安装(三):jetson nano配置ffmpeg和nginx(亲测)
本文介绍了在NVIDIA Jetson Nano上配置FFmpeg和Nginx的步骤，包括安装、配置和自启动设置。
zzy的aly
113 1
Jetson 环境安装(三):jetson nano配置ffmpeg和nginx(亲测)
最好zzz
|
24天前
|
负载均衡 应用服务中间件 nginx
Nginx的6大负载均衡策略及权重轮询手写配置
【10月更文挑战第9天】 Nginx是一款高性能的HTTP服务器和反向代理服务器，它在处理大量并发请求时表现出色。Nginx的负载均衡功能可以将请求分发到多个服务器，提高网站的吞吐量和可靠性。以下是Nginx支持的6大负载均衡策略：
最好zzz
108 7

热门文章

最新文章

  • 1
    阿里巴巴阿外：客服全链路智能解决方案
  • 2
    IM开发干货分享：浅谈IM系统中离线消息、历史消息的最佳实践
  • 3
    使用docker快速部署ferry开源工单系统
  • 4
    企业如何用InfBox架设自己的内部即时信息IM服务器
  • 5
    配置Lync IM/Presence 与 Exchange2010 SP1 OWA 集成
  • 6
    flash 显示 qq客服状态
  • 7
    LLM系列 | 15: 如何链接多个Prompt处理复杂任务？以智能客服为例
  • 8
    PHP+Swoole实现微信小程序客服即时通信聊天功能
  • 9
    Python3+Flask结合Socket.io配合前端Vue实现简单全双工在线客服系统
  • 10
    阿里IM技术分享(十)：深度揭密钉钉后端架构的单元化演进之路
  • 1
    一文读懂HTTPS⭐揭秘加密传输背后的原理与Nginx配置攻略
    332
  • 2
    docker安装nginx
    76
  • 3
    Docker中报错 Error response from daemon: Conflict. The container name “/nginx01“ is already in use
    292
  • 4
    nginx 302 301 设置 url 转跳 nginx 资源重定向 nginx tcp 和 http 转发
    200
  • 5
    Nginx的referer参数的用法和原理
    782
  • 6
    nginx(1.13.7)首次安装出现：【make： *** 没有规则可以创建“default”需要的目标“build” 问题】解决措施
    508
  • 7
    基于nginx反向代理实现OSS固定域名IP访问
    1612
  • 8
    解密Nginx的高性能魔法：事件驱动与异步非阻塞模型
    147
  • 9
    如何在树莓派部署Nginx并实现无公网ip远程访问内网制作的web网站
    52
  • 10
    深入探索Nginx高性能Web服务器配置与优化
    208

    • 相关课程

    更多
  • Nginx企业级Web服务实战
  • Linux Web服务器Nginx搭建与配置
  • 大数据实战项目：反爬虫系统（Lua+Spark+Redis+Hadoop框架搭建）第四阶段
  • 大数据实战项目：反爬虫系统（Lua+Spark+Redis+Hadoop框架搭建）第五阶段
  • 大数据实战项目 - 反爬虫系统（Lua+Spark+Redis+Hadoop框架搭建）第六阶段
  • 大数据实战项目 - 反爬虫系统（Lua+Spark+Redis+Hadoop框架搭建）第七阶段

    • 相关电子书

    更多
  • 客服领域的数据智能实践
  • CentOS Nginx PHP JAVA 多语言镜像使用手
  • CentOS Nginx PHP JAVA多语言镜像使用手册

    • 相关实验场景

    更多
  • 在SAE控制台极速部署个人LLM效能工具
  • 1分钟SAE部署Web在线游戏
  • 以客服场景意图分类为例写Prompt
  • 每个IT人都想学的“Web应用上云经典架构”实战
  • 1分钟SAE部署PHP商城小程序
  • 使用Flink实时发现最热Github项目
    • 下一篇
    DataWorks智能数据建模全面公测开始啦！