storj.io/minio@v0.0.0-20230509071714-0cbc90f649b1/cmd/logger/help.go (about)

     1  /*
     2   * MinIO Cloud Storage, (C) 2019 MinIO, Inc.
     3   *
     4   * Licensed under the Apache License, Version 2.0 (the "License");
     5   * you may not use this file except in compliance with the License.
     6   * You may obtain a copy of the License at
     7   *
     8   *     http://www.apache.org/licenses/LICENSE-2.0
     9   *
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.
    15   */
    16  
    17  package logger
    18  
    19  import (
    20  	"storj.io/minio/cmd/config"
    21  )
    22  
    23  // Help template for logger http and audit
    24  var (
    25  	Help = config.HelpKVS{
    26  		config.HelpKV{
    27  			Key:         Endpoint,
    28  			Description: `HTTP(s) endpoint e.g. "http://localhost:8080/minio/logs/server"`,
    29  			Type:        "url",
    30  		},
    31  		config.HelpKV{
    32  			Key:         AuthToken,
    33  			Description: `opaque string or JWT authorization token`,
    34  			Optional:    true,
    35  			Type:        "string",
    36  		},
    37  		config.HelpKV{
    38  			Key:         config.Comment,
    39  			Description: config.DefaultComment,
    40  			Optional:    true,
    41  			Type:        "sentence",
    42  		},
    43  	}
    44  
    45  	HelpAudit = config.HelpKVS{
    46  		config.HelpKV{
    47  			Key:         Endpoint,
    48  			Description: `HTTP(s) endpoint e.g. "http://localhost:8080/minio/logs/audit"`,
    49  			Type:        "url",
    50  		},
    51  		config.HelpKV{
    52  			Key:         AuthToken,
    53  			Description: `opaque string or JWT authorization token`,
    54  			Optional:    true,
    55  			Type:        "string",
    56  		},
    57  		config.HelpKV{
    58  			Key:         config.Comment,
    59  			Description: config.DefaultComment,
    60  			Optional:    true,
    61  			Type:        "sentence",
    62  		},
    63  		config.HelpKV{
    64  			Key:         ClientCert,
    65  			Description: "mTLS certificate for Audit Webhook authentication",
    66  			Optional:    true,
    67  			Type:        "string",
    68  		},
    69  		config.HelpKV{
    70  			Key:         ClientKey,
    71  			Description: "mTLS certificate key for Audit Webhook authentication",
    72  			Optional:    true,
    73  			Type:        "string",
    74  		},
    75  	}
    76  )