fix(Get started): Update download and installation steps

emqx · Apr 17, 2024 · 682a076 · 682a076
1 parent 5037fe1
commit 682a076
Show file tree

Hide file tree

Showing 12 changed files with 197 additions and 89 deletions.
diff --git a/dir.yaml b/dir.yaml
@@ -15,8 +15,8 @@
 #   the path is relative inside the per-language sub-dir i.e. en_US and zh_CN
 # - A node with 'title_en' 'title_cn' and 'path'
 
-- title_en: Quick Start
-  title_cn: 快速开始
+- title_en: EMQX Enterprise Overview
+  title_cn: EMQX 企业版概览
   path: "./" # this is the index page, {en_US,zh_CN}/README.md is the content
   collapsed: true
   children:

diff --git a/en_US/deploy/install-debian.md b/en_US/deploy/install-debian.md
@@ -173,9 +173,11 @@ The section below will take Debian 11 as an example to illustrate how to downloa
 
 ## Install with deb
 
-1. Go to [EMQ Official Site](https://www.emqx.com/en/try?product=enterprise&currentVersion=@EE_VERSION@&currentOS=Debian=currentOS=Debian12&utm_source=docs.emqx.com&utm_medium=referral&utm_campaign=enterprise-docs-install-to-try-enterprise).
+1. Go to the [official site for EMQX](https://www.emqx.com/en/try?product=enterprise&currentVersion=@EE_VERSION@&currentOS=Debian=currentOS=Debian12&utm_source=docs.emqx.com&utm_medium=referral&utm_campaign=enterprise-docs-install-to-try-enterprise).
 2. Select `@EE_VERSION@` for **Version** and `Debian` for **OS**, and click the **Download** button.
-3. On the Downloads and Install page, select `deb` as the **Install Method** and select the proper **CPU Architecture** that matches your system. Download and install the package according to the instruction.
+3. On the Downloads and Install page, select `deb` as the **Install Method** and select the proper **CPU Architecture** that matches your system. Click **Download Now**.
+
+   You can also follow the command instructions on the page.
 
 ### Start EMQX
 
@@ -213,9 +215,13 @@ sudo apt remove --purge emqx
 
 ## Install with tar.gz
 
-1. Go to [EMQ Official Site](https://www.emqx.com/en/try?product=enterprise&currentVersion=@EE_VERSION@&currentOS=Debian=currentOS=Debian12&utm_source=docs.emqx.com&utm_medium=referral&utm_campaign=enterprise-docs-install-to-try-enterprise).
+1. Go to the [official site for EMQX](https://www.emqx.com/en/try?product=enterprise&currentVersion=@EE_VERSION@&currentOS=Debian=currentOS=Debian12&utm_source=docs.emqx.com&utm_medium=referral&utm_campaign=enterprise-docs-install-to-try-enterprise).
+
 2. Select `@EE_VERSION@` for **Version** and `Debian` for **OS**, and click the **Download** button.
-3. On the Downloads and Install page, select `tar.gz` as **Install Method** and select the proper **CPU Architecture** that matches your system. Download and install the package according to the instruction.
+
+3. On the Downloads and Install page, select `tar.gz` as the **Install Method** and select the proper **CPU Architecture** that matches your system. Click **Download Now**.
+
+   You can also follow the command instructions on the page.
 
 ### Start EMQX
 

diff --git a/en_US/deploy/install-macOS.md b/en_US/deploy/install-macOS.md
@@ -110,9 +110,13 @@ The instructions below will take macOS 12 as an example to illustrate how to dow
 
 ## Install EMQX
 
-1. Go to [EMQ Official Site](https://www.emqx.com/en/try?product=enterprise&currentVersion=@EE_VERSION@&currentOS=macOS=currentOS=macOS12&utm_source=docs.emqx.com&utm_medium=referral&utm_campaign=enterprise-docs-install-to-try-enterprise).
+1. Go to the [official site for EMQX](https://www.emqx.com/en/try?product=enterprise&currentVersion=@EE_VERSION@&currentOS=macOS=currentOS=macOS12&utm_source=docs.emqx.com&utm_medium=referral&utm_campaign=enterprise-docs-install-to-try-enterprise).
+
 2. Select `@EE_VERSION@` for **Version** and `macOS` for **OS**, and click the **Download** button.
-3. On the Downloads and Install page, select `zip` as the **Install Method** and select the proper **CPU Architecture** that matches your system. Download and install the package according to the instruction.
+
+3. On the Downloads and Install page, select `zip` as the **Install Method** and select the proper **CPU Architecture** that matches your system. Click **Download Now**.
+
+   You can also follow the command instructions on the page.
 
 ## Start and Stop EMQX
 

diff --git a/en_US/deploy/install-rhel.md b/en_US/deploy/install-rhel.md
@@ -180,9 +180,13 @@ After the installation, run the command below to start EMQX.
 
 ## Install with rpm
 
-1. Go to [EMQ Official Site](https://www.emqx.com/en/try?product=enterprise&currentVersion=@EE_VERSION@&currentOS=CentOS=currentOS=Centos8&utm_source=docs.emqx.com&utm_medium=referral&utm_campaign=enterprise-docs-install-to-try-enterprise).
+1. Go to the [official site for EMQX](https://www.emqx.com/en/try?product=enterprise&currentVersion=@EE_VERSION@&currentOS=CentOS=currentOS=Centos8&utm_source=docs.emqx.com&utm_medium=referral&utm_campaign=enterprise-docs-install-to-try-enterprise).
+
 2. Select `@EE_VERSION@` for **Version** and `CentOS` for **OS**, and click the **Download** button.
-3. On the Downloads and Install page, select `rpm` as the **Install Method** and select the proper **CPU Architecture** that matches your system. Download and install the package according to the instructions.
+
+3. On the Downloads and Install page, select `rpm` as the **Install Method** and select the proper **CPU Architecture** that matches your system. Click **Download Now**.
+
+   You can also follow the command instructions on the page.
 
 ### Start EMQX
 
@@ -220,9 +224,11 @@ sudo yum remove emqx
 
 ## Install with tar.gz
 
-1. Go to [EMQ Official Site](https://www.emqx.com/en/try?product=enterprise&currentVersion=@EE_VERSION@&currentOS=CentOS=currentOS=Centos8&utm_source=docs.emqx.com&utm_medium=referral&utm_campaign=enterprise-docs-install-to-try-enterprise).
+1. Go to the [official site for EMQX](https://www.emqx.com/en/try?product=enterprise&currentVersion=@EE_VERSION@&currentOS=CentOS=currentOS=Centos8&utm_source=docs.emqx.com&utm_medium=referral&utm_campaign=enterprise-docs-install-to-try-enterprise).
 2. Select `@EE_VERSION@` for **Version** and `CentOS` for **OS**, and click the **Download** button.
-3. On the Downloads and Install page, select `tar.gz` as the **Install Method** and select the proper **CPU Architecture** that matches your system. Download and install the package according to the instruction.
+3. On the Downloads and Install page, select `tar.gz` as the **Install Method** and select the proper **CPU Architecture** that matches your system. Click **Download Now**.
+
+   You can also follow the command instructions on the page.
 
 ### Start EMQX
 

diff --git a/en_US/deploy/install-ubuntu.md b/en_US/deploy/install-ubuntu.md
@@ -173,9 +173,13 @@ The section below will take Ubuntu 22.04 as an example to illustrate how to down
 
 ## Install with deb
 
-1. Go to [EMQ Official Site](https://www.emqx.com/en/try?product=enterprise&currentVersion=@EE_VERSION@&currentOS=Ubuntu=currentOS=Ubuntu22&utm_source=docs.emqx.com&utm_medium=referral&utm_campaign=enterprise-docs-install-to-try-enterprise).
+1. Go to the [official site for EMQX](https://www.emqx.com/en/try?product=enterprise&currentVersion=@EE_VERSION@&currentOS=Ubuntu=currentOS=Ubuntu22&utm_source=docs.emqx.com&utm_medium=referral&utm_campaign=enterprise-docs-install-to-try-enterprise).
+
 2. Select `@EE_VERSION@` for **Version** and `Ubuntu` for **OS**, and click the **Download** button.
-3. On the Downloads and Install page, select `deb` as the **Install Method** and select the proper **CPU Architecture** that matches your system. Download and install the package according to the instruction.
+
+3. On the Downloads and Install page, select `deb` as the **Install Method** and select the proper **CPU Architecture** that matches your system. Click **Download Now**.
+
+   You can also follow the command instructions on the page.
 
 ### Start EMQX
 
@@ -213,9 +217,11 @@ sudo apt remove --purge emqx
 
 ## Install with tar.gz 
 
-1. Go to [EMQ Official Site](https://www.emqx.com/en/try?product=enterprise&currentVersion=@EE_VERSION@&currentOS=Ubuntu=currentOS=Ubuntu22&utm_source=docs.emqx.com&utm_medium=referral&utm_campaign=enterprise-docs-install-to-try-enterprise).
+1. Go to the [official site for EMQX](https://www.emqx.com/en/try?product=enterprise&currentVersion=@EE_VERSION@&currentOS=Ubuntu=currentOS=Ubuntu22&utm_source=docs.emqx.com&utm_medium=referral&utm_campaign=enterprise-docs-install-to-try-enterprise).
 2. Select `@EE_VERSION@` for **Version** and `Ubuntu` for **OS**, and click the **Download** button.
-3. On the Downloads and Install page, select `tar.gz` as the **Install Method** and select the proper **CPU Architecture** that matches your system. Download and install the package according to the instruction.
+3. On the Downloads and Install page, select `tar.gz` as the **Install Method** and select the proper **CPU Architecture** that matches your system. Click **Download Now**.
+
+   You can also follow the command instructions on the page.
 
 ### Start EMQX
 

diff --git a/en_US/getting-started/getting-started.md b/en_US/getting-started/getting-started.md
@@ -75,7 +75,7 @@ EMQX can be run with [Docker](../deploy/install-docker.md), installed with [EMQX
 - Linux
 
 {% emqxce %}
-For other platforms not listed above, you can try to [build and install with  source code](../deploy/install-source.md) or simply [contact EMQ](https://www.emqx.com/en/contact) for support.
+For other platforms not listed above, you can try to [build and install with source code](../deploy/install-source.md) or simply [contact EMQ](https://www.emqx.com/en/contact) for support.
 {% endemqxce %}
 
 {% emqxee %}
@@ -85,7 +85,7 @@ For other platforms not listed above, you can try to simply [contact EMQ](https:
 
 <!-- TODO @wivwiv Update K8s link when EMQX Terraform 5.0 document ready -->
 
-In addition, you can also deploy EMQX with one-click through [EMQX Terraform](https://www.emqx.com/en/emqx-terraform) on the cloud, for example, [Alibaba Cloud](https://github.com/emqx/tf-alicloud) and [AWS](https://github.com/emqx/tf-aws).
+In addition, you can also deploy EMQX with one click through [EMQX Terraform](https://www.emqx.com/en/emqx-terraform) on the cloud, for example, [Alibaba Cloud](https://github.com/emqx/tf-alicloud) and [AWS](https://github.com/emqx/tf-aws).
 
 <!-- TODO @wivwiv Update Terraform link when EMQX Terraform 5.0 document ready -->
 
@@ -97,7 +97,7 @@ This quick start guide shows you the easiest ways to install and run EMQX, eithe
 
 ::: tab Run EMQX with Docker
 
-Container deployment is the quickest way to start exploring EMQX. In this section, we will show you how to run EMQX with Docker. 
+Container deployment is the quickest way to start exploring EMQX. The instructions below show how to run EMQX with Docker. 
 
 1. To download and start the latest version of EMQX, enter the command below.
 
@@ -137,7 +137,7 @@ Container deployment is the quickest way to start exploring EMQX. In this sectio
 
 {% emqxce %}
 
-You can also install EMQX with zip/tar.gz files on a computer or VM, so you can easily adjust the configurations or run performance tuning. In this section, we will use [macOS](https://www.emqx.io/downloads?os=macOS) (macOS12 amd64) as an example to illustrate the operating steps.
+You can also install EMQX with zip/tar.gz files on a computer or VM, so you can easily adjust the configurations or run performance tuning. The instructions below use [macOS](https://www.emqx.io/downloads?os=macOS) (macOS12 amd64) as an example to illustrate the installation steps.
 
 Note: Considering all the runtime dependencies, it is recommended to use zip/tar.gz files for testing and hot upgrades, and **NOT** recommended in a production environment. 
 
@@ -153,46 +153,60 @@ Note: Considering all the runtime dependencies, it is recommended to use zip/tar
    mkdir -p emqx && unzip emqx-@[email protected] -d emqx
    ```
 
-{% endemqxce %}
+3. To run EMQX, enter:
 
-{% emqxee %}
+   ```bash
+   ./emqx/bin/emqx start
+   ```
 
-You can also install EMQX with zip/tar.gz files on a computer or VM, so you can easily adjust the configurations or run performance tuning. In this section, we will use [macOS](https://www.emqx.com/en/try?product=enterprise) (macOS12 amd64) as an example to illustrate the operating steps.
+4. Start your web browser and enter `http://localhost:18083/` ( `localhost` can be substituted with your IP address) in the address bar to access the [EMQX Dashboard](../dashboard/introduction.md), from where you can connect to your clients or check the running status.
 
-Note: Considering all the runtime dependencies, it is recommended to use zip/tar.gz files for testing and hot upgrades, and **NOT** recommended in a production environment.
+   The default user name and password are `admin` & `public`. You will be prompted to change the default password once logged in. 
 
-1. To download the zip file, enter:
+5. To stop EMQX, enter:
 
    ```bash
-   wget https://www.emqx.com/en/downloads/enterprise/@EE_VERSION@/emqx-enterprise-@[email protected]
+   ./emqx/bin/emqx stop
    ```
 
-2. To install EMQX, enter:
+To uninstall EMQX after your testing, simply delete the EMQX folder.
 
-   ```bash
-   mkdir -p emqx && unzip emqx-enterprise-@[email protected] -d emqx
-   ```
+{% endemqxce %}
 
-{% endemqxee %}
+{% emqxee %}
 
-3. To run EMQX, enter:
+You can also install EMQX with zip/tar.gz files on a computer or VM, so you can easily adjust the configurations or run performance tuning. The instructions below use [macOS](https://www.emqx.io/downloads?os=macOS) (macOS12 amd64) as an example to illustrate the installation steps.
+
+Note: Considering all the runtime dependencies, it is recommended to use zip/tar.gz files for testing and hot upgrades, and **NOT** recommended in a production environment.
+
+1. Go to the [official site for EMQX](https://www.emqx.com/en/try?product=enterprise).
+
+2. Select `@EE_VERSION@` for **Version** and `macOS 12` for **OS**, and click the **Download** button.
+
+3. On the Downloads and Install page, select `zip` as the **Install Method** and select the proper **CPU Architecture** that matches your system. 
+
+4. Download and install the package. You can also refer to the command instructions on the page.
+
+5. To run EMQX, enter:
 
    ```bash
    ./emqx/bin/emqx start
    ```
 
-4. Start your web browser and enter `http://localhost:18083/` ( `localhost` can be substituted with your IP address) in the address bar to access the [EMQX Dashboard](../dashboard/introduction.md), from where you can connect to your clients or check the running status.
+6. Start your web browser and enter `http://localhost:18083/` ( `localhost` can be substituted with your IP address) in the address bar to access the [EMQX Dashboard](../dashboard/introduction.md), from where you can connect to your clients or check the running status.
 
    The default user name and password are `admin` & `public`. You will be prompted to change the default password once logged in. 
 
-5. To stop EMQX, enter:
+7. To stop EMQX, enter:
 
    ```bash
    ./emqx/bin/emqx stop
    ```
 
 To uninstall EMQX after your testing, simply delete the EMQX folder.
 
+{% endemqxee %}
+
 :::
 
 ::::
@@ -202,43 +216,52 @@ To uninstall EMQX after your testing, simply delete the EMQX folder.
 
 Now that you have successfully started EMQX, you can continue to test the connection and message services with MQTTX.
 
-[MQTTX](https://mqttx.app) is an elegant cross-platform MQTT 5.0 desktop client, running on macOS, Linux, and Windows. By utilizing a chat style of user interface, MQTT X allows users to quickly create connections and save multiple clients, which facilitates users to quickly test the MQTT/MQTTS connection, as well as the subscription and publication of MQTT messages.
+[MQTTX](https://mqttx.app) is an elegant cross-platform MQTT 5.0 desktop client, running on macOS, Linux, and Windows. By utilizing a chat style of user interface, MQTTX allows users to quickly create connections and save multiple clients, which facilitates users to quickly test the MQTT/MQTTS connection, as well as the subscription and publication of MQTT messages.
 
 This section introduces how to verify the connection with [MQTTX Web](https://mqttx.app/web), the browser-based MQTT 5.0 WebSocket client tool, with zero need to download or install any application. 
 
 ::: tip Prerequisites
 The broker address and the port information should be prepared before testing the connection:
 
-- Broker address: The IP address of your server, in general.
-- Port: Click **Management** -> **Listeners** on the left navigation menu to get the port number.
+- **EMQX address**: The IP address of your server, in general.
+- **Port**: Click **Management** -> **Listeners** from the left navigation menu in the Dashboard to get the port number.
 :::
 
+### Create a Connection
+
 1. Click [MQTTX Web](http://www.emqx.io/online-mqtt-client#/recent_connections) to visit the browser-based MQTTX.
 
 2. Configure and establish the MQTT connection. Click the **+ New Connection** button to enter the configure page: 
 
-   - **Name**: Input a connection name, for example, **MQTTX_Test**;
+   - **Name**: Input a connection name, for example, `MQTTX_Test`.
 
    - **Host**
 
-     - Select the protocol type via the drop-down list, for example, select `ws://` if the WebSockets protocol is adopted; MQTTX Web only supports Websockets protocol, to test the SSL/TLS connection, download [MQTTX desktop client](https://mqttx.app/);
-     - Fill in the EMQX address, for example, **[email protected]**; 
+     - Select the protocol type via the drop-down list, for example, select `ws://` if the WebSockets protocol is adopted. MQTTX Web only supports WebSockets protocol. To test the SSL/TLS connection, download [MQTTX Desktop](https://mqttx.app/downloads).
+     - Enter the EMQX address, for example, `[email protected]`.
 
-   - **Port**: for example, `8083` is for the WebSockets protocol; 
+   - **Port**: for example, `8083` is for the WebSockets protocol.
 
      Keep the default setting for the other fields or set it as your business needs. For a detailed explanation of different fields, see [MQTT User Manual - Connect](https://mqttx.app/docs/get-started).
 
-   Then click the **Connect** button at the top right corner of the page.
 
-3. Subscribe to topics. After the connection is successfully established, you can continue to subscribe to different topics. Click **+ New Subscription**. MQTTX Web has already filled in some fields, according to the setting, you will subscribe to topic `testtopic/#`  with QoS level of 0. You can repeat this step to subscribe to different topics, and MQTTX Web will differentiate topics with colors.
+3. Click the **Connect** button at the top right corner of the page.
 
-4. Test the publish/receive of messages: Click the send icon in the bottom right corner of the chat area, then the messages successfully sent will appear in the chat window above. 
+### Publish and Subscribe to Topics
+
+After the connection is successfully established, you can continue to subscribe to different topics and publish messages.
+
+1. Click **+ New Subscription**. MQTTX Web has already filled in some fields, according to the setting, you will subscribe to topic `testtopic/#`  with QoS level of 0. You can repeat this step to subscribe to different topics, and MQTTX Web will differentiate topics with colors.
+
+2. In the right corner of the chat area at the bottom, click the send icon to test the message publishing/receiving. The messages successfully sent will appear in the chat window. 
 
 <img src="./assets/MQTTXWeb-test.png" alt="MQTT X Web test" style="zoom: 25%;" />
 
 If you want to continue the testing, such as one-way/two-way SSL authentication, and simulate test data with customized scripts, you can continue to explore with [MQTTX](https://mqttx.app). 
 
-Then, on the Cluster Overview page in EMQX Dashboard, you can check metrics such as **Connections**, **Topics**, **Subscriptions**, **Incoming Messages**, **Outgoing messages**, and **Dropped Messages**.
+### View Metrics on Dashboard
+
+On the Cluster Overview page in the EMQX Dashboard, you can check metrics such as **Connections**, **Topics**, **Subscriptions**, **Incoming Messages**, **Outgoing messages**, and **Dropped Messages**.
 
 {% emqxee}
 
@@ -252,7 +275,7 @@ Then, on the Cluster Overview page in EMQX Dashboard, you can check metrics such
 
 {% endemqxce %}
 
-## Advanced Operation
+## Next Steps
 
 So far, you have completed the installation, startup, and access test of EMQX, you can continue to try out more advanced capabilities of EMQX, such as [authentication and authorization](../access-control/authn/authn.md) and integration with [Rule Engine](../data-integration/rules.md).