EMQX

https://docs.emqx.com/zh/emqx/v5.0
Admin
EMQX is a scalable, cloud-native distributed IoT MQTT message server designed for efficient,...
Tokens:221,511
Snippets:850
Trust Score:10
Update:11 months ago
Show doc for...
Tokens:
Raw
### Start EMQX after tar.gz installation

Source: https://docs.emqx.com/zh/emqx/v5.0/deploy/install-centos

This command starts the EMQX broker after it has been installed from a tar.gz archive. It navigates to the installation directory and executes the start script. This method is typically used when EMQX is installed manually without a system service.

```bash
./emqx/bin/emqx start
```

--------------------------------

### Start EMQX using service

Source: https://docs.emqx.com/zh/emqx/v5.0/deploy/install-amazon-linux

Starts the EMQX service using the 'service' command, a common init system command. This method is an alternative for starting the EMQX service.

```bash
sudo service emqx start
```

--------------------------------

### Start EMQX Service on CentOS/RHEL

Source: https://docs.emqx.com/zh/emqx/v5.0/deploy/install-centos

This snippet shows various methods to start the EMQX service after installation. It includes direct command execution, using systemctl for service management, and using the service command. Choose the method that best suits your system's configuration.

```bash
$ emqx start
EMQX 5.0.26 is started successfully!

$ emqx_ctl status
Node 'emqx@127.0.0.1' 5.0.26 is started
```

```bash
sudo systemctl start emqx
```

```bash
sudo service emqx start
```

--------------------------------

### Start EMQX Directly

Source: https://docs.emqx.com/zh/emqx/v5.0/deploy/install-amazon-linux

Starts the EMQX service directly using the 'emqx start' command and checks its status with 'emqx_ctl status'. This method is useful for immediate testing.

```bash
$ emqx start
EMQX 5.0.26 is started successfully!

$ emqx_ctl status
Node 'emqx@127.0.0.1' 5.0.26 is started
```

--------------------------------

### Install EMQX using Yum Repository on CentOS/RHEL

Source: https://docs.emqx.com/zh/emqx/v5.0/deploy/install-centos

This snippet demonstrates how to install EMQX using its Yum repository. It first configures the repository by downloading and executing a script, then installs the EMQX package, and finally starts the EMQX service. This method automates dependency management and installation.

```bash
curl -s https://assets.emqx.com/scripts/install-emqx-rpm.sh | sudo bash
sudo yum install emqx -y
sudo systemctl start emqx
```

--------------------------------

### Start EMQX using systemctl

Source: https://docs.emqx.com/zh/emqx/v5.0/deploy/install-amazon-linux

Starts the EMQX service using the systemctl command, which is the standard service manager for systemd-based systems like Amazon Linux 2. This ensures EMQX starts on boot.

```bash
sudo systemctl start emqx
```

--------------------------------

### Start EMQX Service (Systemd, Service, Direct) (Bash)

Source: https://docs.emqx.com/zh/emqx/v5.0/deploy/install-debian

Provides commands to start the EMQX service on Debian systems using different methods: direct command, systemctl, and service. These commands are essential for running EMQX after installation.

```bash
# Direct start
$ emqx start
EMQX 5.0.26 is started successfully!

$ emqx_ctl status
Node 'emqx@127.0.0.1' 5.0.26 is started

# systemctl start
sudo systemctl start emqx

# service start
sudo service emqx start
```

--------------------------------

### Download EMQX with wget

Source: https://docs.emqx.com/zh/emqx/v5.0/getting-started/getting-started

This command downloads the EMQX macOS zip archive using wget. This is part of the manual installation process for EMQX.

```bash
wget https://www.emqx.com/zh/downloads/broker/5.0.26/emqx-5.0.26-macos11-amd64.zip
```

--------------------------------

### Extract EMQX archive

Source: https://docs.emqx.com/zh/emqx/v5.0/getting-started/getting-started

This command creates a directory and then extracts the downloaded EMQX zip archive into it. This is a step in the manual installation process.

```bash
mkdir -p emqx && unzip emqx-5.0.26-macos11-amd64.zip -d emqx
```

--------------------------------

### Install and Start Kafka (macOS)

Source: https://docs.emqx.com/zh/emqx/v5.0/data-integration/data-bridge-kafka

This snippet shows how to download, extract, and start an Apache Kafka server on macOS using the KRaft mode. It includes formatting the Kafka storage and starting the server.

```bash
wget https://archive.apache.org/direct/kafka/3.3.1/kafka_2.13-3.3.1.tgz

tar -xzf  kafka_2.13-3.3.1.tgz

cd kafka_2.13-3.3.1

# 以 KRaft 启动 Kafka（可选）
KAFKA_CLUSTER_ID="$(bin/kafka-storage.sh random-uuid)"

bin/kafka-storage.sh format -t $KAFKA_CLUSTER_ID -c config/kraft/server.properties

bin/kafka-server-start.sh config/kraft/server.properties
```

--------------------------------

### Start EMQX Server

Source: https://docs.emqx.com/zh/emqx/v5.0/performance/benchmark

This command starts the EMQX server. Ensure that EMQX is installed and configured correctly before executing this command. This is a prerequisite for all testing scenarios.

```bash
./bin/emqx start
```

--------------------------------

### Run EMQX using Docker

Source: https://docs.emqx.com/zh/emqx/v5.0/getting-started/getting-started

This command downloads and runs the latest EMQX version as a Docker container. Ensure Docker is installed and running before execution. It exposes several ports for EMQX services and dashboard access.

```bash
docker run -d --name emqx -p 1883:1883 -p 8083:8083 -p 8084:8084 -p 8883:8883 -p 18083:18083 emqx/emqx:latest
```

--------------------------------

### Unzip and Install EMQX on macOS

Source: https://docs.emqx.com/zh/emqx/v5.0/deploy/install-macOS

Extracts the downloaded EMQX zip archive into a designated directory. This command requires the zip utility to be installed. It creates a directory named 'emqx' and unzips the archive into it.

```bash
mkdir -p emqx && unzip emqx-5.0.26-macos12-arm64.zip -d emqx
```

--------------------------------

### Download EMQX tar.gz for amd64

Source: https://docs.emqx.com/zh/emqx/v5.0/deploy/install-amazon-linux

Downloads the EMQX tar.gz archive for the amd64 architecture on Amazon Linux 2. This is the first step for manual installation.

```bash
wget https://www.emqx.com/zh/downloads/broker/5.0.26/emqx-5.0.26-elixir-amzn2-amd64.tar.gz
```

--------------------------------

### Download EMQX Zip Package for macOS

Source: https://docs.emqx.com/zh/emqx/v5.0/deploy/install-macOS

Downloads the EMQX broker zip package for macOS using wget. Ensure wget is installed on your system. This command fetches the specified version of EMQX.

```bash
wget https://www.emqx.com/zh/downloads/broker/5.0.26/emqx-5.0.26-macos12-arm64.zip
```

--------------------------------

### Start EMQX Cluster with Docker Compose

Source: https://docs.emqx.com/zh/emqx/v5.0/deploy/install-docker

Launches the EMQX cluster defined in the `docker-compose.yml` file in detached mode. This command orchestrates the creation and startup of all defined services and networks.

```bash
docker-compose up -d
```

--------------------------------

### Install EMQX from tar.gz for amd64

Source: https://docs.emqx.com/zh/emqx/v5.0/deploy/install-amazon-linux

Extracts the downloaded EMQX tar.gz archive for the amd64 architecture into an 'emqx' directory. This completes the manual installation process.

```bash
mkdir -p emqx && tar -zxvf emqx-5.0.26-elixir-amzn2-amd64.tar.gz -C emqx
```

--------------------------------

### Download EMQX tar.gz for arm64

Source: https://docs.emqx.com/zh/emqx/v5.0/deploy/install-amazon-linux

Downloads the EMQX tar.gz archive for the arm64 architecture on Amazon Linux 2. This is the first step for manual installation.

```bash
wget https://www.emqx.com/zh/downloads/broker/5.0.26/emqx-5.0.26-amzn2-arm64.tar.gz
```

--------------------------------

### Install PostgreSQL with Docker

Source: https://docs.emqx.com/zh/emqx/v5.0/data-integration/data-bridge-pgsql

This snippet demonstrates how to install and start a PostgreSQL instance using Docker. It also shows how to access the PostgreSQL shell within the container and connect to the server.

```bash
docker run --name PostgreSQL -p 5432:5432 -e POSTGRES_PASSWORD=public -d postgres

docker exec -it PostgreSQL bash

psql -U postgres -W
```

--------------------------------

### Install and Run TDengine via Docker

Source: https://docs.emqx.com/zh/emqx/v5.0/data-integration/data-bridge-tdengine

This snippet shows how to install and start a TDengine container using Docker. It includes commands to run the container, access its bash shell, connect to the TDengine server, and create a database named 'mqtt'.

```bash
# 启动一个 TDengine 容器
docker run --name TDengine -p 6041:6041 tdengine/tdengine

# 进入容器
docker exec -it TDengine bash

# 在容器中连接到 TDengine 服务器
taos

# 创建并选择数据库

CREATE DATABASE mqtt;

use mqtt;
```

--------------------------------

### Install EMQX using Apt Repository (Bash)

Source: https://docs.emqx.com/zh/emqx/v5.0/deploy/install-debian

Configures the EMQX Apt repository and installs EMQX on Debian systems. This method simplifies dependency management and package updates. It involves fetching a script to set up the repository and then using apt-get to install the EMQX package.

```bash
curl -s https://assets.emqx.com/scripts/install-emqx-deb.sh | sudo bash
sudo apt-get install emqx
sudo systemctl start emqx
```

--------------------------------

### Run Single EMQX Node with Docker

Source: https://docs.emqx.com/zh/emqx/v5.0/deploy/install-docker

Starts a single EMQX node as a detached Docker container. It maps necessary ports for communication and management. Ensure data persistence by mounting volumes if required.

```bash
docker run -d --name emqx -p 1883:1883 -p 8083:8083 -p 8084:8084 -p 8883:8883 -p 18083:18083 emqx/emqx:5.0.26
```

--------------------------------

### Install EMQX RPM for arm64

Source: https://docs.emqx.com/zh/emqx/v5.0/deploy/install-amazon-linux

Installs the downloaded EMQX RPM package for the arm64 architecture on Amazon Linux 2 using yum. The '-y' flag automatically confirms the installation.

```bash
sudo yum install emqx-5.0.26-amzn2-arm64.rpm -y
```

--------------------------------

### Install EMQX RPM for amd64

Source: https://docs.emqx.com/zh/emqx/v5.0/deploy/install-amazon-linux

Installs the downloaded EMQX RPM package for the amd64 architecture on Amazon Linux 2 using yum. The '-y' flag automatically confirms the installation.

```bash
sudo yum install emqx-5.0.26-amzn2-amd64.rpm -y
```

--------------------------------

### Install EMQX from tar.gz for arm64

Source: https://docs.emqx.com/zh/emqx/v5.0/deploy/install-amazon-linux

Extracts the downloaded EMQX tar.gz archive for the arm64 architecture into an 'emqx' directory. This completes the manual installation process.

```bash
mkdir -p emqx && tar -zxvf emqx-5.0.26-amzn2-arm64.tar.gz -C emqx
```

--------------------------------

### EMQX System Topic Examples

Source: https://docs.emqx.com/zh/emqx/v5.0/observability/mqtt-system-topics

Examples of EMQX system topics used to retrieve information about the broker's version and uptime.

```bash
$SYS/brokers/emqx@127.0.0.1/version
$SYS/brokers/emqx@127.0.0.1/uptime
```

--------------------------------

### HOCON Configuration Example

Source: https://docs.emqx.com/zh/emqx/v5.0/configuration/configuration

Demonstrates the basic syntax of HOCON configuration files used by EMQX. It shows how to define nested configurations using object notation and a flattened notation, which offers backward compatibility with previous EMQX versions.

```hocon
node {
  name = "emqx@127.0.0.1"
  cookie = "mysecret"
  cluster_call {
    retry_interval  =  1m
  }
}
```

```bash
node.name = "127.0.0.1"
node.cookie = "mysecret"
node.cluster_call.retry_interval = "1m"
```

--------------------------------

### MQTT Topic Examples

Source: https://docs.emqx.com/zh/emqx/v5.0/mqtt/mqtt-publish-and-subscribe

Illustrates various MQTT topic structures, including hierarchical paths and the use of wildcards '+' and '#'. These examples demonstrate how topics are organized and how wildcards can be used for flexible message routing.

```bash
chat/room/1

sensor/10/temperature

sensor/+/temperature

$SYS/broker/metrics/packets/received

$SYS/broker/metrics/#
```

--------------------------------

### Install EMQX using tar.gz (arm64) on CentOS 8

Source: https://docs.emqx.com/zh/emqx/v5.0/deploy/install-centos

This snippet installs EMQX for arm64 architecture on CentOS 8 using a tar.gz archive. It downloads the compressed file and extracts it into an 'emqx' directory. This is an alternative to RPM installation for ARM systems.

```bash
wget https://www.emqx.com/zh/downloads/broker/5.0.26/emqx-5.0.26-el8-arm64.tar.gz
mkdir -p emqx && tar -zxvf emqx-5.0.26-el8-arm64.tar.gz -C emqx
```

--------------------------------

### Install EMQX using tar.gz (amd64) on CentOS 8

Source: https://docs.emqx.com/zh/emqx/v5.0/deploy/install-centos

This code installs EMQX from a tar.gz archive for amd64 architecture on CentOS 8. It downloads the compressed archive and then extracts its contents into an 'emqx' directory. This method provides more control over the installation location.

```bash
wget https://www.emqx.com/zh/downloads/broker/5.0.26/emqx-5.0.26-el8-amd64.tar.gz
mkdir -p emqx && tar -zxvf emqx-5.0.26-el8-amd64.tar.gz -C emqx
```

--------------------------------

### Install MQTT.js globally for CLI

Source: https://docs.emqx.com/zh/emqx/v5.0/connect-emqx/javascript

Globally installs the MQTT.js library for command-line interface (CLI) usage. This allows you to use MQTT commands like 'publish', 'subscribe', and 'help' directly from your terminal.

```bash
npm i mqtt -g

mqtt help
```

--------------------------------

### Configuration File - HTTP GET Authentication

Source: https://docs.emqx.com/zh/emqx/v5.0/access-control/authn/http

Example configuration for HTTP authentication using the GET method via configuration files.

```APIDOC
## Configuration File - HTTP GET Authentication

### Description
This example demonstrates how to configure HTTP-based password authentication using the `GET` method within EMQX configuration files.

### Method
GET

### Endpoint
`http://127.0.0.1:32333/auth`

### Parameters
#### Query Parameters (from Body template):
- **username**: `${username}`
- **password**: `${password}`

#### Headers:
- **X-Request-Source**: `EMQX`

### Request Example
```hcl
{
    mechanism = password_based
    backend = http
    enable = true

    method = get
    url = "http://127.0.0.1:32333/auth"
    body {
        username = "${username}"
        password = "${password}"
    }
    headers {
        "X-Request-Source" = "EMQX"
    }
}
```

### Response
See "HTTP Authentication API - Request and Response Format" for details.
```

--------------------------------

### Install FreeTDS on Ubuntu

Source: https://docs.emqx.com/zh/emqx/v5.0/data-integration/data-bridge-sqlserver

Installs FreeTDS and necessary packages on Ubuntu 20.04 for ODBC driver setup. This process involves using `apt-get` to install `unixodbc-dev`, `tdsodbc`, and Perl modules, and then configuring `odbcinst.ini`.

```bash
$ apt-get install unixodbc unixodbc-dev tdsodbc freetds-bin freetds-common freetds-dev libdbd-odbc-perl liblocal-lib-perl
$ vim /etc/odbcinst.ini
# 加入以下内容
[ms-sql]
Description = ODBC for FreeTDS
Driver      = /usr/lib/x86_64-linux-gnu/odbc/libtdsodbc.so
Setup       = /usr/lib/x86_64-linux-gnu/odbc/libtdsS.so
FileUsage   = 1
```

--------------------------------

### Example: Start Node Evacuation with Custom Rates (CLI) - EMQX

Source: https://docs.emqx.com/zh/emqx/v5.0/deploy/cluster/rebalancing

An example demonstrating how to start node evacuation with specific connection and session eviction rates, and a custom wait-takeover period. This command migrates client sessions from the current node to specified target nodes.

```bash
./bin/emqx_ctl rebalance start --evacuation \
	--wait-takeover 200 \
	--conn-evict-rate 30 \
	--sess-evict-rate 30 \
	--migrate-to "emqx2@127.0.0.1 emqx3@127.0.0.1"
Rebalance(evacuation) started
```

--------------------------------

### 配置 LwM2M 网关 - 配置文件

Source: https://docs.emqx.com/zh/emqx/v5.0/gateway/lwm2m

在 `emqx.conf` 文件中配置 LwM2M 网关的各项参数，包括 XML 目录、心跳超时、生命周期、消息转换规则和监听器设置。此配置仅在单个节点生效，需要集群中每个节点进行配置。

```properties
gateway.lwm2m {
  xml_dir = "etc/lwm2m_xml/"
  auto_observe = true
  enable_stats = true
  idle_timeout = "30s"
  lifetime_max = "86400s"
  lifetime_min = "1s"
  mountpoint = "lwm2m/${endpoint_namea}/"
  qmode_time_window = "22s"
  update_msg_publish_condition = "contains_object_list"
  translators {
    command {qos = 0, topic = "dn/#"}
    notify {qos = 0, topic = "up/notify"}
    register {qos = 0, topic = "up/resp"}
    response {qos = 0, topic = "up/resp"}
    update {qos = 0, topic = "up/update"}
  }
  listeners {
    udp {
      default {
        bind = "5783"
        max_conn_rate = 1000
        max_connections = 1024000
      }
    }
  }
}
```

--------------------------------

### Install EMQX using RPM package (arm64) on CentOS 8

Source: https://docs.emqx.com/zh/emqx/v5.0/deploy/install-centos

This code installs EMQX on CentOS 8 for arm64 architecture using an RPM package. It downloads the ARM64 version of the EMQX 5.0.26 RPM and installs it via yum. Adapt the URL for different EMQX versions or operating system versions.

```bash
wget https://www.emqx.com/zh/downloads/broker/5.0.26/emqx-5.0.26-el8-arm64.rpm
sudo yum install emqx-5.0.26-el8-arm64.rpm -y
```

--------------------------------

### Install Flask and Run HTTP Server

Source: https://docs.emqx.com/zh/emqx/v5.0/data-integration/data-bridge-webhook

Shell commands to install the Flask library and then run the Python HTTP server script. This prepares the environment to receive webhook data. Ensure Python 3 is installed and accessible.

```shell
# 安装 flask 依赖
pip install flask

# 启动服务
python3 http_server.py
```

--------------------------------

### Install EMQX using RPM package (amd64) on CentOS 8

Source: https://docs.emqx.com/zh/emqx/v5.0/deploy/install-centos

This code installs EMQX on CentOS 8 for amd64 architecture using an RPM package. It first downloads the specific RPM file for EMQX version 5.0.26 and then installs it using the yum package manager. Ensure you have the correct URL for other versions or architectures.

```bash
wget https://www.emqx.com/zh/downloads/broker/5.0.26/emqx-5.0.26-el8-amd64.rpm
sudo yum install emqx-5.0.26-el8-amd64.rpm -y
```

--------------------------------

### EMQX SQL: Basic Syntax Examples

Source: https://docs.emqx.com/zh/emqx/v5.0/data-integration/rule-sql-syntax

Provides practical examples of basic EMQX SQL queries, including selecting all fields, selecting from multiple topics, using topic filters, and applying simple WHERE conditions. These examples illustrate common data retrieval and filtering scenarios.

```sql
SELECT * FROM "t/a"
```

```sql
SELECT * FROM "t/a","t/b"
```

```sql
SELECT * FROM "t/#"
```

```sql
SELECT qos, username, clientid FROM "t/#"
```

```sql
SELECT username FROM "#" WHERE username='Steven'
```

```sql
SELECT payload.x as x FROM "#" WHERE x = 1
```

```sql
SELECT payload FROM "#" WHERE payload.x.y = 1
```

```sql
SELECT peername as ip_port FROM "$events/client_connected" WHERE clientid = 'c1'
```

```sql
SELECT clientid FROM "$events/session_subscribed" WHERE topic = 't/#' and qos = 1
```

```sql
SELECT clientid FROM "$events/session_subscribed" WHERE topic =~ 't/#' and qos = 1
```

```sql
SELECT pub_props.'User-Property'.foo as foo FROM "t/#"
```

--------------------------------

### Download EMQX RPM for arm64

Source: https://docs.emqx.com/zh/emqx/v5.0/deploy/install-amazon-linux

Downloads the EMQX RPM package for the arm64 architecture on Amazon Linux 2. This is a prerequisite for installing EMQX via RPM.

```bash
wget https://www.emqx.com/zh/downloads/broker/5.0.26/emqx-5.0.26-amzn2-arm64.rpm
```

--------------------------------

### Start RocketMQ Broker

Source: https://docs.emqx.com/zh/emqx/v5.0/data-integration/data-bridge-rocketmq

This command initiates the RocketMQ services (name server and broker) using the previously defined Docker Compose file.

```bash
docker-compose -f rocketmq.yaml up

```

--------------------------------

### Download EMQX RPM for amd64

Source: https://docs.emqx.com/zh/emqx/v5.0/deploy/install-amazon-linux

Downloads the EMQX RPM package for the amd64 architecture on Amazon Linux 2. This is a prerequisite for installing EMQX via RPM.

```bash
wget https://www.emqx.com/zh/downloads/broker/5.0.26/emqx-5.0.26-amzn2-amd64.rpm
```

--------------------------------

### Prepare RocketMQ Directories

Source: https://docs.emqx.com/zh/emqx/v5.0/data-integration/data-bridge-rocketmq

This command sequence creates the necessary directories for RocketMQ logs, storage, and configuration files on the local filesystem.

```bash
mkdir rocketmq
mkdir rocketmq/logs
mkdir rocketmq/store
mkdir rocketmq/conf

```

--------------------------------

### 启动 EMQX Builder Docker 容器

Source: https://docs.emqx.com/zh/emqx/v5.0/deploy/install-source

使用此命令启动一个名为 emqx-builder 的 Docker 容器，该容器预装了编译 EMQX 源码所需的环境。您还可以选择性地映射 EMQX 的主要端口以方便后续访问。该命令会保持容器运行以供后续使用。

```bash
docker run -d --name emqx-builder \
  # -p 1883:1883 \
  # -p 8083:8083 \
  # -p 8084:8084 \
  # -p 8883:8883 \
  # -p 18083:18083 \
  ghcr.io/emqx/emqx-builder/5.0-17:1.13.4-24.2.1-1-ubuntu20.04 \
  bash -c "tail -f /dev/null"
```

--------------------------------

### EMQX HTTP Authentication Configuration (GET)

Source: https://docs.emqx.com/zh/emqx/v5.0/access-control/authn/http

Configuration for password-based authentication using an external HTTP server with the GET method. This example demonstrates setting the URL and includes placeholders for username and password in the request body, which will be appended as query parameters.

```hcl
{
    mechanism = password_based
    backend = http
    enable = true

    method = get
    url = "http://127.0.0.1:32333/auth"
    body {
        username = "${username}"
        password = "${password}"
    }
    headers {
        "X-Request-Source" = "EMQX"
    }
}
```

--------------------------------

### 测试客户端端口范围和文件句柄设置

Source: https://docs.emqx.com/zh/emqx/v5.0/performance/tune

为测试客户端配置优化的网络端口范围和文件句柄限制。这有助于测试客户端在单个接口上创建大量连接的能力，确保测试环境能够模拟高负载场景。设置包括本地端口范围和 `/proc/sys/fs/nr_open`。

```bash
sysctl -w net.ipv4.ip_local_port_range="500 65535"
echo 1000000 > /proc/sys/fs/nr_open
ulimit -n 100000
```

--------------------------------

### Start 500 Subscriber Clients with emqtt_bench

Source: https://docs.emqx.com/zh/emqx/v5.0/performance/benchmark

This command initiates 500 subscriber clients using emqtt_bench to connect to the EMQX server. These clients will subscribe to the topic 't'. The `-c` flag sets the number of clients, and `-t` specifies the topic.

```bash
./emqtt_bench sub -t t -h 192.168.0.99 -c 500
```

--------------------------------

### JWT Payload Example with Permissions

Source: https://docs.emqx.com/zh/emqx/v5.0/access-control/authn/jwt

This JSON example demonstrates a JWT payload structure that includes expiration time, username, and an access control list (ACL) for publish and subscribe permissions. It shows how to define topic white/blacklists and use placeholders like ${username} and ${clientid}, along with the 'eq' syntax to prevent placeholder interpolation.

```json
{
  "exp": 1654254601,
  "username": "emqx_u",
  "acl": {
    "pub": [
      "testpub1/${username}",
      "eq testpub2/${username}"
    ],
    "sub": [
      "testsub1/${username}",
      "testsub2/${clientid}"
      "testsub2/#"
    ],
    "all": [
      "testall1/${username}",
      "testall2/${clientid}",
      "testall3/#"
    ]
  }
}
```
Tokens:
Raw