max_bandwidth and allowed_bandwidth are provided in bits, but allowed_bandwidth may also be a percentage value of max_bandwidth.
max_bandwidth must be greater than allowed_bandwidth.
allowed_bandwidth defines the maximum total data transfer within one second.
If the combined transfer of all users exceeds allowed_bandwidth, the relay stops establishing new connections.
A user attempting to connect through an overloaded relay will receive a 503 error - relay full.
Example:
If the configuration fields are set to (max_bandwidth is set to 1Gbps):
{
"tlsEnabled": true,
"key": "G:\\remotly-connection-state-server\\key.pem",
"cert": "G:\\remotly-connection-state-server\\crt.pem",
"forceTLS": true,
"domain": "<your relay domain name>",
"port": 443,
"max_bandwidth": 1000000000,
"allowed_bandwidth": "75%",
"auth_timeout": "5s",
"password": "PasswordPasswordPasswordPassword"
}
then the allowed_bandwidth in MB is:
(1000000000 / 8) * 0.75 / 1024 * 1024 = 89.4MB/s
If the total data transfer of all users already connected to the relay exceeds this value, new users attempting to connect through this relay in Remotly will receive a 503 code indicating that the relay is overloaded.
Once the transfer drops below this threshold, new connections will become possible again.
auth_timeout - Read timeout for requests sent to the relay; it does not apply to an already established connection between users through the relay.
max_bandwidth must be greater than allowed_bandwidth.
allowed_bandwidth defines the maximum total data transfer within one second.
If the combined transfer of all users exceeds allowed_bandwidth, the relay stops establishing new connections.
A user attempting to connect through an overloaded relay will receive a 503 error - relay full.
Example:
If the configuration fields are set to (max_bandwidth is set to 1Gbps):
{
"tlsEnabled": true,
"key": "G:\\remotly-connection-state-server\\key.pem",
"cert": "G:\\remotly-connection-state-server\\crt.pem",
"forceTLS": true,
"domain": "<your relay domain name>",
"port": 443,
"max_bandwidth": 1000000000,
"allowed_bandwidth": "75%",
"auth_timeout": "5s",
"password": "PasswordPasswordPasswordPassword"
}
then the allowed_bandwidth in MB is:
(1000000000 / 8) * 0.75 / 1024 * 1024 = 89.4MB/s
If the total data transfer of all users already connected to the relay exceeds this value, new users attempting to connect through this relay in Remotly will receive a 503 code indicating that the relay is overloaded.
Once the transfer drops below this threshold, new connections will become possible again.
auth_timeout - Read timeout for requests sent to the relay; it does not apply to an already established connection between users through the relay.