doc/xml/AdminReference/sect8/upserver.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="upserver8">
   3   <refmeta>
   4     <refentrytitle>upserver</refentrytitle>
   5     <manvolnum>8</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>upserver</refname>
   9     <refpurpose>Initializes the server portion of the Update Server</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">upserver</emphasis> [&lt;<emphasis>directory</emphasis>&gt;+] [<emphasis role="bold">-crypt</emphasis> &lt;<emphasis>directory</emphasis>&gt;+]
  14         [<emphasis role="bold">-clear</emphasis> &lt;<emphasis>directory</emphasis>&gt;+] [<emphasis role="bold">-auth</emphasis> &lt;<emphasis>directory</emphasis>&gt;+] [<emphasis role="bold">-help</emphasis>]</para>
  15
  16   </refsect1>
  17   <refsect1>
  18     <title>Description</title>
  19     <para>The <emphasis role="bold">upserver</emphasis> command initializes the server portion of the Update
  20     Server (the <computeroutput>upserver</computeroutput> process). In the conventional configuration, its
  21     binary file is located in the <replaceable>/usr/afs/bin</replaceable> directory on a file server
  22     machine.</para>
  23
  24     <para>The <emphasis role="bold">upserver</emphasis> command is not normally issued at the command shell prompt
  25     but rather placed into a file server machine's <replaceable>/usr/afs/local/BosConfig</replaceable>
  26     file with the <emphasis role="bold">bos create</emphasis> command. If it is ever issued at the command
  27     shell prompt, the issuer must be logged onto a database server machine as
  28     the local superuser <computeroutput>root</computeroutput>.</para>
  29
  30     <para>The <emphasis role="bold">upserver</emphasis> command specifies which of the directories on the local
  31     disk are eligible for distribution in response to requests from the client
  32     portion of the Update Server (the <emphasis role="bold">upclient</emphasis> process) running on other
  33     machines. If no directories are specified, the <emphasis role="bold">upserver</emphasis> process
  34     distributes the contents of any directory on its local disk.</para>
  35
  36     <para>The <emphasis role="bold">upserver</emphasis> process can distribute a directory's contents in encrypted
  37     or unencrypted form. By default, it does not use encryption unless an
  38     <emphasis role="bold">upclient</emphasis> process requests it (this default is equivalent to setting the
  39     <emphasis role="bold">-clear</emphasis> flag). When the <emphasis role="bold">-crypt</emphasis> flag is provided, the <emphasis role="bold">upserver</emphasis>
  40     process only fulfills requests for encrypted transfer.</para>
  41
  42     <para>The <emphasis role="bold">upclient</emphasis> and <emphasis role="bold">upserver</emphasis> processes always mutually authenticate,
  43     whether or not the data they pass is encrypted; they use the key with the
  44     highest key version number in the <replaceable>/usr/afs/etc/KeyFile</replaceable> file to
  45     construct a server ticket for mutual authentication.</para>
  46
  47     <para>This command does not use the syntax conventions of the AFS command
  48     suites. Provide the command name and all option names in full.</para>
  49
  50   </refsect1>
  51   <refsect1>
  52     <title>Cautions</title>
  53     <para>Do not use the Update Server to distribute the contents of the
  54     <replaceable>/usr/afs/etc</replaceable> directory without the <emphasis role="bold">-crypt</emphasis> flag.  The contents of
  55     this directory are sensitive.</para>
  56
  57   </refsect1>
  58   <refsect1>
  59     <title>Options</title>
  60     <variablelist>
  61       <varlistentry>
  62         <term>&lt;<emphasis>directory</emphasis>&gt;+</term>
  63         <listitem>
  64           <para>Names each directory to distribute in unencrypted form (because they
  65           appear before the first <emphasis role="bold">-crypt</emphasis> or <emphasis role="bold">-clear</emphasis> flag on the command
  66           line). If this argument is omitted, all directories on the machine's local
  67           disk are eligible for distribution.</para>
  68
  69         </listitem>
  70       </varlistentry>
  71       <varlistentry>
  72         <term><emphasis role="bold">-crypt</emphasis> &lt;<emphasis>directory</emphasis>&gt;+</term>
  73         <listitem>
  74           <para>Precedes a list of one or more directories that the <emphasis role="bold">upserver</emphasis> process
  75           distributes only in encrypted form.</para>
  76
  77         </listitem>
  78       </varlistentry>
  79       <varlistentry>
  80         <term><emphasis role="bold">-clear</emphasis> &lt;<emphasis>directory</emphasis>&gt;+</term>
  81         <listitem>
  82           <para>Precedes a list of one or more directories that the <emphasis role="bold">upserver</emphasis> process
  83           distributes in unencrypted form unless the <emphasis role="bold">upclient</emphasis> process requests
  84           them in encrypted form. Use this argument only if a list of directories
  85           headed by the <emphasis role="bold">-crypt</emphasis> flag precedes it on the command line.</para>
  86
  87         </listitem>
  88       </varlistentry>
  89       <varlistentry>
  90         <term><emphasis role="bold">-auth</emphasis> &lt;<emphasis>directory</emphasis>&gt;+</term>
  91         <listitem>
  92           <para>Precedes a list of one or more directories which the upserver process
  93           distributes using a form of encryption that is intermediate in complexity
  94           and security between the unencrypted and encrypted levels set by the
  95           <emphasis role="bold">-clear</emphasis> and <emphasis role="bold">-crypt</emphasis> arguments. Do not use this argument, because the
  96           <emphasis role="bold">upclient</emphasis> process does not have a corresponding argument that it can use
  97           to request data transfer at this level.</para>
  98
  99         </listitem>
 100       </varlistentry>
 101       <varlistentry>
 102         <term><emphasis role="bold">-help</emphasis></term>
 103         <listitem>
 104           <para>Prints the online help for this command. All other valid options are
 105           ignored.</para>
 106
 107         </listitem>
 108       </varlistentry>
 109     </variablelist>
 110   </refsect1>
 111   <refsect1>
 112     <title>Examples</title>
 113     <para>The following example bos create command defines and starts an <emphasis role="bold">upserver</emphasis>
 114     process on the host machine <computeroutput>fs1.abc.com</computeroutput>. The last parameter (enclosed
 115     in quotes) instructs the <emphasis role="bold">upserver</emphasis> process to distribute the contents of
 116     the <replaceable>/usr/afs/bin</replaceable> directory in unencrypted form and the contents of the
 117     <replaceable>/usr/afs/etc</replaceable> directory in encrypted form.</para>
 118
 119 <programlisting>
 120    % bos create  -server fs1.abc.com -instance upserver -type simple \
 121        -cmd "/usr/afs/bin/upserver /usr/afs/bin -crypt /usr/afs/etc"
 122
 123 </programlisting>
 124     </refsect1>
 125     <refsect1>
 126       <title>Privilege Required</title>
 127       <para>The issuer must be logged in as the superuser <computeroutput>root</computeroutput> on a file server
 128       machine to issue the command at a command shell prompt. It is conventional
 129       instead to create and start the process by issuing the <emphasis role="bold">bos create</emphasis>
 130       command.</para>
 131
 132     </refsect1>
 133     <refsect1>
 134       <title>See Also</title>
 135       <para><link linkend="BosConfig5">BosConfig(5)</link>,
 136       <link linkend="bos_create8">bos_create(8)</link>,
 137       <link linkend="upclient8">upclient(8)</link></para>
 138
 139     </refsect1>
 140     <refsect1>
 141       <title>Copyright</title>
 142       <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 143
 144       <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 145       converted from HTML to POD by software written by Chas Williams and Russ
 146       Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 147
 148     </refsect1>
 149   </refentry>