mash_client.conf.5

NAME
{profile}.yaml - Configuration file for the mash client

DESCRIPTION
The mash client is the command line tool to interact with a mash server. The mash command by default reads a configuration file from ~/.config/mash_client. The mash client supports so called profiles. Each profile is represented by a configuration file in the configuration directory with the file name of profile.yaml. This allows a user of mash to configure multiple target mash servers and/or multiple users on a given mash server, if the target mash server supports multiple user configuration. The support of multiple users on the mash server is controlled by the mash server administrator. In most cases the mash server will be configured to use OIDC (Open ID Connect) in which case only a single user account per mash user should exist on the mash server. The configuration file syntax is YAML style expressed as key:value pairs.

email
    Set the e-mail for the mash user account to be used for this profile for authentication to the mash server. If the server is configured to use OIDC the client will set the value based on the e-mail from the OIDC server. Please check with your mash server administrator. Example email: foo@example.com

host
    The mash client communicates with the mash server using the http protocol. Depending on the server setup encrypted communication, i.e. https, is also supported. The host and port settings work in conjunction in that it is possible to specify a server configured for https as using the http protocol on port 443 (if the server runs TLS on the default port) or by specifying the host as using https, and not specifying the port configuration option, if the server accepts communication on the default TLS port of 443. Examples Using TLS on a non default port host: http//:127.0.0.1 port: 9045 Using TLS on the default port host: https://127.0.0.1

log_level
    Set the log level to use for submitted jobs. Log level values follow the Python log setting, https://docs.python.org/3/library/logging.html#levels Example log_level: 30

port
    The port setting works in conjunction with the host setting and is used to specify the port on which the mash server API is set up. Please check with the mash server administrator for this information. If the server uses the default port for the protocol (http or https) specified with the host setting the port value does not need to be set. Example port: 8080

no_color
    By default the output of the mash command is colorized. Setting this option to false enables ANSI colorized output to the terminal. Not all terminals support colorized output and this may lead to the output of control characters as part of the return of a mash command execution. Example no_color: false

verify
    In cases where the mash server is configured to use TLS server certificate validation is enabled by default. If the server has a self signed certificate and the certificate has not been imported into the system chain of trust mash commands will fail with a certificate verification error. Setting the verification to false disables certificate validation. Alternatively the value may also be a path to a specific certificate. This allows verification against a self signed certificate that has not been imported to the trust chain on the system. Examples verify: false verify: /home/my_user/mash_server_cert/mash_server.pem