Configuration Files
These configuration properties are provided for reference purposes only. Direct modification of Chariot configuration files is not recommended and may lead to unexpected behavior. Please use the standard configuration tools provided by Chariot.
📁 com.cirruslink.chariot.client
| Parameter | Type | Description | Default |
|---|---|---|---|
| serverName | string | Name of the MQTT Server to connect to | "mosquitto-test-broker-1" |
| clientId | string | Name of the connecting client | "client-1" |
| serverUrl | string | MQTT Server URL | "test.mosquitto.org" |
| serverPort | integer | MQTT Server port | I"1883" |
| username | string | Username credentials for the connecting client | "" |
| password | string | Password credentials for the connecting client. | "" |
| cleanSession | boolean | Whether to enable Clean Session on connect | B"true" |
| keepAlive | integer | Keep Alive timeout in seconds | I"60" |
| useTIs | boolean | Whether to use secure (TLS/SSL) connection | B"false" |
📁 com.cirruslink.chariot.example
| Parameter | Type | Description | Default |
|---|---|---|---|
| myInt | integer | Sample integer value | I"1" |
| myList | list | Sample list value | i[ \ "8", \ "200", \ "300", \ ] |
| myStr | string | Sample string value | my-custom-string |
📁 com.cirruslink.chariot.http.chariotui
| Parameter | Type | Description | Default |
|---|---|---|---|
| path | string | Default path for Chariot UI | "webserver" |
📁 com.cirruslink.chariot.mqttuser
| Parameter | Type | Description | Default |
|---|---|---|---|
| encryptedProperties | string | All encrypted properties | [ \ "password", \ ] |
| algorithm | string | Encryption algorithm | "SHA-512" |
| saltSize | integer | The size of salt to user before hashing | I"32" |
| hashIterations | integer | The number of times to apply the hashing algorithm | I"1" |
📁 com.cirruslink.chariot.persistence.h2-default
| Parameter | Type | Description | Default |
|---|---|---|---|
| name | string | "default" | |
| folder | string | "h2/default" | |
| user | string | "sa" | |
| password | string | "" | |
| loginTimeout | integer | I"40" | |
| tables.1.name | string | "accounts" | |
| tables.1.keys.1 | string | "account" | |
| tables.1.columns.1.name | string | "id" | |
| tables.1.columns.1.type | string | "INT IDENTITY(1,1)" | |
| tables.1.columns.1.isPrimary | boolean | B"true" | |
| tables.1.columns.2.name | string | "accountName" | |
| tables.1.columns.2.type | string | "VARCHAR (255)" | |
| tables.1.columns.2.isId | boolean | B"true" | |
| tables.1.columns.3.name | string | "accountDescription" | |
| tables.1.columns.3.type | string | "VARCHAR (255)" | |
| tables.1.columns.4.name | string | "meta_createdBy" | |
| tables.1.columns.4.type | string | "VARCHAR (255)" | |
| tables.1.columns.5.name | string | "meta_createdOn" | |
| tables.1.columns.5.type | string | "BIGINT" | |
| tables.1.columns.6.name | string | "meta_modifiedBy" | |
| tables.1.columns.6.type | string | "VARCHAR (255)" | |
| tables.1.columns.7.name | string | "meta_modifiedOn" | |
| tables.1.columns.7.type | string | "BIGINT" | |
| tables.1.columns.8.name | string | "accountId" | |
| tables.1.columns.8.type | string | "VARCHAR (255)" | |
| tables.2.name | string | "users" | |
| tables.2.keys.1 | string | "user" | |
| tables.2.columns.1.name | string | "id" | |
| tables.2.columns.1.type | string | "INT IDENTITY(1,1)" | |
| tables.2.columns.1.isPrimary | boolean | B"true" | |
| tables.2.columns.2.name | string | "username" | |
| tables.2.columns.2.type | string | "VARCHAR (255)" | |
| tables.2.columns.2.isId | boolean | B"true" | |
| tables.2.columns.3.name | string | "meta_createdBy" | |
| tables.2.columns.3.type | string | "VARCHAR (255)" | |
| tables.2.columns.4.name | string | "meta_createdOn" | |
| tables.2.columns.4.type | string | "BIGINT" | |
| tables.2.columns.5.name | string | "meta_modifiedBy" | |
| tables.2.columns.5.type | string | "VARCHAR (255)" | |
| tables.2.columns.6.name | string | "meta_modifiedOn" | |
| tables.2.columns.6.type | string | "BIGINT" | |
| tables.2.columns.7.name | string | "accountId" | |
| tables.2.columns.7.type | string | "VARCHAR (255)" | |
| tables.2.columns.8.name | string | "password_value" | |
| tables.2.columns.8.type | string | "VARCHAR (255)" | |
| tables.2.columns.9.name | string | "password_salt" | |
| tables.2.columns.9.type | string | "BINARY(32)" | |
| tables.2.columns.10.name | string | "password_algorithm" | |
| tables.2.columns.10.type | string | "VARCHAR (255)" | |
| tables.2.columns.11.name | string | "password_hashIterations" | |
| tables.2.columns.11.type | string | "INT" | |
| tables.2.columns.12.name | string | "roles" | |
| tables.2.columns.12.type | string | "VARCHAR" | |
| tables.2.columns.13.name | string | "permissions" | |
| tables.2.columns.13.type | string | "VARCHAR" | |
| tables.2.columns.14.name | string | "firstName" | |
| tables.2.columns.14.type | string | "VARCHAR (255)" | |
| tables.2.columns.15.name | string | "lastName" | |
| tables.2.columns.15.type | string | "VARCHAR (255)" | |
| tables.2.columns.16.name | string | "phoneNumber" | |
| tables.2.columns.16.type | string | "VARCHAR (255)" | |
| tables.2.columns.17.name | string | "email" | |
| tables.2.columns.17.type | string | "VARCHAR (255)" | |
| tables.2.columns.18.name | string | "company" | |
| tables.2.columns.18.type | string | "VARCHAR (255)" | |
| tables.2.columns.19.name | string | "address_number" | |
| tables.2.columns.19.type | string | "INT" | |
| tables.2.columns.20.name | string | "address_street" | |
| tables.2.columns.20.type | string | "VARCHAR (255)" | |
| tables.2.columns.21.name | string | "address_city" | |
| tables.2.columns.21.type | string | "VARCHAR (255)" | |
| tables.2.columns.22.name | string | "address_province" | |
| tables.2.columns.22.type | string | "VARCHAR (255)" | |
| tables.2.columns.23.name | string | "address_zip" | |
| tables.2.columns.23.type | string | "VARCHAR (255)" | |
| tables.2.columns.24.name | string | "address_country" | |
| tables.2.columns.24.type | string | "VARCHAR (255)" |
📁 com.cirruslink.chariot.persistence.h2-logging
⚠️ information only, do not modify without consulting Cirrus Link
| Parameter | Type | Description | Default |
|---|---|---|---|
| name | string | "logging" | |
| folder | string | "h2/logging" | |
| user | string | "sa" | |
| password | string | "" | |
| loginTimeout | integer | I"40" | |
| tables.1.name | string | "logs" | |
| tables.1.maxRows | integer | I"262144" | |
| tables.1.keys.1 | string | "logentry" | |
| tables.1.indexes.1 | string | "LOGS" | |
| tables.1.columns.1.name | string | "id" | |
| tables.1.columns.1.type | string | "INT IDENTITY(1,1)" | |
| tables.1.columns.1.isPrimary | boolean | B"true" | |
| tables.1.columns.1.isId | boolean | B"true" | |
| tables.1.columns.1.index | string | "LOGS" | |
| tables.1.columns.1.order | string | "DESC" | |
| tables.1.columns.2.name | string | "logger" | |
| tables.1.columns.2.type | string | "VARCHAR" | |
| tables.1.columns.3.name | string | "level" | |
| tables.1.columns.3.type | string | "INT" | |
| tables.1.columns.4.name | string | "message" | |
| tables.1.columns.4.type | string | "VARCHAR" | |
| tables.1.columns.5.name | string | "thread" | |
| tables.1.columns.5.type | string | "VARCHAR" | |
| tables.1.columns.6.name | string | "timestamp" | |
| tables.1.columns.6.type | string | "BIGINT" | |
| tables.2.name | string | "version" | |
| tables.2.columns.1.name | string | "id" | |
| tables.2.columns.1.type | string | "INT IDENTITY(1,1)" | |
| tables.2.columns.1.isId | boolean | B"true" | |
| tables.2.columns.2.name | string | "chariotVersion" | |
| tables.2.columns.2.type | string | "VARCHAR" | |
| tables.2.columns.3.name | string | "buildTimestamp" | |
| tables.2.columns.3.type | string | "VARCHAR" | |
| tables.2.columns.4.name | string | "buildPlatform" | |
| tables.2.columns.4.type | string | "VARCHAR" |
📁 com.cirruslink.chariot.server
⚠️ ** indicates property hidden by default
| Parameter | Type | Description | Default |
|---|---|---|---|
| port | integer | The MQTT Server port for TLS enabled connections | I"1883" |
| securePort | integer | The MQTT Server port for plain TCP connections | I"8883" |
| webSocketPort | integer | Chariot Server WebSocket Port | I"8090" |
| webSocketSecurePort | integer | Chariot Server Secure WebSock Port | I"8091" |
| bindAddress | string | The IP address/hostname the MQTT Server will listen for connections on | "0.0.0.0" |
| enableNonSecure | boolean | Enable plain TCP connections for the MQTT Server | B"true" |
| enableSecure | boolean | Enable TLS connections for the MQTT Server (Requires TLS private key and certificates have been uploaded into Chariot) | B"false" |
| webSocketEnable | boolean | Enable Enable Chariot Server WebSocketChariot Server WebSocket | B"false" |
| webSocketEnableSecure | boolean | Enable Chariot Server Secure WebSocket | B"false" |
| allowAnonymous | boolean | Allow anonymous access to the MQTT Server | B"false" |
| maxMessageSize | integer | Maximum length of MQTT message that can be received in bytes | I"268435455" |
| maxConnectSize | integer | Maximum length of MQTT connect message that can be received in bytes | I"268435455" |
| maxClientIdLength | integer | Maximum number of characters in Client ID | I"100" |
| maxTopicLength | integer | Maximum number of characters in topic | I"1024" |
| maxTopicLevels | integer | Maximum number of topic levels | I"10" |
| connectTimeout | integer | Maximum timeout of a client finishing connecting | I"10000" |
| enforceUniqueLwtTopic | boolean | Whether to enforce unique LWT topic checks on connecting clients | B"false" |
| uniqueLwtTopicFilters | string | A comma-separated list of topic filters to match topics that must pass unique LWT topic checks | "" |
| messageThreads | integer | Number of message handler threads | I"2" |
| clientAuthPolicy | string | The client-side authentication policy ("none", "required", or "accepted") | "none" |
| subscriptionManager.target | string | The subscription manager implementation | "(type=default)" |
| ** redeliveryInterval | integer | The interval (in milliseconds) that message re-delivery is attempted | I"1000" |
| ** keepAliveCheckInterval | integer | The interval (in milliseconds) that the client keep alive timeouts are checked | I"1000" |
| ** maxActiveClients | integer | Maximum number of active client connections. Additional client connections will be rejected with "Server Unavailable". | I"2147483647" |
| ** anonymousAuthUsername | string | The username that authorization checks should be applied to for anonymous users. | |
| ** allowEmptyClientId | boolean | Whether to allow connections from clients with no client ID | B"true" |
| ** sslHandShakeTimout | integer | SSL Handshake timeout in ms | I"20000" |
| ** maxOutboundQueueSize | integer | Maximum outbound message queue size | I"16384" |
📁 com.cirruslink.chariot.security
| Parameter | Type | Description | Default |
|---|---|---|---|
| tokenTimeout | string | The UI session token timeout | 5400000 |
| ticketTimeout | string | The UI session ticket timeout | "3000" |
| defaultRealmEnabled | boolean | Whether to enable the Chariot internal User realm | B"true" |
📁 com.cirruslink.chariot.sparkplug
| Parameter | Type | Description | Default |
|---|---|---|---|
| enabled | boolean | Enable Chariot as an MQTT 3.1.1 compliant server | B"true" |
📁 com.cirruslink.chariot.system
| Parameter | Type | Description | Default |
|---|---|---|---|
| chariotServerName | string | The name of the Chariot server | |
| httpEnabled | boolean | Enable HHTP Access | B"true" |
| httpPort | integer | Port to make HTTP available | I"8080" |
| httpsEnabled | boolean | Enable HTTPS Access | B"false" |
| httpsPort | integer | Port to make HTTPS available | I"8443" |
| keyPassword | string | The password for keys in the KeyStore | "secretpassword" |
| keyStoreFile | string | The Java KeyStore filename | "security/ssl.jks" |
| keyStorePassword | string | The Java KeyStore password | "secretpassword" |
| trustStoreFile | string | The Java TrustStore filename | "security/clientcerts.jks" |
| trustStorePassword | string | The Java TrustStore password | "secretpassword |
| chariotVersionFile | string | The file containing the Chariot version | "version.properties" |
📁 com.cirruslink.chariot.upload
| Parameter | Type | Description | Default |
|---|---|---|---|
| maxFileSize | integer | Maximum file size to upload to Chariot | I"1048576" |
| maxMemSize | integer | Maximum memory size allocated for file upload | I"4096" |
| uploadFolderName | string | The folder where the uploaded file will be placed | "upload-folder" |
📁 com.cirruslink.chariot.user
| Parameter | Type | Description | Default |
|---|---|---|---|
| encryptedProperties | string | All properties to be encrypted | [ \ "password", \ ] |
| algorithm | string | Encryption algorithm | "SHA-512" |
| saltSize | integer | The size of salt to user before hashing | I"32" |
| hashIterations | integer | The number of times to apply the hashing algorithm | I"1" |
| usernameRegex | string | Regex applied to username | "^[a-zA-Z0-9._-]+$" |
| usernamePolicyMsg | string | Username Policy | "May only contain alphanumeric, '.', '_', and '-' characters" |