summaryrefslogtreecommitdiffstats
path: root/proto/SQLITE_README.html
blob: 2cd36ad59caae926fee9061ef5408cc60c22be96 (plain)
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN"
        "http://www.w3.org/TR/html4/loose.dtd">

<html>

<head>

<title>Postfix SQLite Howto</title>

<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">

</head>

<body>

<h1><img src="postfix-logo.jpg" width="203" height="98" ALT="">Postfix SQLite Howto</h1>

<hr>

<h2>Introduction</h2>

<p> The Postfix sqlite map type allows you to hook up Postfix to a
SQLite database. This implementation allows for multiple sqlite
databases: you can use one for a virtual(5) table, one for an
access(5) table, and one for an aliases(5) table if you want.  </p>

<h2>Building Postfix with SQLite support</h2>

<p> The Postfix SQLite client utilizes the sqlite3 library,
which can be obtained from: </p>

<blockquote>
    <p> http://www.sqlite.org/ </p>
</blockquote>

<p> In order to build Postfix with sqlite map support, you will
need to add to CCARGS the flags -DHAS_SQLITE and -I with the directory
containing the sqlite header files, and you will need to add to
AUXLIBS the directory and name of the sqlite3 library, plus the
name of the standard POSIX thread library (pthread).  For example:
</p>

<blockquote>
<pre>
make -f Makefile.init makefiles \
     'CCARGS=-DHAS_SQLITE -I/usr/local/include' \
     'AUXLIBS_SQLITE=-L/usr/local/lib -lsqlite3 -lpthread'
</pre>
</blockquote>

<p> Postfix versions before 3.0 use AUXLIBS instead of AUXLIBS_SQLITE.
With Postfix 3.0 and later, the old AUXLIBS variable still supports
building a statically-loaded SQLite database client, but only the new
AUXLIBS_SQLITE variable supports building a dynamically-loaded or 
statically-loaded SQLite database client.  </p>

<blockquote>
 
<p> Failure to use the AUXLIBS_SQLITE variable will defeat the purpose
of dynamic database client loading. Every Postfix executable file
will have SQLITE database library dependencies. And that was exactly
what dynamic database client loading was meant to avoid. </p>
 
</blockquote>

<p> Then, just run 'make'.</p>

<h2>Using SQLite tables</h2>

<p> Once Postfix is built with sqlite support, you can specify a
map type in main.cf like this: </p>

<blockquote>
<pre>
alias_maps = sqlite:/etc/postfix/sqlite-aliases.cf
</pre>
</blockquote>

<p> The file /etc/postfix/sqlite-aliases.cf specifies lots of
information telling Postfix how to reference the sqlite database.
For a complete description, see the sqlite_table(5) manual page. </p>

<h2>Example: local aliases </h2>

<pre>
#
# sqlite config file for local(8) aliases(5) lookups
#

# Path to database 
dbpath = /some/path/to/sqlite_database

# See sqlite_table(5) for details.
query = SELECT forw_addr FROM mxaliases WHERE alias='%s' AND status='paid'
</pre>

<h2>Additional notes</h2>

<p> The SQLite configuration interface setup allows for multiple
sqlite databases: you can use one for a virtual table, one for an
access table, and one for an aliases table if you want. </p>

<h2>Credits</h2>

<p> SQLite support was added with Postfix version 2.8. </p>

<ul>

<li>Implementation by Axel Steiner</li>
<li>Documentation by Jesus Garcia Crespo</li>

</ul>

</body>

</html>