yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #11129 from id/0622-readme-update-get-started 

docs: update Get Started section in README.md
This commit is contained in:
Zaiming (Stone) Shi 2023-06-26 13:15:43 +02:00 committed by GitHub
parent f2e3446e29 9bebdf9439
commit 1dfbb7ac80
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 23 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
.github/workflows/run_jmeter_tests.yaml vendored
View File

@ -22,7 +22,15 @@ jobs:
env:
JMETER_VERSION: 5.4.3
run: |
wget --no-verbose --no-check-certificate -O /tmp/apache-jmeter.tgz https://downloads.apache.org/jmeter/binaries/apache-jmeter-$JMETER_VERSION.tgz
# versions below 5.5 had been moved to the archive area
# latest version is 5.6, the script below should handle both scenarios
URL=https://downloads.apache.org/jmeter/binaries/apache-jmeter-$JMETER_VERSION.tgz
ARCHIVE_URL=https://archive.apache.org/dist/jmeter/binaries/apache-jmeter-$JMETER_VERSION.tgz
if wget -q --method HEAD $URL; then
wget --no-verbose --no-check-certificate -O /tmp/apache-jmeter.tgz $URL
else
wget --no-verbose --no-check-certificate -O /tmp/apache-jmeter.tgz $ARCHIVE_URL
fi
- uses: actions/upload-artifact@v3
with:
name: apache-jmeter.tgz

19
README.md
View File

@ -32,17 +32,26 @@ The simplest way to set up EMQX is to create a managed deployment with EMQX Clou
docker run -d --name emqx -p 1883:1883 -p 8083:8083 -p 8084:8084 -p 8883:8883 -p 18083:18083 emqx/emqx:latest
```
Next, please follow the [getting started guide](https://www.emqx.io/docs/en/v5.0/getting-started/getting-started.html#start-emqx) to tour the EMQX features.
Next, please follow the [Deploy with Docker](https://www.emqx.io/docs/en/v5.1/deploy/install-docker.html) guide for further instructions.
#### Run EMQX cluster on kubernetes
For details: [EMQX Operator](https://github.com/emqx/emqx-operator/blob/main/docs/en_US/getting-started/getting-started.md).
Please consult official [EMQX Operator](https://github.com/emqx/emqx-operator/blob/main/docs/en_US/getting-started/getting-started.md) documentation for details.
#### Run EMQX on macOS
EMQX is available as core [Homebrew](https://brew.sh/) package.
```
brew install emqx
emqx start
```
#### More installation options
If you prefer to install and manage EMQX yourself, you can download the latest version from [www.emqx.io/downloads](https://www.emqx.io/downloads).
For more installation options, see the [EMQX installation documentation](https://www.emqx.io/docs/en/v5.0/deploy/install.html).
For more installation options, see the [EMQX installation documentation](https://www.emqx.io/docs/en/v5.1/deploy/install.html).
## Documentation
@ -84,9 +93,9 @@ For more organised improvement proposals, you can send pull requests to [EIP](ht
## Build From Source
The `master` branch is for the latest version 5 release, checkout `main-v4.4` for version 4.4.
The `master` branch tracks the latest version 5. For version 4.4 checkout the `main-v4.4` branch.
EMQX requires OTP 24 for 4.4, 5.0 can be built with OTP 24 or 25.
EMQX 4.4 requires OTP 24. EMQX 5.0 and 5.1 can be built with OTP 24 or 25.
```bash
git clone https://github.com/emqx/emqx.git