summaryrefslogtreecommitdiff
path: root/usr/src/man/man4/ftpservers.4
blob: 743c85d0382d425be0c0cfc85405eddcba0309ea (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
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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
'\" te
.\" Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH FTPSERVERS 4 "May 1, 2003"
.SH NAME
ftpservers \- FTP Server virtual hosting configuration file
.SH SYNOPSIS
.LP
.nf
/etc/ftpd/ftpservers
.fi

.SH DESCRIPTION
.sp
.LP
The \fBftpservers\fR file is used to configure complete virtual hosting. In
contrast to limited virtual hosting, complete virtual hosting allows separate
configuration files to be specified for each virtual host.
.sp
.LP
The set of configuration files for each virtual host are placed in their own
directory. The \fBftpservers\fR file associates the address of each virtual
host with the directory its configuration files are stored in. The virtual host
configuration files must be named:
.sp
.ne 2
.na
\fB\fBftpaccess\fR\fR
.ad
.RS 18n
Virtual host's access file
.RE

.sp
.ne 2
.na
\fB\fBftpusers\fR\fR
.ad
.RS 18n
Restricts the accounts that can use the virtual host
.RE

.sp
.ne 2
.na
\fB\fBftpgroups\fR\fR
.ad
.RS 18n
Virtual hosts enhanced group access file
.RE

.sp
.ne 2
.na
\fB\fBftphosts\fR\fR
.ad
.RS 18n
Allow or deny usernames access to the virtual host
.RE

.sp
.ne 2
.na
\fB\fBftpconversions\fR\fR
.ad
.RS 18n
Customize conversions available from the virtual host
.RE

.sp
.LP
You do not need to put every file in each virtual host directory. If you want a
virtual host to use the master copy of a file, then do not include it in the
virtual host directory. If the file is not included, the master copy from the
\fB/etc/ftpd\fR directory will be used.
.sp
.LP
The file names must match exactly. If you misspell any of  them or name them
differently, the server will not find them, and the server will use the master
copy instead.
.sp
.LP
The \fBftpaddhost\fR utility is an administrative tool to configure virtual
hosts. See \fBftpaddhost\fR(1M).
.SS "File Format"
.sp
.LP
There are two fields to each entry in the \fBftpservers\fR file:
.sp
.in +2
.nf
address   directory-containing-configuration-files
.fi
.in -2

.sp
.LP
For example:
.sp
.in +2
.nf
10.196.145.10    /etc/ftpd/virtual-ftpd/10.196.145.10
10.196.145.200   /etc/ftpd//virtual-ftpd/10.196.145.200
some.domain      INTERNAL
.fi
.in -2

.sp
.LP
When an FTP client connects to the FTP Server, \fBin.ftpd\fR(1M) tries to match
the IP address to which the FTP client connected with one found in the
\fBftpservers\fR file.
.sp
.LP
The \fBaddress\fR can be an IPv4 or IPv6 address, or a hostname.
.sp
.LP
If a match is found, The FTP server uses any configuration files found in the
associated directory.
.sp
.LP
If a match is not found,  or an invalid directory path is encountered,  the
default paths to the configuration files are used. The use of \fBINTERNAL\fR in
the example above fails the check for a specific directory, and the master
configuration files will be used.
.sp
.LP
Either the actual IP address or a specific hostname can be used to specify the
virtual host. It is better to specify the actual IP of the virtual host, as it
reduces the need for a domain lookup and eliminates DNS security related naming
issues, for example:
.sp
.in +2
.nf
10.196.145.20     /etc/ftpd/config/faqs.org/
ftp.some.domain   /etc/ftpd/config/faqs.org/
.fi
.in -2

.sp
.LP
Lines that begin with a \fB#\fR sign are treated as comment lines and are
ignored.
.SH FILES
.sp
.ne 2
.na
\fB/etc/ftpd/ftpservers\fR
.ad
.RS 24n

.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5)  for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	External
.TE

.SH SEE ALSO
.sp
.LP
\fBftpaddhost\fR(1M), \fBin.ftpd\fR(1M), \fBftpaccess\fR(4),
\fBftpconversions\fR(4), \fBftpgroups\fR(4), \fBftphosts\fR(4),
\fBftpusers\fR(4), \fBattributes\fR(5)