diff --git a/docs/cn/README.md b/docs/cn/README.md index 0183c3277d..acfbd2f69f 100644 --- a/docs/cn/README.md +++ b/docs/cn/README.md @@ -27,6 +27,7 @@ - [权限管理(Auth Management)](acl/user_guide.md):介绍如何快速部署和使用支持权限控制特性的RocketMQ集群。 - [自动主从切换快速开始](controller/quick_start.md):RocketMQ 5.0 自动主从切换快速开始。 - [自动主从切换部署升级指南](controller/deploy.md):RocketMQ 5.0 自动主从切换部署升级指南。 +- [Proxy 部署指南](proxy/deploy_guide.md):介绍如何部署Proxy (包括 `Local` 模式和 `Cluster` 模式). ### 5. 运维管理 - [集群部署(Operation)](operation.md):介绍单Master模式、多Master模式、多Master多slave模式等RocketMQ集群各种形式的部署方法以及运维工具mqadmin的使用方式。 diff --git a/docs/cn/proxy/deploy_guide.md b/docs/cn/proxy/deploy_guide.md new file mode 100644 index 0000000000..5ecc1386b6 --- /dev/null +++ b/docs/cn/proxy/deploy_guide.md @@ -0,0 +1,35 @@ +# RocketMQ Proxy部署指南 + +## 概述 + +RocketMQ Proxy 支持两种代理模式: `Local` and `Cluster`。 + +## 配置 + +该配置适用于 `Cluster` 和 `Local` 两种模式, 默认路径为 `distribution/conf/rmq-proxy.json`。 + +## `Cluster` 模式 + +* 设置 `nameSrvAddr` +* 设置 `proxyMode` 为 `cluster` (不区分大小写) + +运行以下命令: + +```shell +nohup sh mqproxy & +``` + +该命令仅会启动 `Proxy` 组件本身。它假设已经在指定的 `nameSrvAddr` 地址上运行着 `Namesrv` 节点,同时也有 broker 节点通过 `nameSrvAddr` 注册自己并运行。 + +## `Local` 模式 + +* 设置 `nameSrvAddr` +* 设置 `proxyMode` 为 `local` (不区分大小写) + +运行以下命令: + +```shell +nohup sh mqproxy & +``` + +上面的命令将启动`Proxy`,并在同一进程中运行`Broker`。它假设`Namesrv`节点正在按照`nameSrvAddr`指定的地址运行。