Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(web-readme): add docker local deployment guide #1621

Merged
merged 1 commit into from
Apr 9, 2024
Merged

docs(web-readme): add docker local deployment guide #1621

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions web/README-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ docker pull emqx/mqttx-web:latest
docker run -d --name mqttx-web -p 80:80 emqx/mqttx-web:latest
```

## 手动编译部署

如果你需要进行某些个性化设置，例如改变默认的连接路径、部署路径等，你可以编辑 .env 配置文件并手动编译来实现这些修改。如果你想知道如何编译项目和打包 docker 镜像，你可以参考我们的[开发部分](#开发)。

## 与 EMQX 更好的合作

MQTTX 为连接测试 EMQX 等 MQTT 消息服务器而生，一键式的连接方式和简洁的图形界面可以帮助您快速连接到 EMQX 或 EMQX Cloud 调试并探索其功能特性。
Expand Down Expand Up @@ -77,6 +81,15 @@ yarn run build

# 编译并启动一个本地 HTTP 服务器以进行测试
yarn run start

# 编译和压缩以构建生产版本，用于 Docker 容器化
yarn run build:docker

# 构建 Docker 镜像
docker build -t mqttx-web .

# 运行 Docker 镜像
docker run -p 80:80 mqttx-web
```

## 贡献
Expand Down
16 changes: 11 additions & 5 deletions web/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

[![GitHub Downloads](https://img.shields.io/github/downloads/emqx/MQTTX/total?label=GitHub%20Downloads)](https://mqttx.app/downloads)
[![Docker Web Pulls](https://img.shields.io/docker/pulls/emqx/mqttx-web?label=Docker%20Web%20Pulls)](https://hub.docker.com/r/emqx/mqttx-web)
[![Docker CLI Pulls](https://img.shields.io/docker/pulls/emqx/mqttx-cli?label=Docker%20CLI%20Pulls)](https://hub.docker.com/r/emqx/mqttx-cli)
[![Docker CLI Pulls](https://img.shields.io/docker/pulls/emqx/mqttx-cli?label=Docker%20CLI%20Pulls)](https://hub.docker.com/r/emqx/mqttx-cli)

[![Community](https://img.shields.io/badge/Community-MQTTX-yellow?logo=github)](https://github.com/emqx/MQTTX/discussions)
[![Slack](https://img.shields.io/badge/Slack-EMQX-39AE85?logo=slack)](https://slack-invite.emqx.io/)
Expand Down Expand Up @@ -42,6 +42,10 @@ docker pull emqx/mqttx-web:latest
docker run -d --name mqttx-web -p 80:80 emqx/mqttx-web:latest
```

## Manual compilation and deployment

If you need to make some personalized settings, such as changing the default connection path, deployment path, etc., you can achieve these modifications by editing the .env configuration file and compiling manually. For information on how to compile the project and package docker images, you can refer to the [development section](#Develop).

## Better Together with EMQX

MQTTX is designed to connect to test MQTT Brokers such as EMQX, The one-click connection and simple graphical interface make it easy to connect to EMQX or EMQX Cloud to debug and explore functional features.
Expand Down Expand Up @@ -71,10 +75,6 @@ git clone [email protected]:emqx/MQTTX.git
cd MQTTX/web
yarn install

# Set Web app's title and description (customizable as per user requirements)
echo "VUE_APP_PAGE_TITLE=Easy-to-Use Online MQTT Client | Try Now" > .env.local
echo "VUE_APP_PAGE_DESCRIPTION=Online MQTT 5.0 client on the web, using MQTT over WebSocket to connect to the MQTT Broker and test message publishing and receiving in the browser." >> .env.local

# Compiles and hot-reloads for development
yarn run serve

Expand All @@ -86,6 +86,12 @@ yarn run start

# Compiles and prepares for Docker containerization
yarn run build:docker

# Build Docker image
docker build -t mqttx-web .

# Run Docker image
docker run -p 80:80 mqttx-web
```

## Contributing
Expand Down
Loading