1 '\" te
   2 .\" Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH FTPSERVERS 4 "May 1, 2003"
   7 .SH NAME
   8 ftpservers \- FTP Server virtual hosting configuration file
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 /etc/ftpd/ftpservers
  13 .fi
  14 
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBftpservers\fR file is used to configure complete virtual hosting. In
  19 contrast to limited virtual hosting, complete virtual hosting allows separate
  20 configuration files to be specified for each virtual host.
  21 .sp
  22 .LP
  23 The set of configuration files for each virtual host are placed in their own
  24 directory. The \fBftpservers\fR file associates the address of each virtual
  25 host with the directory its configuration files are stored in. The virtual host
  26 configuration files must be named:
  27 .sp
  28 .ne 2
  29 .na
  30 \fB\fBftpaccess\fR\fR
  31 .ad
  32 .RS 18n
  33 Virtual host's access file
  34 .RE
  35 
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fBftpusers\fR\fR
  40 .ad
  41 .RS 18n
  42 Restricts the accounts that can use the virtual host
  43 .RE
  44 
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fBftpgroups\fR\fR
  49 .ad
  50 .RS 18n
  51 Virtual hosts enhanced group access file
  52 .RE
  53 
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fBftphosts\fR\fR
  58 .ad
  59 .RS 18n
  60 Allow or deny usernames access to the virtual host
  61 .RE
  62 
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fBftpconversions\fR\fR
  67 .ad
  68 .RS 18n
  69 Customize conversions available from the virtual host
  70 .RE
  71 
  72 .sp
  73 .LP
  74 You do not need to put every file in each virtual host directory. If you want a
  75 virtual host to use the master copy of a file, then do not include it in the
  76 virtual host directory. If the file is not included, the master copy from the
  77 \fB/etc/ftpd\fR directory will be used.
  78 .sp
  79 .LP
  80 The file names must match exactly. If you misspell any of  them or name them
  81 differently, the server will not find them, and the server will use the master
  82 copy instead.
  83 .sp
  84 .LP
  85 The \fBftpaddhost\fR utility is an administrative tool to configure virtual
  86 hosts. See \fBftpaddhost\fR(1M).
  87 .SS "File Format"
  88 .sp
  89 .LP
  90 There are two fields to each entry in the \fBftpservers\fR file:
  91 .sp
  92 .in +2
  93 .nf
  94 address   directory-containing-configuration-files
  95 .fi
  96 .in -2
  97 
  98 .sp
  99 .LP
 100 For example:
 101 .sp
 102 .in +2
 103 .nf
 104 10.196.145.10    /etc/ftpd/virtual-ftpd/10.196.145.10
 105 10.196.145.200   /etc/ftpd//virtual-ftpd/10.196.145.200
 106 some.domain      INTERNAL
 107 .fi
 108 .in -2
 109 
 110 .sp
 111 .LP
 112 When an FTP client connects to the FTP Server, \fBin.ftpd\fR(1M) tries to match
 113 the IP address to which the FTP client connected with one found in the
 114 \fBftpservers\fR file.
 115 .sp
 116 .LP
 117 The \fBaddress\fR can be an IPv4 or IPv6 address, or a hostname.
 118 .sp
 119 .LP
 120 If a match is found, The FTP server uses any configuration files found in the
 121 associated directory.
 122 .sp
 123 .LP
 124 If a match is not found,  or an invalid directory path is encountered,  the
 125 default paths to the configuration files are used. The use of \fBINTERNAL\fR in
 126 the example above fails the check for a specific directory, and the master
 127 configuration files will be used.
 128 .sp
 129 .LP
 130 Either the actual IP address or a specific hostname can be used to specify the
 131 virtual host. It is better to specify the actual IP of the virtual host, as it
 132 reduces the need for a domain lookup and eliminates DNS security related naming
 133 issues, for example:
 134 .sp
 135 .in +2
 136 .nf
 137 10.196.145.20     /etc/ftpd/config/faqs.org/
 138 ftp.some.domain   /etc/ftpd/config/faqs.org/
 139 .fi
 140 .in -2
 141 
 142 .sp
 143 .LP
 144 Lines that begin with a \fB#\fR sign are treated as comment lines and are
 145 ignored.
 146 .SH FILES
 147 .sp
 148 .ne 2
 149 .na
 150 \fB/etc/ftpd/ftpservers\fR
 151 .ad
 152 .RS 24n
 153 
 154 .RE
 155 
 156 .SH ATTRIBUTES
 157 .sp
 158 .LP
 159 See \fBattributes\fR(5)  for descriptions of the following attributes:
 160 .sp
 161 
 162 .sp
 163 .TS
 164 box;
 165 c | c
 166 l | l .
 167 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 168 _
 169 Interface Stability     External
 170 .TE
 171 
 172 .SH SEE ALSO
 173 .sp
 174 .LP
 175 \fBftpaddhost\fR(1M), \fBin.ftpd\fR(1M), \fBftpaccess\fR(4),
 176 \fBftpconversions\fR(4), \fBftpgroups\fR(4), \fBftphosts\fR(4),
 177 \fBftpusers\fR(4), \fBattributes\fR(5)