File: cvm-mysql.html

package info (click to toggle)
cvm 0.97-0.1
  • links: PTS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 1,036 kB
  • sloc: ansic: 4,065; sh: 2,758; makefile: 235; sql: 15
file content (65 lines) | stat: -rw-r--r-- 1,933 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
<html>
<body>

<h2><a href="cvm.html">CVM</a></h2>
<h2><a href="sql.html">CVM SQL Framework</a></h2>

<h1>The cvm-mysql Module</h1>

<h2>Synopsis:</h2> <p>MySQL module</p>

<h2>Credentials:</h2>

<ol>
<li>Pass phrase
</ol>

<h2>Description:</h2>

<p>This module queries a MySQL database for the account name, compares
the stored pass phrase with the given one using <tt>crypt</tt>.</p>

<h2>Configuration Variables:</h2>

<dl>

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

<dt><tt>$CVM_MYSQL_DEFAULT_GROUP</tt></dt> <dd>If set, the module will
read connection default options from the named group in the defaults
file as above.</dd>

<dt><tt>$CVM_MYSQL_HOST</tt></dt> <dd>The hostname or IP of the MySQL
server.  If not set, a connection to the local host is assumed.</dd>

<dt><tt>$CVM_MYSQL_USER</tt></dt> <dd>The MySQL login ID to connect as.
If not set, the invoking user is assumed.</dd>

<dt><tt>$CVM_MYSQL_PASS</tt></dt> <dd>The password for the above
user.</dd>

<dt><tt>$CVM_MYSQL_DB</tt></dt> <dd>The database name, must be set.</dd>

<dt><tt>$CVM_MYSQL_PORT</tt></dt> <dd>The port number for the TCP/IP
connection (only used if the server is not local).</dd>

<dt><tt>$CVM_MYSQL_POSTQ</tt> (optional)</dt> <dd>The <a
href="sql.html">SQL</a> query to execute after the credentials have been
validated.</dd>

<dt><tt>$CVM_MYSQL_PWCMP</tt> (optional)</dt> <dd>The <a
href="../pwcmp/pwcmp.html">password comparison module</a> to use.</dd>

<dt><tt>$CVM_MYSQL_SOCKET</tt></dt> <dd>The path to the socket that
should be used for connections to a local server.</dd>

<dt><tt>$CVM_MYSQL_QUERY</tt> (optional)</dt> <dd>The <a
href="sql.html">SQL</a> query to issue to retrieve the row containing
the account information from the database.</dd>

</dl>

</body>
</html>