---
name: "cvm-mysql"
section: "8"
platform: "linux"
package: "cvm-mysql"
version: "0.97-3"
release: "Debian 12 (Bookworm)"
platforms: ["linux"]
url: "https://new.carta.tech/cvm-mysql"
---

# cvm-mysql(8)

MySQL module

## NAME

cvm-mysql - MySQL module

## SYNOPSIS

cvm-mysql

## CREDENTIALS

Pass phrase

## DESCRIPTION

This module queries a MySQL database for the account name, compares the stored pass phrase with the given one using [**crypt**(3)](/crypt/3.md).

## CONFIGURATION VARIABLES

- **CVM\_MYSQL\_DEFAULT\_FILE**

  The full path of the defaults file to read if the following variable is set. If not set, the file *$HOME/.my.cnf* will be read (the MySQL default).

- **CVM\_MYSQL\_DEFAULT\_GROUP**

  If set, the module will read connection default options from the named group in the defaults file as above

- **CVM\_MYSQL\_HOST**

  The hostname or IP of the MySQL server. If not set, a connection to the local host is assumed.

- **CVM\_MYSQL\_USER**

  The MySQL login ID to connect as. If not set, the invoking user is assumed.

- **CVM\_MYSQL\_PASS**

  The password for the above user.

- **CVM\_MYSQL\_DB**

  The database name, must be set.

- **CVM\_MYSQL\_PORT**

  The port number for the TCP/IP connection (only used if the server is not local).

- **CVM\_MYSQL\_POSTQ (optional)**

  The SQL query to execute after the credentials have been validated, see [**cvm-sql**(7)](/cvm-sql/7.md).

- **CVM\_MYSQL\_PWCMP (optional)**

  The *password comparison module* to use.

- **CVM\_MYSQL\_SOCKET**

  The path to the socket that should be used for connections to a local server.

- **CVM\_MYSQL\_QUERY (optional)**

  The SQL query to issue to retrieve the row containing the account information from the database, see [**cvm-sql**(7)](/cvm-sql/7.md).

## SEE ALSO

[cvm-sql(7)](/cvm-sql/7.md), [cvm-pgsql(8)](/cvm-pgsql/8.md), [cvm-pwfile(8)](/cvm-pwfile/8.md), [cvm-qmail(8)](/cvm-qmail/8.md), [cvm-unix(8)](/cvm-unix/8.md), [cvm-vmailmgr(8)](/cvm-vmailmgr/8.md), [cvm-benchclient(8)](/cvm-benchclient/8.md), [cvm-checkpassword(8)](/cvm-checkpassword/8.md), [cvm-testclient(8)](/cvm-testclient/8.md)

 http://untroubled.org/pwcmp/pwcmp.html\
  http://untroubled.org/cvm/cvm.html