Skip to content

Commit

Permalink
GitBook: [1.12.3] 45 pages modified
Browse files Browse the repository at this point in the history
  • Loading branch information
ioolkos authored and gitbook-bot committed Sep 19, 2021
1 parent fede5a6 commit d56e4ce
Show file tree
Hide file tree
Showing 45 changed files with 4,501 additions and 55 deletions.
115 changes: 60 additions & 55 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,69 +5,74 @@
* [Downloads](https://vernemq.com/downloads)
* [VerneMQ / MQTT Introduction](https://vernemq.com/intro)

## Installing VerneMQ

* [Installing on Debian and Ubuntu](installing-vernemq/debian_and_ubuntu.md)
* [Installing on CentOS and RHEL](installing-vernemq/centos_and_redhat.md)
* [Running VerneMQ using Docker](installing-vernemq/docker.md)

## Configuring VerneMQ

* [Introduction](configuring-vernemq/introduction.md)
* [Auth using files](configuring-vernemq/file-auth.md)
* [Auth using a database](configuring-vernemq/db-auth.md)
* [MQTT Options](configuring-vernemq/options.md)
* [MQTT Listeners](configuring-vernemq/listeners.md)
* [HTTP Listeners](configuring-vernemq/http-listeners.md)
* [Non-standard MQTT options](configuring-vernemq/nonstandard.md)
* [Websockets](configuring-vernemq/websockets.md)
* [Logging](configuring-vernemq/logging.md)
* [Consumer session balancing](configuring-vernemq/balancing.md)
* [Plugins](configuring-vernemq/plugins.md)
* [Shared subscriptions](configuring-vernemq/shared_subscriptions.md)
* [Advanced Options](configuring-vernemq/advanced_options.md)
* [Storage](configuring-vernemq/storage.md)
* [MQTT Bridge](configuring-vernemq/bridge.md)

## VerneMQ Clustering

* [Introduction](vernemq-clustering/introduction.md)
* [Inter-node Communication](vernemq-clustering/communication.md)
* [Dealing with Netsplits](vernemq-clustering/netsplits.md)

## Live Administration

* [Introduction](live-administration/introduction.md)
* [Inspecting and managing sessions](live-administration/managing-sessions.md)
* [Retained messages](live-administration/retained-store.md)
* [Live reconfiguration](live-administration/config_values.md)
* [Managing Listeners](live-administration/listeners.md)
* [HTTP API](live-administration/http-administration.md)
* [Tracing](live-administration/tracing.md)
## Installation

* [Accepting the VerneMQ EULA](installation/accepting-the-vernemq-eula.md)
* [Installing on Debian and Ubuntu](installation/debian_and_ubuntu.md)
* [Installing on CentOS and RHEL](installation/centos_and_redhat.md)
* [Running VerneMQ using Docker](installation/docker.md)

## Configuration

* [Introduction](configuration/introduction.md)
* [Auth using files](configuration/file-auth.md)
* [Auth using a database](configuration/db-auth.md)
* [MQTT Options](configuration/options.md)
* [MQTT Listeners](configuration/listeners.md)
* [HTTP Listeners](configuration/http-listeners.md)
* [Non-standard MQTT options](configuration/nonstandard.md)
* [Websockets](configuration/websockets.md)
* [Logging](configuration/logging.md)
* [Consumer session balancing](configuration/balancing.md)
* [Plugins](configuration/plugins.md)
* [Shared subscriptions](configuration/shared_subscriptions.md)
* [Advanced Options](configuration/advanced_options.md)
* [Storage](configuration/storage.md)
* [MQTT Bridge](configuration/bridge.md)

## Clustering

* [Introduction](clustering/introduction.md)
* [Inter-node Communication](clustering/communication.md)
* [Dealing with Netsplits](clustering/netsplits.md)

## Administration

* [Introduction](administration/introduction.md)
* [Inspecting and managing sessions](administration/managing-sessions.md)
* [Retained messages](administration/retained-store.md)
* [Live reconfiguration](administration/config_values.md)
* [Managing Listeners](administration/listeners.md)
* [HTTP API](administration/http-administration.md)
* [Tracing](administration/tracing.md)

## Monitoring

* [Introduction](monitoring/introduction.md)
* [$SYSTree](monitoring/systree.md)
* [Graphite](monitoring/graphite.md)
* [Netdata](monitoring/netdata.md)
* [Prometheus](monitoring/prometheus.md)
* [Health Checker](monitoring/health-check.md)
* [Status Page](monitoring/status.md)

## Plugin Development

* [Introduction](plugin-development/introduction.md)
* [Session lifecycle](plugin-development/sessionlifecycle.md)
* [Subscribe Flow](plugin-development/subscribeflow.md)
* [Publish Flow](plugin-development/publishflow.md)
* [Enhanced Auth Flow](plugin-development/enhancedauthflow.md)
* [Erlang Boilerplate](plugin-development/boilerplate.md)
* [Lua Scripting Support](plugin-development/luaplugins.md)
* [Webhooks](plugin-development/webhookplugins.md)

## Misc

* [Loadtesting VerneMQ](misc/loadtesting.md)
* [Not a tuning guide](misc/not-a-tuning-guide.md)
* [Change Open File Limits](misc/change-open-file-limits.md)
## Plugindevelopment

* [Introduction](plugindevelopment/introduction.md)
* [Session lifecycle](plugindevelopment/sessionlifecycle.md)
* [Subscribe Flow](plugindevelopment/subscribeflow.md)
* [Publish Flow](plugindevelopment/publishflow.md)
* [Enhanced Auth Flow](plugindevelopment/enhancedauthflow.md)
* [Erlang Boilerplate](plugindevelopment/boilerplate.md)
* [Lua Scripting Support](plugindevelopment/luaplugins.md)
* [Webhooks](plugindevelopment/webhookplugins.md)

## Guides

* [A typical VerneMQ deployment](guides/typical-vernemq-deployment.md)
* [VerneMQ on Kubernetes](guides/vernemq-on-kubernetes.md)
* [Loadtesting VerneMQ](guides/loadtesting.md)
* [Clustering during development](guides/clustering-during-development.md)
* [Not a tuning guide](guides/not-a-tuning-guide.md)
* [Change Open File Limits](guides/change-open-file-limits.md)

118 changes: 118 additions & 0 deletions administration/config_values.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
---
description: Managing VerneMQ live config values.
---

# Live reconfiguration

You can dynamically re-configure most of VerneMQ's settings on a running node by using the `vmq-admin set` command.

The following config values can be handled dynamically:

```text
allow_anonymous
topic_alias_max_broker
receive_max_broker
vmq_acl.acl_file
graphite_host
vmq_acl.acl_reload_interval
graphite_enabled
queue_type
suppress_lwt_on_session_takeover
max_message_size
vmq_passwd.password_file
graphite_port
max_client_id_size
upgrade_outgoing_qos
max_message_rate
graphite_interval
allow_multiple_sessions
systree_enabled
max_last_will_delay
retry_interval
receive_max_client
max_offline_messages
max_online_messages
max_inflight_messages
allow_register_during_netsplit
vmq_passwd.password_reload_interval
topic_alias_max_client
systree_interval
allow_publish_during_netsplit
coordinate_registrations
remote_enqueue_timeout
persistent_client_expiration
allow_unsubscribe_during_netsplit
graphite_include_labels
shared_subscription_policy
queue_deliver_mode
allow_subscribe_during_netsplit
```

{% hint style="warning" %}
Settings dynamically configured with the `vmq-admin set` command will be reset by vernemq.conf upon broker restart.
{% endhint %}

## Setting a value for the local node

Let's change the `max_client_id_size` as an example. \(We might have noticed that some clients can't login because their client ID is too long, but we don't want to restart the broker for that\). Note that you can also set multiple values with the same command.

```text
vmq-admin set max_client_id_size=45
```

## Setting a value for an arbitrary cluster node

```text
vmq-admin set max_client_id_size=45 [email protected]
```

## Setting a value for all cluster nodes

```text
vmq-admin set max_client_id_size=45 --all
```

## Show current VerneMQ config values

### For the local node

You can show one or multiple values in a simple table:

```text
vmq-admin show max_client_id_size retry_interval
```

```text
+----------------------+------------------+--------------+
| node |max_client_id_size|retry_interval|
+----------------------+------------------+--------------+
|[email protected]| 28 | 20 |
+----------------------+------------------+--------------+
`
```

### For an arbitrary node

```text
vmq-admin show max_client_id_size retry_interval --node [email protected]
```

### For all cluster nodes

```text
vmq-admin show max_client_id_size retry_interval --all
```

```text
+----------------------+------------------+--------------+
| node |max_client_id_size|retry_interval|
+----------------------+------------------+--------------+
|[email protected]| 33 | 20 |
|[email protected]| 33 | 20 |
|[email protected]| 33 | 20 |
|[email protected]| 33 | 20 |
|[email protected]| 28 | 20 |
+----------------------+------------------+--------------+
```

Loading

0 comments on commit d56e4ce

Please sign in to comment.