yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(schema): Add descriptions of events

This commit is contained in:
ieQu1 2022-03-23 09:51:51 +01:00
parent 617022f276
commit d1e8fefa1f
1 changed files with 23 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
apps/emqx/src/emqx_schema.erl
View File

@ -1288,22 +1288,34 @@ fields("event_names") ->
{"client_connected", {"client_connected",
sc( sc(
boolean(), boolean(),
#{default => true} #{
default => true,
desc => "Connection complete"
}
)}, )},
{"client_disconnected", {"client_disconnected",
sc( sc(
boolean(), boolean(),
#{default => true} #{
default => true,
desc => "Disconnect"
}
)}, )},
{"client_subscribed", {"client_subscribed",
sc( sc(
boolean(), boolean(),
#{default => false} #{
default => false,
desc => "Subscribe"
}
)}, )},
{"client_unsubscribed", {"client_unsubscribed",
sc( sc(
boolean(), boolean(),
#{default => false} #{
default => false,
desc => "Unsubscribe"
}
)} )}
]; ];
fields("sysmon") -> fields("sysmon") ->
@ -1589,10 +1601,8 @@ fields("alarm") ->
default => "24h", default => "24h",
example => "24h", example => "24h",
desc => desc =>
""
"Retention time of deactivated alarms. Alarms are not deleted immediately\n" "Retention time of deactivated alarms. Alarms are not deleted immediately\n"
"when deactivated, but after the retention time.\n" "when deactivated, but after the retention time.\n"
""
} }
)} )}
]; ];
@ -1757,7 +1767,7 @@ common_ssl_opts_schema(Defaults) ->
"issue chain. That is, the host's certificate should be placed in the beginning\n" "issue chain. That is, the host's certificate should be placed in the beginning\n"
"of the file, followed by the immediate issuer certificate and so on.\n" "of the file, followed by the immediate issuer certificate and so on.\n"
"Although the root CA certificate is optional, it should be placed at the end of\n" "Although the root CA certificate is optional, it should be placed at the end of\n"
"the file if it is to be added.\n" "the file if it is to be added."
} }
)}, )},
{"keyfile", {"keyfile",
@ -1767,7 +1777,7 @@ common_ssl_opts_schema(Defaults) ->
default => D("keyfile"), default => D("keyfile"),
required => false, required => false,
desc => desc =>
"PEM format private key file.<br>\n" "PEM format private key file."
} }
)}, )},
{"verify", {"verify",
@ -1805,7 +1815,7 @@ common_ssl_opts_schema(Defaults) ->
"All TLS/DTLS versions to be supported.<br>\n" "All TLS/DTLS versions to be supported.<br>\n"
"NOTE: PSK ciphers are suppressed by 'tlsv1.3' version config<br>\n" "NOTE: PSK ciphers are suppressed by 'tlsv1.3' version config<br>\n"
"In case PSK cipher suites are intended, make sure to configured\n" "In case PSK cipher suites are intended, make sure to configured\n"
"<code>['tlsv1.2', 'tlsv1.1']</code> here.\n", "<code>['tlsv1.2', 'tlsv1.1']</code> here.",
validator => fun validate_tls_versions/1 validator => fun validate_tls_versions/1
} }
)}, )},
@ -1827,7 +1837,7 @@ common_ssl_opts_schema(Defaults) ->
"SSL parameter renegotiation is a feature that allows a client and a server\n" "SSL parameter renegotiation is a feature that allows a client and a server\n"
"to renegotiate the parameters of the SSL connection on the fly.\n" "to renegotiate the parameters of the SSL connection on the fly.\n"
"RFC 5746 defines a more secure way of doing this. By enabling secure renegotiation,\n" "RFC 5746 defines a more secure way of doing this. By enabling secure renegotiation,\n"
"you drop support for the insecure renegotiation, prone to MitM attacks.\n" "you drop support for the insecure renegotiation, prone to MitM attacks."
} }
)} )}
]. ].
@ -1864,7 +1874,7 @@ server_ssl_opts_schema(Defaults, IsRanchListener) ->
"If set to true, the server fails if the client does not have a\n" "If set to true, the server fails if the client does not have a\n"
"certificate to send, that is, sends an empty certificate.\n" "certificate to send, that is, sends an empty certificate.\n"
"If set to false, it fails only if the client sends an invalid\n" "If set to false, it fails only if the client sends an invalid\n"
"certificate (an empty certificate is considered valid).\n" "certificate (an empty certificate is considered valid)."
} }
)}, )},
{"honor_cipher_order", {"honor_cipher_order",
@ -1887,7 +1897,7 @@ server_ssl_opts_schema(Defaults, IsRanchListener) ->
"this option to false.\n" "this option to false.\n"
"The default value is true. Note that disabling renegotiation can result in\n" "The default value is true. Note that disabling renegotiation can result in\n"
"long-lived connections becoming unusable due to limits on\n" "long-lived connections becoming unusable due to limits on\n"
"the number of messages the underlying cipher suite can encipher.\n" "the number of messages the underlying cipher suite can encipher."
} }
)} )}
| [ | [
@ -1980,8 +1990,7 @@ ciphers_schema(Default) ->
"PSK cipher suites: <code>\"RSA-PSK-AES256-GCM-SHA384,RSA-PSK-AES256-CBC-SHA384,\n" "PSK cipher suites: <code>\"RSA-PSK-AES256-GCM-SHA384,RSA-PSK-AES256-CBC-SHA384,\n"
"RSA-PSK-AES128-GCM-SHA256,RSA-PSK-AES128-CBC-SHA256,\n" "RSA-PSK-AES128-GCM-SHA256,RSA-PSK-AES128-CBC-SHA256,\n"
"RSA-PSK-AES256-CBC-SHA,RSA-PSK-AES128-CBC-SHA,\n" "RSA-PSK-AES256-CBC-SHA,RSA-PSK-AES128-CBC-SHA,\n"
"RSA-PSK-DES-CBC3-SHA,RSA-PSK-RC4-SHA\"</code><br>\n" "RSA-PSK-DES-CBC3-SHA,RSA-PSK-RC4-SHA\"</code><br>\n" ++
"" ++
case Default of case Default of
quic -> "NOTE: QUIC listener supports only 'tlsv1.3' ciphers<br>"; quic -> "NOTE: QUIC listener supports only 'tlsv1.3' ciphers<br>";
_ -> "" _ -> ""