开发者社区 开发与运维 文章 正文

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

2022-11-15 797
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
本文涉及的产品
.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
目录
相关文章
LALA
|
1月前
|
缓存 应用服务中间件 网络安全
Nginx中配置HTTP2协议的方法
Nginx中配置HTTP2协议的方法
LALA
79 7
快乐就是哈哈哈
|
2月前
|
应用服务中间件 BI nginx
Nginx的location配置详解
【10月更文挑战第16天】Nginx的location配置详解
快乐就是哈哈哈
119 4
邹荣乐
|
2月前
|
缓存 负载均衡 安全
Nginx常用基本配置总结：从入门到实战的全方位指南
Nginx常用基本配置总结：从入门到实战的全方位指南
邹荣乐
328 0
zzy的aly
|
2月前
|
应用服务中间件 Linux nginx
Jetson 环境安装(四):jetson nano配置ffmpeg和nginx(亲测)之编译错误汇总
这篇文章是关于在Jetson Nano上配置FFmpeg和Nginx时遇到的编译错误及其解决方案的汇总。
zzy的aly
105 4
虹猫持币
|
5天前
|
存储 应用服务中间件 nginx
nginx反向代理bucket目录配置
该配置实现通过Nginx代理访问阿里云OSS存储桶中的图片资源。当用户访问代理域名下的图片URL（如 `http://代理域名/123.png`）时，Nginx会将请求转发到指定的OSS存储桶地址，并重写路径为 `/prod/files/2024/12/12/123.png`。
虹猫持币
33 5
我是快乐的嘟嘟
|
29天前
|
缓存 负载均衡 算法
如何配置Nginx反向代理以实现负载均衡？
如何配置Nginx反向代理以实现负载均衡？
我是快乐的嘟嘟
107 28
mikechen的互联网架构
|
1月前
|
存储 负载均衡 中间件
Nginx反向代理配置详解，图文全面总结，建议收藏
Nginx 是大型架构必备中间件，也是大厂喜欢考察的内容，必知必会。本篇全面详解 Nginx 反向代理及配置，建议收藏。
mikechen的互联网架构
373 3
Nginx反向代理配置详解，图文全面总结，建议收藏
Echo_Wish
|
20天前
|
负载均衡 前端开发 应用服务中间件
负载均衡指南：Nginx与HAProxy的配置与优化
负载均衡指南：Nginx与HAProxy的配置与优化
Echo_Wish
39 3
技能实验室
|
1月前
|
应用服务中间件 API nginx
nginx配置反向代理404问题
【10月更文挑战第18天】本文介绍了使用Nginx进行反向代理的配置方法，解决了404错误、跨域问题和302重定向问题。关键配置包括代理路径、请求头设置、跨域头添加以及端口转发设置。通过调整`proxy_set_header`和添加必要的HTTP头，实现了稳定的服务代理和跨域访问。
技能实验室
253 1
nginx配置反向代理404问题
dufadayang
|
29天前
|
负载均衡 监控 应用服务中间件
配置Nginx反向代理时如何指定后端服务器的权重？
配置Nginx反向代理时如何指定后端服务器的权重？
dufadayang
49 4

热门文章

最新文章

  • 1
    Nginx报错403 forbidden几个解决方法
  • 2
    如何优雅打印nginx header和body
  • 3
    nginx hello world模块编译运行的问题
  • 4
    Nginx防盗链、Nginx访问控制、Nginx解析php相关配置、Nginx代理
  • 5
    Nginx的Upload上传模块
  • 6
    Nginx动静分离经典案例配置
  • 7
    nginx反向代理与微信测试全攻略
  • 8
    debian下LAMP+nginx代理+awstats+cacti+nagios(四)
  • 9
    NGINX + TOMCAT7 + MEMCACHED 实现SESSION 共享
  • 10
    nginx之yum源
  • 1
    解码客服工单系统：选型指南让您信手拈来
    201
  • 2
    开源即时通讯IM框架 MobileIMSDK v6.5 发布
    149
  • 3
    即时通讯技术文集（第37期）：IM代码入门实践(Part1) [共16篇]
    68
  • 4
    智能客服助手自动化
    70
  • 5
    自动化客服响应与知识库查询
    86
  • 6
    稳扎稳打 部署丝滑 开源即时通讯（IM）项目OpenIM源码部署流程（linux windows mac）稳扎稳打 部署丝滑 开源即时通讯（IM）项目OpenIM源码部署流程（linux windows mac）
    438
  • 7
    数据管理DMS产品使用合集之要在DMS中实现数据库工单发布时必须经过人工审核才能进入下一步，我该怎么配置
    93
  • 8
    总结反思 持续进步-开源即时通讯（IM）项目OpenIM 新版本release-v3.7发布
    162
  • 9
    电话客服热线系统的详细搭建方案（十大关键要素）
    815
  • 10
    即时通讯技术文集（第36期）：《跟着源码学IM》系列专题 [共12篇]
    92

    • 相关课程

    更多
  • Nginx企业级Web服务实战
  • Linux Web服务器Nginx搭建与配置
  • 软件供应商发布服务实操
  • Flume基础应用实战 - 企业全场景解决方案
  • 软件供应商进阶管理实操
  • 大数据实战项目：反爬虫系统（Lua+Spark+Redis+Hadoop框架搭建）第四阶段

    • 相关电子书

    更多
  • Phoenix在客服系统的实践
  • # Apache Spark系列技术直播# 第八讲 【 微软Azure平台利用Intel Analytics Zoo构建AI客服支持实践 】
  • 客服领域的数据智能实践

    • 相关实验场景

    更多
  • MySQL数据库快速部署实践
  • 以客服场景意图分类为例写Prompt
  • 每个IT人都想学的“Web应用上云经典架构”实战
  • 使用Flink实时发现最热Github项目
  • 星轨-钉钉APP分发实训
  • RocketMQ的常规运维实践应用
    • 下一篇
    DataWorks