HTTP binding for the Stasis API
This configuration documentation is for functionality provided by res_ari.
ari.conf
general
General configuration settings
Configuration Option Reference
Option Name |
Type |
Default Value |
Regular Expression |
Description |
|---|---|---|---|---|
|
|
|
Enable/disable the ARI module |
|
|
|
|
The timeout (in milliseconds) to set on WebSocket connections. |
|
|
|
|
|
Responses from ARI are formatted to be human readable |
|
|
|
|
Realm to use for authentication. Defaults to Asterisk REST Interface. |
|
|
|
|
Comma separated list of allowed origins, for Cross-Origin Resource Sharing. May be set to * to allow all origins. |
Configuration Option Descriptions
enabled
This option enables or disables the ARI module.
websocket_write_timeout
If a websocket connection accepts input slowly, the timeout for writes to it can be increased to keep it from being disconnected. Value is in milliseconds; default is 100 ms.
user
Per-user configuration settings
Configuration Option Reference
Option Name |
Type |
Default Value |
Regular Expression |
Description |
|---|---|---|---|---|
|
|
|
Define this configuration section as a user. |
|
|
|
|
|
When set to yes, user is only authorized for read-only requests |
|
|
|
|
Crypted or plaintext password (see password_format) |
|
|
|
|
password_format may be set to plain (the default) or crypt. When set to crypt, crypt(3) is used to validate the password. A crypted password can be generated using mkpasswd -m sha-512. When set to plain, the password is in plaintext |
Configuration Option Descriptions
type
user- Configure this section as a user
Import Version
This documentation was imported from Asterisk Version SVN-branch-13-r420538