/
fai.conf.5
155 lines (131 loc) · 4.96 KB
/
fai.conf.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
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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
.\" Hey, EMACS: -*- nroff -*-
.TH fai.conf 5 "December 2013" "FAI 4.0"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh disable hyphenation
.\" .hy enable hyphenation
.\" .ad l left justify
.\" .ad b justify to both left and right margins
.\" .nf disable filling
.\" .fi enable filling
.\" .br insert line break
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
fai.conf \- FAI Configuration
.SH SYNOPSIS
.B /etc/fai/fai.conf
.SH DESCRIPTION
The configuration for a target host consists of two parts:
.IP \(bu
The
\fINFSROOT\fP, a very basic yet complete root file system,
which is exported to clients.
The NFSROOT is built using
.BR fai-make-nfsroot (8).
.IP \(bu
The
\fIconfiguration space\fP, which is loaded as one of the first steps of a FAI run.
Several tools and protocols are supported for maintaining and accessing the
configuration space.
See
.BR FAI_CONFIG_SRC
below.
.LP
.BR fai.conf
defines the essential options to successfully start a FAI run.
It must be valid
.BR bash (1)
code.
This configuration file is NOT copied into the nfsroot by fai-make-nfsroot.
.SH VARIABLES
.TP
\fBFAI_CONFIG_SRC\fP
This variable defines how to access the configuration space. It
defines the protocol, the server and the location of the config space.
For an initial installation of a client this variable is defined by using fai-chboot(8).
If you do a fai softupdate, you can set the value in /etc/fai/fai.conf
or by using the option --cspace.
.LP
The following protocols and URL schemes are currently supported:
.IP \(bu
NFS: nfs://<server>/<exported directory>
Example: nfs://faiserver/srv/fai/config
.IP \(bu
Local directory: file://<directory>
The directory has to be an absolute path. So, this URL always starts
with three slashes like this: file:///
.IP \(bu
CVS: cvs[+ssh]://<user>@<host>/<cvs root> <module>[=<tag>]
The config space is received from a cvs checkout.
.IP \(bu
Subversion: svn[+(file|http|https|ssh)]://[<user>@]<host>/<repository>
The config space checked out from a subversion repository using
several protocol variants. Checkouts without a user name are also supported.
.IP \(bu
Git: git[+<protocol>]://<git path>
The config space checked out from a
git repository, host can be empty. Also supported is git+http.
.IP \(bu
Mercurial: hg+(http|https)://<hg path>
.IP \(bu
HTTP: (http|https|scp|sftp)://<server>/<filename>
where <filename> is a (compressed) tar archive.
The config space will be downloaded from the given location via the
specified protocol. <filename> will be extracted by ftar(8), and thus
needs to have a recognized suffix, such as .tar.gz or tar.xz.
.TP
\fBLOGUSER\fP Account name on the install server to save log files and call
.BR fai-chboot (8).
At the end of an installation,
.BR fai (8)
may connect to the install server using
.BR FAI_LOGPROTO
(see below) to store the generated log files and to change the network boot
configuration of the target host.
To fully enable this, configure .rhosts and PAM such that the configured user
can log in from all install clients without password.
This account should have write permissions for /srv/tftp/fai. For example, you
can use write permissions for the group linuxadm. chgrp linuxadm
/srv/tftp/fai;chmod g+w /srv/tftp/fai.
If the variable is undefined, this feature is disabled.
.TP
\fBFAI_LOGPROTO\fP Protocol for saving logs
Supported values are: ssh (default), rsh, ftp and none. This will only be used
if also
.BR LOGUSER
is set.
ssh: Use the scp command to copy the log files to the log server.
rsh: Use the rcp command to copy the log files to the log server.
ftp: This option saves logs to the remote FTP server defined by the
$LOGSERVER variable ($SERVER value is used if not set). Connection
to the FTP server is done as user $LOGUSER using password
$LOGPASSWD. The FTP server log directory is defined in
$LOGREMOTEDIR. These variables are also defined in file
'fai.conf'. You need write access for the $LOGREMOTEDIR on the FTP
server. All files in the directory /tmp/fai are copied to the
FTP server following this example:
ftp://$LOGUSER:$LOGPASSWD@$LOGSERVER/$LOGREMOTEDIR/
none: Don't save the log files to the install server.
.TP
\fBFAI_DEBMIRROR\fP Access Debian mirror via NFS-mounted directory
If defined, FAI mounts the NFS share to $MNTPOINT during installation.
Example: installserver:/srv/debianmirror
.TP
.B FAI_MONITOR_PORT
The port to which FAI sents messages, if the fai-monitor is
running. Default to 4711. See also fai-monitor(8). This variable has
to be set inside the nfsroot before the configuration space is
available.
.SH SEE ALSO
.BR fai (8),
.BR fai\-make-nfsroot (8),
.BR fai\-setup (8),
.BR fai\-mirror (1),
.BR fai\-cd (8)
.br
This file is part of FAI (Fully Automatic Installation). See the FAI
manual for more information. The FAI homepage is http://fai-project.org.
.SH AUTHOR
This man page was written by Michael Tautschnig <mt@debian.org>.