doc/man-pages/pod8/upserver.pod

   1 =head1 NAME
   2
   3 upserver - Initializes the server portion of the Update Server
   4
   5 =head1 SYNOPSIS
   6
   7 B<upserver> [<I<directory>>+] [B<-crypt> <I<directory>>+]
   8     [B<-clear> <I<directory>>+] [B<-auth> <I<directory>>+] [B<-help>]
   9
  10 =head1 DESCRIPTION
  11
  12 The B<upserver> command initializes the server portion of the Update
  13 Server (the C<upserver> process). In the conventional configuration, its
  14 binary file is located in the F</usr/afs/bin> directory on a file server
  15 machine.
  16
  17 The B<upserver> command is not normally issued at the command shell prompt
  18 but rather placed into a file server machine's F</usr/afs/local/BosConfig>
  19 file with the B<bos create> command. If it is ever issued at the command
  20 shell prompt, the issuer must be logged onto a database server machine as
  21 the local superuser C<root>.
  22
  23 The B<upserver> command specifies which of the directories on the local
  24 disk are eligible for distribution in response to requests from the client
  25 portion of the Update Server (the B<upclient> process) running on other
  26 machines. If no directories are specified, the B<upserver> process
  27 distributes the contents of any directory on its local disk.
  28
  29 The B<upserver> process can distribute a directory's contents in encrypted
  30 or unencrypted form. By default, it does not use encryption unless an
  31 B<upclient> process requests it (this default is equivalent to setting the
  32 B<-clear> flag). When the B<-crypt> flag is provided, the B<upserver>
  33 process only fulfills requests for encrypted transfer.
  34
  35 The B<upclient> and B<upserver> processes always mutually authenticate,
  36 whether or not the data they pass is encrypted; they use the key with the
  37 highest key version number in the F</usr/afs/etc/KeyFile> file to
  38 construct a server ticket for mutual authentication.
  39
  40 This command does not use the syntax conventions of the AFS command
  41 suites. Provide the command name and all option names in full.
  42
  43 =head1 CAUTIONS
  44
  45 Do not use the Update Server to distribute the contents of the
  46 F</usr/afs/etc> directory without the B<-crypt> flag.  The contents of
  47 this directory are sensitive.
  48
  49 =head1 OPTIONS
  50
  51 =over 4
  52
  53 =item <I<directory>>+
  54
  55 Names each directory to distribute in unencrypted form (because they
  56 appear before the first B<-crypt> or B<-clear> flag on the command
  57 line). If this argument is omitted, all directories on the machine's local
  58 disk are eligible for distribution.
  59
  60 =item B<-crypt> <I<directory>>+
  61
  62 Precedes a list of one or more directories that the B<upserver> process
  63 distributes only in encrypted form.
  64
  65 =item B<-clear> <I<directory>>+
  66
  67 Precedes a list of one or more directories that the B<upserver> process
  68 distributes in unencrypted form unless the B<upclient> process requests
  69 them in encrypted form. Use this argument only if a list of directories
  70 headed by the B<-crypt> flag precedes it on the command line.
  71
  72 =item B<-auth> <I<directory>>+
  73
  74 Precedes a list of one or more directories which the upserver process
  75 distributes using a form of encryption that is intermediate in complexity
  76 and security between the unencrypted and encrypted levels set by the
  77 B<-clear> and B<-crypt> arguments. Do not use this argument, because the
  78 B<upclient> process does not have a corresponding argument that it can use
  79 to request data transfer at this level.
  80
  81 =item B<-help>
  82
  83 Prints the online help for this command. All other valid options are
  84 ignored.
  85
  86 =back
  87
  88 =head1 EXAMPLES
  89
  90 The following example bos create command defines and starts an B<upserver>
  91 process on the host machine C<fs1.abc.com>. The last parameter (enclosed
  92 in quotes) instructs the B<upserver> process to distribute the contents of
  93 the F</usr/afs/bin> directory in unencrypted form and the contents of the
  94 F</usr/afs/etc> directory in encrypted form.
  95
  96    % bos create  -server fs1.abc.com -instance upserver -type simple \
  97        -cmd "/usr/afs/bin/upserver /usr/afs/bin -crypt /usr/afs/etc"
  98
  99 =head1 PRIVILEGE REQUIRED
 100
 101 The issuer must be logged in as the superuser C<root> on a file server
 102 machine to issue the command at a command shell prompt. It is conventional
 103 instead to create and start the process by issuing the B<bos create>
 104 command.
 105
 106 =head1 SEE ALSO
 107
 108 L<BosConfig(5)>,
 109 L<bos_create(8)>,
 110 L<upclient(8)>
 111
 112 =head1 COPYRIGHT
 113
 114 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 115
 116 This documentation is covered by the IBM Public License Version 1.0.  It was
 117 converted from HTML to POD by software written by Chas Williams and Russ
 118 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.