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