Update release date.
[aox:aox.git] / doc / installer.man
1 .\" Copyright 2009 The Archiveopteryx Developers <info@aox.org>
2 .TH installer 8 2009-07-13 aox.org "Archiveopteryx Documentation"
3 .SH NAME
4 installer - Archiveopteryx installer.
5 .SH SYNOPSIS
6 .B $LIBDIR/installer
7 [
8 .I -n
9 ] [
10 .I -q
11 ] [
12 .I -v
13 ] ...
14 .SH DESCRIPTION
15 .nh
16 .PP
17 This program does the following:
18 .PP
19 1. Creates a Unix group named $AOXGROUP.
20 .PP
21 2. Creates a Unix user named $AOXUSER.
22 .PP
23 3. Creates a Postgres user named $AOXUSER.
24 .PP
25 4. Creates a Postgres user named $DBOWNER.
26 .PP
27 5. Creates a Postgres database named $DBNAME owned by $DBOWNER.
28 .PP
29 6. Loads the database schema and grants limited privileges to user $AOXUSER.
30 .PP
31 7. Generates an initial configuration file.
32 .PP
33 8. Adjusts ownership and permissions if necessary.
34 .PP
35 .B installer
36 should be run after
37 .I "jam install"
38 when installing from source.
39 .PP
40 By default, the address of the PostgreSQL server is derived from the
41 compile-time
42 .I DBADDRESS
43 setting in the
44 .I Jamsettings
45 file (which is
46 .I $DBADDRESS
47 by default). If the
48 .I db-address
49 variable is set in an existing configuration file, that value takes
50 precedence. If the
51 .I -a
52 command-line flag is used, then the address specified has precedence
53 over either of the former values.
54 .PP
55 If the server address (as determined above) is
56 .IR 127.0.0.1 ,
57 the installer will try to use a Unix domain socket to connect to the
58 server. The location of this socket is determined by the
59 .I -s socket
60 command-line argument. If no socket is specified, the default named
61 socket location (
62 .IR /tmp/.s.PGSQL.5432 )
63 is used instead.
64 For any other server address, the installer will try to use a Unix
65 domain socket only if one is explicitly specified with
66 .IR -s .
67 In any case, if password authentication is to be used when talking to
68 the server, the
69 .I -P
70 option will cause the installer to prompt for the password.
71 .SH OPTIONS
72 .IP -q
73 Suppresses all normal output.
74 .IP -v
75 Makes the output more verbose (may be repeated).
76 .IP -n
77 Causes the program to report what it would do, but not actually do
78 anything.
79 .IP "-g group"
80 Allows you to specify a Unix group other than the default of $AOXGROUP.
81 .IP "-u user"
82 Allows you to specify a Unix username other than the default of
83 $AOXUSER.
84 .IP "-p postgres"
85 Allows you to specify the name of the PostgreSQL superuser. The default
86 is to try $PGUSER (if set), postgres and pgsql in turn.
87 .IP "-P"
88 Instructs the installer to prompt for and read the PostgreSQL
89 superuser's password, and be prepared to use that for authentication (if
90 necessary).
91 .IP "-a address"
92 Allows you to specify a different address for the Postgres server. The
93 default is $DBADDRESS.
94 .IP "-s /path/to/socket"
95 Allows you to specify a location for the PostgreSQL server's Unix-domain
96 listening socket. The specified value is used as described above.
97 .IP "-t port"
98 Allows you to specify a different port for the Postgres server. The
99 default is 5432. (This value is used only if the server address does
100 not refer to a Unix socket.)
101 .IP "-d dbname"
102 Allows you to specify a database to use. The default is
103 .IR $DBNAME .
104 .IP "-S schema"
105 Allows you to specify a schema where the Archiveopteryx database objects
106 will be installed. If this is not specified, objects are installed into
107 the
108 .I $DBSCHEMA
109 schema.
110 .IP
111 Please do not use
112 .I -S
113 unless you are sure you understand all its implications. It is safe to
114 ignore it entirely if you don't.
115 .PP
116 The defaults come from
117 .IR Jamsettings .
118 .SH DIAGNOSTICS
119 The return code is zero if all goes well, and a non-zero in case of
120 errors. Disasters are logged via stderr.
121 .SH AUTHOR
122 The Archiveopteryx Developers, info@aox.org.
123 .SH VERSION
124 This man page covers Archiveopteryx version 3.1.2, released 2009-07-13,
125 http://www.archiveopteryx.org/3.1.2
126 .SH SEE ALSO
127 .BR archiveopteryx (8),
128 .BR archiveopteryx.conf (5),
129 .BR logd (8),
130 .BR tlsproxy (8),
131 http://www.archiveopteryx.org