# Command - Run

Start the message broker and connect to a FoxMQ cluster.

Usage: `foxmq run <--secret-key <SECRET_KEY>|--secret-key-file <SECRET_KEY_FILE>> [CONFIG_DIR]`

{% hint style="info" %}
Windows users: Traffic on the loopback interface (`localhost`/`127.0.0.1`) does not connect to applications listening on `0.0.0.0`. Use `127.0.0.1` IP to listen for loopback connections.
{% endhint %}

### Options listing

* `--log`, `-l`\
  Set the format of log output.
  * Default: `full`
  * Options: `full`, `compact`, `pretty`, `json`
    * `json` is structured and is intended for usage by tools that process structured logs in production environments, and is not optimized for human readability.
  * Example: `--log=json` \
    May lead to a message such as (note: JSON output is not prettiefied, this is just an example):&#x20;

```json
{
    "timestamp":"2024-04-12T23:14:00.243145Z",
    "level":"INFO",
    "fields":{
        "message":"listening for connections",
        "listen_addr":"0.0.0.0:1883"
    },
    "target":"foxmq::mqtt::broker"
}
```

* `--mqtt-addr`, `-L`\
  The TCP socket address to listen for MQTT (non-TLS) connections from clients.
  * Default: `0.0.0.0:1883`
* `--cluster-addr`, `-C`\
  The UDP socket address to listen for cluster connections from other FoxMQ brokers.
  * Default: `0.0.0.0:19793`
* `--allow-anonymous-login`

  Allow clients to authenticate without providing user credentials

  * Default: `false` (not present)
* `--silent-connect-errors`\
  Don't respond to mqtt `CONNECT` packets if the result would be an error.\
  \
  This can be used to avoid advertising that an MQTT broker is running on the given port, which makes it harder to categorize in a port scanning attack and identify as a potential target.\
  \
  By default, a response is sent to the client detailing the reason why the handshake failed.\
  When enabled, the error is simply logged at `DEBUG` level, and the socket is silently closed.
  * Default: `false` (not present)
* `--secret-key`, `-k`\
  Read the P-256 secret key used to identify this broker in the cluster from hex encoded DER.\
  \
  If `--tls-key-file` is not provided and `mqtts` is enabled, this or `--secret-key-file` will be used by default.
  * &#x20;env: `SECRET_KEY=`
  * Conflicts: `--secret-key-file`&#x20;
* `--secret-key-file`, `-f`\
  Read the PEM-encoded P-256 secret key used to identify this broker in the cluster from a file.&#x20;
  * env: `SECRET_KEY_FILE=`
  * Conflicts: `--secret-key`
* `--mqtts`\
  Enable listening for MQTT-over-TLS connections on a separate socket (`0.0.0.0:8883` by default)
* `--mqtts-addr`\
  The TCP socket address to listen for MQTT-over-TLS (`mmqts`) connections from clients.
  * Default: `0.0.0.0:8883`
* `--server-name`\
  The domain name to report for Server Name Identification (SNI) in TLS
  * Default: `foxmq.local`
* `--tls-key-file`\
  Override the secret key used for TLS handshakes.
  * Default: The main secret key (`--secret-key`/`seecret-key-file`)
* `--tls-cert-file`\
  Path to the X.509 certificate to use for TLS.
  * Default: A certificate self-signed with TLS key (`--tls-key-file` or the main key)&#x20;

### Example

Refer to [Broken mention](broken://pages/pjiNwtHXpLCGzglvG2xI) or [Broken mention](broken://pages/pKJCc4gWRtl1CEYIxfsE) for more in-depth examples.

<pre class="language-bash"><code class="lang-bash"><strong>foxmq run \
</strong><strong>    --log=full
</strong><strong>    --mqtt-addr "0.0.0.0:1883" \
</strong><strong>    --cluster-addr "0.0.0.0:19793"
</strong><strong>    --secret-key-file foxmq.d/key_0.pem \
</strong><strong>    --mqtts \
</strong><strong>    --mqtts-addr "0.0.0.0:8883"
</strong><strong>    --server-name "foxmq.local
</strong><strong>    --tls-key-file foxmq.d/key_0.pem
</strong><strong>    --tls-cert-file "my-cert.crt"
</strong></code></pre>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.tashi.network/resources/foxmq/cli-options/command-run.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.