docs(authn): optimize i18n in authn

This commit is contained in:
zhouzb 2022-04-26 15:10:44 +08:00
parent 9f35dd7f80
commit a863dcb61d
12 changed files with 411 additions and 473 deletions

View File

@ -2,212 +2,212 @@ emqx_authn_api {
authentication_get { authentication_get {
desc { desc {
en: """List authenticators for global authentication""" en: """List authenticators for global authentication."""
zh: """列出全局认证链上的认证器信息""" zh: """列出全局认证链上的认证器"""
} }
} }
authentication_post { authentication_post {
desc { desc {
en: """Create authenticator for global authentication""" en: """Create authenticator for global authentication."""
zh: """为全局认证链创建认证器信息""" zh: """为全局认证链创建认证器"""
} }
} }
authentication_id_get { authentication_id_get {
desc { desc {
en: """Get authenticator from global authentication chain""" en: """Get authenticator from global authentication chain."""
zh: """获取全局认证链上指定的认证器信息""" zh: """获取全局认证链上的指定认证器。"""
} }
} }
authentication_id_put { authentication_id_put {
desc { desc {
en: """Update authenticator from global authentication chain""" en: """Update authenticator from global authentication chain."""
zh: """更新全局认证链上指定认证器""" zh: """更新全局认证链上指定认证器"""
} }
} }
authentication_id_delete { authentication_id_delete {
desc { desc {
en: """Delete authenticator from global authentication chain""" en: """Delete authenticator from global authentication chain."""
zh: """删除全局认证链上指定的认证器信息""" zh: """删除全局认证链上的指定认证器。"""
} }
} }
authentication_id_status_get { authentication_id_status_get {
desc { desc {
en: """Get authenticator status from global authentication chain""" en: """Get authenticator status from global authentication chain."""
zh: """获取全局认证链上指定认证器状态""" zh: """获取全局认证链上指定认证器状态"""
} }
} }
listeners_listener_id_authentication_get { listeners_listener_id_authentication_get {
desc { desc {
en: """List authenticators for listener authentication""" en: """List authenticators for listener authentication."""
zh: """列出监听器上的认证器信息""" zh: """列出监听器认证链上的认证器。"""
} }
} }
listeners_listener_id_authentication_post { listeners_listener_id_authentication_post {
desc { desc {
en: """Create authenticator for listener authentication""" en: """Create authenticator for listener authentication."""
zh: """在指定的监听器上创建认证器""" zh: """在监听器认证链上创建认证器"""
} }
} }
listeners_listener_id_authentication_id_get { listeners_listener_id_authentication_id_get {
desc { desc {
en: """Get authenticator from listener authentication chain""" en: """Get authenticator from listener authentication chain."""
zh: """获取监听器上指定的认证器信息""" zh: """获取监听器认证链上的指定认证器。"""
} }
} }
listeners_listener_id_authentication_id_put { listeners_listener_id_authentication_id_put {
desc { desc {
en: """Update authenticator from listener authentication chain""" en: """Update authenticator from listener authentication chain."""
zh: """更新监听器上指定认证器""" zh: """更新监听器认证链指定认证器"""
} }
} }
listeners_listener_id_authentication_id_delete { listeners_listener_id_authentication_id_delete {
desc { desc {
en: """Delete authenticator from listener authentication chain""" en: """Delete authenticator from listener authentication chain."""
zh: """删除监听器上指定认证器""" zh: """删除监听器认证链指定认证器"""
} }
} }
listeners_listener_id_authentication_id_status_get { listeners_listener_id_authentication_id_status_get {
desc { desc {
en: """Get authenticator status from listener authentication chain""" en: """Get authenticator status from listener authentication chain."""
zh: """获取监听器上指定认证器状态""" zh: """获取监听器认证链上指定认证器状态"""
} }
} }
authentication_id_move_post { authentication_id_move_post {
desc { desc {
en: """Move authenticator in global authentication chain""" en: """Move authenticator in global authentication chain."""
zh: """移动全局认证链上认证器的顺序""" zh: """更改全局认证链上指定认证器的顺序。"""
} }
} }
listeners_listener_id_authentication_id_move_post { listeners_listener_id_authentication_id_move_post {
desc { desc {
en: """Move authenticator in listener authentication chain""" en: """Move authenticator in listener authentication chain."""
zh: """移动监听器上认证器的顺序""" zh: """更改监听器认证链上指定认证器的顺序。"""
} }
} }
authentication_id_import_users_post { authentication_id_import_users_post {
desc { desc {
en: """Import users into authenticator in global authentication chain""" en: """Import users into authenticator in global authentication chain."""
zh: """为全局认证链上的认证器导入用户数据""" zh: """为全局认证链上的指定认证器导入用户数据"""
} }
} }
listeners_listener_id_authentication_id_import_users_post { listeners_listener_id_authentication_id_import_users_post {
desc { desc {
en: """Import users into authenticator in listener authentication chain""" en: """Import users into authenticator in listener authentication chain."""
zh: """为监听器上的认证器导入用户数据""" zh: """为监听器认证链上的指定认证器导入用户数据"""
} }
} }
authentication_id_users_post { authentication_id_users_post {
desc { desc {
en: """Create users for authenticator in global authentication chain""" en: """Create users for authenticator in global authentication chain."""
zh: """为全局认证链上的认证器创建用户数据""" zh: """为全局认证链上的指定认证器创建用户数据"""
} }
} }
authentication_id_users_get { authentication_id_users_get {
desc { desc {
en: """List users in authenticator in global authentication chain""" en: """List users in authenticator in global authentication chain."""
zh: """获取全局认证链上指定认证器中的用户数据""" zh: """获取全局认证链上指定认证器中的用户数据"""
} }
} }
listeners_listener_id_authentication_id_users_post { listeners_listener_id_authentication_id_users_post {
desc { desc {
en: """Create users for authenticator in listener authentication chain""" en: """Create users for authenticator in listener authentication chain."""
zh: """更新指定监听器上认证器中的用户数据""" zh: """为监听器认证链上的指定认证器创建用户数据。"""
} }
} }
listeners_listener_id_authentication_id_users_get { listeners_listener_id_authentication_id_users_get {
desc { desc {
en: """List users in authenticator in listener authentication chain""" en: """List users in authenticator in listener authentication chain."""
zh: """列出指定监听器上认证器中的用户数据""" zh: """列出监听器认证链指定认证器中的用户数据"""
} }
} }
authentication_id_users_user_id_get { authentication_id_users_user_id_get {
desc { desc {
en: """Get user from authenticator in global authentication chain""" en: """Get user from authenticator in global authentication chain."""
zh: """获取指定监听器上认证器中指定用户数据""" zh: """获取全局认证链上指定认证器中指定用户数据"""
} }
} }
authentication_id_users_user_id_put { authentication_id_users_user_id_put {
desc { desc {
en: """Update user in authenticator in global authentication chain""" en: """Update user in authenticator in global authentication chain."""
zh: """为指定监听器上认证器添加用户数据""" zh: """更新全局认证链上指定认证器中的指定用户数据。"""
} }
} }
authentication_id_users_user_id_delete { authentication_id_users_user_id_delete {
desc { desc {
en: """Update user in authenticator in global authentication chain""" en: """Delete user in authenticator in global authentication chain."""
zh: """更新指定监听器上认证器中的用户数据""" zh: """删除全局认证链上指定认证器中的指定用户数据。"""
} }
} }
listeners_listener_id_authentication_id_users_user_id_get { listeners_listener_id_authentication_id_users_user_id_get {
desc { desc {
en: """Get user from authenticator in listener authentication chain""" en: """Get user from authenticator in listener authentication chain."""
zh: """获取指定监听器上认证器中指定用户数据""" zh: """获取监听器认证链指定认证器中指定用户数据"""
} }
} }
listeners_listener_id_authentication_id_users_user_id_put { listeners_listener_id_authentication_id_users_user_id_put {
desc { desc {
en: """Update user in authenticator in listener authentication chain""" en: """Update user in authenticator in listener authentication chain."""
zh: """更新指定监听器上认证器中的用户数据""" zh: """更新监听器认证链指定认证器中的指定用户数据"""
} }
} }
listeners_listener_id_authentication_id_users_user_id_delete { listeners_listener_id_authentication_id_users_user_id_delete {
desc { desc {
en: """Delete user in authenticator in listener authentication chain""" en: """Delete user in authenticator in listener authentication chain."""
zh: """删除指定监听器上认证器中的用户数据""" zh: """删除监听器认证链指定认证器中的指定用户数据"""
} }
} }
param_auth_id { param_auth_id {
desc { desc {
en: """Authenticator ID""" en: """Authenticator ID."""
zh: """认证器 ID""" zh: """认证器 ID"""
} }
} }
param_listener_id { param_listener_id {
desc { desc {
en: """Listener ID""" en: """Listener ID."""
zh: """监听器 ID""" zh: """监听器 ID"""
} }
} }
param_user_id { param_user_id {
desc { desc {
en: """User ID""" en: """User ID."""
zh: """用户 ID""" zh: """用户 ID"""
} }
} }
like_username { like_username {
desc { desc {
en: """Fuzzy search username""" en: """Fuzzy search username."""
zh: """使用用户名模糊查询""" zh: """使用用户名模糊查询"""
} }
label { label {
en: """like_username""" en: """like_username"""
@ -217,8 +217,8 @@ emqx_authn_api {
like_clientid { like_clientid {
desc { desc {
en: """Fuzzy search clientid""" en: """Fuzzy search clientid."""
zh: """使用客户端标识符模糊查询""" zh: """使用客户端标识符模糊查询"""
} }
label { label {
en: """like_clientid""" en: """like_clientid"""

View File

@ -1,88 +1,80 @@
emqx_authn_http { emqx_authn_http {
get { get {
desc { desc {
en: """Settings for HTTP-based authentication (GET).""" en: """Configuration of authenticator using HTTP Server as authentication service (Using GET request)."""
zh: """基于 HTTP 的认证请求 (GET)""" zh: """使用 HTTP Server 作为认证服务的认证器的配置项 (使用 GET 请求)。"""
}
label: {
en: """get"""
zh: """get"""
} }
} }
post { post {
desc { desc {
en: """Settings for HTTP-based authentication (POST).""" en: """Configuration of authenticator using HTTP Server as authentication service (Using POST request)."""
zh: """基于 HTTP 的认证请求 (POST)""" zh: """使用 HTTP Server 作为认证服务的认证器的配置项 (使用 POST 请求)。"""
}
label: {
en: """post"""
zh: """post"""
} }
} }
method { method {
desc { desc {
en: """HTTP method.""" en: """HTTP request method."""
zh: """HTTP 请求方法""" zh: """HTTP 请求方法"""
} }
label: { label: {
en: """method""" en: """Request Method"""
zh: """请求方法""" zh: """请求方法"""
} }
} }
url { url {
desc { desc {
en: """URL of the auth server.""" en: """URL of the HTTP server."""
zh: """认证服务器地址""" zh: """HTTP 服务器地址。"""
} }
label: { label: {
en: """url""" en: """URL"""
zh: """统一资源定位符""" zh: """URL"""
} }
} }
headers { headers {
desc { desc {
en: """List of HTTP headers.""" en: """HTTP request headers."""
zh: """HTTP 请求头列表""" zh: """HTTP request headers。"""
} }
label: { label: {
en: """headers""" en: """Request Headers"""
zh: """请求头""" zh: """Request Headers"""
} }
} }
headers_no_content_type { headers_no_content_type {
desc { desc {
en: """List of HTTP headers. (without <code>content-type</code>)""" en: """HTTP request headers (without <code>content-type</code>)."""
zh: """HTTP 请求头列表(无 <code>content-type</code>)""" zh: """HTTP request headers无 <code>content-type</code>)。"""
} }
label: { label: {
en: """headers_no_content_type""" en: """Request Headers"""
zh: """无content_type的请求头""" zh: """Request Headers"""
} }
} }
body { body {
desc { desc {
en: """Body of the HTTP request.""" en: """HTTP request body."""
zh: """HTTP 请求体""" zh: """HTTP request body。"""
} }
label: { label: {
en: """body""" en: """Request Body"""
zh: """请求体""" zh: """Request Body"""
} }
} }
request_timeout { request_timeout {
desc { desc {
en: """HTTP request timeout""" en: """HTTP request timeout."""
zh: """HTTP 请求超时时长""" zh: """HTTP 请求超时时长"""
} }
label: { label: {
en: """request_timeout""" en: """Request Timeout"""
zh: """请求超时时间""" zh: """请求超时时间"""
} }
} }

View File

@ -1,155 +0,0 @@
emqx_authn_schema {
enable {
desc {
en: """Set to <code>true</code> or <code>false</code> to disable this auth provider"""
zh: """设为 <code>true</code> 或 <code>false</code> 以启用或禁用此认证数据源"""
}
label: {
en: """enable"""
zh: """启用"""
}
}
mechanism {
desc {
en: """Authentication mechanism."""
zh: """认证机制"""
}
label: {
en: """mechanism"""
zh: """机制"""
}
}
backend {
desc {
en: """Backend type."""
zh: """后端类型"""
}
label: {
en: """backend"""
zh: """后端"""
}
}
metrics {
desc {
en: """The metrics of the resource"""
zh: """统计指标"""
}
label: {
en: """metrics"""
zh: """指标"""
}
}
node_metrics {
desc {
en: """The metrics of the resource for each node"""
zh: """每个节点上资源的统计指标"""
}
label: {
en: """node_metrics"""
zh: """节点指标"""
}
}
status {
desc {
en: """The status of the resource"""
zh: """资源状态"""
}
label: {
en: """status"""
zh: """状态"""
}
}
node_status {
desc {
en: """The status of the resource for each node"""
zh: """每个节点上资源的状态"""
}
label: {
en: """node_status"""
zh: """节点状态"""
}
}
matched {
desc {
en: """Count of this resource is queried"""
zh: """请求命中次数"""
}
label: {
en: """matched"""
zh: """已命中"""
}
}
success {
desc {
en: """Count of query success"""
zh: """请求成功次数"""
}
label: {
en: """success"""
zh: """成功"""
}
}
failed {
desc {
en: """Count of query failed"""
zh: """请求失败次数"""
}
label: {
en: """failed"""
zh: """失败"""
}
}
rate {
desc {
en: """The rate of matched, times/second"""
zh: """命中速率,单位: 次/秒"""
}
label: {
en: """rate"""
zh: """速率"""
}
}
rate_max {
desc {
en: """The max rate of matched, times/second"""
zh: """最大命中速率,单位: 次/秒"""
}
label: {
en: """rate_max"""
zh: """最大速率"""
}
}
rate_last5m {
desc {
en: """The average rate of matched in the last 5 minutes, times/second"""
zh: """5分钟内平均命中速率单位 次/秒"""
}
label: {
en: """rate_last5m"""
zh: """5分钟内速率"""
}
}
node {
desc {
en: """The node name"""
zh: """节点名"""
}
label: {
en: """node"""
zh: """节点"""
}
}
}

View File

@ -1,30 +1,30 @@
emqx_authn_jwt { emqx_authn_jwt {
use_jwks { use_jwks {
desc { desc {
en: """JWKs flag""" en: """Whether to use JWKS."""
zh: """jwks 状态""" zh: """是否使用 JWKS。"""
} }
label { label {
en: """use_jwks""" en: """Whether to Use JWKS"""
zh: """使用jwks""" zh: """是否使用 JWKS"""
} }
} }
algorithm { algorithm {
desc { desc {
en: """Signing algorithm.""" en: """JWT signing algorithm, Supports HMAC (configured as <code>hmac-based</code>) and RSA, ECDSA (configured as <code>public-key</code>)."""
zh: """签名算法""" zh: """JWT 签名算法,支持 HMAC (配置为 <code>hmac-based</code>)和 RSA、ECDSA (配置为 <code>public-key</code>)。"""
} }
label { label {
en: """Algorithm""" en: """JWT Signing Algorithm"""
zh: """算法""" zh: """JWT 签名算法"""
} }
} }
certificate { certificate {
desc { desc {
en: """The certificate used for signing the token.""" en: """The public key used to verify the JWT."""
zh: """用于签名token的证书""" zh: """用于验证 JWT 的公钥。"""
} }
label { label {
en: """Certificate""" en: """Certificate"""
@ -34,52 +34,52 @@ emqx_authn_jwt {
secret_base64_encoded { secret_base64_encoded {
desc { desc {
en: """Enable/disable base64 encoding of the secret.""" en: """Whether secret is base64 encoded."""
zh: """启用/关闭私私钥 base64 编码""" zh: """密钥是否为 Base64 编码。"""
} }
label { label {
en: """Secret with base64 encoded""" en: """Whether Secret is Base64 Encoded"""
zh: """密钥 base64 编码""" zh: """密钥是否为 Base64 编码"""
} }
} }
secret { secret {
desc { desc {
en: """The key to verify the JWT Token using HMAC algorithm.""" en: """The key to verify the JWT using HMAC algorithm."""
zh: """使用对称加密的算法""" zh: """使用 HMAC 算法时用于验证 JWT 的密钥"""
} }
label { label {
en: """Secret""" en: """Secret"""
zh: """密钥""" zh: """Secret"""
} }
} }
endpoint { endpoint {
desc { desc {
en: """JWKs endpoint""" en: """JWKS endpoint, it's a read-only endpoint that returns the server's public key set in the JWKS format."""
zh: """JWKs endpoint""" zh: """JWKS 端点, 它是一个以 JWKS 格式返回服务端的公钥集的只读端点。"""
} }
label { label {
en: """Endpoint""" en: """JWKS Endpoint"""
zh: """Endpoint""" zh: """JWKS Endpoint"""
} }
} }
refresh_interval { refresh_interval {
desc { desc {
en: """JWKs refresh interval""" en: """JWKS refresh interval."""
zh: """JWKs 更新间隔""" zh: """JWKS 刷新间隔。"""
} }
label { label {
en: """Refresh Interval""" en: """JWKS Refresh Interval"""
zh: """新间隔""" zh: """JWKS 刷新间隔"""
} }
} }
cacertfile { cacertfile {
desc { desc {
en: """Path to the SSL CA certificate file.""" en: """Path to a file containing PEM-encoded CA certificates."""
zh: """SSL CA 证书公钥文件路径""" zh: """包含 PEM 编码的 CA 证书的文件的路径。"""
} }
label { label {
en: """CA Certificate File""" en: """CA Certificate File"""
@ -89,8 +89,8 @@ emqx_authn_jwt {
certfile { certfile {
desc { desc {
en: """Path to the SSL certificate file.""" en: """Path to a file containing the user certificate."""
zh: """证书文件路径""" zh: """包含用户证书文件路径"""
} }
label { label {
en: """Certificate File""" en: """Certificate File"""
@ -100,8 +100,8 @@ emqx_authn_jwt {
keyfile { keyfile {
desc { desc {
en: """Path to the SSL secret key file.""" en: """Path to a file containing the user's private PEM-encoded key."""
zh: """SSL 私钥文件路径""" zh: """包含 PEM 编码的用户私钥的文件的路径。"""
} }
label { label {
en: """Key File""" en: """Key File"""
@ -112,7 +112,7 @@ emqx_authn_jwt {
verify { verify {
desc { desc {
en: """Enable or disable SSL peer verification.""" en: """Enable or disable SSL peer verification."""
zh: """指定握手过程中是否校验客户端""" zh: """指定握手过程中是否校验对端证书。"""
} }
label { label {
en: """Verify""" en: """Verify"""
@ -122,8 +122,8 @@ emqx_authn_jwt {
server_name_indication { server_name_indication {
desc { desc {
en: """SSL SNI (Server Name Indication)""" en: """Server Name Indication (SNI), ."""
zh: """SSL SNI (服务器名称指示)""" zh: """服务器名称指示SNI未指定时将使用 <code>endpoint</code> 作为 SNI。"""
} }
label { label {
en: """Server Name Indication""" en: """Server Name Indication"""
@ -144,8 +144,8 @@ emqx_authn_jwt {
pool_size { pool_size {
desc { desc {
en: """JWKs connection count""" en: """JWKS connection count."""
zh: """JWKs 连接数量""" zh: """JWKS 连接数量。"""
} }
label { label {
en: """Pool Size""" en: """Pool Size"""
@ -156,7 +156,7 @@ emqx_authn_jwt {
ssl { ssl {
desc { desc {
en: """SSL options.""" en: """SSL options."""
zh: """SSL 选项""" zh: """SSL 选项"""
} }
label { label {
en: """SSL Options""" en: """SSL Options"""
@ -167,66 +167,46 @@ emqx_authn_jwt {
enable { enable {
desc { desc {
en: """Enable/disable SSL.""" en: """Enable/disable SSL."""
zh: """启用/禁用 SSL""" zh: """启用/禁用 SSL"""
} }
label { label {
en: """Enable/disable SSL.""" en: """Enable/disable SSL"""
zh: """启用/禁用 SSL""" zh: """启用/禁用 SSL"""
} }
} }
hmac-based { hmac-based {
desc { desc {
en: """Settings for HMAC-based token signing algorithm.""" en: """Configuration when the JWT for authentication is issued using the HMAC algorithm."""
zh: """HMAC-based token 签名配置""" zh: """用于认证的 JWT 使用 HMAC 算法签发时的配置。"""
}
label {
en: """hmac-based"""
zh: """hmac-based"""
} }
} }
public-key { public-key {
desc { desc {
en: """Settings for public key-based token signing algorithm.""" en: """Configuration when the JWT for authentication is issued using RSA or ECDSA algorithm."""
zh: """公钥token签名配置""" zh: """用于认证的 JWT 使用 RSA 或 ECDSA 算法签发时的配置。"""
}
label {
en: """public-key"""
zh: """public-key"""
} }
} }
jwks { jwks {
desc { desc {
en: """Settings for a signing using JSON Web Key Set (JWKs).""" en: """Configuration when JWTs used for authentication need to be fetched from the JWKS endpoint."""
zh: """JWks 签名配置""" zh: """用于认证的 JWTs 需要从 JWKS 端点获取时的配置。"""
}
label {
en: """jwks"""
zh: """jwks"""
} }
} }
ssl_disable { ssl_disable {
desc { desc {
en: """SSL disabled""" en: """SSL configuration."""
zh: """SSL 关闭""" zh: """SSL 配置。"""
}
label {
en: """ssl_disable"""
zh: """关闭SSL"""
} }
} }
ssl_enable { ssl_enable {
desc { desc {
en: """SSL configuration.""" en: """SSL configuration."""
zh: """SSL 配置""" zh: """SSL 配置。"""
}
label {
en: """ssl_enable"""
zh: """启用SSL"""
} }
} }
} }

View File

@ -1,23 +1,21 @@
emqx_authn_mnesia { emqx_authn_mnesia {
authentication { authentication {
desc { desc {
en: """Configuration for authentication using the built-in database.""" en: """Configuration of authenticator using built-in database as authentication data source."""
zh: """内置数据库认证配置""" zh: """使用内置数据库作为认证数据源的认证器的配置项。"""
}
label: {
en: """authentication"""
zh: """认证配置"""
} }
} }
user_id_type { user_id_type {
desc { desc {
en: """Authenticate by Client ID or Username.""" en: """Specify whether to use ClientID or Username as User ID for authentication."""
zh: """认证类型,基于 Client ID 或 Username""" zh: """指定使用 ClientID 还是 Username 作为 User ID 进行认证。"""
} }
label: { label: {
en: """user_id_type""" en: """User ID Type"""
zh: """用户标识类型""" zh: """用户 ID 类型"""
} }
} }
} }

View File

@ -1,99 +0,0 @@
emqx_authn_mongodb {
standalone {
desc {
en: """Configuration for a standalone MongoDB instance."""
zh: """MongoDB 单节点认证配置"""
}
label: {
en: """standalone"""
zh: """standalone 模式"""
}
}
replica-set {
desc {
en: """Configuration for a replica set."""
zh: """MongoDB replica set 模式认证配置"""
}
label: {
en: """replica-set"""
zh: """replica-set 模式"""
}
}
sharded-cluster {
desc {
en: """Configuration for a sharded cluster."""
zh: """MongoDB sharded cluster 模式认证配置"""
}
label: {
en: """sharded-cluster"""
zh: """sharded-cluster 模式"""
}
}
collection {
desc {
en: """Collection used to store authentication data."""
zh: """认证数据集名称"""
}
label: {
en: """collection"""
zh: """数据集"""
}
}
selector {
desc {
en: """
Statement that is executed during the authentication process.
Commands can support following wildcards:\n
- `${username}`: substituted with client's username\n
- `${clientid}`: substituted with the clientid
"""
zh: """
认证过程中所使用的查询命令。
查询命令支持如下占位符:
- `${username}`: 代替客户端的用户名
- `${clientid}`: 代替客户端的客户端标识符
"""
}
label: {
en: """selector"""
zh: """认证查询"""
}
}
password_hash_field {
desc {
en: """Document field that contains password hash."""
zh: """数据文档中的密码散列值"""
}
label: {
en: """password_hash_field"""
zh: """密码散列字段"""
}
}
salt_field {
desc {
en: """Document field that contains the password salt."""
zh: """数据文档中的密码加盐"""
}
label: {
en: """salt_field"""
zh: """加盐字段"""
}
}
is_superuser_field {
desc {
en: """Document field that defines if the user has superuser privileges."""
zh: """数据文档中的超级用户权限记录"""
}
label: {
en: """is_superuser_field"""
zh: """超级用户字段"""
}
}
}

View File

@ -0,0 +1,87 @@
emqx_authn_mongodb {
standalone {
desc {
en: """Configuration of authenticator using MongoDB (Standalone) as authentication data source."""
zh: """使用 MongoDB (Standalone) 作为认证数据源的认证器的配置项。"""
}
}
replica-set {
desc {
en: """Configuration of authenticator using MongoDB (Replica Set) as authentication data source."""
zh: """使用 MongoDB (Replica Set) 作为认证数据源的认证器的配置项。"""
}
}
sharded-cluster {
desc {
en: """Configuration of authenticator using MongoDB (Sharded Cluster) as authentication data source."""
zh: """使用 MongoDB (Sharded Cluster) 作为认证数据源的认证器的配置项。"""
}
}
collection {
desc {
en: """Collection used to store authentication data."""
zh: """存储认证数据的集合。"""
}
label: {
en: """Collection"""
zh: """集合"""
}
}
selector {
desc {
en: """
Statement that is executed during the authentication process.
Commands can support following wildcards:\n
- `${username}`: substituted with client's username\n
- `${clientid}`: substituted with the clientid
"""
zh: """
认证过程中所使用的查询命令。
查询命令支持如下占位符:
- `${username}`: 将在运行时被替换为客户端连接时使用的用户名
- `${clientid}`: 将在运行时被替换为客户端连接时使用的客户端标识符
"""
}
label: {
en: """Selector"""
zh: """查询"""
}
}
password_hash_field {
desc {
en: """Document field that contains password hash."""
zh: """文档中用于存放密码散列的字段。"""
}
label: {
en: """Password Hash Field"""
zh: """密码散列字段"""
}
}
salt_field {
desc {
en: """Document field that contains the password salt."""
zh: """文档中用于存放盐值的字段。"""
}
label: {
en: """Salt Field"""
zh: """盐值字段"""
}
}
is_superuser_field {
desc {
en: """Document field that defines if the user has superuser privileges."""
zh: """文档中用于定义用户是否具有超级用户权限的字段。"""
}
label: {
en: """Is Superuser Field"""
zh: """超级用户字段"""
}
}
}

View File

@ -1,34 +1,30 @@
emqx_authn_mysql { emqx_authn_mysql {
authentication { authentication {
desc { desc {
en: """Configuration for authentication using MySQL database.""" en: """Configuration of authenticator using MySQL as authentication data source."""
zh: """MySQL 认证配置""" zh: """使用 MySQL 作为认证数据源的认证器的配置项。"""
}
label: {
en: """Authentication Options"""
zh: """认证配置"""
} }
} }
query { query {
desc { desc {
en: """SQL query used to lookup client data.""" en: """SQL used to query data for authentication, such as password hash."""
zh: """客户端数据查询 SQL 语句""" zh: """用于查询密码散列等用于认证的数据的 SQL 语句。"""
} }
label: { label: {
en: """SQL Query""" en: """Query"""
zh: """SQL 查询语句""" zh: """查询语句"""
} }
} }
query_timeout { query_timeout {
desc { desc {
en: """Timeout for the SQL query.""" en: """Timeout for the SQL query."""
zh: """SQL 查询超时时长""" zh: """SQL 查询的超时时间。"""
} }
label: { label: {
en: """Query Timeout""" en: """Query Timeout"""
zh: """请求超时""" zh: """查询超时"""
} }
} }
} }

View File

@ -1,23 +1,19 @@
emqx_authn_pgsql { emqx_authn_pgsql {
authentication { authentication {
desc { desc {
en: """Configuration for PostgreSQL authentication backend.""" en: """Configuration of authenticator using PostgreSQL as authentication data source."""
zh: """PostgreSQL 认证配置""" zh: """使用 PostgreSQL 作为认证数据源的认证器的配置项。"""
}
label: {
en: """authentication"""
zh: """认证配置"""
} }
} }
query { query {
desc { desc {
en: """`SQL` query for looking up authentication data.""" en: """SQL used to query data for authentication, such as password hash."""
zh: """客户端数据查询 SQL 语句""" zh: """用于查询密码散列等用于认证的数据的 SQL 语句。"""
} }
label: { label: {
en: """query""" en: """Query"""
zh: """请求""" zh: """查询语句"""
} }
} }
} }

View File

@ -1,45 +1,33 @@
emqx_authn_redis { emqx_authn_redis {
standalone { standalone {
desc { desc {
en: """Configuration for a standalone Redis instance.""" en: """Configuration of authenticator using Redis (Standalone) as authentication data source."""
zh: """Redis 单节点认证配置""" zh: """使用 Redis (Standalone) 作为认证数据源的认证器的配置项。"""
}
label: {
en: """standalone"""
zh: """standalone"""
} }
} }
cluster { cluster {
desc { desc {
en: """Configuration for a Redis cluster.""" en: """Configuration of authenticator using Redis (Cluster) as authentication data source."""
zh: """Redis 集群模式认证配置""" zh: """使用 Redis (Cluster) 作为认证数据源的认证器的配置项。"""
}
label: {
en: """cluster"""
zh: """cluster"""
} }
} }
sentinel { sentinel {
desc { desc {
en: """Configuration for a Redis Sentinel.""" en: """Configuration of authenticator using Redis (Sentinel) as authentication data source."""
zh: """Redis 哨兵模式认证配置""" zh: """使用 Redis (Sentinel) 作为认证数据源的认证器的配置项。"""
}
label: {
en: """sentinel"""
zh: """sentinel"""
} }
} }
cmd { cmd {
desc { desc {
en: """Database query used to retrieve authentication data.""" en: """The Redis Command used to query data for authentication such as password hash, currently only supports HGET and HMGET."""
zh: """Redis 认证数据查询语句""" zh: """用于查询密码散列等用于认证的数据的 Redis Command目前仅支持 HGET 与 HMGET。"""
} }
label: { label: {
en: """cmd""" en: """Command"""
zh: """查询命令""" zh: """Command"""
} }
} }
} }

View File

@ -0,0 +1,155 @@
emqx_authn_schema {
enable {
desc {
en: """Set to <code>true</code> or <code>false</code> to disable this auth provider."""
zh: """设为 <code>true</code> 或 <code>false</code> 以启用或禁用此认证数据源。"""
}
label: {
en: """Enable"""
zh: """启用"""
}
}
mechanism {
desc {
en: """Authentication mechanism."""
zh: """认证机制。"""
}
label: {
en: """Authentication Mechanism"""
zh: """认证机制"""
}
}
backend {
desc {
en: """Backend type."""
zh: """后端类型。"""
}
label: {
en: """Backend Type"""
zh: """后端类型"""
}
}
metrics {
desc {
en: """The metrics of the resource."""
zh: """资源统计指标。"""
}
label: {
en: """Metrics"""
zh: """指标"""
}
}
node_metrics {
desc {
en: """The metrics of the resource for each node."""
zh: """每个节点上资源的统计指标。"""
}
label: {
en: """Resource Metrics in Node"""
zh: """节点资源指标"""
}
}
status {
desc {
en: """The status of the resource."""
zh: """资源状态。"""
}
label: {
en: """Status"""
zh: """状态"""
}
}
node_status {
desc {
en: """The status of the resource for each node."""
zh: """每个节点上资源的状态。"""
}
label: {
en: """Resource Status in Node"""
zh: """节点资源状态"""
}
}
matched {
desc {
en: """Count of this resource is queried."""
zh: """请求命中次数。"""
}
label: {
en: """Matched"""
zh: """已命中"""
}
}
success {
desc {
en: """Count of query success."""
zh: """请求成功次数。"""
}
label: {
en: """Success"""
zh: """成功"""
}
}
failed {
desc {
en: """Count of query failed."""
zh: """请求失败次数。"""
}
label: {
en: """Failed"""
zh: """失败"""
}
}
rate {
desc {
en: """The rate of matched, times/second."""
zh: """命中速率,单位:次/秒。"""
}
label: {
en: """Rate"""
zh: """速率"""
}
}
rate_max {
desc {
en: """The max rate of matched, times/second."""
zh: """最大命中速率,单位:次/秒。"""
}
label: {
en: """Max Rate"""
zh: """最大速率"""
}
}
rate_last5m {
desc {
en: """The average rate of matched in the last 5 minutes, times/second."""
zh: """5分钟内平均命中速率单位次/秒。"""
}
label: {
en: """Rate in Last 5min"""
zh: """5分钟内速率"""
}
}
node {
desc {
en: """Node name."""
zh: """节点名称。"""
}
label: {
en: """Node Name."""
zh: """节点名称。"""
}
}
}

View File

@ -3,7 +3,7 @@
##-------------------------------------------------------------------- ##--------------------------------------------------------------------
dashboard { dashboard {
default_username = "admin" default_username = "test"
default_password = "public" default_password = "public"
## Note: sample_interval should be a divisor of 60. ## Note: sample_interval should be a divisor of 60.
## like 1s, 2s, 3s, 5s, 10s, 12s, 15s, 20s, 30s, 60s ## like 1s, 2s, 3s, 5s, 10s, 12s, 15s, 20s, 30s, 60s