doc/xml/QuickStartUnix/auqbg005.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <chapter id="HDRWQ17">
   3   <title>Installing the First AFS Machine</title>
   4
   5   <indexterm>
   6     <primary>file server machine</primary>
   7
   8     <seealso>first AFS machine</seealso>
   9
  10     <seealso>file server machine, additional</seealso>
  11   </indexterm>
  12
  13   <indexterm>
  14     <primary>instructions</primary>
  15
  16     <secondary>first AFS machine</secondary>
  17   </indexterm>
  18
  19   <indexterm>
  20     <primary>installing</primary>
  21
  22     <secondary>first AFS machine</secondary>
  23   </indexterm>
  24
  25   <para>This chapter describes how to install the first AFS machine in your cell, configuring it as both a file server machine and a
  26   client machine. After completing all procedures in this chapter, you can remove the client functionality if you wish, as described
  27   in <link linkend="HDRWQ98">Removing Client Functionality</link>.</para>
  28
  29   <para>To install additional file server machines after completing this chapter, see <link linkend="HDRWQ99">Installing Additional
  30   Server Machines</link>.</para>
  31
  32   <para>To install additional client machines after completing this chapter, see <link linkend="HDRWQ133">Installing Additional
  33   Client Machines</link>. <indexterm>
  34       <primary>requirements</primary>
  35
  36       <secondary>first AFS machine</secondary>
  37     </indexterm></para>
  38
  39   <sect1 id="Header_29">
  40     <title>Requirements and Configuration Decisions</title>
  41
  42     <para>The instructions in this chapter assume that you meet the following requirements.
  43       <itemizedlist>
  44         <listitem>
  45           <para>You are logged onto the machine's console as the local superuser <emphasis role="bold">root</emphasis></para>
  46         </listitem>
  47
  48         <listitem>
  49           <para>A standard version of one of the operating systems supported by the current version of AFS is running on the
  50           machine</para>
  51         </listitem>
  52
  53         <listitem>
  54           <para>You have either installed the provided OpenAFS packages for
  55           your system, have access to a binary distribution tarball, or have
  56           successfully built OpenAFS from source</para>
  57         </listitem>
  58
  59         <listitem>
  60           <para>You have a Kerberos v5 realm running for your site. If you are
  61           working with an existing cell which uses
  62           <emphasis role="bold">kaserver</emphasis> or Kerberos v4 for
  63           authentication, please see
  64           <link linkend="KAS001">kaserver and Legacy Kerberos v4 Authentication</link>
  65           for the modifications required to this installation procedure.</para>
  66         </listitem>
  67
  68         <listitem>
  69           <para>You have a NTP, or similar, time service deployed to ensure
  70           rough clock syncronistation between your clients and servers. If you
  71           wish to use AFS's built in timeservice (which is deprecated) please
  72           see Appendix B for the necessary modifications to this installation
  73           procedure.</para>
  74         </listitem>
  75       </itemizedlist></para>
  76
  77     <para>You must make the following configuration decisions while installing the first AFS machine. To speed the installation
  78     itself, it is best to make the decisions before beginning. See the chapter in the <emphasis>OpenAFS Administration
  79     Guide</emphasis> about issues in cell administration and configuration for detailed guidelines. <indexterm>
  80         <primary>cell name</primary>
  81
  82         <secondary>choosing</secondary>
  83       </indexterm> <indexterm>
  84         <primary>AFS filespace</primary>
  85
  86         <secondary>deciding how to configure</secondary>
  87       </indexterm> <indexterm>
  88         <primary>filespace</primary>
  89
  90         <see>AFS filespace</see>
  91       </indexterm> <itemizedlist>
  92         <listitem>
  93           <para>Select the first AFS machine</para>
  94         </listitem>
  95
  96         <listitem>
  97           <para>Select the cell name</para>
  98         </listitem>
  99
 100         <listitem>
 101           <para>Decide which partitions or logical volumes to configure as AFS server partitions, and choose the directory names on
 102           which to mount them</para>
 103         </listitem>
 104
 105         <listitem>
 106           <para>Decide how big to make the client cache</para>
 107         </listitem>
 108
 109         <listitem>
 110           <para>Decide how to configure the top levels of your cell's AFS filespace</para>
 111         </listitem>
 112       </itemizedlist></para>
 113
 114     <para>This chapter is divided into three large sections corresponding to the three parts of installing the first AFS machine.
 115     Perform all of the steps in the order they appear. Each functional section begins with a summary of the procedures to perform.
 116     The sections are as follows: <itemizedlist>
 117         <listitem>
 118           <para>Installing server functionality (begins in <link linkend="HDRWQ18">Overview: Installing Server
 119           Functionality</link>)</para>
 120         </listitem>
 121
 122         <listitem>
 123           <para>Installing client functionality (begins in <link linkend="HDRWQ63">Overview: Installing Client
 124           Functionality</link>)</para>
 125         </listitem>
 126
 127         <listitem>
 128           <para>Configuring your cell's filespace, establishing further security mechanisms, and enabling access to foreign cells
 129           (begins in <link linkend="HDRWQ71">Overview: Completing the Installation of the First AFS Machine</link>)</para>
 130         </listitem>
 131       </itemizedlist></para>
 132
 133     <indexterm>
 134       <primary>overview</primary>
 135
 136       <secondary>installing server functionality on first AFS machine</secondary>
 137     </indexterm>
 138
 139     <indexterm>
 140       <primary>first AFS machine</primary>
 141
 142       <secondary>server functionality</secondary>
 143     </indexterm>
 144
 145     <indexterm>
 146       <primary>installing</primary>
 147
 148       <secondary>server functionality</secondary>
 149
 150       <tertiary>first AFS machine</tertiary>
 151     </indexterm>
 152   </sect1>
 153
 154   <sect1 id="HDRWQ18">
 155     <title>Overview: Installing Server Functionality</title>
 156
 157     <para>In the first phase of installing your cell's first AFS machine, you install file server and database server functionality
 158     by performing the following procedures:
 159     <orderedlist>
 160         <listitem>
 161           <para>Choose which machine to install as the first AFS machine</para>
 162         </listitem>
 163
 164         <listitem>
 165           <para>Create AFS-related directories on the local disk</para>
 166         </listitem>
 167
 168         <listitem>
 169           <para>Incorporate AFS modifications into the machine's kernel</para>
 170         </listitem>
 171
 172         <listitem>
 173           <para>Configure partitions or logical volumes for storing AFS volumes</para>
 174         </listitem>
 175
 176         <listitem>
 177           <para>On some system types, install and configure an AFS-modified version of the <emphasis role="bold">fsck</emphasis>
 178           program</para>
 179         </listitem>
 180
 181         <listitem>
 182           <para>If the machine is to remain a client machine, incorporate AFS into its authentication system</para>
 183         </listitem>
 184
 185         <listitem>
 186           <para>Start the Basic OverSeer (BOS) Server</para>
 187         </listitem>
 188
 189         <listitem>
 190           <para>Define the cell name and the machine's cell membership</para>
 191         </listitem>
 192
 193         <listitem>
 194           <para>Start the database server processes: Backup Server, Protection Server, and Volume Location
 195           (VL) Server</para>
 196         </listitem>
 197
 198         <listitem>
 199           <para>Configure initial security mechanisms</para>
 200         </listitem>
 201
 202         <listitem>
 203           <para>Start the <emphasis role="bold">fs</emphasis> process, which incorporates three component processes: the File
 204           Server, Volume Server, and Salvager</para>
 205         </listitem>
 206
 207         <listitem>
 208           <para>Start the server portion of the Update Server</para>
 209         </listitem>
 210
 211       </orderedlist></para>
 212   </sect1>
 213
 214   <sect1 id="HDRWQ19">
 215     <title>Choosing the First AFS Machine</title>
 216
 217     <para>The first AFS machine you install must have sufficient disk space to store AFS volumes. To take best advantage of AFS's
 218     capabilities, store client-side binaries as well as user files in volumes. When you later install additional file server
 219     machines in your cell, you can distribute these volumes among the different machines as you see fit.</para>
 220
 221     <para>These instructions configure the first AFS machine as a <emphasis>database server machine</emphasis>, the <emphasis>binary
 222     distribution machine</emphasis> for its system type, and the cell's <emphasis>system control machine</emphasis>. For a
 223     description of these roles, see the <emphasis>OpenAFS Administration Guide</emphasis>.</para>
 224
 225     <para>Installation of additional machines is simplest if the first machine has the lowest IP address of any database server
 226     machine you currently plan to install. If you later install database server functionality on a machine with a lower IP address,
 227     you must first update the <emphasis role="bold">/usr/vice/etc/CellServDB</emphasis> file on all of your cell's client machines.
 228     For more details, see <link linkend="HDRWQ114">Installing Database Server Functionality</link>.</para>
 229   </sect1>
 230
 231   <sect1 id="Header_32">
 232     <title>Creating AFS Directories</title>
 233
 234     <indexterm>
 235       <primary>usr/afs directory</primary>
 236
 237       <secondary>first AFS machine</secondary>
 238     </indexterm>
 239
 240     <indexterm>
 241       <primary>first AFS machine</primary>
 242
 243       <secondary>/usr/afs directory</secondary>
 244     </indexterm>
 245
 246     <indexterm>
 247       <primary>creating</primary>
 248
 249       <secondary>/usr/afs directory</secondary>
 250
 251       <tertiary>first AFS machine</tertiary>
 252     </indexterm>
 253
 254     <indexterm>
 255       <primary>usr/vice/etc directory</primary>
 256
 257       <secondary>first AFS machine</secondary>
 258     </indexterm>
 259
 260     <indexterm>
 261       <primary>first AFS machine</primary>
 262
 263       <secondary>/usr/vice/etc directory</secondary>
 264     </indexterm>
 265
 266     <indexterm>
 267       <primary>creating</primary>
 268
 269       <secondary>/usr/vice/etc directory</secondary>
 270
 271       <tertiary>first AFS machine</tertiary>
 272     </indexterm>
 273
 274     <indexterm>
 275       <primary>/ as start to file and directory names</primary>
 276
 277       <secondary>see alphabetized entries without initial slash</secondary>
 278     </indexterm>
 279
 280     <para>If you are installing from packages (such as Debian .deb or
 281     Fedora/SuSe .rpm files), you should now install all of the available
 282     OpenAFS packages for your system type. Typically, these will include
 283     packages for client and server functionality, and a seperate package
 284     containing a suitable kernel module for your running kernel. Consult
 285     the package lists on the OpenAFS website to determine the packages
 286     appropriate for your system.</para>
 287
 288     <para>If you are installing from a tarfile, or from a locally compiled
 289     source tree you should create the <emphasis role="bold">/usr/afs</emphasis>
 290     and <emphasis role="bold">/usr/vice/etc</emphasis> directories on the
 291     local disk, to house server and client files respectively. Subsequent
 292     instructions copy files from the distribution tarfile into them. </para>
 293 <programlisting>
 294    # <emphasis role="bold">mkdir /usr/afs</emphasis>
 295    # <emphasis role="bold">mkdir /usr/vice</emphasis>
 296    # <emphasis role="bold">mkdir /usr/vice/etc</emphasis>
 297 </programlisting>
 298   </sect1>
 299
 300   <sect1 id="HDRWQ20">
 301     <title>Performing Platform-Specific Procedures</title>
 302
 303     <para>Several of the initial procedures for installing a file server machine differ for each system type. For convenience, the
 304     following sections group them together for each system type: <itemizedlist>
 305         <indexterm>
 306           <primary>kernel extensions</primary>
 307
 308           <see>AFS kernel extensions</see>
 309         </indexterm>
 310
 311         <indexterm>
 312           <primary>loading AFS kernel extensions</primary>
 313
 314           <see>incorporating</see>
 315         </indexterm>
 316
 317         <indexterm>
 318           <primary>building</primary>
 319
 320           <secondary>AFS extensions into kernel</secondary>
 321
 322           <see>incorporating AFS kernel extensions</see>
 323         </indexterm>
 324
 325         <listitem>
 326           <para>Incorporate AFS modifications into the kernel.</para>
 327
 328           <para>The kernel on every AFS client machine and, on some systems,
 329           the AFS fileservers, must incorporate AFS extensions. On machines
 330           that use a dynamic kernel module loader, it is conventional to
 331           alter the machine's initialization script to load the AFS extensions
 332           at each reboot. <indexterm>
 333               <primary>AFS server partition</primary>
 334
 335               <secondary>mounted on /vicep directory</secondary>
 336             </indexterm> <indexterm>
 337               <primary>partition</primary>
 338
 339               <see>AFS server partition</see>
 340             </indexterm> <indexterm>
 341               <primary>logical volume</primary>
 342
 343               <see>AFS server partition</see>
 344             </indexterm> <indexterm>
 345               <primary>requirements</primary>
 346
 347               <secondary>AFS server partition name and location</secondary>
 348             </indexterm> <indexterm>
 349               <primary>naming conventions for AFS server partition</primary>
 350             </indexterm> <indexterm>
 351               <primary>vicep<emphasis>xx</emphasis> directory</primary>
 352
 353               <see>AFS server partition</see>
 354             </indexterm> <indexterm>
 355               <primary>directories</primary>
 356
 357               <secondary>/vicep<emphasis>xx</emphasis></secondary>
 358
 359               <see>AFS server partition</see>
 360             </indexterm></para>
 361         </listitem>
 362
 363         <listitem>
 364           <para>Configure server partitions or logical volumes to house AFS volumes.</para>
 365
 366           <para>Every AFS file server machine must have at least one partition or logical volume dedicated to storing AFS volumes
 367           (for convenience, the documentation hereafter refers to partitions only). Each server partition is mounted at a directory
 368           named <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>, where <replaceable>xx</replaceable> is one or
 369           two lowercase letters. By convention, the first 26 partitions are mounted on the directories called <emphasis
 370           role="bold">/vicepa</emphasis> through <emphasis role="bold">/vicepz</emphasis>, the 27th one is mounted on the <emphasis
 371           role="bold">/vicepaa</emphasis> directory, and so on through <emphasis role="bold">/vicepaz</emphasis> and <emphasis
 372           role="bold">/vicepba</emphasis>, continuing up to the index corresponding to the maximum number of server partitions
 373           supported in the current version of AFS (which is specified in the <emphasis>OpenAFS Release Notes</emphasis>).</para>
 374
 375           <para>The <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable> directories must reside in the file server
 376           machine's root directory, not in one of its subdirectories (for example, <emphasis role="bold">/usr/vicepa</emphasis> is
 377           not an acceptable directory location).</para>
 378
 379           <para>You can also add or remove server partitions on an existing file server machine. For instructions, see the chapter
 380           in the <emphasis>OpenAFS Administration Guide</emphasis> about maintaining server machines.</para>
 381
 382           <note>
 383             <para>Not all file system types supported by an operating system are necessarily supported as AFS server partitions. For
 384             possible restrictions, see the <emphasis>OpenAFS Release Notes</emphasis>.</para>
 385           </note>
 386         </listitem>
 387
 388         <listitem>
 389           <para>On some system types, install and configure a modified <emphasis role="bold">fsck</emphasis> program which
 390           recognizes the structures that the File Server uses to organize volume data on AFS server partitions. The <emphasis
 391           role="bold">fsck</emphasis> program provided with the operating system does not understand the AFS data structures, and so
 392           removes them to the <emphasis role="bold">lost+found</emphasis> directory.</para>
 393         </listitem>
 394
 395         <listitem>
 396           <para>If the machine is to remain an AFS client machine, modify the machine's authentication system so that users obtain
 397           an AFS token as they log into the local file system. Using AFS is simpler and more convenient for your users if you make
 398           the modifications on all client machines. Otherwise, users must perform a two or three step login procedure (login to the local
 399           system, then obtain Kerberos credentials, and then issue the <emphasis role="bold">aklog</emphasis> command). For further discussion of AFS
 400           authentication, see the chapter in the <emphasis>OpenAFS Administration Guide</emphasis> about cell configuration and
 401           administration issues.</para>
 402         </listitem>
 403       </itemizedlist></para>
 404
 405     <para>To continue, proceed to the appropriate section: <itemizedlist>
 406         <listitem>
 407           <para><link linkend="HDRWQ21">Getting Started on AIX Systems</link></para>
 408         </listitem>
 409
 410         <listitem>
 411           <para><link linkend="HDRWQ31">Getting Started on HP-UX Systems</link></para>
 412         </listitem>
 413
 414         <listitem>
 415           <para><link linkend="HDRWQ36">Getting Started on IRIX Systems</link></para>
 416         </listitem>
 417
 418         <listitem>
 419           <para><link linkend="HDRWQ41">Getting Started on Linux Systems</link></para>
 420         </listitem>
 421
 422         <listitem>
 423           <para><link linkend="HDRWQ45">Getting Started on Solaris Systems</link></para>
 424         </listitem>
 425       </itemizedlist></para>
 426   </sect1>
 427
 428   <sect1 id="HDRWQ21">
 429     <title>Getting Started on AIX Systems</title>
 430
 431     <para>Begin by running the AFS initialization script to call the AIX kernel extension facility, which dynamically loads AFS
 432     modifications into the kernel. Then use the <emphasis role="bold">SMIT</emphasis> program to configure partitions for storing
 433     AFS volumes, and replace the AIX <emphasis role="bold">fsck</emphasis> program helper with a version that correctly handles AFS
 434     volumes. If the machine is to remain an AFS client machine, incorporate AFS into the AIX secondary authentication system.
 435     <indexterm>
 436         <primary>incorporating AFS kernel extensions</primary>
 437
 438         <secondary>first AFS machine</secondary>
 439
 440         <tertiary>AIX</tertiary>
 441       </indexterm> <indexterm>
 442         <primary>AFS kernel extensions</primary>
 443
 444         <secondary>on first AFS machine</secondary>
 445
 446         <tertiary>AIX</tertiary>
 447       </indexterm> <indexterm>
 448         <primary>first AFS machine</primary>
 449
 450         <secondary>AFS kernel extensions</secondary>
 451
 452         <tertiary>on AIX</tertiary>
 453       </indexterm> <indexterm>
 454         <primary>AIX</primary>
 455
 456         <secondary>AFS kernel extensions</secondary>
 457
 458         <tertiary>on first AFS machine</tertiary>
 459       </indexterm></para>
 460
 461     <sect2 id="HDRWQ22">
 462       <title>Loading AFS into the AIX Kernel</title>
 463
 464       <para>The AIX kernel extension facility is the dynamic kernel loader
 465       provided by IBM Corporation.  AIX does not support incorporation of
 466       AFS modifications during a kernel build.</para>
 467
 468       <para>For AFS to function correctly, the kernel extension facility must run each time the machine reboots, so the AFS
 469       initialization script (included in the AFS distribution) invokes it automatically. In this section you copy the script to the
 470       conventional location and edit it to select the appropriate options depending on whether NFS is also to run.</para>
 471
 472       <para>After editing the script, you run it to incorporate AFS into the kernel. In later sections you verify that the script
 473       correctly initializes all AFS components, then configure the AIX <emphasis role="bold">inittab</emphasis> file so that the
 474       script runs automatically at reboot. <orderedlist>
 475           <listitem>
 476             <para>Unpack the distribution tarball. The examples below assume
 477             that you have unpacked the files into the
 478             <emphasis role="bold">/tmp/afsdist</emphasis> directory. If you
 479             pick a different location, substitute this in all of the following
 480             examples. Once you have unpacked the distribution,
 481             change directory as indicated.
 482 <programlisting>
 483    # <emphasis role="bold">cd /tmp/afsdist/rs_aix42/root.client/usr/vice/etc</emphasis>
 484 </programlisting></para>
 485           </listitem>
 486
 487           <listitem>
 488             <para>Copy the AFS kernel library files to the local <emphasis role="bold">/usr/vice/etc/dkload</emphasis> directory,
 489             and the AFS initialization script to the <emphasis role="bold">/etc</emphasis> directory. <programlisting>
 490    # <emphasis role="bold">cp -rp  dkload  /usr/vice/etc</emphasis>
 491    # <emphasis role="bold">cp -p  rc.afs  /etc/rc.afs</emphasis>
 492 </programlisting></para>
 493           </listitem>
 494
 495           <listitem>
 496             <para>Edit the <emphasis role="bold">/etc/rc.afs</emphasis> script, setting the <computeroutput>NFS</computeroutput>
 497             variable as indicated.</para>
 498
 499             <para>If the machine is not to function as an NFS/AFS Translator, set the <computeroutput>NFS</computeroutput> variable
 500             as follows.</para>
 501
 502             <programlisting>
 503    NFS=$NFS_NONE
 504 </programlisting>
 505
 506             <para>If the machine is to function as an NFS/AFS Translator and is running AIX 4.2.1 or higher, set the
 507             <computeroutput>NFS</computeroutput> variable as follows. Note that NFS must already be loaded into the kernel, which
 508             happens automatically on systems running AIX 4.1.1 and later, as long as the file <emphasis
 509             role="bold">/etc/exports</emphasis> exists.</para>
 510
 511             <programlisting>
 512    NFS=$NFS_IAUTH
 513 </programlisting>
 514           </listitem>
 515
 516           <listitem>
 517             <para>Invoke the <emphasis role="bold">/etc/rc.afs</emphasis> script to load AFS modifications into the kernel. You can
 518             ignore any error messages about the inability to start the BOS Server or the Cache Manager or AFS client.
 519             <programlisting>
 520    # <emphasis role="bold">/etc/rc.afs</emphasis>
 521 </programlisting></para>
 522           </listitem>
 523         </orderedlist></para>
 524
 525       <indexterm>
 526         <primary>configuring</primary>
 527
 528         <secondary>AFS server partition on first AFS machine</secondary>
 529
 530         <tertiary>AIX</tertiary>
 531       </indexterm>
 532
 533       <indexterm>
 534         <primary>AFS server partition</primary>
 535
 536         <secondary>configuring on first AFS machine</secondary>
 537
 538         <tertiary>AIX</tertiary>
 539       </indexterm>
 540
 541       <indexterm>
 542         <primary>first AFS machine</primary>
 543
 544         <secondary>AFS server partition</secondary>
 545
 546         <tertiary>on AIX</tertiary>
 547       </indexterm>
 548
 549       <indexterm>
 550         <primary>AIX</primary>
 551
 552         <secondary>AFS server partition</secondary>
 553
 554         <tertiary>on first AFS machine</tertiary>
 555       </indexterm>
 556     </sect2>
 557
 558     <sect2 id="HDRWQ23">
 559       <title>Configuring Server Partitions on AIX Systems</title>
 560
 561       <para>Every AFS file server machine must have at least one partition or logical volume dedicated to storing AFS volumes. Each
 562       server partition is mounted at a directory named <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>, where
 563       <replaceable>xx</replaceable> is one or two lowercase letters. The <emphasis
 564       role="bold">/vicep</emphasis><replaceable>xx</replaceable> directories must reside in the file server machine's root
 565       directory, not in one of its subdirectories (for example, <emphasis role="bold">/usr/vicepa</emphasis> is not an acceptable
 566       directory location). For additional information, see <link linkend="HDRWQ20">Performing Platform-Specific
 567       Procedures</link>.</para>
 568
 569       <para>To configure server partitions on an AIX system, perform the following procedures: <orderedlist>
 570           <listitem>
 571             <para>Create a directory called <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable> for each AFS server
 572             partition you are configuring (there must be at least one). Repeat the command for each partition. <programlisting>
 573    # <emphasis role="bold">mkdir /vicep</emphasis><replaceable>xx</replaceable>
 574 </programlisting></para>
 575           </listitem>
 576
 577           <listitem>
 578             <para>Use the <emphasis role="bold">SMIT</emphasis> program to create a journaling file system on each partition to be
 579             configured as an AFS server partition.</para>
 580           </listitem>
 581
 582           <listitem>
 583             <para>Mount each partition at one of the <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>
 584             directories. Choose one of the following three methods: <itemizedlist>
 585                 <listitem>
 586                   <para>Use the <emphasis role="bold">SMIT</emphasis> program</para>
 587                 </listitem>
 588
 589                 <listitem>
 590                   <para>Use the <emphasis role="bold">mount -a</emphasis> command to mount all partitions at once</para>
 591                 </listitem>
 592
 593                 <listitem>
 594                   <para>Use the <emphasis role="bold">mount</emphasis> command on each partition in turn</para>
 595                 </listitem>
 596               </itemizedlist></para>
 597
 598             <para>Also configure the partitions so that they are mounted automatically at each reboot. For more information, refer
 599             to the AIX documentation.</para>
 600           </listitem>
 601         </orderedlist></para>
 602
 603       <indexterm>
 604         <primary>replacing fsck program</primary>
 605
 606         <secondary>first AFS machine</secondary>
 607
 608         <tertiary>AIX</tertiary>
 609       </indexterm>
 610
 611       <indexterm>
 612         <primary>fsck program</primary>
 613
 614         <secondary>on first AFS machine</secondary>
 615
 616         <tertiary>AIX</tertiary>
 617       </indexterm>
 618
 619       <indexterm>
 620         <primary>first AFS machine</primary>
 621
 622         <secondary>fsck program</secondary>
 623
 624         <tertiary>on AIX</tertiary>
 625       </indexterm>
 626
 627       <indexterm>
 628         <primary>AIX</primary>
 629
 630         <secondary>fsck program</secondary>
 631
 632         <tertiary>on first AFS machine</tertiary>
 633       </indexterm>
 634     </sect2>
 635
 636     <sect2 id="HDRWQ24">
 637       <title>Replacing the fsck Program Helper on AIX Systems</title>
 638
 639       <note><para>The AFS modified fsck program is not required on AIX 5.1
 640       systems, and the <emphasis role="bold">v3fshelper</emphasis> program
 641       refered to below is not shipped for these systems.</para></note>
 642
 643       <para>In this section, you make modifications to guarantee that the appropriate <emphasis role="bold">fsck</emphasis> program
 644       runs on AFS server partitions. The <emphasis role="bold">fsck</emphasis> program provided with the operating system must never
 645       run on AFS server partitions. Because it does not recognize the structures that the File Server uses to organize volume data,
 646       it removes all of the data. To repeat:</para>
 647
 648       <para><emphasis role="bold">Never run the standard fsck program on AFS server partitions. It discards AFS
 649       volumes.</emphasis></para>
 650
 651       <para>On AIX systems, you do not replace the <emphasis role="bold">fsck</emphasis> binary itself, but rather the
 652       <emphasis>program helper</emphasis> file included in the AIX distribution as <emphasis
 653       role="bold">/sbin/helpers/v3fshelper</emphasis>. <orderedlist>
 654           <listitem>
 655             <para>Move the AIX <emphasis role="bold">fsck</emphasis> program helper to a safe location and install the version from
 656             the AFS distribution in its place.
 657 <programlisting>
 658    # <emphasis role="bold">cd /sbin/helpers</emphasis>
 659    # <emphasis role="bold">mv v3fshelper v3fshelper.noafs</emphasis>
 660    # <emphasis role="bold">cp -p /tmp/afsdist/rs_aix42/root.server/etc/v3fshelper v3fshelper</emphasis>
 661 </programlisting></para>
 662           </listitem>
 663
 664           <listitem>
 665             <para>If you plan to retain client functionality on this machine after completing the installation, proceed to <link
 666             linkend="HDRWQ25">Enabling AFS Login on AIX Systems</link>. Otherwise, proceed to <link linkend="HDRWQ50">Starting the
 667             BOS Server</link>.</para>
 668           </listitem>
 669         </orderedlist></para>
 670
 671       <indexterm>
 672         <primary>enabling AFS login</primary>
 673
 674         <secondary>file server machine</secondary>
 675
 676         <tertiary>AIX</tertiary>
 677       </indexterm>
 678
 679       <indexterm>
 680         <primary>AFS login</primary>
 681
 682         <secondary>on file server machine</secondary>
 683
 684         <tertiary>AIX</tertiary>
 685       </indexterm>
 686
 687       <indexterm>
 688         <primary>first AFS machine</primary>
 689
 690         <secondary>AFS login</secondary>
 691
 692         <tertiary>on AIX</tertiary>
 693       </indexterm>
 694
 695       <indexterm>
 696         <primary>AIX</primary>
 697
 698         <secondary>AFS login</secondary>
 699
 700         <tertiary>on file server machine</tertiary>
 701       </indexterm>
 702
 703       <indexterm>
 704         <primary>secondary authentication system (AIX)</primary>
 705
 706         <secondary>server machine</secondary>
 707       </indexterm>
 708     </sect2>
 709
 710     <sect2 id="HDRWQ25">
 711       <title>Enabling AFS Login on AIX Systems</title>
 712
 713       <note>
 714         <para>If you plan to remove client functionality from this machine after completing the installation, skip this section and
 715         proceed to <link linkend="HDRWQ50">Starting the BOS Server</link>.</para>
 716       </note>
 717
 718       <para>In modern AFS installations, you should be using Kerberos v5
 719       for user login, and obtaining AFS tokens following this authentication
 720       step.</para>
 721
 722       <para>There are currently no instructions available on configuring AIX to
 723       automatically obtain AFS tokens at login. Following login, users can
 724       obtain tokens by running the <emphasis role="bold">aklog</emphasis>
 725       command</para>
 726
 727       <para>Sites which still require <emphasis role="bold">kaserver</emphasis>
 728       or external Kerberos v4 authentication should consult
 729       <link linkend="KAS012">Enabling kaserver based AFS login on AIX systems</link>
 730       for details of how to enable AIX login.</para>
 731
 732       <para>Proceed to <link linkend="HDRWQ50">Starting the BOS Server</link>
 733       (or if referring to these instructions while installing an additional
 734       file server machine, return to <link linkend="HDRWQ108">Starting Server
 735       Programs</link>).</para>
 736     </sect2>
 737   </sect1>
 738
 739   <sect1 id="HDRWQ31">
 740     <title>Getting Started on HP-UX Systems</title>
 741
 742     <para>Begin by building AFS modifications into a new kernel; HP-UX
 743     does not support dynamic loading. Then create partitions for storing
 744     AFS volumes, and install and configure the AFS-modified <emphasis
 745     role="bold">fsck</emphasis> program to run on AFS server
 746     partitions. If the machine is to remain an AFS client machine,
 747     incorporate AFS into the machine's Pluggable Authentication Module
 748     (PAM) scheme. <indexterm>
 749         <primary>incorporating AFS kernel extensions</primary>
 750
 751         <secondary>first AFS machine</secondary>
 752
 753         <tertiary>HP-UX</tertiary>
 754       </indexterm> <indexterm>
 755         <primary>AFS kernel extensions</primary>
 756
 757         <secondary>on first AFS machine</secondary>
 758
 759         <tertiary>HP-UX</tertiary>
 760       </indexterm> <indexterm>
 761         <primary>first AFS machine</primary>
 762
 763         <secondary>AFS kernel extensions</secondary>
 764
 765         <tertiary>on HP-UX</tertiary>
 766       </indexterm> <indexterm>
 767         <primary>HP-UX</primary>
 768
 769         <secondary>AFS-modified kernel</secondary>
 770
 771         <tertiary>on first AFS machine</tertiary>
 772       </indexterm></para>
 773
 774     <sect2 id="HDRWQ32">
 775       <title>Building AFS into the HP-UX Kernel</title>
 776
 777       <para>Use the following instructions to build AFS modifications into the kernel on an HP-UX system. <orderedlist>
 778           <listitem>
 779             <para>Move the existing kernel-related files to a safe location. <programlisting>
 780    # <emphasis role="bold">cp /stand/vmunix /stand/vmunix.noafs</emphasis>
 781    # <emphasis role="bold">cp /stand/system /stand/system.noafs</emphasis>
 782 </programlisting></para>
 783           </listitem>
 784
 785           <listitem>
 786             <para>Unpack the OpenAFS HP-UX distribution tarball. The examples
 787             below assume that you have unpacked the files into the
 788             <emphasis role="bold">/tmp/afsdist</emphasis> directory. If you
 789             pick a different location, substitute this in all of the following
 790             examples. Once you have unpacked the distribution, change directory
 791             as indicated.
 792             <programlisting>
 793    # <emphasis role="bold">cd /tmp/afsdist/hp_ux110/root.client</emphasis>
 794 </programlisting></para>
 795           </listitem>
 796
 797           <listitem>
 798             <para>Copy the AFS initialization file to the local directory for initialization files (by convention, <emphasis
 799             role="bold">/sbin/init.d</emphasis> on HP-UX machines). Note the removal of the <emphasis role="bold">.rc</emphasis>
 800             extension as you copy the file. <programlisting>
 801    # <emphasis role="bold">cp usr/vice/etc/afs.rc  /sbin/init.d/afs</emphasis>
 802 </programlisting></para>
 803           </listitem>
 804
 805           <listitem>
 806             <para>Copy the file <emphasis role="bold">afs.driver</emphasis> to the local <emphasis
 807             role="bold">/usr/conf/master.d</emphasis> directory, changing its name to <emphasis role="bold">afs</emphasis> as you
 808             do. <programlisting>
 809    # <emphasis role="bold">cp  usr/vice/etc/afs.driver  /usr/conf/master.d/afs</emphasis>
 810 </programlisting></para>
 811           </listitem>
 812
 813           <listitem>
 814             <para>Copy the AFS kernel module to the local <emphasis role="bold">/usr/conf/lib</emphasis> directory.</para>
 815
 816             <para>If the machine's kernel supports NFS server functionality:</para>
 817
 818             <programlisting>
 819    # <emphasis role="bold">cp bin/libafs.a /usr/conf/lib</emphasis>
 820 </programlisting>
 821
 822             <para>If the machine's kernel does not support NFS server functionality, change the file's name as you copy it:</para>
 823
 824             <programlisting>
 825    # <emphasis role="bold">cp bin/libafs.nonfs.a /usr/conf/lib/libafs.a</emphasis>
 826 </programlisting>
 827           </listitem>
 828
 829           <listitem>
 830             <para>Incorporate the AFS driver into the kernel, either using the <emphasis role="bold">SAM</emphasis> program or a
 831             series of individual commands. <itemizedlist>
 832                 <listitem>
 833                   <para>To use the <emphasis role="bold">SAM</emphasis> program: <orderedlist>
 834                       <listitem>
 835                         <para>Invoke the <emphasis role="bold">SAM</emphasis> program, specifying the hostname of the local machine
 836                         as <replaceable>local_hostname</replaceable>. The <emphasis role="bold">SAM</emphasis> graphical user
 837                         interface pops up. <programlisting>
 838    # <emphasis role="bold">sam -display</emphasis> <replaceable>local_hostname</replaceable><emphasis role="bold">:0</emphasis>
 839 </programlisting></para>
 840                       </listitem>
 841
 842                       <listitem>
 843                         <para>Choose the <emphasis role="bold">Kernel Configuration</emphasis> icon, then the <emphasis
 844                         role="bold">Drivers</emphasis> icon. From the list of drivers, select <emphasis
 845                         role="bold">afs</emphasis>.</para>
 846                       </listitem>
 847
 848                       <listitem>
 849                         <para>Open the pull-down <emphasis role="bold">Actions</emphasis> menu and choose the <emphasis
 850                         role="bold">Add Driver to Kernel</emphasis> option.</para>
 851                       </listitem>
 852
 853                       <listitem>
 854                         <para>Open the <emphasis role="bold">Actions</emphasis> menu again and choose the <emphasis
 855                         role="bold">Create a New Kernel</emphasis> option.</para>
 856                       </listitem>
 857
 858                       <listitem>
 859                         <para>Confirm your choices by choosing <emphasis role="bold">Yes</emphasis> and <emphasis
 860                         role="bold">OK</emphasis> when prompted by subsequent pop-up windows. The <emphasis
 861                         role="bold">SAM</emphasis> program builds the kernel and reboots the system.</para>
 862                       </listitem>
 863
 864                       <listitem>
 865                         <para>Login again as the superuser <emphasis role="bold">root</emphasis>. <programlisting>
 866    login: <emphasis role="bold">root</emphasis>
 867    Password: <replaceable>root_password</replaceable>
 868 </programlisting></para>
 869                       </listitem>
 870                     </orderedlist></para>
 871                 </listitem>
 872
 873                 <listitem>
 874                   <para>To use individual commands: <orderedlist>
 875                       <listitem>
 876                         <para>Edit the file <emphasis role="bold">/stand/system</emphasis>, adding an entry for <emphasis
 877                         role="bold">afs</emphasis> to the <computeroutput>Subsystems</computeroutput> section.</para>
 878                       </listitem>
 879
 880                       <listitem>
 881                         <para>Change to the <emphasis role="bold">/stand/build</emphasis> directory and issue the <emphasis
 882                         role="bold">mk_kernel</emphasis> command to build the kernel. <programlisting>
 883    # <emphasis role="bold">cd /stand/build</emphasis>
 884    # <emphasis role="bold">mk_kernel</emphasis>
 885 </programlisting></para>
 886                       </listitem>
 887
 888                       <listitem>
 889                         <para>Move the new kernel to the standard location (<emphasis role="bold">/stand/vmunix</emphasis>), reboot
 890                         the machine to start using it, and login again as the superuser <emphasis role="bold">root</emphasis>.
 891                         <programlisting>
 892    # <emphasis role="bold">mv /stand/build/vmunix_test /stand/vmunix</emphasis>
 893    # <emphasis role="bold">cd /</emphasis>
 894    # <emphasis role="bold">shutdown -r now</emphasis>
 895    login: <emphasis role="bold">root</emphasis>
 896    Password: <replaceable>root_password</replaceable>
 897 </programlisting></para>
 898                       </listitem>
 899                     </orderedlist></para>
 900                 </listitem>
 901               </itemizedlist></para>
 902           </listitem>
 903         </orderedlist></para>
 904
 905       <indexterm>
 906         <primary>configuring</primary>
 907
 908         <secondary>AFS server partition on first AFS machine</secondary>
 909
 910         <tertiary>HP-UX</tertiary>
 911       </indexterm>
 912
 913       <indexterm>
 914         <primary>AFS server partition</primary>
 915
 916         <secondary>configuring on first AFS machine</secondary>
 917
 918         <tertiary>HP-UX</tertiary>
 919       </indexterm>
 920
 921       <indexterm>
 922         <primary>first AFS machine</primary>
 923
 924         <secondary>AFS server partition</secondary>
 925
 926         <tertiary>on HP-UX</tertiary>
 927       </indexterm>
 928
 929       <indexterm>
 930         <primary>HP-UX</primary>
 931
 932         <secondary>AFS server partition</secondary>
 933
 934         <tertiary>on first AFS machine</tertiary>
 935       </indexterm>
 936     </sect2>
 937
 938     <sect2 id="HDRWQ33">
 939       <title>Configuring Server Partitions on HP-UX Systems</title>
 940
 941       <para>Every AFS file server machine must have at least one partition or logical volume dedicated to storing AFS volumes. Each
 942       server partition is mounted at a directory named <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>, where
 943       <replaceable>xx</replaceable> is one or two lowercase letters. The <emphasis
 944       role="bold">/vicep</emphasis><replaceable>xx</replaceable> directories must reside in the file server machine's root
 945       directory, not in one of its subdirectories (for example, <emphasis role="bold">/usr/vicepa</emphasis> is not an acceptable
 946       directory location). For additional information, see <link linkend="HDRWQ20">Performing Platform-Specific Procedures</link>.
 947       <orderedlist>
 948           <listitem>
 949             <para>Create a directory called <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable> for each AFS server
 950             partition you are configuring (there must be at least one). Repeat the command for each partition. <programlisting>
 951    # <emphasis role="bold">mkdir /vicep</emphasis><replaceable>xx</replaceable>
 952 </programlisting></para>
 953           </listitem>
 954
 955           <listitem>
 956             <para>Use the <emphasis role="bold">SAM</emphasis> program to create a file system on each partition. For instructions,
 957             consult the HP-UX documentation.</para>
 958           </listitem>
 959
 960           <listitem>
 961             <para>On some HP-UX systems that use logical volumes, the <emphasis role="bold">SAM</emphasis> program automatically
 962             mounts the partitions. If it has not, mount each partition by issuing either the <emphasis role="bold">mount
 963             -a</emphasis> command to mount all partitions at once or the <emphasis role="bold">mount</emphasis> command to mount
 964             each partition in turn.</para>
 965           </listitem>
 966         </orderedlist></para>
 967
 968       <indexterm>
 969         <primary>replacing fsck program</primary>
 970
 971         <secondary>first AFS machine</secondary>
 972
 973         <tertiary>HP-UX</tertiary>
 974       </indexterm>
 975
 976       <indexterm>
 977         <primary>fsck program</primary>
 978
 979         <secondary>on first AFS machine</secondary>
 980
 981         <tertiary>HP-UX</tertiary>
 982       </indexterm>
 983
 984       <indexterm>
 985         <primary>first AFS machine</primary>
 986
 987         <secondary>fsck program</secondary>
 988
 989         <tertiary>on HP-UX</tertiary>
 990       </indexterm>
 991
 992       <indexterm>
 993         <primary>HP-UX</primary>
 994
 995         <secondary>fsck program</secondary>
 996
 997         <tertiary>on first AFS machine</tertiary>
 998       </indexterm>
 999     </sect2>
1000
1001     <sect2 id="HDRWQ34">
1002       <title>Configuring the AFS-modified fsck Program on HP-UX Systems</title>
1003
1004       <para>In this section, you make modifications to guarantee that the appropriate <emphasis role="bold">fsck</emphasis> program
1005       runs on AFS server partitions. The <emphasis role="bold">fsck</emphasis> program provided with the operating system must never
1006       run on AFS server partitions. Because it does not recognize the structures that the File Server uses to organize volume data,
1007       it removes all of the data. To repeat:</para>
1008
1009       <para><emphasis role="bold">Never run the standard fsck program on AFS server partitions. It discards AFS
1010       volumes.</emphasis></para>
1011
1012       <para>On HP-UX systems, there are several configuration files to install in addition to the AFS-modified <emphasis
1013       role="bold">fsck</emphasis> program (the <emphasis role="bold">vfsck</emphasis> binary). <orderedlist>
1014           <listitem>
1015             <para>Create the command configuration file <emphasis role="bold">/sbin/lib/mfsconfig.d/afs</emphasis>. Use a text
1016             editor to place the indicated two lines in it: <programlisting>
1017    format_revision 1
1018    fsck            0        m,P,p,d,f,b:c:y,n,Y,N,q,
1019 </programlisting></para>
1020           </listitem>
1021
1022           <listitem>
1023             <para>Create and change directory to an AFS-specific command directory called <emphasis
1024             role="bold">/sbin/fs/afs</emphasis>. <programlisting>
1025    # <emphasis role="bold">mkdir /sbin/fs/afs</emphasis>
1026    # <emphasis role="bold">cd  /sbin/fs/afs</emphasis>
1027 </programlisting></para>
1028           </listitem>
1029
1030           <listitem>
1031             <para>Copy the AFS-modified version of the <emphasis role="bold">fsck</emphasis> program (the <emphasis
1032             role="bold">vfsck</emphasis> binary) and related files from the distribution directory to the new AFS-specific command
1033             directory. <programlisting>
1034    # <emphasis role="bold">cp -p /tmp/afsdist/hp_ux110/root.server/etc/*  .</emphasis>
1035 </programlisting></para>
1036           </listitem>
1037
1038           <listitem>
1039             <para>Change the <emphasis role="bold">vfsck</emphasis> binary's name to <emphasis role="bold">fsck</emphasis> and set
1040             the mode bits appropriately on all of the files in the <emphasis role="bold">/sbin/fs/afs</emphasis> directory.
1041             <programlisting>
1042    # <emphasis role="bold">mv  vfsck  fsck</emphasis>
1043    # <emphasis role="bold">chmod  755  *</emphasis>
1044 </programlisting></para>
1045           </listitem>
1046
1047           <listitem>
1048             <para>Edit the <emphasis role="bold">/etc/fstab</emphasis> file, changing the file system type for each AFS server
1049             partition from <computeroutput>hfs</computeroutput> to <computeroutput>afs</computeroutput>. This ensures that the
1050             AFS-modified <emphasis role="bold">fsck</emphasis> program runs on the appropriate partitions.</para>
1051
1052             <para>The sixth line in the following example of an edited file shows an AFS server partition, <emphasis
1053             role="bold">/vicepa</emphasis>.</para>
1054
1055             <programlisting>
1056    /dev/vg00/lvol1 / hfs defaults 0 1
1057    /dev/vg00/lvol4 /opt hfs defaults 0 2
1058    /dev/vg00/lvol5 /tmp hfs defaults 0 2
1059    /dev/vg00/lvol6 /usr hfs defaults 0 2
1060    /dev/vg00/lvol8 /var hfs defaults 0 2
1061    /dev/vg00/lvol9 /vicepa afs defaults 0 2
1062    /dev/vg00/lvol7 /usr/vice/cache hfs defaults 0 2
1063 </programlisting>
1064           </listitem>
1065
1066           <listitem>
1067             <para>If you plan to retain client functionality on this machine after completing the installation, proceed to <link
1068             linkend="HDRWQ35">Enabling AFS Login on HP-UX Systems</link>. Otherwise, proceed to <link linkend="HDRWQ50">Starting the
1069             BOS Server</link>.</para>
1070           </listitem>
1071         </orderedlist></para>
1072
1073       <indexterm>
1074         <primary>enabling AFS login</primary>
1075
1076         <secondary>file server machine</secondary>
1077
1078         <tertiary>HP-UX</tertiary>
1079       </indexterm>
1080
1081       <indexterm>
1082         <primary>AFS login</primary>
1083
1084         <secondary>on file server machine</secondary>
1085
1086         <tertiary>HP-UX</tertiary>
1087       </indexterm>
1088
1089       <indexterm>
1090         <primary>first AFS machine</primary>
1091
1092         <secondary>AFS login</secondary>
1093
1094         <tertiary>on HP-UX</tertiary>
1095       </indexterm>
1096
1097       <indexterm>
1098         <primary>HP-UX</primary>
1099
1100         <secondary>AFS login</secondary>
1101
1102         <tertiary>on file server machine</tertiary>
1103       </indexterm>
1104
1105       <indexterm>
1106         <primary>PAM</primary>
1107
1108         <secondary>on HP-UX</secondary>
1109
1110         <tertiary>file server machine</tertiary>
1111       </indexterm>
1112
1113       <indexterm>
1114         <primary>Pluggable Authentication Module</primary>
1115
1116         <see>PAM</see>
1117       </indexterm>
1118     </sect2>
1119
1120     <sect2 id="HDRWQ35">
1121       <title>Enabling AFS Login on HP-UX Systems</title>
1122
1123       <note><para>If you plan to remove client functionality from this machine after completing the installation, skip this section and proceed to <link linkend="HDRWQ50">Starting the BOS Server</link>.</para></note>
1124
1125       <para>At this point you incorporate AFS into the operating system's
1126       Pluggable Authentication Module (PAM) scheme. PAM integrates all
1127       authentication mechanisms on the machine, including login, to
1128       provide the security infrastructure for authenticated access to and
1129       from the machine.</para>
1130
1131       <para>In modern AFS installations, you should be using Kerberos v5
1132       for user login, and obtaining AFS tokens subsequent to this
1133       authentication step. OpenAFS does not currently distribute a PAM
1134       module allowing AFS tokens to be automatically gained at
1135       login. Whilst there are a number of third party modules providing
1136       this functionality, it is not know if these have been tested with
1137       HP/UX.</para>
1138
1139       <para>Following login, users can obtain tokens by running the
1140       <emphasis role="bold">aklog</emphasis> command</para>
1141
1142       <para>Sites which still require <emphasis
1143       role="bold">kaserver</emphasis> or external Kerberos v4
1144       authentication should consult <link linkend="KAS013">Enabling
1145       kaserver based AFS login on HP-UX systems</link> for details of how
1146       to enable HP-UX login.</para>
1147
1148       <para>Proceed to <link linkend="HDRWQ50">Starting the BOS
1149       Server</link> (or if referring to these instructions while
1150       installing an additional file server machine, return to <link
1151       linkend="HDRWQ108">Starting Server Programs</link>).</para>
1152     </sect2>
1153   </sect1>
1154
1155   <sect1 id="HDRWQ36">
1156     <title>Getting Started on IRIX Systems</title>
1157
1158     <indexterm>
1159       <primary>incorporating AFS kernel extensions</primary>
1160
1161       <secondary>first AFS machine</secondary>
1162
1163       <tertiary>IRIX</tertiary>
1164     </indexterm>
1165
1166     <indexterm>
1167       <primary>AFS kernel extensions</primary>
1168
1169       <secondary>on first AFS machine</secondary>
1170
1171       <tertiary>IRIX</tertiary>
1172     </indexterm>
1173
1174     <indexterm>
1175       <primary>first AFS machine</primary>
1176
1177       <secondary>AFS kernel extensions</secondary>
1178
1179       <tertiary>on IRIX</tertiary>
1180     </indexterm>
1181
1182     <indexterm>
1183       <primary>replacing fsck program</primary>
1184
1185       <secondary>not necessary on IRIX</secondary>
1186     </indexterm>
1187
1188     <indexterm>
1189       <primary>fsck program</primary>
1190
1191       <secondary>on first AFS machine</secondary>
1192
1193       <tertiary>IRIX</tertiary>
1194     </indexterm>
1195
1196     <indexterm>
1197       <primary>first AFS machine</primary>
1198
1199       <secondary>fsck program</secondary>
1200
1201       <tertiary>on IRIX</tertiary>
1202     </indexterm>
1203
1204     <indexterm>
1205       <primary>IRIX</primary>
1206
1207       <secondary>fsck program replacement not necessary</secondary>
1208     </indexterm>
1209
1210     <para>To incorporate AFS into the kernel on IRIX systems, choose one of two methods: <itemizedlist>
1211         <listitem>
1212           <para>Run the AFS initialization script to invoke the <emphasis role="bold">ml</emphasis> program distributed by Silicon
1213           Graphics, Incorporated (SGI), which dynamically loads AFS modifications into the kernel</para>
1214         </listitem>
1215
1216         <listitem>
1217           <para>Build a new static kernel</para>
1218         </listitem>
1219       </itemizedlist></para>
1220
1221     <para>Then create partitions for storing AFS volumes. You do not need to replace the IRIX <emphasis role="bold">fsck</emphasis>
1222     program because SGI has already modified it to handle AFS volumes properly. If the machine is to remain an AFS client machine,
1223     verify that the IRIX login utility installed on the machine grants an AFS token.</para>
1224
1225     <para>In preparation for either dynamic loading or kernel building, perform the following procedures: <orderedlist>
1226         <listitem>
1227           <para>Unpack the OpenAFS IRIX distribution tarball. The examples
1228           below assume that you have unpacked the files into the
1229           <emphasis role="bold">/tmp/afsdist</emphasis> directory. If you
1230           pick a different location, substitue this in all of the following
1231           examples. Once you have unpacked the distribution, change directory
1232           as indicated.
1233 <programlisting>
1234    # <emphasis role="bold">cd  /tmp/afsdist/sgi_65/root.client</emphasis>
1235 </programlisting></para>
1236         </listitem>
1237
1238         <listitem>
1239           <para>Copy the AFS initialization script to the local directory for initialization files (by convention, <emphasis
1240           role="bold">/etc/init.d</emphasis> on IRIX machines). Note the removal of the <emphasis role="bold">.rc</emphasis>
1241           extension as you copy the script. <programlisting>
1242    # <emphasis role="bold">cp -p   usr/vice/etc/afs.rc  /etc/init.d/afs</emphasis>
1243 </programlisting></para>
1244         </listitem>
1245
1246         <listitem>
1247           <para>Issue the <emphasis role="bold">uname -m</emphasis> command to determine the machine's CPU board type. The <emphasis
1248           role="bold">IP</emphasis><replaceable>xx</replaceable> value in the output must match one of the supported CPU board types
1249           listed in the <emphasis>OpenAFS Release Notes</emphasis> for the current version of AFS. <programlisting>
1250    # <emphasis role="bold">uname -m</emphasis>
1251 </programlisting></para>
1252         </listitem>
1253
1254         <listitem>
1255           <para>Proceed to either <link linkend="HDRWQ37">Loading AFS into the IRIX Kernel</link> or <link
1256           linkend="HDRWQ38">Building AFS into the IRIX Kernel</link>.</para>
1257         </listitem>
1258       </orderedlist></para>
1259
1260     <indexterm>
1261       <primary>IRIX</primary>
1262
1263       <secondary>AFS kernel extensions</secondary>
1264
1265       <tertiary>on first AFS machine</tertiary>
1266     </indexterm>
1267
1268     <indexterm>
1269       <primary>afsml variable (IRIX)</primary>
1270
1271       <secondary>first AFS machine</secondary>
1272     </indexterm>
1273
1274     <indexterm>
1275       <primary>variables</primary>
1276
1277       <secondary>afsml (IRIX)</secondary>
1278
1279       <tertiary>first AFS machine</tertiary>
1280     </indexterm>
1281
1282     <indexterm>
1283       <primary>IRIX</primary>
1284
1285       <secondary>afsml variable</secondary>
1286
1287       <tertiary>first AFS machine</tertiary>
1288     </indexterm>
1289
1290     <indexterm>
1291       <primary>afsxnfs variable (IRIX)</primary>
1292
1293       <secondary>first AFS machine</secondary>
1294     </indexterm>
1295
1296     <indexterm>
1297       <primary>variables</primary>
1298
1299       <secondary>afsxnfs (IRIX)</secondary>
1300
1301       <tertiary>first AFS machine</tertiary>
1302     </indexterm>
1303
1304     <indexterm>
1305       <primary>IRIX</primary>
1306
1307       <secondary>afsxnfs variable</secondary>
1308
1309       <tertiary>first AFS machine</tertiary>
1310     </indexterm>
1311
1312     <sect2 id="HDRWQ37">
1313       <title>Loading AFS into the IRIX Kernel</title>
1314
1315       <para>The <emphasis role="bold">ml</emphasis> program is the dynamic kernel loader provided by SGI for IRIX systems. If you
1316       use it rather than building AFS modifications into a static kernel, then for AFS to function correctly the <emphasis
1317       role="bold">ml</emphasis> program must run each time the machine reboots. Therefore, the AFS initialization script (included
1318       on the AFS CD-ROM) invokes it automatically when the <emphasis role="bold">afsml</emphasis> configuration variable is
1319       activated. In this section you activate the variable and run the script.</para>
1320
1321       <para>In later sections you verify that the script correctly initializes all AFS components, then create the links that
1322       incorporate AFS into the IRIX startup and shutdown sequence. <orderedlist>
1323           <listitem>
1324             <para>Create the local <emphasis role="bold">/usr/vice/etc/sgiload</emphasis> directory to house the AFS kernel library
1325             file. <programlisting>
1326    # <emphasis role="bold">mkdir /usr/vice/etc/sgiload</emphasis>
1327 </programlisting></para>
1328           </listitem>
1329
1330           <listitem>
1331             <para>Copy the appropriate AFS kernel library file to the <emphasis role="bold">/usr/vice/etc/sgiload</emphasis>
1332             directory. The <emphasis role="bold">IP</emphasis><replaceable>xx</replaceable> portion of the library file name must
1333             match the value previously returned by the <emphasis role="bold">uname -m</emphasis> command. Also choose the file
1334             appropriate to whether the machine's kernel supports NFS server functionality (NFS must be supported for the machine to
1335             act as an NFS/AFS Translator). Single- and multiprocessor machines use the same library file.</para>
1336
1337             <para>(You can choose to copy all of the kernel library files into the <emphasis
1338             role="bold">/usr/vice/etc/sgiload</emphasis> directory, but they require a significant amount of space.)</para>
1339
1340             <para>If the machine's kernel supports NFS server functionality:</para>
1341
1342             <programlisting>
1343    # <emphasis role="bold">cp -p  usr/vice/etc/sgiload/libafs.IP</emphasis><replaceable>xx</replaceable><emphasis role="bold">.o  /usr/vice/etc/sgiload</emphasis>
1344 </programlisting>
1345
1346             <para>If the machine's kernel does not support NFS server functionality:</para>
1347
1348             <programlisting>
1349    # <emphasis role="bold">cp -p  usr/vice/etc/sgiload/libafs.IP</emphasis><replaceable>xx</replaceable><emphasis role="bold">.nonfs.o</emphasis>   \
1350                    <emphasis role="bold">/usr/vice/etc/sgiload</emphasis>
1351 </programlisting>
1352           </listitem>
1353
1354           <listitem>
1355             <para>Issue the <emphasis role="bold">chkconfig</emphasis> command to activate the <emphasis
1356             role="bold">afsml</emphasis> configuration variable. <programlisting>
1357    # <emphasis role="bold">/etc/chkconfig -f afsml on</emphasis>
1358 </programlisting></para>
1359
1360             <para>If the machine is to function as an NFS/AFS Translator and the kernel supports NFS server functionality, activate
1361             the <emphasis role="bold">afsxnfs</emphasis> variable.</para>
1362
1363             <programlisting>
1364    # <emphasis role="bold">/etc/chkconfig -f afsxnfs on</emphasis>
1365 </programlisting>
1366           </listitem>
1367
1368           <listitem>
1369             <para>Run the <emphasis role="bold">/etc/init.d/afs</emphasis> script to load AFS extensions into the kernel. The script
1370             invokes the <emphasis role="bold">ml</emphasis> command, automatically determining which kernel library file to use
1371             based on this machine's CPU type and the activation state of the <emphasis role="bold">afsxnfs</emphasis>
1372             variable.</para>
1373
1374             <para>You can ignore any error messages about the inability to start the BOS Server or the Cache Manager or AFS
1375             client.</para>
1376
1377             <programlisting>
1378    # <emphasis role="bold">/etc/init.d/afs start</emphasis>
1379 </programlisting>
1380           </listitem>
1381
1382           <listitem>
1383             <para>Proceed to <link linkend="HDRWQ39">Configuring Server Partitions on IRIX Systems</link>.</para>
1384           </listitem>
1385         </orderedlist></para>
1386
1387       <indexterm>
1388         <primary>IRIX</primary>
1389
1390         <secondary>AFS-modified kernel</secondary>
1391
1392         <tertiary>on first AFS machine</tertiary>
1393       </indexterm>
1394     </sect2>
1395
1396     <sect2 id="HDRWQ38">
1397       <title>Building AFS into the IRIX Kernel</title>
1398
1399       <para>Use the following instructions to build AFS modifications into the kernel on an IRIX system. <orderedlist>
1400           <listitem>
1401             <para>Copy the kernel initialization file <emphasis role="bold">afs.sm</emphasis> to the local <emphasis
1402             role="bold">/var/sysgen/system</emphasis> directory, and the kernel master file <emphasis role="bold">afs</emphasis> to
1403             the local <emphasis role="bold">/var/sysgen/master.d</emphasis> directory. <programlisting>
1404    # <emphasis role="bold">cp -p  bin/afs.sm  /var/sysgen/system</emphasis>
1405    # <emphasis role="bold">cp -p  bin/afs  /var/sysgen/master.d</emphasis>
1406 </programlisting></para>
1407           </listitem>
1408
1409           <listitem>
1410             <para>Copy the appropriate AFS kernel library file to the local file <emphasis
1411             role="bold">/var/sysgen/boot/afs.a</emphasis>; the <emphasis role="bold">IP</emphasis><replaceable>xx</replaceable>
1412             portion of the library file name must match the value previously returned by the <emphasis role="bold">uname
1413             -m</emphasis> command. Also choose the file appropriate to whether the machine's kernel supports NFS server
1414             functionality (NFS must be supported for the machine to act as an NFS/AFS Translator). Single- and multiprocessor
1415             machines use the same library file.</para>
1416
1417             <para>If the machine's kernel supports NFS server functionality:</para>
1418
1419             <programlisting>
1420    # <emphasis role="bold">cp -p   bin/libafs.IP</emphasis><replaceable>xx</replaceable><emphasis role="bold">.a   /var/sysgen/boot/afs.a</emphasis>
1421 </programlisting>
1422
1423             <para>If the machine's kernel does not support NFS server functionality:</para>
1424
1425             <programlisting>
1426    # <emphasis role="bold">cp -p  bin/libafs.IP</emphasis><replaceable>xx</replaceable><emphasis role="bold">.nonfs.a  /var/sysgen/boot/afs.a</emphasis>
1427 </programlisting>
1428           </listitem>
1429
1430           <listitem>
1431             <para>Issue the <emphasis role="bold">chkconfig</emphasis> command to deactivate the <emphasis
1432             role="bold">afsml</emphasis> configuration variable. <programlisting>
1433    # <emphasis role="bold">/etc/chkconfig -f afsml off</emphasis>
1434 </programlisting></para>
1435
1436             <para>If the machine is to function as an NFS/AFS Translator and the kernel supports NFS server functionality, activate
1437             the <emphasis role="bold">afsxnfs</emphasis> variable.</para>
1438
1439             <programlisting>
1440    # <emphasis role="bold">/etc/chkconfig -f afsxnfs on</emphasis>
1441 </programlisting>
1442           </listitem>
1443
1444           <listitem>
1445             <para>Copy the existing kernel file, <emphasis role="bold">/unix</emphasis>, to a safe location. Compile the new kernel,
1446             which is created in the file <emphasis role="bold">/unix.install</emphasis>. It overwrites the existing <emphasis
1447             role="bold">/unix</emphasis> file when the machine reboots in the next step. <programlisting>
1448    # <emphasis role="bold">cp /unix /unix_noafs</emphasis>
1449    # <emphasis role="bold">autoconfig</emphasis>
1450 </programlisting></para>
1451           </listitem>
1452
1453           <listitem>
1454             <para>Reboot the machine to start using the new kernel, and login again as the superuser <emphasis
1455             role="bold">root</emphasis>. <programlisting>
1456    # <emphasis role="bold">cd /</emphasis>
1457    # <emphasis role="bold">shutdown -i6 -g0 -y</emphasis>
1458    login: <emphasis role="bold">root</emphasis>
1459    Password: <replaceable>root_password</replaceable>
1460 </programlisting></para>
1461           </listitem>
1462         </orderedlist></para>
1463
1464       <indexterm>
1465         <primary>configuring</primary>
1466
1467         <secondary>AFS server partition on first AFS machine</secondary>
1468
1469         <tertiary>IRIX</tertiary>
1470       </indexterm>
1471
1472       <indexterm>
1473         <primary>AFS server partition</primary>
1474
1475         <secondary>configuring on first AFS machine</secondary>
1476
1477         <tertiary>IRIX</tertiary>
1478       </indexterm>
1479
1480       <indexterm>
1481         <primary>first AFS machine</primary>
1482
1483         <secondary>AFS server partition</secondary>
1484
1485         <tertiary>on IRIX</tertiary>
1486       </indexterm>
1487
1488       <indexterm>
1489         <primary>IRIX</primary>
1490
1491         <secondary>AFS server partition</secondary>
1492
1493         <tertiary>on first AFS machine</tertiary>
1494       </indexterm>
1495     </sect2>
1496
1497     <sect2 id="HDRWQ39">
1498       <title>Configuring Server Partitions on IRIX Systems</title>
1499
1500       <para>Every AFS file server machine must have at least one partition or logical volume dedicated to storing AFS volumes. Each
1501       server partition is mounted at a directory named <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>, where
1502       <replaceable>xx</replaceable> is one or two lowercase letters. The <emphasis
1503       role="bold">/vicep</emphasis><replaceable>xx</replaceable> directories must reside in the file server machine's root
1504       directory, not in one of its subdirectories (for example, <emphasis role="bold">/usr/vicepa</emphasis> is not an acceptable
1505       directory location). For additional information, see <link linkend="HDRWQ20">Performing Platform-Specific
1506       Procedures</link>.</para>
1507
1508       <para>AFS supports use of both EFS and XFS partitions for housing AFS volumes. SGI encourages use of XFS partitions.
1509       <orderedlist>
1510           <listitem>
1511             <para>Create a directory called <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable> for each AFS server
1512             partition you are configuring (there must be at least one). Repeat the command for each partition. <programlisting>
1513    # <emphasis role="bold">mkdir /vicep</emphasis><replaceable>xx</replaceable>
1514 </programlisting></para>
1515           </listitem>
1516
1517           <listitem>
1518             <para>Add a line with the following format to the file systems registry file, <emphasis
1519             role="bold">/etc/fstab</emphasis>, for each partition (or logical volume created with the XLV volume manager) to be
1520             mounted on one of the directories created in the previous step.</para>
1521
1522             <para>For an XFS partition or logical volume:</para>
1523
1524             <programlisting>
1525    /dev/dsk/<replaceable>disk</replaceable>  /vicep<replaceable>xx</replaceable>  xfs  rw,raw=/dev/rdsk/<replaceable>disk</replaceable>  0  0
1526 </programlisting>
1527
1528             <para>For an EFS partition:</para>
1529
1530             <programlisting>
1531    /dev/dsk/<replaceable>disk</replaceable>  /vicep<replaceable>xx</replaceable>  efs  rw,raw=/dev/rdsk/<replaceable>disk</replaceable>  0  0
1532 </programlisting>
1533
1534             <para>The following are examples of an entry for each file system type:</para>
1535
1536             <programlisting>
1537    /dev/dsk/dks0d2s6 /vicepa  xfs rw,raw=/dev/rdsk/dks0d2s6  0 0
1538    /dev/dsk/dks0d3s1 /vicepb  efs rw,raw=/dev/rdsk/dks0d3s1  0 0
1539 </programlisting>
1540           </listitem>
1541
1542           <listitem>
1543             <para>Create a file system on each partition that is to be mounted on a <emphasis
1544             role="bold">/vicep</emphasis><replaceable>xx</replaceable> directory. The following commands are probably appropriate,
1545             but consult the IRIX documentation for more information. In both cases, <replaceable>raw_device</replaceable> is a raw
1546             device name like <emphasis role="bold">/dev/rdsk/dks0d0s0</emphasis> for a single disk partition or <emphasis
1547             role="bold">/dev/rxlv/xlv0</emphasis> for a logical volume.</para>
1548
1549             <para>For XFS file systems, include the indicated options to configure the partition or logical volume with inodes large
1550             enough to accommodate AFS-specific information:</para>
1551
1552             <programlisting>
1553    # <emphasis role="bold">mkfs -t xfs -i size=512 -l size=4000b</emphasis> <replaceable>raw_device</replaceable>
1554 </programlisting>
1555
1556             <para>For EFS file systems:</para>
1557
1558             <programlisting>
1559    # <emphasis role="bold">mkfs -t efs</emphasis> <replaceable>raw_device</replaceable>
1560 </programlisting>
1561           </listitem>
1562
1563           <listitem>
1564             <para>Mount each partition by issuing either the <emphasis role="bold">mount -a</emphasis> command to mount all
1565             partitions at once or the <emphasis role="bold">mount</emphasis> command to mount each partition in turn.</para>
1566           </listitem>
1567
1568           <listitem>
1569             <para><emphasis role="bold">(Optional)</emphasis> If you have configured partitions or logical volumes to use XFS, issue
1570             the following command to verify that the inodes are configured properly (are large enough to accommodate AFS-specific
1571             information). If the configuration is correct, the command returns no output. Otherwise, it specifies the command to run
1572             in order to configure each partition or logical volume properly. <programlisting>
1573    # <emphasis role="bold">/usr/afs/bin/xfs_size_check</emphasis>
1574 </programlisting></para>
1575           </listitem>
1576
1577           <listitem>
1578             <para>If you plan to retain client functionality on this machine after completing the installation, proceed to <link
1579             linkend="HDRWQ40">Enabling AFS Login on IRIX Systems</link>. Otherwise, proceed to <link linkend="HDRWQ50">Starting the
1580             BOS Server</link>.</para>
1581           </listitem>
1582         </orderedlist></para>
1583
1584       <indexterm>
1585         <primary>enabling AFS login</primary>
1586
1587         <secondary>file server machine</secondary>
1588
1589         <tertiary>IRIX</tertiary>
1590       </indexterm>
1591
1592       <indexterm>
1593         <primary>AFS login</primary>
1594
1595         <secondary>on file server machine</secondary>
1596
1597         <tertiary>IRIX</tertiary>
1598       </indexterm>
1599
1600       <indexterm>
1601         <primary>first AFS machine</primary>
1602
1603         <secondary>AFS login</secondary>
1604
1605         <tertiary>on IRIX</tertiary>
1606       </indexterm>
1607
1608       <indexterm>
1609         <primary>IRIX</primary>
1610
1611         <secondary>AFS login</secondary>
1612       </indexterm>
1613     </sect2>
1614
1615     <sect2 id="HDRWQ40">
1616       <title>Enabling AFS Login on IRIX Systems</title>
1617
1618       <note>
1619         <para>If you plan to remove client functionality from this machine after completing the installation, skip this section and
1620         proceed to <link linkend="HDRWQ50">Starting the BOS Server</link>.</para>
1621       </note>
1622
1623       <para>Whilst the standard IRIX command-line
1624       <emphasis role="bold">login</emphasis> program and the
1625       graphical <emphasis role="bold">xdm</emphasis> login program both have
1626       the ability to grant AFS tokens, this ability relies upon the deprecated
1627       kaserver authentication system.</para>
1628
1629       <para>Users who have been successfully authenticated via Kerberos 5
1630       authentication may obtain AFS tokens following login by running the
1631       <emphasis role="bold">aklog</emphasis> command.</para>
1632
1633       <para>Sites which still require <emphasis role="bold">kaserver</emphasis>
1634       or external Kerberos v4 authentication should consult
1635       <link linkend="KAS014">Enabling kaserver based AFS Login on IRIX Systems</link>
1636       for details of how to enable IRIX login.</para>
1637
1638       <para>After taking any necessary action, proceed to
1639       <link linkend="HDRWQ50">Starting the BOS Server</link>.</para>
1640     </sect2>
1641   </sect1>
1642
1643   <sect1 id="HDRWQ41">
1644     <title>Getting Started on Linux Systems</title>
1645
1646     <indexterm>
1647       <primary>replacing fsck program</primary>
1648
1649       <secondary>not necessary on Linux</secondary>
1650     </indexterm>
1651
1652     <indexterm>
1653       <primary>fsck program</primary>
1654
1655       <secondary>on first AFS machine</secondary>
1656
1657       <tertiary>Linux</tertiary>
1658     </indexterm>
1659
1660     <indexterm>
1661       <primary>first AFS machine</primary>
1662
1663       <secondary>fsck program</secondary>
1664
1665       <tertiary>on Linux</tertiary>
1666     </indexterm>
1667
1668     <indexterm>
1669       <primary>Linux</primary>
1670
1671       <secondary>fsck program replacement not necessary</secondary>
1672     </indexterm>
1673
1674     <para>Since this guide was originally written, the procedure for starting
1675     OpenAFS has diverged significantly between different Linux distributions.
1676     The instructions that follow are appropriate for both the Fedora and
1677     RedHat Enterprise Linux packages distributed by OpenAFS. Additional
1678     instructions are provided for those building from source.</para>
1679
1680     <para>Begin by running the AFS client startup scripts, which call the
1681     <emphasis role="bold">modprobe</emphasis> program, which dynamically
1682     loads AFS modifications into the kernel. Then create partitions for
1683     storing AFS volumes. You do not need to replace the Linux <emphasis
1684     role="bold">fsck</emphasis> program. If the machine is to remain an
1685     AFS client machine, incorporate AFS into the machine's Pluggable
1686     Authentication Module (PAM) scheme. <indexterm>
1687         <primary>incorporating AFS kernel extensions</primary>
1688
1689         <secondary>first AFS machine</secondary>
1690
1691         <tertiary>Linux</tertiary>
1692       </indexterm> <indexterm>
1693         <primary>AFS kernel extensions</primary>
1694
1695         <secondary>on first AFS machine</secondary>
1696
1697         <tertiary>Linux</tertiary>
1698       </indexterm> <indexterm>
1699         <primary>first AFS machine</primary>
1700
1701         <secondary>AFS kernel extensions</secondary>
1702
1703         <tertiary>on Linux</tertiary>
1704       </indexterm> <indexterm>
1705         <primary>Linux</primary>
1706
1707         <secondary>AFS kernel extensions</secondary>
1708
1709         <tertiary>on first AFS machine</tertiary>
1710       </indexterm></para>
1711
1712     <sect2 id="HDRWQ42">
1713       <title>Loading AFS into the Linux Kernel</title>
1714
1715       <para>The <emphasis role="bold">modprobe</emphasis> program is the dynamic kernel loader for Linux. Linux does not support
1716       incorporation of AFS modifications during a kernel build.</para>
1717
1718       <para>For AFS to function correctly, the <emphasis role="bold">modprobe</emphasis> program must run each time the machine
1719       reboots, so your distribution's AFS initialization script invokes it automatically. The script also includes
1720       commands that select the appropriate AFS library file automatically. In this section you run the script.</para>
1721
1722       <para>In later sections you verify that the script correctly initializes all AFS components, then activate a configuration
1723       variable, which results in the script being incorporated into the Linux startup and shutdown sequence.</para>
1724
1725       <para>The procedure for starting up OpenAFS depends upon your distribution</para>
1726       <sect3>
1727         <title>Fedora and RedHat Enterprise Linux</title>
1728         <para>OpenAFS ship RPMS for all current Fedora and RHEL releases.
1729         <orderedlist>
1730           <listitem>
1731             <para>Download and install the RPM set for your operating system.
1732             RPMs are available from the OpenAFS web site. You will need the
1733             <emphasis role="bold">openafs</emphasis>
1734             <emphasis role="bold">openafs-client></emphasis>
1735             <emphasis role="bold">openafs-server</emphasis> packages, along with
1736             an <emphasis role="bold">openafs-kernel</emphasis> package matching
1737             your current, running, kernel.</para>
1738             <para>You can find the version of your current kernel by running
1739 <programlisting>
1740   # uname -r
1741 <replaceable>2.6.20-1.2933.fc6</replaceable>
1742 </programlisting></para>
1743             <para>Once downloaded, the packages may be installed with the
1744             <emphasis role="bold">rpm</emphasis> command
1745 <programlisting>
1746   # rpm -U openafs-* openafs-client-* openafs-server-* openafs-kernel-*
1747 </programlisting></para>
1748           </listitem>
1749 <!-- If you do this with current RHEL and Fedora releases you end up with
1750      a dynroot'd client running - this breaks setting up the root.afs volume
1751      as described later in this guide
1752           <listitem>
1753             <para>Run the AFS initialization script to load AFS extensions into
1754             the kernel. You can ignore any error messages about the inability
1755             to start the BOS Server or the Cache Manager or AFS client.</para>
1756 <programlisting>
1757    # <emphasis role="bold">/etc/rc.d/init.d/openafs-client  start</emphasis>
1758 </programlisting>
1759           </listitem>
1760 -->
1761         </orderedlist>
1762       </para>
1763       </sect3>
1764       <sect3>
1765          <title>Systems packaged as tar files</title>
1766          <para>If you are running a system where the OpenAFS Binary Distribution
1767          is provided as a tar file, or where you have built the system from
1768          source yourself, you need to install the relevant components by hand
1769          </para>
1770          <orderedlist>
1771
1772           <listitem>
1773             <para>Unpack the distribution tarball. The examples below assume
1774             that you have unpacked the files into the
1775             <emphasis role="bold">/tmp/afsdist</emphasis>directory. If you
1776             pick a different location, substitute this in all of the following
1777             examples. Once you have unpacked the distribution,
1778             change directory as indicated.
1779 <programlisting>
1780   # <emphasis role="bold">cd /tmp/afsdist/linux/root.client/usr/vice/etc</emphasis>
1781 </programlisting></para>
1782           </listitem>
1783
1784           <listitem>
1785             <para>Copy the AFS kernel library files to the local <emphasis role="bold">/usr/vice/etc/modload</emphasis> directory.
1786             The filenames for the libraries have the format <emphasis
1787             role="bold">libafs-</emphasis><replaceable>version</replaceable><emphasis role="bold">.o</emphasis>, where
1788             <replaceable>version</replaceable> indicates the kernel build level. The string <emphasis role="bold">.mp</emphasis> in
1789             the <replaceable>version</replaceable> indicates that the file is appropriate for machines running a multiprocessor
1790             kernel. <programlisting>
1791    # <emphasis role="bold">cp -rp  modload  /usr/vice/etc</emphasis>
1792 </programlisting></para>
1793           </listitem>
1794
1795           <listitem>
1796             <para>Copy the AFS initialization script to the local directory for initialization files (by convention, <emphasis
1797             role="bold">/etc/rc.d/init.d</emphasis> on Linux machines). Note the removal of the <emphasis role="bold">.rc</emphasis>
1798             extension as you copy the script. <programlisting>
1799    # <emphasis role="bold">cp -p   afs.rc  /etc/rc.d/init.d/afs</emphasis>
1800 </programlisting></para>
1801           </listitem>
1802
1803 <!-- I don't think we need to do this for Linux, and it complicates things if
1804      dynroot is enabled ...
1805           <listitem>
1806             <para>Run the AFS initialization script to load AFS extensions into the kernel. You can ignore any error messages about
1807             the inability to start the BOS Server or the Cache Manager or AFS client.</para>
1808 <programlisting>
1809    # <emphasis role="bold">/etc/rc.d/init.d/afs start</emphasis>
1810 </programlisting>
1811           </listitem>
1812 -->
1813         </orderedlist>
1814
1815       <indexterm>
1816         <primary>configuring</primary>
1817
1818         <secondary>AFS server partition on first AFS machine</secondary>
1819
1820         <tertiary>Linux</tertiary>
1821       </indexterm>
1822
1823       <indexterm>
1824         <primary>AFS server partition</primary>
1825
1826         <secondary>configuring on first AFS machine</secondary>
1827
1828         <tertiary>Linux</tertiary>
1829       </indexterm>
1830
1831       <indexterm>
1832         <primary>first AFS machine</primary>
1833
1834         <secondary>AFS server partition</secondary>
1835
1836         <tertiary>on Linux</tertiary>
1837       </indexterm>
1838
1839       <indexterm>
1840         <primary>Linux</primary>
1841
1842         <secondary>AFS server partition</secondary>
1843
1844         <tertiary>on first AFS machine</tertiary>
1845       </indexterm>
1846     </sect3>
1847     </sect2>
1848
1849     <sect2 id="HDRWQ43">
1850       <title>Configuring Server Partitions on Linux Systems</title>
1851
1852       <para>Every AFS file server machine must have at least one partition or logical volume dedicated to storing AFS volumes. Each
1853       server partition is mounted at a directory named <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>, where
1854       <replaceable>xx</replaceable> is one or two lowercase letters. The <emphasis
1855       role="bold">/vicep</emphasis><replaceable>xx</replaceable> directories must reside in the file server machine's root
1856       directory, not in one of its subdirectories (for example, <emphasis role="bold">/usr/vicepa</emphasis> is not an acceptable
1857       directory location). For additional information, see <link linkend="HDRWQ20">Performing Platform-Specific Procedures</link>.
1858       <orderedlist>
1859           <listitem>
1860             <para>Create a directory called <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable> for each AFS server
1861             partition you are configuring (there must be at least one). Repeat the command for each partition. <programlisting>
1862    # <emphasis role="bold">mkdir /vicep</emphasis><replaceable>xx</replaceable>
1863 </programlisting></para>
1864           </listitem>
1865
1866           <listitem>
1867             <para>Add a line with the following format to the file systems registry file, <emphasis
1868             role="bold">/etc/fstab</emphasis>, for each directory just created. The entry maps the directory name to the disk
1869             partition to be mounted on it. <programlisting>
1870    /dev/<replaceable>disk</replaceable>  /vicep<replaceable>xx</replaceable>  ext2  defaults  0  2
1871 </programlisting></para>
1872
1873             <para>The following is an example for the first partition being configured.</para>
1874
1875             <programlisting>
1876    /dev/sda8 /vicepa ext2 defaults 0 2
1877 </programlisting>
1878           </listitem>
1879
1880           <listitem>
1881             <para>Create a file system on each partition that is to be mounted at a <emphasis
1882             role="bold">/vicep</emphasis><replaceable>xx</replaceable> directory. The following command is probably appropriate, but
1883             consult the Linux documentation for more information. <programlisting>
1884    # <emphasis role="bold">mkfs -v /dev/</emphasis><replaceable>disk</replaceable>
1885 </programlisting></para>
1886           </listitem>
1887
1888           <listitem>
1889             <para>Mount each partition by issuing either the <emphasis role="bold">mount -a</emphasis> command to mount all
1890             partitions at once or the <emphasis role="bold">mount</emphasis> command to mount each partition in turn.</para>
1891           </listitem>
1892
1893           <listitem>
1894             <para>If you plan to retain client functionality on this machine after completing the installation, proceed to <link
1895             linkend="HDRWQ44">Enabling AFS Login on Linux Systems</link>. Otherwise, proceed to <link linkend="HDRWQ50">Starting the
1896             BOS Server</link>.</para>
1897           </listitem>
1898         </orderedlist></para>
1899
1900       <indexterm>
1901         <primary>enabling AFS login</primary>
1902
1903         <secondary>file server machine</secondary>
1904
1905         <tertiary>Linux</tertiary>
1906       </indexterm>
1907
1908       <indexterm>
1909         <primary>AFS login</primary>
1910
1911         <secondary>on file server machine</secondary>
1912
1913         <tertiary>Linux</tertiary>
1914       </indexterm>
1915
1916       <indexterm>
1917         <primary>first AFS machine</primary>
1918
1919         <secondary>AFS login</secondary>
1920
1921         <tertiary>on Linux</tertiary>
1922       </indexterm>
1923
1924       <indexterm>
1925         <primary>Linux</primary>
1926
1927         <secondary>AFS login</secondary>
1928
1929         <tertiary>on file server machine</tertiary>
1930       </indexterm>
1931
1932       <indexterm>
1933         <primary>PAM</primary>
1934
1935         <secondary>on Linux</secondary>
1936
1937         <tertiary>file server machine</tertiary>
1938       </indexterm>
1939     </sect2>
1940
1941     <sect2 id="HDRWQ44">
1942       <title>Enabling AFS Login on Linux Systems</title>
1943
1944       <note>
1945         <para>If you plan to remove client functionality from this machine
1946         after completing the installation, skip this section and proceed
1947         to <link linkend="HDRWQ50">Starting the BOS Server</link>.</para>
1948       </note>
1949
1950       <para>At this point you incorporate AFS into the operating system's
1951       Pluggable Authentication Module (PAM) scheme.  PAM integrates all
1952       authentication mechanisms on the machine, including login, to provide
1953       the security infrastructure for authenticated access to and from the
1954       machine.</para>
1955
1956       <para>You should first configure your system to obtain Kerberos v5
1957       tickets as part of the authentication process, and then run an AFS PAM
1958       module to obtain tokens from those tickets after authentication.  Many
1959       Linux distributions come with a Kerberos v5 PAM module (usually called
1960       pam-krb5 or pam_krb5), or you can download and install <ulink
1961       url="http://www.eyrie.org/~eagle/software/pam-krb5">Russ Allbery's
1962       Kerberos v5 PAM module</ulink>, which is tested regularly with AFS.
1963       See the instructions of whatever PAM module you use for how to
1964       configure it.</para>
1965
1966       <para>Some Kerberos v5 PAM modules do come with native AFS support
1967       (usually requiring the Heimdal Kerberos implementation rather than the
1968       MIT Kerberos implementation).  If you are using one of those PAM
1969       modules, you can configure it to obtain AFS tokens.  It's more common,
1970       however, to separate the AFS token acquisition into a separate PAM
1971       module.</para>
1972
1973       <para>The recommended AFS PAM module is <ulink
1974       url="http://www.eyrie.org/~eagle/software/pam-afs-session/">Russ
1975       Allbery's pam-afs-session module</ulink>.  It should work with any of
1976       the Kerberos v5 PAM modules.  To add it to the PAM configuration, you
1977       often only need to add configuration to the session group:</para>
1978
1979       <example>
1980         <title>Linux PAM session example</title>
1981         <literallayout>session  required  pam_afs_session.so</literallayout>
1982       </example>
1983
1984       <para>If you also want to obtain AFS tokens for <command>scp</command>
1985       and similar commands that don't open a session, you will also need to
1986       add the AFS PAM module to the auth group so that the PAM
1987       <function>setcred</function> call will obtain tokens.  The
1988       <literal>pam_afs_session</literal> module will always return success
1989       for authentication so that it can be added to the auth group only for
1990       <function>setcred</function>, so make sure that it's not marked as
1991       <literal>sufficient</literal>.</para>
1992
1993       <example>
1994         <title>Linux PAM auth example</title>
1995 <literallayout>auth  [success=ok default=1]  pam_krb5.so
1996 auth  [default=done]          pam_afs_session.so
1997 auth  required                pam_unix.so try_first_pass</literallayout>
1998       </example>
1999
2000       <para>This example will work if you want to try Kerberos v5 first and
2001       then fall back to regular Unix authentication.
2002       <literal>success=ok</literal> for the Kerberos PAM module followed by
2003       <literal>default=done</literal> for the AFS PAM module will cause a
2004       successful Kerberos login to run the AFS PAM module and then skip the
2005       Unix authentication module.  <literal>default=1</literal> on the
2006       Kerberos PAM module causes failure of that module to skip the next
2007       module (the AFS PAM module) and fall back to the Unix module.  If you
2008       want to try Unix authentication first and rearrange the order, be sure
2009       to use <literal>default=die</literal> instead.</para>
2010
2011       <para>The PAM configuration is stored in different places in different
2012       Linux distributions.  On Red Hat, look in
2013       <filename>/etc/pam.d/system-auth</filename>.  On Debian and
2014       derivatives, look in <filename>/etc/pam.d/common-session</filename>
2015       and <filename>/etc/pam.d/common-auth</filename>.</para>
2016
2017       <para>For additional configuration examples and the configuration
2018       options of the AFS PAM module, see its documentation.  For more
2019       details on the available options for the PAM configuration, see the
2020       Linux PAM documentation.</para>
2021
2022       <para>Sites which still require <command>kaserver</command> or
2023       external Kerberos v4 authentication should consult <link
2024       linkend="KAS015">Enabling kaserver based AFS Login on Linux
2025       Systems</link> for details of how to enable AFS login on Linux.</para>
2026
2027       <para>Proceed to <link linkend="HDRWQ50">Starting the BOS
2028       Server</link> (or if referring to these instructions while installing
2029       an additional file server machine, return to <link
2030       linkend="HDRWQ108">Starting Server Programs</link>).</para>
2031     </sect2>
2032   </sect1>
2033
2034   <sect1 id="HDRWQ45">
2035     <title>Getting Started on Solaris Systems</title>
2036
2037     <para>Begin by running the AFS initialization script to call the <emphasis role="bold">modload</emphasis> program distributed by
2038     Sun Microsystems, which dynamically loads AFS modifications into the kernel. Then create partitions for storing AFS volumes, and
2039     install and configure the AFS-modified <emphasis role="bold">fsck</emphasis> program to run on AFS server partitions. If the
2040     machine is to remain an AFS client machine, incorporate AFS into the machine's Pluggable Authentication Module (PAM) scheme.
2041     <indexterm>
2042         <primary>incorporating AFS kernel extensions</primary>
2043
2044         <secondary>first AFS machine</secondary>
2045
2046         <tertiary>Solaris</tertiary>
2047       </indexterm> <indexterm>
2048         <primary>AFS kernel extensions</primary>
2049
2050         <secondary>on first AFS machine</secondary>
2051
2052         <tertiary>Solaris</tertiary>
2053       </indexterm> <indexterm>
2054         <primary>first AFS machine</primary>
2055
2056         <secondary>AFS kernel extensions</secondary>
2057
2058         <tertiary>on Solaris</tertiary>
2059       </indexterm> <indexterm>
2060         <primary>Solaris</primary>
2061
2062         <secondary>AFS kernel extensions</secondary>
2063
2064         <tertiary>on first AFS machine</tertiary>
2065       </indexterm></para>
2066
2067     <sect2 id="HDRWQ46">
2068       <title>Loading AFS into the Solaris Kernel</title>
2069
2070       <para>The <emphasis role="bold">modload</emphasis> program is the dynamic kernel loader provided by Sun Microsystems for
2071       Solaris systems. Solaris does not support incorporation of AFS modifications during a kernel build.</para>
2072
2073       <para>For AFS to function correctly, the <emphasis role="bold">modload</emphasis> program must run each time the machine
2074       reboots, so the AFS initialization script (included on the AFS CD-ROM) invokes it automatically. In this section you copy the
2075       appropriate AFS library file to the location where the <emphasis role="bold">modload</emphasis> program accesses it and then
2076       run the script.</para>
2077
2078       <para>In later sections you verify that the script correctly initializes all AFS components, then create the links that
2079       incorporate AFS into the Solaris startup and shutdown sequence. <orderedlist>
2080           <listitem>
2081             <para>Unpack the OpenAFS Solaris distribution tarball. The examples
2082             below assume that you have unpacked the files into the
2083             <emphasis role="bold">/tmp/afsdist</emphasis> directory. If you
2084             pick a diferent location, substitute this in all of the following
2085             exmaples. Once you have unpacked the distribution, change directory
2086             as indicated.
2087 <programlisting>
2088    # <emphasis role="bold">cd  /tmp/afsdist/sun4x_56/root.client/usr/vice/etc</emphasis>
2089 </programlisting></para>
2090           </listitem>
2091
2092           <listitem>
2093             <para>Copy the AFS initialization script to the local directory for initialization files (by convention, <emphasis
2094             role="bold">/etc/init.d</emphasis> on Solaris machines). Note the removal of the <emphasis role="bold">.rc</emphasis>
2095             extension as you copy the script. <programlisting>
2096    # <emphasis role="bold">cp -p  afs.rc  /etc/init.d/afs</emphasis>
2097 </programlisting></para>
2098           </listitem>
2099
2100           <listitem>
2101             <para>Copy the appropriate AFS kernel library file to the local file <emphasis
2102             role="bold">/kernel/fs/afs</emphasis>.</para>
2103
2104             <para>If the machine is running Solaris 2.6 or the 32-bit version of Solaris 7, its kernel supports NFS server
2105             functionality, and the <emphasis role="bold">nfsd</emphasis> process is running:</para>
2106
2107             <programlisting>
2108    # <emphasis role="bold">cp -p modload/libafs.o /kernel/fs/afs</emphasis>
2109 </programlisting>
2110
2111             <para>If the machine is running Solaris 2.6 or the 32-bit version of Solaris 7, and its kernel does not support NFS
2112             server functionality or the <emphasis role="bold">nfsd</emphasis> process is not running:</para>
2113
2114             <programlisting>
2115    # <emphasis role="bold">cp -p modload/libafs.nonfs.o /kernel/fs/afs</emphasis>
2116 </programlisting>
2117
2118             <para>If the machine is running the 64-bit version of Solaris 7, its kernel supports NFS server functionality, and the
2119             <emphasis role="bold">nfsd</emphasis> process is running:</para>
2120
2121             <programlisting>
2122    # <emphasis role="bold">cp -p modload/libafs64.o /kernel/fs/sparcv9/afs</emphasis>
2123 </programlisting>
2124
2125             <para>If the machine is running the 64-bit version of Solaris 7, and its kernel does not support NFS server
2126             functionality or the <emphasis role="bold">nfsd</emphasis> process is not running:</para>
2127
2128             <programlisting>
2129    # <emphasis role="bold">cp -p modload/libafs64.nonfs.o /kernel/fs/sparcv9/afs</emphasis>
2130 </programlisting>
2131           </listitem>
2132
2133           <listitem>
2134             <para>Run the AFS initialization script to load AFS modifications into the kernel. You can ignore any error messages
2135             about the inability to start the BOS Server or the Cache Manager or AFS client. <programlisting>
2136    # <emphasis role="bold">/etc/init.d/afs start</emphasis>
2137 </programlisting></para>
2138
2139             <para>When an entry called <computeroutput>afs</computeroutput> does not already exist in the local <emphasis
2140             role="bold">/etc/name_to_sysnum</emphasis> file, the script automatically creates it and reboots the machine to start
2141             using the new version of the file. If this happens, log in again as the superuser <emphasis role="bold">root</emphasis>
2142             after the reboot and run the initialization script again. This time the required entry exists in the <emphasis
2143             role="bold">/etc/name_to_sysnum</emphasis> file, and the <emphasis role="bold">modload</emphasis> program runs.</para>
2144
2145             <programlisting>
2146    login: <emphasis role="bold">root</emphasis>
2147    Password: <replaceable>root_password</replaceable>
2148    # <emphasis role="bold">/etc/init.d/afs start</emphasis>
2149 </programlisting>
2150           </listitem>
2151         </orderedlist></para>
2152
2153       <indexterm>
2154         <primary>replacing fsck program</primary>
2155
2156         <secondary>first AFS machine</secondary>
2157
2158         <tertiary>Solaris</tertiary>
2159       </indexterm>
2160
2161       <indexterm>
2162         <primary>fsck program</primary>
2163
2164         <secondary>on first AFS machine</secondary>
2165
2166         <tertiary>Solaris</tertiary>
2167       </indexterm>
2168
2169       <indexterm>
2170         <primary>first AFS machine</primary>
2171
2172         <secondary>fsck program</secondary>
2173
2174         <tertiary>on Solaris</tertiary>
2175       </indexterm>
2176
2177       <indexterm>
2178         <primary>Solaris</primary>
2179
2180         <secondary>fsck program</secondary>
2181
2182         <tertiary>on first AFS machine</tertiary>
2183       </indexterm>
2184     </sect2>
2185
2186     <sect2 id="HDRWQ47">
2187       <title>Configuring the AFS-modified fsck Program on Solaris Systems</title>
2188
2189       <para>In this section, you make modifications to guarantee that the appropriate <emphasis role="bold">fsck</emphasis> program
2190       runs on AFS server partitions. The <emphasis role="bold">fsck</emphasis> program provided with the operating system must never
2191       run on AFS server partitions. Because it does not recognize the structures that the File Server uses to organize volume data,
2192       it removes all of the data. To repeat:</para>
2193
2194       <para><emphasis role="bold">Never run the standard fsck program on AFS server partitions. It discards AFS volumes.</emphasis>
2195       <orderedlist>
2196           <listitem>
2197             <para>Create the <emphasis role="bold">/usr/lib/fs/afs</emphasis> directory to house the AFS-modified <emphasis
2198             role="bold">fsck</emphasis> program and related files. <programlisting>
2199    # <emphasis role="bold">mkdir /usr/lib/fs/afs</emphasis>
2200    # <emphasis role="bold">cd /usr/lib/fs/afs</emphasis>
2201 </programlisting></para>
2202           </listitem>
2203
2204           <listitem>
2205             <para>Copy the <emphasis role="bold">vfsck</emphasis> binary to the newly created directory, changing the name as you do
2206             so. <programlisting>
2207    # <emphasis role="bold">cp  /tmp/afsdist/sun4x_56/root.server/etc/vfsck  fsck</emphasis>
2208 </programlisting></para>
2209           </listitem>
2210
2211           <listitem>
2212             <para>Working in the <emphasis role="bold">/usr/lib/fs/afs</emphasis> directory, create the following links to Solaris
2213             libraries: <programlisting>
2214    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/clri</emphasis>
2215    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/df</emphasis>
2216    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/edquota</emphasis>
2217    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/ff</emphasis>
2218    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/fsdb</emphasis>
2219    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/fsirand</emphasis>
2220    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/fstyp</emphasis>
2221    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/labelit</emphasis>
2222    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/lockfs</emphasis>
2223    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/mkfs</emphasis>
2224    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/mount</emphasis>
2225    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/ncheck</emphasis>
2226    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/newfs</emphasis>
2227    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/quot</emphasis>
2228    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/quota</emphasis>
2229    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/quotaoff</emphasis>
2230    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/quotaon</emphasis>
2231    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/repquota</emphasis>
2232    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/tunefs</emphasis>
2233    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/ufsdump</emphasis>
2234    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/ufsrestore</emphasis>
2235    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/volcopy</emphasis>
2236 </programlisting></para>
2237           </listitem>
2238
2239           <listitem>
2240             <para>Append the following line to the end of the file <emphasis role="bold">/etc/dfs/fstypes</emphasis>.
2241             <programlisting>
2242    afs AFS Utilities
2243 </programlisting></para>
2244           </listitem>
2245
2246           <listitem>
2247             <para>Edit the <emphasis role="bold">/sbin/mountall</emphasis> file, making two changes. <itemizedlist>
2248                 <listitem>
2249                   <para>Add an entry for AFS to the <computeroutput>case</computeroutput> statement for option 2, so that it reads
2250                   as follows: <programlisting>
2251    case "$2" in
2252    ufs)    foptions="-o p"
2253            ;;
2254    afs)    foptions="-o p"
2255            ;;
2256    s5)     foptions="-y -t /var/tmp/tmp$$ -D"
2257            ;;
2258    *)      foptions="-y"
2259            ;;
2260 </programlisting></para>
2261                 </listitem>
2262
2263                 <listitem>
2264                   <para>Edit the file so that all AFS and UFS partitions are checked in parallel. Replace the following section of
2265                   code: <programlisting>
2266    # For  fsck purposes, we make a distinction between ufs and
2267    # other file systems
2268    #
2269    if [ "$fstype" = "ufs" ]; then
2270         ufs_fscklist="$ufs_fscklist $fsckdev"
2271         saveentry $fstype "$OPTIONS" $special $mountp
2272         continue
2273    fi
2274 </programlisting></para>
2275
2276                   <para>with the following section of code:</para>
2277
2278                   <programlisting>
2279    # For fsck purposes, we make a distinction between ufs/afs
2280    # and other file systems.
2281    #
2282    if [ "$fstype" = "ufs" -o "$fstype" = "afs" ]; then
2283         ufs_fscklist="$ufs_fscklist $fsckdev"
2284         saveentry $fstype "$OPTIONS" $special $mountp
2285         continue
2286    fi
2287 </programlisting>
2288                 </listitem>
2289               </itemizedlist></para>
2290           </listitem>
2291         </orderedlist></para>
2292
2293       <indexterm>
2294         <primary>configuring</primary>
2295
2296         <secondary>AFS server partition on first AFS machine</secondary>
2297
2298         <tertiary>Solaris</tertiary>
2299       </indexterm>
2300
2301       <indexterm>
2302         <primary>AFS server partition</primary>
2303
2304         <secondary>configuring on first AFS machine</secondary>
2305
2306         <tertiary>Solaris</tertiary>
2307       </indexterm>
2308
2309       <indexterm>
2310         <primary>first AFS machine</primary>
2311
2312         <secondary>AFS server partition</secondary>
2313
2314         <tertiary>on Solaris</tertiary>
2315       </indexterm>
2316
2317       <indexterm>
2318         <primary>Solaris</primary>
2319
2320         <secondary>AFS server partition</secondary>
2321
2322         <tertiary>on first AFS machine</tertiary>
2323       </indexterm>
2324     </sect2>
2325
2326     <sect2 id="HDRWQ48">
2327       <title>Configuring Server Partitions on Solaris Systems</title>
2328
2329       <para>Every AFS file server machine must have at least one partition or logical volume dedicated to storing AFS volumes. Each
2330       server partition is mounted at a directory named <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>, where
2331       <replaceable>xx</replaceable> is one or two lowercase letters. The <emphasis
2332       role="bold">/vicep</emphasis><replaceable>xx</replaceable> directories must reside in the file server machine's root
2333       directory, not in one of its subdirectories (for example, <emphasis role="bold">/usr/vicepa</emphasis> is not an acceptable
2334       directory location). For additional information, see <link linkend="HDRWQ20">Performing Platform-Specific Procedures</link>.
2335       <orderedlist>
2336           <listitem>
2337             <para>Create a directory called <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable> for each AFS server
2338             partition you are configuring (there must be at least one). Repeat the command for each partition. <programlisting>
2339    # <emphasis role="bold">mkdir /vicep</emphasis><replaceable>xx</replaceable>
2340 </programlisting></para>
2341           </listitem>
2342
2343           <listitem>
2344             <para>Add a line with the following format to the file systems registry file, <emphasis
2345             role="bold">/etc/vfstab</emphasis>, for each partition to be mounted on a directory created in the previous step. Note
2346             the value <computeroutput>afs</computeroutput> in the fourth field, which tells Solaris to use the AFS-modified
2347             <emphasis role="bold">fsck</emphasis> program on this partition. <programlisting>
2348    /dev/dsk/<replaceable>disk</replaceable>   /dev/rdsk/<replaceable>disk</replaceable>   /vicep<replaceable>xx</replaceable>   afs   <replaceable>boot_order</replaceable>  yes
2349 </programlisting></para>
2350
2351             <para>The following is an example for the first partition being configured.</para>
2352
2353             <programlisting>
2354    /dev/dsk/c0t6d0s1 /dev/rdsk/c0t6d0s1 /vicepa afs 3 yes
2355 </programlisting>
2356           </listitem>
2357
2358           <listitem>
2359             <para>Create a file system on each partition that is to be mounted at a <emphasis
2360             role="bold">/vicep</emphasis><replaceable>xx</replaceable> directory. The following command is probably appropriate, but
2361             consult the Solaris documentation for more information. <programlisting>
2362    # <emphasis role="bold">newfs -v /dev/rdsk/</emphasis><replaceable>disk</replaceable>
2363 </programlisting></para>
2364           </listitem>
2365
2366           <listitem>
2367             <para>Issue the <emphasis role="bold">mountall</emphasis> command to mount all partitions at once.</para>
2368           </listitem>
2369
2370           <listitem>
2371             <para>If you plan to retain client functionality on this machine after completing the installation, proceed to <link
2372             linkend="HDRWQ49">Enabling AFS Login and Editing the File Systems Clean-up Script on Solaris Systems</link>. Otherwise,
2373             proceed to <link linkend="HDRWQ50">Starting the BOS Server</link>.</para>
2374           </listitem>
2375         </orderedlist></para>
2376     </sect2>
2377
2378     <sect2 id="HDRWQ49">
2379       <title>Enabling AFS Login on Solaris Systems</title>
2380       <indexterm>
2381         <primary>enabling AFS login</primary>
2382
2383         <secondary>file server machine</secondary>
2384
2385         <tertiary>Solaris</tertiary>
2386       </indexterm>
2387
2388       <indexterm>
2389         <primary>AFS login</primary>
2390
2391         <secondary>on file server machine</secondary>
2392
2393         <tertiary>Solaris</tertiary>
2394       </indexterm>
2395
2396       <indexterm>
2397         <primary>first AFS machine</primary>
2398
2399         <secondary>AFS login</secondary>
2400
2401         <tertiary>on Solaris</tertiary>
2402       </indexterm>
2403
2404       <indexterm>
2405         <primary>Solaris</primary>
2406
2407         <secondary>AFS login</secondary>
2408
2409         <tertiary>on file server machine</tertiary>
2410       </indexterm>
2411
2412       <indexterm>
2413         <primary>PAM</primary>
2414
2415         <secondary>on Solaris</secondary>
2416
2417         <tertiary>file server machine</tertiary>
2418       </indexterm>
2419
2420       <note>
2421         <para>If you plan to remove client functionality from this machine after completing the installation, skip this section and
2422         proceed to <link linkend="HDRWQ50">Starting the BOS Server</link>.</para>
2423       </note>
2424
2425       <para>At this point you incorporate AFS into the operating system's
2426       Pluggable Authentication Module (PAM) scheme.  PAM integrates all
2427       authentication mechanisms on the machine, including login, to provide
2428       the security infrastructure for authenticated access to and from the
2429       machine.</para>
2430
2431       <para>Explaining PAM is beyond the scope of this document.  It is
2432       assumed that you understand the syntax and meanings of settings in the
2433       PAM configuration file (for example, how the
2434       <computeroutput>other</computeroutput> entry works, the effect of
2435       marking an entry as <computeroutput>required</computeroutput>,
2436       <computeroutput>optional</computeroutput>, or
2437       <computeroutput>sufficient</computeroutput>, and so on).</para>
2438
2439       <para>You should first configure your system to obtain Kerberos v5
2440       tickets as part of the authentication process, and then run an AFS PAM
2441       module to obtain tokens from those tickets after authentication.
2442       Current versions of Solaris come with a Kerberos v5 PAM module that
2443       will work, or you can download and install <ulink
2444       url="http://www.eyrie.org/~eagle/software/pam-krb5">Russ Allbery's
2445       Kerberos v5 PAM module</ulink>, which is tested regularly with AFS.
2446       See the instructions of whatever PAM module you use for how to
2447       configure it.</para>
2448
2449       <para>Some Kerberos v5 PAM modules do come with native AFS support
2450       (usually requiring the Heimdal Kerberos implementation rather than the
2451       MIT Kerberos implementation).  If you are using one of those PAM
2452       modules, you can configure it to obtain AFS tokens.  It's more common,
2453       however, to separate the AFS token acquisition into a separate PAM
2454       module.</para>
2455
2456       <para>The recommended AFS PAM module is <ulink
2457       url="http://www.eyrie.org/~eagle/software/pam-afs-session/">Russ
2458       Allbery's pam-afs-session module</ulink>.  It should work with any of
2459       the Kerberos v5 PAM modules.  To add it to the PAM configuration, you
2460       often only need to add configuration to the session group in
2461       <filename>pam.conf</filename>:</para>
2462
2463       <example>
2464         <title>Solaris PAM session example</title>
2465         <literallayout>login session required pam_afs_session.so</literallayout>
2466       </example>
2467
2468       <para>This example enables PAM authentication only for console login.
2469       You may want to add a similar line for the ssh service and for any
2470       other login service that you use, including possibly the
2471       <literal>other</literal> service (which serves as a catch-all).  You
2472       may also want to add options to the AFS PAM session module
2473       (particularly <literal>retain_after_close</literal>, which is
2474       necessary for some versions of Solaris.</para>
2475
2476       <para>For additional configuration examples and the configuration
2477       options of the AFS PAM module, see its documentation.  For more
2478       details on the available options for the PAM configuration, see the
2479       <filename>pam.conf</filename> manual page.</para>
2480
2481       <para>Sites which still require <emphasis
2482       role="bold">kaserver</emphasis> or external Kerberos v4 authentication
2483       should consult <link linkend="KAS016">Enabling kaserver based AFS
2484       Login on Solaris Systems"</link> for details of how to enable AFS
2485       login on Solaris.</para>
2486
2487       <para>Proceed to <link linkend="HDRWQ49a">Editing the File Systems
2488       Clean-up Script on Solaris Systems</link></para>
2489     </sect2>
2490     <sect2 id="HDRWQ49a">
2491       <title>Editing the File Systems Clean-up Script on Solaris Systems</title>
2492       <indexterm>
2493         <primary>Solaris</primary>
2494
2495         <secondary>file systems clean-up script</secondary>
2496
2497         <tertiary>on file server machine</tertiary>
2498       </indexterm>
2499
2500       <indexterm>
2501         <primary>file systems clean-up script (Solaris)</primary>
2502
2503         <secondary>file server machine</secondary>
2504       </indexterm>
2505
2506       <indexterm>
2507         <primary>scripts</primary>
2508
2509         <secondary>file systems clean-up (Solaris)</secondary>
2510
2511         <tertiary>file server machine</tertiary>
2512       </indexterm>
2513
2514
2515         <orderedlist>
2516           <listitem>
2517             <para>Some Solaris distributions include a script that locates and removes unneeded files from various file systems. Its
2518             conventional location is <emphasis role="bold">/usr/lib/fs/nfs/nfsfind</emphasis>. The script generally uses an argument
2519             to the <emphasis role="bold">find</emphasis> command to define which file systems to search. In this step you modify the
2520             command to exclude the <emphasis role="bold">/afs</emphasis> directory. Otherwise, the command traverses the AFS
2521             filespace of every cell that is accessible from the machine, which can take many hours. The following alterations are
2522             possibilities, but you must verify that they are appropriate for your cell.</para>
2523
2524             <para>The first possible alteration is to add the <emphasis role="bold">-local</emphasis> flag to the existing command,
2525             so that it looks like the following:</para>
2526
2527             <programlisting>
2528    find $dir -local -name .nfs\* -mtime +7 -mount -exec rm -f {} \;
2529 </programlisting>
2530
2531             <para>Another alternative is to exclude any directories whose names begin with the lowercase letter <emphasis
2532             role="bold">a</emphasis> or a non-alphabetic character.</para>
2533
2534             <programlisting>
2535    find /[A-Zb-z]*  <replaceable>remainder of existing command</replaceable>
2536 </programlisting>
2537
2538             <para>Do not use the following command, which still searches under the <emphasis role="bold">/afs</emphasis> directory,
2539             looking for a subdirectory of type <emphasis role="bold">4.2</emphasis>.</para>
2540
2541             <programlisting>
2542    find / -fstype 4.2     /* <replaceable>do not use</replaceable> */
2543 </programlisting>
2544           </listitem>
2545
2546           <listitem>
2547             <para>Proceed to <link linkend="HDRWQ50">Starting the BOS Server</link> (or if referring to these instructions while
2548             installing an additional file server machine, return to <link linkend="HDRWQ108">Starting Server
2549             Programs</link>).</para>
2550           </listitem>
2551         </orderedlist>
2552
2553       <indexterm>
2554         <primary>Basic OverSeer Server</primary>
2555
2556         <see>BOS Server</see>
2557       </indexterm>
2558
2559       <indexterm>
2560         <primary>BOS Server</primary>
2561
2562         <secondary>starting</secondary>
2563
2564         <tertiary>first AFS machine</tertiary>
2565       </indexterm>
2566
2567       <indexterm>
2568         <primary>starting</primary>
2569
2570         <secondary>BOS Server</secondary>
2571
2572         <tertiary>first AFS machine</tertiary>
2573       </indexterm>
2574
2575       <indexterm>
2576         <primary>first AFS machine</primary>
2577
2578         <secondary>BOS Server</secondary>
2579       </indexterm>
2580
2581       <indexterm>
2582         <primary>authorization checking (disabling)</primary>
2583
2584         <secondary>first AFS machine</secondary>
2585       </indexterm>
2586
2587       <indexterm>
2588         <primary>disabling authorization checking</primary>
2589
2590         <secondary>first AFS machine</secondary>
2591       </indexterm>
2592
2593       <indexterm>
2594         <primary>first AFS machine</primary>
2595
2596         <secondary>authorization checking (disabling)</secondary>
2597       </indexterm>
2598     </sect2>
2599   </sect1>
2600   <sect1 id="HDRWQ50">
2601     <title>Starting the BOS Server</title>
2602
2603     <para>You are now ready to start the AFS server processes on this machine.
2604     If you are not working from a packaged distribution, begin by copying the
2605     AFS server binaries from the distribution to the conventional local disk
2606     location, the <emphasis role="bold">/usr/afs/bin</emphasis> directory. The
2607     following instructions also create files in other subdirectories of the
2608     <emphasis role="bold">/usr/afs</emphasis> directory.</para>
2609
2610     <para>Then issue the <emphasis role="bold">bosserver</emphasis> command to initialize the Basic OverSeer (BOS) Server, which
2611     monitors and controls other AFS server processes on its server machine. Include the <emphasis role="bold">-noauth</emphasis>
2612     flag to disable authorization checking. Because you have not yet configured your cell's AFS authentication and authorization
2613     mechanisms, the BOS Server cannot perform authorization checking as it does during normal operation. In no-authorization mode,
2614     it does not verify the identity or privilege of the issuer of a <emphasis role="bold">bos</emphasis> command, and so performs
2615     any operation for anyone.</para>
2616
2617     <para>Disabling authorization checking gravely compromises cell security. You must complete all subsequent steps in one
2618     uninterrupted pass and must not leave the machine unattended until you restart the BOS Server with authorization checking
2619     enabled, in <link linkend="HDRWQ72">Verifying the AFS Initialization Script</link>.</para>
2620
2621     <para>As it initializes for the first time, the BOS Server creates the following directories and files, setting the owner to the
2622     local superuser <emphasis role="bold">root</emphasis> and the mode bits to limit the ability to write (and in some cases, read)
2623     them. For a description of the contents and function of these directories and files, see the chapter in the <emphasis>OpenAFS
2624     Administration Guide</emphasis> about administering server machines. For further discussion of the mode bit settings, see <link
2625     linkend="HDRWQ96">Protecting Sensitive AFS Directories</link>. <indexterm>
2626         <primary>Binary Distribution</primary>
2627
2628         <secondary>copying server files from</secondary>
2629
2630         <tertiary>first AFS machine</tertiary>
2631       </indexterm> <indexterm>
2632         <primary>first AFS machine</primary>
2633
2634         <secondary>subdirectories of /usr/afs</secondary>
2635       </indexterm> <indexterm>
2636         <primary>creating</primary>
2637
2638         <secondary>/usr/afs/bin directory</secondary>
2639
2640         <tertiary>first AFS machine</tertiary>
2641       </indexterm> <indexterm>
2642         <primary>creating</primary>
2643
2644         <secondary>/usr/afs/etc directory</secondary>
2645
2646         <tertiary>first AFS machine</tertiary>
2647       </indexterm> <indexterm>
2648         <primary>copying</primary>
2649
2650         <secondary>server files to local disk</secondary>
2651
2652         <tertiary>first AFS machine</tertiary>
2653       </indexterm> <indexterm>
2654         <primary>first AFS machine</primary>
2655
2656         <secondary>copying</secondary>
2657
2658         <tertiary>server files to local disk</tertiary>
2659       </indexterm> <indexterm>
2660         <primary>usr/afs/bin directory</primary>
2661
2662         <secondary>first AFS machine</secondary>
2663       </indexterm> <indexterm>
2664         <primary>usr/afs/etc directory</primary>
2665
2666         <secondary>first AFS machine</secondary>
2667       </indexterm> <indexterm>
2668         <primary>usr/afs/db directory</primary>
2669       </indexterm> <indexterm>
2670         <primary>usr/afs/local directory</primary>
2671       </indexterm> <indexterm>
2672         <primary>usr/afs/logs directory</primary>
2673       </indexterm> <itemizedlist>
2674         <listitem>
2675           <para><emphasis role="bold">/usr/afs/db</emphasis></para>
2676         </listitem>
2677
2678         <listitem>
2679           <para><emphasis role="bold">/usr/afs/etc/CellServDB</emphasis></para>
2680         </listitem>
2681
2682         <listitem>
2683           <para><emphasis role="bold">/usr/afs/etc/ThisCell</emphasis></para>
2684         </listitem>
2685
2686         <listitem>
2687           <para><emphasis role="bold">/usr/afs/local</emphasis></para>
2688         </listitem>
2689
2690         <listitem>
2691           <para><emphasis role="bold">/usr/afs/logs</emphasis></para>
2692         </listitem>
2693       </itemizedlist></para>
2694
2695     <para>The BOS Server also creates symbolic links called <emphasis role="bold">/usr/vice/etc/ThisCell</emphasis> and <emphasis
2696     role="bold">/usr/vice/etc/CellServDB</emphasis> to the corresponding files in the <emphasis role="bold">/usr/afs/etc</emphasis>
2697     directory. The AFS command interpreters consult the <emphasis role="bold">CellServDB</emphasis> and <emphasis
2698     role="bold">ThisCell</emphasis> files in the <emphasis role="bold">/usr/vice/etc</emphasis> directory because they generally run
2699     on client machines. On machines that are AFS servers only (as this machine currently is), the files reside only in the <emphasis
2700     role="bold">/usr/afs/etc</emphasis> directory; the links enable the command interpreters to retrieve the information they need.
2701     Later instructions for installing the client functionality replace the links with actual files. <orderedlist>
2702         <listitem>
2703           <para>If you are not working from a packaged distribution, you may need to copy files from the distribution media to the local <emphasis role="bold">/usr/afs</emphasis> directory.
2704 <programlisting>
2705    # <emphasis role="bold">cd /tmp/afsdist/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/root.server/usr/afs</emphasis>
2706    # <emphasis role="bold">cp -rp  *  /usr/afs</emphasis>
2707 </programlisting> <indexterm>
2708               <primary>commands</primary>
2709
2710               <secondary>bosserver</secondary>
2711             </indexterm> <indexterm>
2712               <primary>bosserver command</primary>
2713             </indexterm></para>
2714         </listitem>
2715
2716         <listitem>
2717           <para>Issue the <emphasis role="bold">bosserver</emphasis> command. Include the <emphasis role="bold">-noauth</emphasis>
2718           flag to disable authorization checking. <programlisting>
2719    # <emphasis role="bold">/usr/afs/bin/bosserver -noauth &amp;</emphasis>
2720 </programlisting></para>
2721         </listitem>
2722
2723         <listitem>
2724           <para>Verify that the BOS Server created <emphasis role="bold">/usr/vice/etc/ThisCell</emphasis> and <emphasis
2725           role="bold">/usr/vice/etc/CellServDB</emphasis> as symbolic links to the corresponding files in the <emphasis
2726           role="bold">/usr/afs/etc</emphasis> directory. <programlisting>
2727    # <emphasis role="bold">ls -l  /usr/vice/etc</emphasis>
2728 </programlisting></para>
2729
2730           <para>If either or both of <emphasis role="bold">/usr/vice/etc/ThisCell</emphasis> and <emphasis
2731           role="bold">/usr/vice/etc/CellServDB</emphasis> do not exist, or are not links, issue the following commands.</para>
2732
2733           <programlisting>
2734    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
2735    # <emphasis role="bold">ln -s /usr/afs/etc/ThisCell</emphasis>
2736    # <emphasis role="bold">ln -s /usr/afs/etc/CellServDB</emphasis>
2737 </programlisting>
2738         </listitem>
2739       </orderedlist></para>
2740
2741     <indexterm>
2742       <primary>cell name</primary>
2743
2744       <secondary>defining during installation of first machine</secondary>
2745     </indexterm>
2746
2747     <indexterm>
2748       <primary>defining</primary>
2749
2750       <secondary>cell name during installation of first machine</secondary>
2751     </indexterm>
2752
2753     <indexterm>
2754       <primary>cell name</primary>
2755
2756       <secondary>setting in server ThisCell file</secondary>
2757
2758       <tertiary>first AFS machine</tertiary>
2759     </indexterm>
2760
2761     <indexterm>
2762       <primary>setting</primary>
2763
2764       <secondary>cell name in server ThisCell file</secondary>
2765
2766       <tertiary>first AFS machine</tertiary>
2767     </indexterm>
2768
2769     <indexterm>
2770       <primary>first AFS machine</primary>
2771
2772       <secondary>ThisCell file (server)</secondary>
2773     </indexterm>
2774
2775     <indexterm>
2776       <primary>usr/afs/etc/ThisCell</primary>
2777
2778       <see>ThisCell file (server)</see>
2779     </indexterm>
2780
2781     <indexterm>
2782       <primary>ThisCell file (server)</primary>
2783
2784       <secondary>first AFS machine</secondary>
2785     </indexterm>
2786
2787     <indexterm>
2788       <primary>files</primary>
2789
2790       <secondary>ThisCell (server)</secondary>
2791     </indexterm>
2792
2793     <indexterm>
2794       <primary>database server machine</primary>
2795
2796       <secondary>entry in server CellServDB file</secondary>
2797
2798       <tertiary>on first AFS machine</tertiary>
2799     </indexterm>
2800
2801     <indexterm>
2802       <primary>first AFS machine</primary>
2803
2804       <secondary>cell membership, defining</secondary>
2805
2806       <tertiary>for server processes</tertiary>
2807     </indexterm>
2808
2809     <indexterm>
2810       <primary>usr/afs/etc/CellServDB file</primary>
2811
2812       <see>CellServDB file (server)</see>
2813     </indexterm>
2814
2815     <indexterm>
2816       <primary>CellServDB file (server)</primary>
2817
2818       <secondary>creating</secondary>
2819
2820       <tertiary>on first AFS machine</tertiary>
2821     </indexterm>
2822
2823     <indexterm>
2824       <primary>creating</primary>
2825
2826       <secondary>CellServDB file (server)</secondary>
2827
2828       <tertiary>first AFS machine</tertiary>
2829     </indexterm>
2830
2831     <indexterm>
2832       <primary>files</primary>
2833
2834       <secondary>CellServDB (server)</secondary>
2835     </indexterm>
2836
2837     <indexterm>
2838       <primary>first AFS machine</primary>
2839
2840       <secondary>CellServDB file (server)</secondary>
2841     </indexterm>
2842
2843     <indexterm>
2844       <primary>first AFS machine</primary>
2845
2846       <secondary>defining</secondary>
2847
2848       <tertiary>as database server</tertiary>
2849     </indexterm>
2850
2851     <indexterm>
2852       <primary>defining</primary>
2853
2854       <secondary>first AFS machine as database server</secondary>
2855     </indexterm>
2856   </sect1>
2857
2858   <sect1 id="HDRWQ51">
2859     <title>Defining Cell Name and Membership for Server Processes</title>
2860
2861     <para>Now assign your cell's name. The chapter in the <emphasis>OpenAFS Administration Guide</emphasis> about cell configuration
2862     and administration issues discusses the important considerations, explains why changing the name is difficult, and outlines the
2863     restrictions on name format. Two of the most important restrictions are that the name cannot include uppercase letters or more
2864     than 64 characters.</para>
2865
2866     <para>Use the <emphasis role="bold">bos setcellname</emphasis> command to assign the cell name. It creates two files:
2867     <itemizedlist>
2868         <listitem>
2869           <para><emphasis role="bold">/usr/afs/etc/ThisCell</emphasis>, which defines this machine's cell membership</para>
2870         </listitem>
2871
2872         <listitem>
2873           <para><emphasis role="bold">/usr/afs/etc/CellServDB</emphasis>, which lists the cell's database server machines; the
2874           machine named on the command line is placed on the list automatically</para>
2875         </listitem>
2876       </itemizedlist> <note>
2877         <para>In the following and every instruction in this guide, for the <replaceable>machine name</replaceable> argument
2878         substitute the fully-qualified hostname (such as <emphasis role="bold">fs1.example.com</emphasis>) of the machine you are
2879         installing. For the <replaceable>cell name</replaceable> argument substitute your cell's complete name (such as <emphasis
2880         role="bold">example.com</emphasis>).</para>
2881       </note></para>
2882
2883     <indexterm>
2884       <primary>commands</primary>
2885
2886       <secondary>bos setcellname</secondary>
2887     </indexterm>
2888
2889     <indexterm>
2890       <primary>bos commands</primary>
2891
2892       <secondary>setcellname</secondary>
2893     </indexterm>
2894
2895     <orderedlist>
2896       <listitem>
2897         <para>If necessary, add the directory containing the <emphasis role="bold">bos</emphasis> command to your path.
2898       <programlisting>
2899    # <emphasis role="bold">export PATH=$PATH:/usr/afs/bin</emphasis>
2900       </programlisting>
2901         </para>
2902       </listitem>
2903
2904       <listitem>
2905         <para>Issue the <emphasis role="bold">bos setcellname</emphasis> command to set the cell name. <programlisting>
2906    # <emphasis role="bold">bos setcellname</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>cell name</replaceable>&gt; <emphasis
2907               role="bold">-noauth</emphasis>
2908 </programlisting></para>
2909
2910         <para>Because you are not authenticated and authorization checking is disabled, the <emphasis role="bold">bos</emphasis>
2911         command interpreter possibly produces error messages about being unable to obtain tickets and running unauthenticated. You
2912         can safely ignore the messages. <indexterm>
2913             <primary>commands</primary>
2914
2915             <secondary>bos listhosts</secondary>
2916           </indexterm> <indexterm>
2917             <primary>bos commands</primary>
2918
2919             <secondary>listhosts</secondary>
2920           </indexterm> <indexterm>
2921             <primary>CellServDB file (server)</primary>
2922
2923             <secondary>displaying entries</secondary>
2924           </indexterm> <indexterm>
2925             <primary>displaying</primary>
2926
2927             <secondary>CellServDB file (server) entries</secondary>
2928           </indexterm></para>
2929       </listitem>
2930
2931       <listitem>
2932         <para>Issue the <emphasis role="bold">bos listhosts</emphasis> command to verify that the machine you are installing is now
2933         registered as the cell's first database server machine. <programlisting>
2934    # <emphasis role="bold">bos listhosts</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">-noauth</emphasis>
2935    Cell name is <replaceable>cell_name</replaceable>
2936        Host 1 is <replaceable>machine_name</replaceable>
2937 </programlisting></para>
2938       </listitem>
2939     </orderedlist>
2940
2941     <indexterm>
2942       <primary>database server machine</primary>
2943
2944       <secondary>installing</secondary>
2945
2946       <tertiary>first</tertiary>
2947     </indexterm>
2948
2949     <indexterm>
2950       <primary>instructions</primary>
2951
2952       <secondary>database server machine, installing first</secondary>
2953     </indexterm>
2954
2955     <indexterm>
2956       <primary>installing</primary>
2957
2958       <secondary>database server machine</secondary>
2959
2960       <tertiary>first</tertiary>
2961     </indexterm>
2962
2963     <indexterm>
2964       <primary>Backup Server</primary>
2965
2966       <secondary>starting</secondary>
2967
2968       <tertiary>first AFS machine</tertiary>
2969     </indexterm>
2970
2971     <indexterm>
2972       <primary>buserver process</primary>
2973
2974       <see>Backup Server</see>
2975     </indexterm>
2976
2977     <indexterm>
2978       <primary>starting</primary>
2979
2980       <secondary>Backup Server</secondary>
2981
2982       <tertiary>first AFS machine</tertiary>
2983     </indexterm>
2984
2985     <indexterm>
2986       <primary>first AFS machine</primary>
2987
2988       <secondary>Backup Server</secondary>
2989     </indexterm>
2990
2991     <indexterm>
2992       <primary>Protection Server</primary>
2993
2994       <secondary>starting</secondary>
2995
2996       <tertiary>first AFS machine</tertiary>
2997     </indexterm>
2998
2999     <indexterm>
3000       <primary>ptserver process</primary>
3001
3002       <see>Protection Server</see>
3003     </indexterm>
3004
3005     <indexterm>
3006       <primary>starting</primary>
3007
3008       <secondary>Protection Server</secondary>
3009
3010       <tertiary>first AFS machine</tertiary>
3011     </indexterm>
3012
3013     <indexterm>
3014       <primary>first AFS machine</primary>
3015
3016       <secondary>Protection Server</secondary>
3017     </indexterm>
3018
3019     <indexterm>
3020       <primary>VL Server (vlserver process)</primary>
3021
3022       <secondary>starting</secondary>
3023
3024       <tertiary>first AFS machine</tertiary>
3025     </indexterm>
3026
3027     <indexterm>
3028       <primary>Volume Location Server</primary>
3029
3030       <see>VL Server</see>
3031     </indexterm>
3032
3033     <indexterm>
3034       <primary>starting</primary>
3035
3036       <secondary>VL Server</secondary>
3037
3038       <tertiary>first AFS machine</tertiary>
3039     </indexterm>
3040
3041     <indexterm>
3042       <primary>first AFS machine</primary>
3043
3044       <secondary>VL Server</secondary>
3045     </indexterm>
3046
3047     <indexterm>
3048       <primary>usr/afs/local/BosConfig</primary>
3049
3050       <see>BosConfig file</see>
3051     </indexterm>
3052
3053     <indexterm>
3054       <primary>BosConfig file</primary>
3055
3056       <secondary>adding entries</secondary>
3057
3058       <tertiary>first AFS machine</tertiary>
3059     </indexterm>
3060
3061     <indexterm>
3062       <primary>adding</primary>
3063
3064       <secondary>entries to BosConfig file</secondary>
3065
3066       <tertiary>first AFS machine</tertiary>
3067     </indexterm>
3068
3069     <indexterm>
3070       <primary>files</primary>
3071
3072       <secondary>BosConfig</secondary>
3073     </indexterm>
3074
3075     <indexterm>
3076       <primary>initializing</primary>
3077
3078       <secondary>server process</secondary>
3079
3080       <see>starting</see>
3081     </indexterm>
3082
3083     <indexterm>
3084       <primary>server process</primary>
3085
3086       <secondary>see also entry for each server's name</secondary>
3087     </indexterm>
3088   </sect1>
3089
3090   <sect1 id="HDRWQ52">
3091     <title>Starting the Database Server Processes</title>
3092
3093     <para>Next use the <emphasis role="bold">bos create</emphasis> command to create entries for the three database server processes
3094     in the <emphasis role="bold">/usr/afs/local/BosConfig</emphasis> file and start them running. The three processes run on database
3095     server machines only: <itemizedlist>
3096
3097         <listitem>
3098           <para>The Backup Server (the <emphasis role="bold">buserver</emphasis> process) maintains the Backup Database</para>
3099         </listitem>
3100
3101         <listitem>
3102           <para>The Protection Server (the <emphasis role="bold">ptserver</emphasis> process) maintains the Protection
3103           Database</para>
3104         </listitem>
3105
3106         <listitem>
3107           <para>The Volume Location (VL) Server (the <emphasis role="bold">vlserver</emphasis> process) maintains the Volume
3108           Location Database (VLDB)</para>
3109         </listitem>
3110       </itemizedlist></para>
3111
3112     <indexterm>
3113       <primary>Kerberos</primary>
3114     </indexterm>
3115
3116     <note>
3117       <para>AFS ships with an additional database server named 'kaserver', which
3118       was historically used to provide authentication services to AFS cells.
3119       kaserver was based on <emphasis>Kerberos v4</emphasis>, as such, it is
3120       not recommended for new cells. This guide assumes you have already
3121       configured a Kerberos v5 realm for your site, and details the procedures
3122       required to use AFS with this realm. If you do wish to use
3123       <emphasis role="bold">kaserver</emphasis>, please see the modifications
3124       to these instructions detailed in
3125       <link linkend="KAS006">Starting the kaserver Database Server Process</link>
3126       </para>
3127     </note>
3128
3129     <para>The remaining instructions in this chapter include the <emphasis role="bold">-cell</emphasis> argument on all applicable
3130     commands. Provide the cell name you assigned in <link linkend="HDRWQ51">Defining Cell Name and Membership for Server
3131     Processes</link>. If a command appears on multiple lines, it is only for legibility. <indexterm>
3132         <primary>commands</primary>
3133
3134         <secondary>bos create</secondary>
3135       </indexterm> <indexterm>
3136         <primary>bos commands</primary>
3137
3138         <secondary>create</secondary>
3139       </indexterm> <orderedlist>
3140         <listitem>
3141           <para>Issue the <emphasis role="bold">bos create</emphasis> command to start the Backup Server. <programlisting>
3142    # <emphasis role="bold">./bos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">buserver simple /usr/afs/bin/buserver</emphasis>  \
3143  <emphasis role="bold">                 -cell</emphasis> &lt;<replaceable>cell name</replaceable>&gt;  <emphasis role="bold">-noauth</emphasis>
3144 </programlisting></para>
3145         </listitem>
3146
3147         <listitem>
3148           <para>Issue the <emphasis role="bold">bos create</emphasis> command to start the Protection Server. <programlisting>
3149    # <emphasis role="bold">./bos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">ptserver simple /usr/afs/bin/ptserver</emphasis>  \
3150  <emphasis role="bold">                 -cell</emphasis> &lt;<replaceable>cell name</replaceable>&gt;  <emphasis role="bold">-noauth</emphasis>
3151 </programlisting></para>
3152         </listitem>
3153
3154         <listitem>
3155           <para>Issue the <emphasis role="bold">bos create</emphasis> command to start the VL Server. <programlisting>
3156    # <emphasis role="bold">./bos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">vlserver simple /usr/afs/bin/vlserver</emphasis>  \
3157  <emphasis role="bold">                 -cell</emphasis> &lt;<replaceable>cell name</replaceable>&gt;  <emphasis role="bold">-noauth</emphasis>
3158 </programlisting></para>
3159         </listitem>
3160       </orderedlist></para>
3161
3162     <indexterm>
3163       <primary>admin account</primary>
3164
3165       <secondary>creating</secondary>
3166     </indexterm>
3167
3168     <indexterm>
3169       <primary>afs entry in Kerberos Database</primary>
3170     </indexterm>
3171
3172     <indexterm>
3173       <primary>Kerberos Database</primary>
3174     </indexterm>
3175
3176     <indexterm>
3177       <primary>creating</primary>
3178
3179       <secondary>afs entry in Kerberos Database</secondary>
3180     </indexterm>
3181
3182     <indexterm>
3183       <primary>creating</primary>
3184
3185       <secondary>admin account in Kerberos Database</secondary>
3186     </indexterm>
3187
3188     <indexterm>
3189       <primary>security</primary>
3190
3191       <secondary>initializing cell-wide</secondary>
3192     </indexterm>
3193
3194     <indexterm>
3195       <primary>cell</primary>
3196
3197       <secondary>initializing security mechanisms</secondary>
3198     </indexterm>
3199
3200     <indexterm>
3201       <primary>initializing</primary>
3202
3203       <secondary>cell security mechanisms</secondary>
3204     </indexterm>
3205
3206     <indexterm>
3207       <primary>usr/afs/etc/KeyFile</primary>
3208
3209       <see>KeyFile file</see>
3210     </indexterm>
3211
3212     <indexterm>
3213       <primary>KeyFile file</primary>
3214
3215       <secondary>first AFS machine</secondary>
3216     </indexterm>
3217
3218     <indexterm>
3219       <primary>files</primary>
3220
3221       <secondary>KeyFile</secondary>
3222     </indexterm>
3223
3224     <indexterm>
3225       <primary>key</primary>
3226
3227       <see>server encryption key</see>
3228     </indexterm>
3229
3230     <indexterm>
3231       <primary>encryption key</primary>
3232
3233       <see>server encryption key</see>
3234     </indexterm>
3235   </sect1>
3236
3237   <sect1 id="HDRWQ53">
3238     <title>Initializing Cell Security </title>
3239
3240     <para>If you are working with an existing cell which uses
3241     <emphasis role="bold">kaserver</emphasis> or Kerberos v4 for authentication,
3242     please see
3243     <link linkend="HDRWQ53">Initializing Cell Security with kaserver</link>
3244     for installation instructions which replace this section.</para>
3245
3246     <para>Now initialize the cell's security mechanisms. Begin by creating the following two entires in your site's Kerberos database: <itemizedlist>
3247         <listitem>
3248           <para>A generic administrative account, called <emphasis role="bold">admin</emphasis> by convention. If you choose to
3249           assign a different name, substitute it throughout the remainder of this document.</para>
3250
3251           <para>After you complete the installation of the first machine, you can continue to have all administrators use the
3252           <emphasis role="bold">admin</emphasis> account, or you can create a separate administrative account for each of them. The
3253           latter scheme implies somewhat more overhead, but provides a more informative audit trail for administrative
3254           operations.</para>
3255         </listitem>
3256
3257         <listitem>
3258           <para>The entry for AFS server processes, called either
3259           <emphasis role="bold">afs</emphasis> or
3260           <emphasis role="bold">afs/<replaceable>cell</replaceable></emphasis>.
3261           No user logs in under this identity, but it is used to encrypt the
3262           server tickets that granted to AFS clients for presentation to
3263           server processes during mutual authentication. (The
3264           chapter in the <emphasis>OpenAFS Administration Guide</emphasis> about cell configuration and administration describes the
3265           role of server encryption keys in mutual authentication.)</para>
3266
3267           <para>In Step <link linkend="LIWQ58">7</link>, you also place the initial AFS server encryption key into the <emphasis
3268           role="bold">/usr/afs/etc/KeyFile</emphasis> file. The AFS server processes refer to this file to learn the server
3269           encryption key when they need to decrypt server tickets.</para>
3270         </listitem>
3271       </itemizedlist></para>
3272
3273     <para>You also issue several commands that enable the new <emphasis role="bold">admin</emphasis> user to issue privileged
3274     commands in all of the AFS suites.</para>
3275
3276     <para>The following instructions do not configure all of the security mechanisms related to the AFS Backup System. See the
3277     chapter in the <emphasis>OpenAFS Administration Guide</emphasis> about configuring the Backup System.</para>
3278
3279     <para>The examples below assume you are using MIT Kerberos. Please refer
3280     to the documentation for your KDC's administrative interface if you are
3281     using a different vendor</para>
3282
3283     <orderedlist>
3284         <listitem>
3285           <para>Enter <emphasis role="bold">kadmin</emphasis> interactive mode.
3286 <programlisting>
3287    # <emphasis role="bold">kadmin</emphasis>
3288 Authenticating as principal <replaceable>you</replaceable>/admin@<replaceable>YOUR REALM</replaceable> with password
3289 Password for <replaceable>you/admin@REALM</replaceable>: <replaceable>your_password</replaceable>
3290 </programlisting> <indexterm>
3291               <primary>server encryption key</primary>
3292
3293               <secondary>in Kerberos Database</secondary>
3294             </indexterm> <indexterm>
3295               <primary>creating</primary>
3296
3297               <secondary>server encryption key</secondary>
3298
3299               <tertiary>Kerberos Database</tertiary>
3300             </indexterm></para>
3301         </listitem>
3302
3303         <listitem>
3304           <para><anchor id="LIWQ54" />Issue the
3305           <emphasis role="bold">add_principal</emphasis> command to create
3306           Kerberos Database entries called
3307           <emphasis role="bold">admin</emphasis> and
3308           <emphasis role="bold">afs/&lt;<replaceable>cell name</replaceable>&gt;</emphasis>.</para>
3309
3310           <para>You should make the <replaceable>admin_passwd</replaceable> as
3311           long and complex as possible, but keep in mind that administrators
3312           need to enter it often. It must be at least six characters long.</para>
3313           <para>Note that when creating the
3314           <emphasis role="bold">afs/&lt;<replaceable>cell name</replaceable>&gt;</emphasis>
3315           entry, the encryption types should be restricted to des-cbc-crc:v4.
3316           For more details regarding encryption types, see the documentation
3317           for your Kerberos installation.
3318
3319 <programlisting>
3320    kadmin: <emphasis role="bold">add_principal -randkey -e des-cbc-crc:v4 afs/</emphasis>&lt;<replaceable>cell name</replaceable>&gt;
3321    Principal "afs/<replaceable>cell name</replaceable>@<replaceable>REALM</replaceable>" created.
3322    kadmin:  <emphasis role="bold">add_principal admin</emphasis>
3323    Enter password for principal "admin@<replaceable>REALM</replaceable>": <emphasis role="bold"><replaceable>admin_password</replaceable></emphasis>
3324    Principal "admin@<replaceable>REALM</replaceable>" created.
3325 </programlisting>
3326           </para>
3327
3328           <indexterm>
3329             <primary>commands</primary>
3330
3331             <secondary>kas examine</secondary>
3332           </indexterm>
3333
3334           <indexterm>
3335             <primary>kas commands</primary>
3336
3337             <secondary>examine</secondary>
3338           </indexterm>
3339
3340           <indexterm>
3341             <primary>displaying</primary>
3342
3343             <secondary>server encryption key</secondary>
3344
3345             <tertiary>Authentication Database</tertiary>
3346           </indexterm>
3347         </listitem>
3348
3349         <listitem>
3350           <para><anchor id="LIWQ55" />Issue the <emphasis role="bold">kadmin
3351           get_principal</emphasis> command to display the <emphasis
3352           role="bold">afs/</emphasis>&lt;<replaceable>cell name</replaceable>&gt; entry.
3353 <programlisting>
3354   kadmin: <emphasis role="bold">get_principal afs/&lt;<replaceable>cell name</replaceable>&gt;</emphasis>
3355   Principal: afs/<replaceable>cell</replaceable>
3356   [ ... ]
3357   Key: vno 2, DES cbc mode with CRC-32, no salt
3358   [ ... ]
3359 </programlisting>
3360 </para>
3361         </listitem>
3362         <listitem>
3363           <para>Extract the newly created key for <emphasis role="bold">afs/<replaceable>cell</replaceable></emphasis> to a keytab on the local machine. We will use <emphasis role="bold">/etc/afs.keytab</emphasis> as the location for this keytab.</para>
3364
3365           <para>The keytab contains the key material that ensures the security of your AFS cell. You should ensure that it is kept in a secure location at all times.</para>
3366
3367 <programlisting>
3368   kadmin: <emphasis role="bold">ktadd -k /etc/afs.keytab -e des-cbc-crc:v4 afs/&lt;<replaceable>cell name</replaceable>&gt;</emphasis>
3369 Entry for principal afs/&lt;<replaceable>cell name</replaceable>&gt; with kvno 3, encryption type DES cbc mode with CRC-32 added to keytab WRFILE:/etc/afs.keytab
3370 </programlisting>
3371           <para>Make a note of the key version number (kvno) given in the
3372           response, as you will need it to load the key into bos in a later
3373           step</para>
3374
3375           <note><para>Note that each time you run
3376           <emphasis role="bold">ktadd</emphasis> a new key is generated
3377           for the item being extracted. This means that you cannot run ktadd
3378           multiple times and end up with the same key material each time.
3379           </para></note>
3380
3381         </listitem>
3382         <listitem>
3383           <para>Issue the <emphasis role="bold">kadmin quit</emphasis> command to leave <emphasis role="bold">kadmin</emphasis>
3384           interactive mode. <programlisting>
3385    kadmin: <emphasis role="bold">quit</emphasis>
3386 </programlisting> <indexterm>
3387               <primary>commands</primary>
3388
3389               <secondary>bos adduser</secondary>
3390             </indexterm> <indexterm>
3391               <primary>bos commands</primary>
3392
3393               <secondary>adduser</secondary>
3394             </indexterm> <indexterm>
3395               <primary>usr/afs/etc/UserList</primary>
3396
3397               <see>UserList file</see>
3398             </indexterm> <indexterm>
3399               <primary>UserList file</primary>
3400
3401               <secondary>first AFS machine</secondary>
3402             </indexterm> <indexterm>
3403               <primary>files</primary>
3404
3405               <secondary>UserList</secondary>
3406             </indexterm> <indexterm>
3407               <primary>creating</primary>
3408
3409               <secondary>UserList file entry</secondary>
3410             </indexterm> <indexterm>
3411               <primary>admin account</primary>
3412
3413               <secondary>adding</secondary>
3414
3415               <tertiary>to UserList file</tertiary>
3416             </indexterm></para>
3417         </listitem>
3418
3419         <listitem>
3420           <para><anchor id="LIWQ57" />Issue the <emphasis role="bold">bos adduser</emphasis> command to add the <emphasis
3421           role="bold">admin</emphasis> user to the <emphasis role="bold">/usr/afs/etc/UserList</emphasis> file. This enables the
3422           <emphasis role="bold">admin</emphasis> user to issue privileged <emphasis role="bold">bos</emphasis> and <emphasis
3423           role="bold">vos</emphasis> commands. <programlisting>
3424    # <emphasis role="bold">./bos adduser</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">admin -cell</emphasis> &lt;<replaceable>cell name</replaceable>&gt; <emphasis
3425                 role="bold">-noauth</emphasis>
3426 </programlisting>
3427             <indexterm>
3428               <primary>commands</primary>
3429               <secondary>asetkey</secondary>
3430             </indexterm>
3431             <indexterm>
3432               <primary>creating</primary>
3433               <secondary>server encryption key</secondary>
3434               <tertiary>KeyFile file</tertiary>
3435             </indexterm>
3436             <indexterm>
3437               <primary>server encryption key</primary>
3438               <secondary>in KeyFile file</secondary>
3439             </indexterm></para>
3440         </listitem>
3441
3442         <listitem>
3443           <para><anchor id="LIWQ58" />Issue the
3444           <emphasis role="bold">asetkey</emphasis> command to set the AFS
3445           server encryption key in the
3446           <emphasis role="bold">/usr/afs/etc/KeyFile</emphasis> file. This key
3447           is created from the <emphasis role="bold">/etc/afs.keytab</emphasis>
3448           file created earlier.</para>
3449
3450           <para>asetkey requires the key version number (or kvno) of the
3451           <emphasis role="bold">afs/</emphasis><replaceable>cell</replaceable>
3452           key. You should have noted this down when creating the key earlier.
3453           The key version number can also be found by running the
3454           <emphasis role="bold">kvno</emphasis> command</para>
3455 <programlisting>
3456    # <emphasis role="bold">kvno afs/</emphasis>&lt;<replaceable>cell name</replaceable>&gt;
3457 </programlisting>
3458
3459           <para>Once the kvno is known, the key can then be extracted using
3460           asetkey</para>
3461 <programlisting>
3462    # <emphasis role="bold">asetkey</emphasis> &lt;<replaceable>kvno</replaceable>&gt;  <emphasis role="bold">/etc/afs.keytab afs/</emphasis>&lt;<replaceable>cell name</replaceable>&gt;
3463 </programlisting>
3464
3465           <indexterm>
3466             <primary>commands</primary>
3467             <secondary>bos listkeys</secondary>
3468           </indexterm>
3469
3470           <indexterm>
3471             <primary>bos commands</primary>
3472             <secondary>listkeys</secondary>
3473           </indexterm>
3474
3475           <indexterm>
3476             <primary>displaying</primary>
3477             <secondary>server encryption key</secondary>
3478             <tertiary>KeyFile file</tertiary>
3479           </indexterm>
3480         </listitem>
3481
3482         <listitem>
3483           <para><anchor id="LIWQ59" />Issue the
3484           <emphasis role="bold">bos listkeys</emphasis> command to verify that
3485           the key version number for the new key in the
3486           <emphasis role="bold">KeyFile</emphasis> file is the same as the key
3487           version number in the Authentication Database's
3488           <emphasis role="bold">afs/<replaceable>cell name</replaceable></emphasis>
3489           entry, which you displayed in Step <link linkend="LIWQ55">3</link>.
3490 <programlisting>
3491    # <emphasis role="bold">./bos listkeys</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">-cell</emphasis> &lt;<replaceable>cell name</replaceable>&gt; <emphasis
3492                 role="bold">-noauth</emphasis>
3493    key 0 has cksum <replaceable>checksum</replaceable>
3494 </programlisting></para>
3495
3496           <para>You can safely ignore any error messages indicating that <emphasis role="bold">bos</emphasis> failed to get tickets
3497           or that authentication failed.</para>
3498         </listitem>
3499       </orderedlist>
3500     </sect1>
3501     <sect1 id="HDRWQ53a">
3502       <title>Initializing the Protection Database</title>
3503
3504       <para>Now continue to configure your cell's security systems by
3505       populating the Protection Database with the newly created
3506       <emphasis role="bold">admin</emphasis> user, and permitting it
3507       to issue priviledged commands on the AFS filesystem.</para>
3508
3509         <orderedlist>
3510           <listitem>
3511           <indexterm>
3512             <primary>commands</primary>
3513             <secondary>pts createuser</secondary>
3514           </indexterm>
3515
3516           <indexterm>
3517             <primary>pts commands</primary>
3518             <secondary>createuser</secondary>
3519           </indexterm>
3520
3521           <indexterm>
3522             <primary>Protection Database</primary>
3523           </indexterm>
3524           <para>Issue the <emphasis role="bold">pts createuser</emphasis> command to create a Protection Database entry for the
3525           <emphasis role="bold">admin</emphasis> user.</para>
3526
3527           <para>By default, the Protection Server assigns AFS UID 1 (one) to the <emphasis role="bold">admin</emphasis> user,
3528           because it is the first user entry you are creating. If the local password file (<emphasis
3529           role="bold">/etc/passwd</emphasis> or equivalent) already has an entry for <emphasis role="bold">admin</emphasis> that
3530           assigns it a UNIX UID other than 1, it is best to use the <emphasis role="bold">-id</emphasis> argument to the <emphasis
3531           role="bold">pts createuser</emphasis> command to make the new AFS UID match the existing UNIX UID. Otherwise, it is best
3532           to accept the default.</para>
3533
3534           <programlisting>
3535    # <emphasis role="bold">pts createuser -name admin -cell</emphasis> &lt;<replaceable>cell name</replaceable>&gt; [<emphasis
3536               role="bold">-id</emphasis> &lt;<replaceable>AFS UID</replaceable>&gt;]  <emphasis role="bold">-noauth</emphasis>
3537    User admin has id <replaceable>AFS UID</replaceable>
3538 </programlisting>
3539
3540           <indexterm>
3541             <primary>commands</primary>
3542             <secondary>pts adduser</secondary>
3543           </indexterm>
3544
3545           <indexterm>
3546             <primary>pts commands</primary>
3547             <secondary>adduser</secondary>
3548           </indexterm>
3549
3550           <indexterm>
3551             <primary>system:administrators group</primary>
3552           </indexterm>
3553
3554           <indexterm>
3555             <primary>admin account</primary>
3556             <secondary>adding</secondary>
3557             <tertiary>to system:administrators group</tertiary>
3558           </indexterm>
3559         </listitem>
3560
3561         <listitem>
3562           <para>Issue the <emphasis role="bold">pts adduser</emphasis> command to make the <emphasis role="bold">admin</emphasis>
3563           user a member of the <emphasis role="bold">system:administrators</emphasis> group, and the <emphasis role="bold">pts
3564           membership</emphasis> command to verify the new membership. Membership in the group enables the <emphasis
3565           role="bold">admin</emphasis> user to issue privileged <emphasis role="bold">pts</emphasis> commands and some privileged
3566           <emphasis role="bold">fs</emphasis> commands. <programlisting>
3567    # <emphasis role="bold">./pts adduser admin system:administrators -cell</emphasis> &lt;<replaceable>cell name</replaceable>&gt; <emphasis
3568                 role="bold">-noauth</emphasis>
3569    # <emphasis role="bold">./pts membership admin -cell</emphasis>  &lt;<replaceable>cell name</replaceable>&gt; <emphasis
3570                 role="bold">-noauth</emphasis>
3571    Groups admin (id: 1) is a member of:
3572      system:administrators
3573 </programlisting> <indexterm>
3574               <primary>commands</primary>
3575               <secondary>bos restart</secondary>
3576               <tertiary>on first AFS machine</tertiary>
3577             </indexterm> <indexterm>
3578               <primary>bos commands</primary>
3579               <secondary>restart</secondary>
3580               <tertiary>on first AFS machine</tertiary>
3581             </indexterm> <indexterm>
3582               <primary>restarting server process</primary>
3583               <secondary>on first AFS machine</secondary>
3584             </indexterm> <indexterm>
3585               <primary>server process</primary>
3586               <secondary>restarting</secondary>
3587               <tertiary>on first AFS machine</tertiary>
3588             </indexterm></para>
3589         </listitem>
3590
3591         <listitem>
3592           <para>Issue the <emphasis role="bold">bos restart</emphasis> command with the <emphasis role="bold">-all</emphasis> flag
3593           to restart the database server processes, so that they start using the new server encryption key. <programlisting>
3594    # <emphasis role="bold">./bos restart</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">-all -cell</emphasis> &lt;<replaceable>cell name</replaceable>&gt; <emphasis
3595                 role="bold">-noauth</emphasis>
3596 </programlisting></para>
3597         </listitem>
3598       </orderedlist>
3599
3600     <indexterm>
3601       <primary>File Server</primary>
3602
3603       <secondary>first AFS machine</secondary>
3604     </indexterm>
3605
3606     <indexterm>
3607       <primary>fileserver process</primary>
3608
3609       <see>File Server</see>
3610     </indexterm>
3611
3612     <indexterm>
3613       <primary>starting</primary>
3614
3615       <secondary>File Server</secondary>
3616
3617       <tertiary>first AFS machine</tertiary>
3618     </indexterm>
3619
3620     <indexterm>
3621       <primary>first AFS machine</primary>
3622
3623       <secondary>File Server, fs process</secondary>
3624     </indexterm>
3625
3626     <indexterm>
3627       <primary>Volume Server</primary>
3628
3629       <secondary>first AFS machine</secondary>
3630     </indexterm>
3631
3632     <indexterm>
3633       <primary>volserver process</primary>
3634
3635       <see>Volume Server</see>
3636     </indexterm>
3637
3638     <indexterm>
3639       <primary>starting</primary>
3640
3641       <secondary>Volume Server</secondary>
3642
3643       <tertiary>first AFS machine</tertiary>
3644     </indexterm>
3645
3646     <indexterm>
3647       <primary>first AFS machine</primary>
3648
3649       <secondary>Volume Server</secondary>
3650     </indexterm>
3651
3652     <indexterm>
3653       <primary>Salvager (salvager process)</primary>
3654
3655       <secondary>first AFS machine</secondary>
3656     </indexterm>
3657
3658     <indexterm>
3659       <primary>fs process</primary>
3660
3661       <secondary>first AFS machine</secondary>
3662     </indexterm>
3663
3664     <indexterm>
3665       <primary>starting</primary>
3666
3667       <secondary>fs process</secondary>
3668
3669       <tertiary>first AFS machine</tertiary>
3670     </indexterm>
3671
3672     <indexterm>
3673       <primary>first AFS machine</primary>
3674
3675       <secondary>Salvager</secondary>
3676     </indexterm>
3677   </sect1>
3678
3679   <sect1 id="HDRWQ60">
3680     <title>Starting the File Server, Volume Server, and Salvager</title>
3681
3682     <para>Start the <emphasis role="bold">fs</emphasis> process, which consists of the File Server, Volume Server, and Salvager
3683     (<emphasis role="bold">fileserver</emphasis>, <emphasis role="bold">volserver</emphasis> and <emphasis
3684     role="bold">salvager</emphasis> processes). <orderedlist>
3685         <listitem>
3686           <para>Issue the <emphasis role="bold">bos create</emphasis> command to start the <emphasis role="bold">fs</emphasis>
3687           process. The command appears here on multiple lines only for legibility. <programlisting>
3688    # <emphasis role="bold">./bos create</emphasis>  &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">fs fs /usr/afs/bin/fileserver</emphasis>   \
3689                    <emphasis role="bold">/usr/afs/bin/volserver /usr/afs/bin/salvager</emphasis>  \
3690                    <emphasis role="bold">-cell</emphasis> &lt;<replaceable>cell name</replaceable>&gt;  <emphasis role="bold">-noauth</emphasis>
3691 </programlisting></para>
3692
3693           <para>Sometimes a message about Volume Location Database (VLDB) initialization appears, along with one or more instances
3694           of an error message similar to the following:</para>
3695
3696           <programlisting>
3697    FSYNC_clientInit temporary failure (will retry)
3698 </programlisting>
3699
3700           <para>This message appears when the <emphasis role="bold">volserver</emphasis> process tries to start before the <emphasis
3701           role="bold">fileserver</emphasis> process has completed its initialization. Wait a few minutes after the last such message
3702           before continuing, to guarantee that both processes have started successfully. <indexterm>
3703               <primary>commands</primary>
3704
3705               <secondary>bos status</secondary>
3706             </indexterm> <indexterm>
3707               <primary>bos commands</primary>
3708
3709               <secondary>status</secondary>
3710             </indexterm></para>
3711
3712           <para>You can verify that the <emphasis role="bold">fs</emphasis> process has started successfully by issuing the
3713           <emphasis role="bold">bos status</emphasis> command. Its output mentions two <computeroutput>proc
3714           starts</computeroutput>.</para>
3715
3716           <programlisting>
3717    # <emphasis role="bold">./bos status</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">fs -long -noauth</emphasis>
3718 </programlisting>
3719         </listitem>
3720
3721         <listitem>
3722           <para>Your next action depends on whether you have ever run AFS file server machines in the cell: <itemizedlist>
3723               <indexterm>
3724                 <primary>commands</primary>
3725
3726                 <secondary>vos create</secondary>
3727
3728                 <tertiary>root.afs volume</tertiary>
3729               </indexterm>
3730
3731               <indexterm>
3732                 <primary>vos commands</primary>
3733
3734                 <secondary>create</secondary>
3735
3736                 <tertiary>root.afs volume</tertiary>
3737               </indexterm>
3738
3739               <indexterm>
3740                 <primary>root.afs volume</primary>
3741
3742                 <secondary>creating</secondary>
3743               </indexterm>
3744
3745               <indexterm>
3746                 <primary>volume</primary>
3747
3748                 <secondary>creating</secondary>
3749
3750                 <tertiary>root.afs</tertiary>
3751               </indexterm>
3752
3753               <indexterm>
3754                 <primary>creating</primary>
3755
3756                 <secondary>root.afs volume</secondary>
3757               </indexterm>
3758
3759               <listitem>
3760                 <para>If you are installing the first AFS server machine ever in the cell (that is, you are not upgrading the AFS
3761                 software from a previous version), create the first AFS volume, <emphasis role="bold">root.afs</emphasis>.</para>
3762
3763                 <para>For the <replaceable>partition name</replaceable> argument, substitute the name of one of the machine's AFS
3764                 server partitions (such as <emphasis role="bold">/vicepa</emphasis>).</para>
3765
3766                 <programlisting>
3767    # <emphasis role="bold">./vos create</emphasis>  &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <emphasis
3768                     role="bold">root.afs</emphasis>   \
3769                    <emphasis role="bold">-cell</emphasis> &lt;<replaceable>cell name</replaceable>&gt;  <emphasis role="bold">-noauth</emphasis>
3770 </programlisting>
3771
3772                 <para>The Volume Server produces a message confirming that it created the volume on the specified partition. You can
3773                 ignore error messages indicating that tokens are missing, or that authentication failed. <indexterm>
3774                     <primary>commands</primary>
3775
3776                     <secondary>vos syncvldb</secondary>
3777                   </indexterm> <indexterm>
3778                     <primary>vos commands</primary>
3779
3780                     <secondary>syncvldb</secondary>
3781                   </indexterm> <indexterm>
3782                     <primary>commands</primary>
3783
3784                     <secondary>vos syncserv</secondary>
3785                   </indexterm> <indexterm>
3786                     <primary>vos commands</primary>
3787
3788                     <secondary>syncserv</secondary>
3789                   </indexterm></para>
3790               </listitem>
3791
3792               <listitem>
3793                 <para>If there are existing AFS file server machines and volumes in the cell, issue the <emphasis role="bold">vos
3794                 syncvldb</emphasis> and <emphasis role="bold">vos syncserv</emphasis> commands to synchronize the VLDB with the
3795                 actual state of volumes on the local machine. To follow the progress of the synchronization operation, which can
3796                 take several minutes, use the <emphasis role="bold">-verbose</emphasis> flag. <programlisting>
3797    # <emphasis role="bold">./vos syncvldb</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">-cell</emphasis> &lt;<replaceable>cell name</replaceable>&gt; <emphasis
3798                       role="bold">-verbose  -noauth</emphasis>
3799    # <emphasis role="bold">./vos syncserv</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">-cell</emphasis> &lt;<replaceable>cell name</replaceable>&gt; <emphasis
3800                       role="bold">-verbose  -noauth</emphasis>
3801 </programlisting></para>
3802
3803                 <para>You can ignore error messages indicating that tokens are missing, or that authentication failed.</para>
3804               </listitem>
3805             </itemizedlist></para>
3806         </listitem>
3807       </orderedlist></para>
3808
3809     <indexterm>
3810       <primary>Update Server</primary>
3811
3812       <secondary>starting server portion</secondary>
3813
3814       <tertiary>first AFS machine</tertiary>
3815     </indexterm>
3816
3817     <indexterm>
3818       <primary>upserver process</primary>
3819
3820       <see>Update Server</see>
3821     </indexterm>
3822
3823     <indexterm>
3824       <primary>starting</primary>
3825
3826       <secondary>Update Server server portion</secondary>
3827
3828       <tertiary>first AFS machine</tertiary>
3829     </indexterm>
3830
3831     <indexterm>
3832       <primary>first AFS machine</primary>
3833
3834       <secondary>Update Server server portion</secondary>
3835     </indexterm>
3836
3837     <indexterm>
3838       <primary>first AFS machine</primary>
3839
3840       <secondary>defining</secondary>
3841
3842       <tertiary>as binary distribution machine</tertiary>
3843     </indexterm>
3844
3845     <indexterm>
3846       <primary>first AFS machine</primary>
3847
3848       <secondary>defining</secondary>
3849
3850       <tertiary>as system control machine</tertiary>
3851     </indexterm>
3852
3853     <indexterm>
3854       <primary>system control machine</primary>
3855     </indexterm>
3856
3857     <indexterm>
3858       <primary>binary distribution machine</primary>
3859     </indexterm>
3860   </sect1>
3861
3862   <sect1 id="HDRWQ61">
3863     <title>Starting the Server Portion of the Update Server</title>
3864
3865     <para>Start the server portion of the Update Server (the <emphasis role="bold">upserver</emphasis> process), to distribute the
3866     contents of directories on this machine to other server machines in the cell. It becomes active when you configure the client
3867     portion of the Update Server on additional server machines.</para>
3868
3869     <para>Distributing the contents of its <emphasis role="bold">/usr/afs/etc</emphasis> directory makes this machine the cell's
3870     <emphasis>system control machine</emphasis>. The other server machines in the cell run the <emphasis
3871     role="bold">upclientetc</emphasis> process (an instance of the client portion of the Update Server) to retrieve the
3872     configuration files. Use the <emphasis role="bold">-crypt</emphasis> argument to the <emphasis role="bold">upserver</emphasis>
3873     initialization command to specify that the Update Server distributes the contents of the <emphasis
3874     role="bold">/usr/afs/etc</emphasis> directory only in encrypted form, as shown in the following instruction. Several of the
3875     files in the directory, particularly the <emphasis role="bold">KeyFile</emphasis> file, are crucial to cell security and so must
3876     never cross the network unencrypted.</para>
3877
3878     <para>(You can choose not to configure a system control machine, in which case you must update the configuration files in each
3879     server machine's <emphasis role="bold">/usr/afs/etc</emphasis> directory individually. The <emphasis role="bold">bos</emphasis>
3880     commands used for this purpose also encrypt data before sending it across the network.)</para>
3881
3882     <para>Distributing the contents of its <emphasis role="bold">/usr/afs/bin</emphasis> directory to other server machines of its
3883     system type makes this machine a <emphasis>binary distribution machine</emphasis>. The other server machines of its system type
3884     run the <emphasis role="bold">upclientbin</emphasis> process (an instance of the client portion of the Update Server) to
3885     retrieve the binaries. If your platform has a package management system,
3886     such as 'rpm' or 'apt', running the Update Server to distribute binaries
3887     may interfere with this system.</para>
3888
3889     <para>The binaries in the <emphasis role="bold">/usr/afs/bin</emphasis> directory are not sensitive, so it is not necessary to
3890     encrypt them before transfer across the network. Include the <emphasis role="bold">-clear</emphasis> argument to the <emphasis
3891     role="bold">upserver</emphasis> initialization command to specify that the Update Server distributes the contents of the
3892     <emphasis role="bold">/usr/afs/bin</emphasis> directory in unencrypted form unless an <emphasis
3893     role="bold">upclientbin</emphasis> process requests encrypted transfer.</para>
3894
3895     <para>Note that the server and client portions of the Update Server always mutually authenticate with one another, regardless of
3896     whether you use the <emphasis role="bold">-clear</emphasis> or <emphasis role="bold">-crypt</emphasis> arguments. This protects
3897     their communications from eavesdropping to some degree.</para>
3898
3899     <para>For more information on the <emphasis role="bold">upclient</emphasis> and <emphasis role="bold">upserver</emphasis>
3900     processes, see their reference pages in the <emphasis>OpenAFS Administration Reference</emphasis>. The commands appear on
3901     multiple lines here only for legibility. <orderedlist>
3902         <listitem>
3903           <para>Issue the <emphasis role="bold">bos create</emphasis> command to start the <emphasis role="bold">upserver</emphasis>
3904           process. <programlisting>
3905    # <emphasis role="bold">./bos create</emphasis>  &lt;<replaceable>machine name&gt;</replaceable> <emphasis role="bold">upserver simple</emphasis>  \
3906              <emphasis role="bold">"/usr/afs/bin/upserver  -crypt /usr/afs/etc</emphasis>    \
3907              <emphasis role="bold">-clear /usr/afs/bin" -cell</emphasis> &lt;<replaceable>cell name</replaceable>&gt;  <emphasis
3908                 role="bold">-noauth</emphasis>
3909 </programlisting></para>
3910         </listitem>
3911       </orderedlist></para>
3912   </sect1>
3913
3914   <sect1 id="HDRWQ62">
3915     <title>Starting the Controller for NTPD</title>
3916
3917     <para>Keeping the clocks on all server and client machines in your cell synchronized is crucial to several functions, and in
3918     particular to the correct operation of AFS's distributed database technology, Ubik. The chapter in the <emphasis>OpenAFS
3919     Administration Guide</emphasis> about administering server machines explains how time skew can disturb Ubik's performance and
3920     cause service outages in your cell.</para>
3921
3922     <para>Historically, AFS used to distribute its own version of the Network
3923 Time Protocol Daemon. Whilst this is still provided for existing sites, we
3924 recommend that you configure and install your time service independently of
3925 AFS. A reliable timeservice will also be required by your Kerberos realm,
3926 and so may already be available at your site.</para>
3927
3928     <indexterm>
3929       <primary>overview</primary>
3930
3931       <secondary>installing client functionality on first machine</secondary>
3932     </indexterm>
3933
3934     <indexterm>
3935       <primary>first AFS machine</primary>
3936
3937       <secondary>client functionality</secondary>
3938
3939       <tertiary>installing</tertiary>
3940     </indexterm>
3941
3942     <indexterm>
3943       <primary>installing</primary>
3944
3945       <secondary>client functionality</secondary>
3946
3947       <tertiary>first AFS machine</tertiary>
3948     </indexterm>
3949   </sect1>
3950
3951   <sect1 id="HDRWQ63">
3952     <title>Overview: Installing Client Functionality</title>
3953
3954     <para>The machine you are installing is now an AFS file server machine,
3955     database server machine, system control machine, and binary distribution
3956     machine. Now make it a client machine by completing the following tasks:
3957     <orderedlist>
3958         <listitem>
3959           <para>Define the machine's cell membership for client processes</para>
3960         </listitem>
3961
3962         <listitem>
3963           <para>Create the client version of the <emphasis role="bold">CellServDB</emphasis> file</para>
3964         </listitem>
3965
3966         <listitem>
3967           <para>Define cache location and size</para>
3968         </listitem>
3969
3970         <listitem>
3971           <para>Create the <emphasis role="bold">/afs</emphasis> directory and start the Cache Manager</para>
3972         </listitem>
3973       </orderedlist></para>
3974
3975     <indexterm>
3976       <primary>Distribution</primary>
3977
3978       <secondary>copying client files from</secondary>
3979
3980       <tertiary>first AFS machine</tertiary>
3981     </indexterm>
3982
3983     <indexterm>
3984       <primary>first AFS machine</primary>
3985
3986       <secondary>copying</secondary>
3987
3988       <tertiary>client files to local disk</tertiary>
3989     </indexterm>
3990
3991     <indexterm>
3992       <primary>copying</primary>
3993
3994       <secondary>client files to local disk</secondary>
3995
3996       <tertiary>first AFS machine</tertiary>
3997     </indexterm>
3998   </sect1>
3999
4000   <sect1 id="HDRWQ64">
4001     <title>Copying Client Files to the Local Disk</title>
4002
4003     <para>You need only undertake the steps in this section, if you are using
4004     a tar file distribution, or one built from scratch. Packaged distributions,
4005     such as RPMs or DEBs will already have installed the necessary files in
4006     the correct locations.</para>
4007
4008     <para>Before installing and configuring the AFS client, copy the necessary files from the tarball to the local <emphasis
4009     role="bold">/usr/vice/etc</emphasis> directory. <orderedlist>
4010         <listitem>
4011           <para>If you have not already done so, unpack the distribution
4012           tarball for this machine's system type into a suitable location on
4013           the filesystem, such as <emphasis role="bold">/tmp/afsdist</emphasis>.
4014           If you use a different location, substitue that in the examples that
4015           follow.</para>
4016         </listitem>
4017
4018         <listitem>
4019           <para>Copy files to the local <emphasis role="bold">/usr/vice/etc</emphasis> directory.</para>
4020
4021           <para>This step places a copy of the AFS initialization script (and related files, if applicable) into the <emphasis
4022           role="bold">/usr/vice/etc</emphasis> directory. In the preceding instructions for incorporating AFS into the kernel, you
4023           copied the script directly to the operating system's conventional location for initialization files. When you incorporate
4024           AFS into the machine's startup sequence in a later step, you can choose to link the two files.</para>
4025
4026           <para>On some system types that use a dynamic kernel loader program, you previously copied AFS library files into a
4027           subdirectory of the <emphasis role="bold">/usr/vice/etc</emphasis> directory. On other system types, you copied the
4028           appropriate AFS library file directly to the directory where the operating system accesses it. The following commands do
4029           not copy or recopy the AFS library files into the <emphasis role="bold">/usr/vice/etc</emphasis> directory, because on
4030           some system types the library files consume a large amount of space. If you want to copy them, add the <emphasis
4031           role="bold">-r</emphasis> flag to the first <emphasis role="bold">cp</emphasis> command and skip the second <emphasis
4032           role="bold">cp</emphasis> command.</para>
4033
4034           <programlisting>
4035    # <emphasis role="bold">cd /tmp/afsdist/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/root.client/usr/vice/etc</emphasis>
4036    # <emphasis role="bold">cp -p  *  /usr/vice/etc</emphasis>
4037    # <emphasis role="bold">cp -rp  C  /usr/vice/etc</emphasis>
4038 </programlisting>
4039         </listitem>
4040       </orderedlist></para>
4041
4042     <indexterm>
4043       <primary>cell name</primary>
4044
4045       <secondary>setting in client ThisCell file</secondary>
4046
4047       <tertiary>first AFS machine</tertiary>
4048     </indexterm>
4049
4050     <indexterm>
4051       <primary>setting</primary>
4052
4053       <secondary>cell name in client ThisCell file</secondary>
4054
4055       <tertiary>first AFS machine</tertiary>
4056     </indexterm>
4057
4058     <indexterm>
4059       <primary>first AFS machine</primary>
4060
4061       <secondary>ThisCell file (client)</secondary>
4062     </indexterm>
4063
4064     <indexterm>
4065       <primary>first AFS machine</primary>
4066
4067       <secondary>cell membership, defining</secondary>
4068
4069       <tertiary>for client processes</tertiary>
4070     </indexterm>
4071
4072     <indexterm>
4073       <primary>usr/vice/etc/ThisCell</primary>
4074
4075       <see>ThisCell file (client)</see>
4076     </indexterm>
4077
4078     <indexterm>
4079       <primary>ThisCell file (client)</primary>
4080
4081       <secondary>first AFS machine</secondary>
4082     </indexterm>
4083
4084     <indexterm>
4085       <primary>files</primary>
4086
4087       <secondary>ThisCell (client)</secondary>
4088     </indexterm>
4089   </sect1>
4090
4091   <sect1 id="HDRWQ65">
4092     <title>Defining Cell Membership for Client Processes</title>
4093
4094     <para>Every AFS client machine has a copy of the <emphasis role="bold">/usr/vice/etc/ThisCell</emphasis> file on its local disk
4095     to define the machine's cell membership for the AFS client programs that run on it. The <emphasis
4096     role="bold">ThisCell</emphasis> file you created in the <emphasis role="bold">/usr/afs/etc</emphasis> directory (in <link
4097     linkend="HDRWQ51">Defining Cell Name and Membership for Server Processes</link>) is used only by server processes.</para>
4098
4099     <para>Among other functions, the <emphasis role="bold">ThisCell</emphasis> file on a client machine determines the following:
4100     <itemizedlist>
4101         <listitem>
4102           <para>The cell in which users gain tokens when they log onto the
4103           machine, assuming it is using an AFS-modified login utility</para>
4104         </listitem>
4105
4106         <listitem>
4107           <para>The cell in which users gain tokens by default when they issue
4108           the <emphasis role="bold">aklog</emphasis> command</para>
4109         </listitem>
4110
4111         <listitem>
4112           <para>The cell membership of the AFS server processes that the AFS
4113           command interpreters on this machine contact by default</para>
4114         </listitem>
4115       </itemizedlist>
4116     <orderedlist>
4117         <listitem>
4118           <para>Change to the <emphasis role="bold">/usr/vice/etc</emphasis> directory and remove the symbolic link created in <link
4119           linkend="HDRWQ50">Starting the BOS Server</link>. <programlisting>
4120    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
4121    # <emphasis role="bold">rm ThisCell</emphasis>
4122 </programlisting></para>
4123         </listitem>
4124
4125         <listitem>
4126           <para>Create the <emphasis role="bold">ThisCell</emphasis> file as a copy of the <emphasis
4127           role="bold">/usr/afs/etc/ThisCell</emphasis> file. Defining the same local cell for both server and client processes leads
4128           to the most consistent AFS performance. <programlisting>
4129    # <emphasis role="bold">cp  /usr/afs/etc/ThisCell  ThisCell</emphasis>
4130 </programlisting></para>
4131         </listitem>
4132       </orderedlist></para>
4133
4134     <indexterm>
4135       <primary>database server machine</primary>
4136
4137       <secondary>entry in client CellServDB file</secondary>
4138
4139       <tertiary>on first AFS machine</tertiary>
4140     </indexterm>
4141
4142     <indexterm>
4143       <primary>usr/vice/etc/CellServDB</primary>
4144
4145       <see>CellServDB file (client)</see>
4146     </indexterm>
4147
4148     <indexterm>
4149       <primary>CellServDB file (client)</primary>
4150
4151       <secondary>creating</secondary>
4152
4153       <tertiary>on first AFS machine</tertiary>
4154     </indexterm>
4155
4156     <indexterm>
4157       <primary>creating</primary>
4158
4159       <secondary>CellServDB file (client)</secondary>
4160
4161       <tertiary>first AFS machine</tertiary>
4162     </indexterm>
4163
4164     <indexterm>
4165       <primary>CellServDB file (client)</primary>
4166
4167       <secondary>required format</secondary>
4168     </indexterm>
4169
4170     <indexterm>
4171       <primary>requirements</primary>
4172
4173       <secondary>CellServDB file format (client version)</secondary>
4174     </indexterm>
4175
4176     <indexterm>
4177       <primary>files</primary>
4178
4179       <secondary>CellServDB (client)</secondary>
4180     </indexterm>
4181
4182     <indexterm>
4183       <primary>first AFS machine</primary>
4184
4185       <secondary>CellServDB file (client)</secondary>
4186     </indexterm>
4187   </sect1>
4188
4189   <sect1 id="HDRWQ66">
4190     <title>Creating the Client CellServDB File</title>
4191
4192     <para>The <emphasis role="bold">/usr/vice/etc/CellServDB</emphasis> file on a client machine's local disk lists the database
4193     server machines for each cell that the local Cache Manager can contact. If there is no entry in the file for a cell, or if the
4194     list of database server machines is wrong, then users working on this machine cannot access the cell. The chapter in the
4195     <emphasis>OpenAFS Administration Guide</emphasis> about administering client machines explains how to maintain the file after
4196     creating it.</para>
4197
4198     <para>As the <emphasis role="bold">afsd</emphasis> program initializes the Cache Manager, it copies the contents of the
4199     <emphasis role="bold">CellServDB</emphasis> file into kernel memory. The Cache Manager always consults the list in kernel memory
4200     rather than the <emphasis role="bold">CellServDB</emphasis> file itself. Between reboots of the machine, you can use the
4201     <emphasis role="bold">fs newcell</emphasis> command to update the list in kernel memory directly; see the chapter in the
4202     <emphasis>OpenAFS Administration Guide</emphasis> about administering client machines.</para>
4203
4204     <para>The AFS distribution includes the file
4205     <emphasis role="bold">CellServDB.dist</emphasis>. It includes an entry for
4206     all AFS cells that agreed to share their database server machine
4207     information at the time the distribution was
4208     created. The definitive copy of this file is maintained at
4209     grand.central.org, and updates may be obtained from
4210     /afs/grand.central.org/service/CellServDB or
4211     <ulink url="http://grand.central.org/dl/cellservdb/CellServDB">
4212     http://grand.central.org/dl/cellservdb/CellServDB</ulink></para>
4213
4214     <para>The <emphasis role="bold">CellServDB.dist</emphasis> file can be a
4215     good basis for the client <emphasis role="bold">CellServDB</emphasis> file,
4216     because all of the entries in it use the correct format. You can add or
4217     remove cell entries as you see fit. Depending on your cache manager
4218     configuration, additional steps (as detailed in
4219     <link linkend="HDRWQ91">Enabling Access to Foreign Cells</link>) may be
4220     required to enable the Cache Manager to actually reach the cells.</para>
4221
4222     <para>In this section, you add an entry for the local cell to the local <emphasis role="bold">CellServDB</emphasis> file. The
4223     current working directory is still <emphasis role="bold">/usr/vice/etc</emphasis>. <orderedlist>
4224         <listitem>
4225           <para>Remove the symbolic link created in <link linkend="HDRWQ50">Starting the BOS Server</link> and rename the <emphasis
4226           role="bold">CellServDB.sample</emphasis> file to <emphasis role="bold">CellServDB</emphasis>. <programlisting>
4227    # <emphasis role="bold">rm CellServDB</emphasis>
4228    # <emphasis role="bold">mv CellServDB.sample CellServDB</emphasis>
4229 </programlisting></para>
4230         </listitem>
4231
4232         <listitem>
4233           <para>Add an entry for the local cell to the <emphasis role="bold">CellServDB</emphasis> file. One easy method is to use
4234           the <emphasis role="bold">cat</emphasis> command to append the contents of the server <emphasis
4235           role="bold">/usr/afs/etc/CellServDB</emphasis> file to the client version. <programlisting>
4236     # <emphasis role="bold">cat  /usr/afs/etc/CellServDB &gt;&gt;  CellServDB</emphasis>
4237 </programlisting></para>
4238
4239           <para>Then open the file in a text editor to verify that there are no blank lines, and that all entries have the required
4240           format, which is described just following. The ordering of cells is not significant, but it can be convenient to have the
4241           client machine's home cell at the top; move it there now if you wish. <itemizedlist>
4242               <listitem>
4243                 <para>The first line of a cell's entry has the following format: <programlisting>
4244    &gt;<replaceable>cell_name</replaceable>      #<replaceable>organization</replaceable>
4245 </programlisting></para>
4246
4247                 <para>where <replaceable>cell_name</replaceable> is the cell's complete Internet domain name (for example, <emphasis
4248                 role="bold">example.com</emphasis>) and <replaceable>organization</replaceable> is an optional field that follows any
4249                 number of spaces and the number sign (<computeroutput>#</computeroutput>). By convention it names the organization
4250                 to which the cell corresponds (for example, the Example Corporation).</para>
4251               </listitem>
4252
4253               <listitem>
4254                 <para>After the first line comes a separate line for each database server machine. Each line has the following
4255                 format: <programlisting>
4256    <replaceable>IP_address</replaceable>   #<replaceable>machine_name</replaceable>
4257 </programlisting></para>
4258
4259                 <para>where <replaceable>IP_address</replaceable> is the machine's IP address in dotted decimal format (for example,
4260                 192.12.105.3). Following any number of spaces and the number sign (<computeroutput>#</computeroutput>) is
4261                 <replaceable>machine_name</replaceable>, the machine's fully-qualified hostname (for example, <emphasis
4262                 role="bold">db1.example.com</emphasis>). In this case, the number sign does not indicate a comment;
4263                 <replaceable>machine_name</replaceable> is a required field.</para>
4264               </listitem>
4265             </itemizedlist></para>
4266         </listitem>
4267
4268         <listitem>
4269           <para>If the file includes cells that you do not wish users of this machine to access, remove their entries.</para>
4270         </listitem>
4271       </orderedlist></para>
4272
4273     <para>The following example shows entries for two cells, each of which has three database server machines:</para>
4274
4275     <programlisting>
4276    &gt;example.com       #Example Corporation (home cell)
4277    192.12.105.3      #db1.example.com
4278    192.12.105.4      #db2.example.com
4279    192.12.105.55     #db3.example.com
4280    &gt;stateu.edu    #State University cell
4281    138.255.68.93     #serverA.stateu.edu
4282    138.255.68.72     #serverB.stateu.edu
4283    138.255.33.154    #serverC.stateu.edu
4284 </programlisting>
4285
4286     <indexterm>
4287       <primary>cache</primary>
4288
4289       <secondary>configuring</secondary>
4290
4291       <tertiary>first AFS machine</tertiary>
4292     </indexterm>
4293
4294     <indexterm>
4295       <primary>configuring</primary>
4296
4297       <secondary>cache</secondary>
4298
4299       <tertiary>first AFS machine</tertiary>
4300     </indexterm>
4301
4302     <indexterm>
4303       <primary>setting</primary>
4304
4305       <secondary>cache size and location</secondary>
4306
4307       <tertiary>first AFS machine</tertiary>
4308     </indexterm>
4309
4310     <indexterm>
4311       <primary>first AFS machine</primary>
4312
4313       <secondary>cache size and location</secondary>
4314     </indexterm>
4315   </sect1>
4316
4317   <sect1 id="HDRWQ67">
4318     <title>Configuring the Cache</title>
4319
4320     <para>The Cache Manager uses a cache on the local disk or in machine memory to store local copies of files fetched from file
4321     server machines. As the <emphasis role="bold">afsd</emphasis> program initializes the Cache Manager, it sets basic cache
4322     configuration parameters according to definitions in the local <emphasis role="bold">/usr/vice/etc/cacheinfo</emphasis> file.
4323     The file has three fields: <orderedlist>
4324         <listitem>
4325           <para>The first field names the local directory on which to mount the AFS filespace. The conventional location is the
4326           <emphasis role="bold">/afs</emphasis> directory.</para>
4327         </listitem>
4328
4329         <listitem>
4330           <para>The second field defines the local disk directory to use for the disk cache. The conventional location is the
4331           <emphasis role="bold">/usr/vice/cache</emphasis> directory, but you can specify an alternate directory if another
4332           partition has more space available. There must always be a value in this field, but the Cache Manager ignores it if the
4333           machine uses a memory cache.</para>
4334         </listitem>
4335
4336         <listitem>
4337           <para>The third field specifies the number of kilobyte (1024 byte) blocks to allocate for the cache.</para>
4338         </listitem>
4339       </orderedlist></para>
4340
4341     <para>The values you define must meet the following requirements. <itemizedlist>
4342         <listitem>
4343           <para>On a machine using a disk cache, the Cache Manager expects always to be able to use the amount of space specified in
4344           the third field. Failure to meet this requirement can cause serious problems, some of which can be repaired only by
4345           rebooting. You must prevent non-AFS processes from filling up the cache partition. The simplest way is to devote a
4346           partition to the cache exclusively.</para>
4347         </listitem>
4348
4349         <listitem>
4350           <para>The amount of space available in memory or on the partition housing the disk cache directory imposes an absolute
4351           limit on cache size.</para>
4352         </listitem>
4353
4354         <listitem>
4355           <para>The maximum supported cache size can vary in each AFS release; see the <emphasis>OpenAFS Release Notes</emphasis>
4356           for the current version.</para>
4357         </listitem>
4358
4359         <listitem>
4360           <para>For a disk cache, you cannot specify a value in the third field that exceeds 95% of the space available on the
4361           partition mounted at the directory named in the second field. If you violate this restriction, the <emphasis
4362           role="bold">afsd</emphasis> program exits without starting the Cache Manager and prints an appropriate message on the
4363           standard output stream. A value of 90% is more appropriate on most machines. Some operating systems (such as AIX) do not
4364           automatically reserve some space to prevent the partition from filling completely; for them, a smaller value (say, 80% to
4365           85% of the space available) is more appropriate.</para>
4366         </listitem>
4367
4368         <listitem>
4369           <para>For a memory cache, you must leave enough memory for other processes and applications to run. If you try to allocate
4370           more memory than is actually available, the <emphasis role="bold">afsd</emphasis> program exits without initializing the
4371           Cache Manager and produces the following message on the standard output stream. <programlisting>
4372    afsd: memCache allocation failure at <replaceable>number</replaceable> KB
4373 </programlisting></para>
4374
4375           <para>The <replaceable>number</replaceable> value is how many kilobytes were allocated just before the failure, and so
4376           indicates the approximate amount of memory available.</para>
4377         </listitem>
4378       </itemizedlist></para>
4379
4380     <para>Within these hard limits, the factors that determine appropriate cache size include the number of users working on the
4381     machine, the size of the files with which they work, and (for a memory cache) the number of processes that run on the machine.
4382     The higher the demand from these factors, the larger the cache needs to be to maintain good performance.</para>
4383
4384     <para>Disk caches smaller than 10 MB do not generally perform well. Machines serving multiple users usually perform better with
4385     a cache of at least 60 to 70 MB. The point at which enlarging the cache further does not really improve performance depends on
4386     the factors mentioned previously and is difficult to predict.</para>
4387
4388     <para>Memory caches smaller than 1 MB are nonfunctional, and the performance of caches smaller than 5 MB is usually
4389     unsatisfactory. Suitable upper limits are similar to those for disk caches but are probably determined more by the demands on
4390     memory from other sources on the machine (number of users and processes). Machines running only a few processes possibly can use
4391     a smaller memory cache.</para>
4392
4393     <sect2 id="HDRWQ68">
4394       <title>Configuring a Disk Cache</title>
4395
4396       <note>
4397         <para>Not all file system types that an operating system supports are necessarily supported for use as the cache partition.
4398         For possible restrictions, see the <emphasis>OpenAFS Release Notes</emphasis>.</para>
4399       </note>
4400
4401       <para>To configure the disk cache, perform the following procedures: <orderedlist>
4402           <listitem>
4403             <para>Create the local directory to use for caching. The following instruction shows the conventional location,
4404             <emphasis role="bold">/usr/vice/cache</emphasis>. If you are devoting a partition exclusively to caching, as
4405             recommended, you must also configure it, make a file system on it, and mount it at the directory created in this step.
4406             <programlisting>
4407    # <emphasis role="bold">mkdir /usr/vice/cache</emphasis>
4408 </programlisting></para>
4409           </listitem>
4410
4411           <listitem>
4412             <para>Create the <emphasis role="bold">cacheinfo</emphasis> file to define the configuration parameters discussed
4413             previously. The following instruction shows the standard mount location, <emphasis role="bold">/afs</emphasis>, and the
4414             standard cache location, <emphasis role="bold">/usr/vice/cache</emphasis>. <programlisting>
4415    # <emphasis role="bold">echo "/afs:/usr/vice/cache:</emphasis><replaceable>#blocks</replaceable><emphasis role="bold">" &gt; /usr/vice/etc/cacheinfo</emphasis>
4416 </programlisting></para>
4417
4418             <para>The following example defines the disk cache size as 50,000 KB:</para>
4419
4420             <programlisting>
4421    # <emphasis role="bold">echo "/afs:/usr/vice/cache:50000" &gt; /usr/vice/etc/cacheinfo</emphasis>
4422 </programlisting>
4423           </listitem>
4424         </orderedlist></para>
4425     </sect2>
4426
4427     <sect2 id="HDRWQ69">
4428       <title>Configuring a Memory Cache</title>
4429
4430       <para>To configure a memory cache, create the <emphasis role="bold">cacheinfo</emphasis> file to define the configuration
4431       parameters discussed previously. The following instruction shows the standard mount location, <emphasis
4432       role="bold">/afs</emphasis>, and the standard cache location, <emphasis role="bold">/usr/vice/cache</emphasis> (though the
4433       exact value of the latter is irrelevant for a memory cache).</para>
4434
4435       <programlisting>
4436    # <emphasis role="bold">echo "/afs:/usr/vice/cache:</emphasis><replaceable>#blocks</replaceable><emphasis role="bold">" &gt; /usr/vice/etc/cacheinfo</emphasis>
4437 </programlisting>
4438
4439       <para>The following example allocates 25,000 KB of memory for the cache.</para>
4440
4441       <programlisting>
4442    # <emphasis role="bold">echo "/afs:/usr/vice/cache:25000" &gt; /usr/vice/etc/cacheinfo</emphasis>
4443 </programlisting>
4444
4445       <indexterm>
4446         <primary>Cache Manager</primary>
4447
4448         <secondary>first AFS machine</secondary>
4449       </indexterm>
4450
4451       <indexterm>
4452         <primary>configuring</primary>
4453
4454         <secondary>Cache Manager</secondary>
4455
4456         <tertiary>first AFS machine</tertiary>
4457       </indexterm>
4458
4459       <indexterm>
4460         <primary>first AFS machine</primary>
4461
4462         <secondary>Cache Manager</secondary>
4463       </indexterm>
4464
4465       <indexterm>
4466         <primary>afs (/afs) directory</primary>
4467
4468         <secondary>creating</secondary>
4469
4470         <tertiary>first AFS machine</tertiary>
4471       </indexterm>
4472
4473       <indexterm>
4474         <primary>AFS initialization script</primary>
4475
4476         <secondary>setting afsd parameters</secondary>
4477
4478         <tertiary>first AFS machine</tertiary>
4479       </indexterm>
4480
4481       <indexterm>
4482         <primary>first AFS machine</primary>
4483
4484         <secondary>afsd command parameters</secondary>
4485       </indexterm>
4486     </sect2>
4487   </sect1>
4488
4489   <sect1 id="HDRWQ70">
4490     <title>Configuring the Cache Manager</title>
4491
4492     <para>By convention, the Cache Manager mounts the AFS filespace on the local <emphasis role="bold">/afs</emphasis> directory. In
4493     this section you create that directory.</para>
4494
4495     <para>The <emphasis role="bold">afsd</emphasis> program sets several cache configuration parameters as it initializes the Cache
4496     Manager, and starts daemons that improve performance. You can use the <emphasis role="bold">afsd</emphasis> command's arguments
4497     to override the parameters' default values and to change the number of some of the daemons. Depending on the machine's cache
4498     size, its amount of RAM, and how many people work on it, you can sometimes improve Cache Manager performance by overriding the
4499     default values. For a discussion of all of the <emphasis role="bold">afsd</emphasis> command's arguments, see its reference page
4500     in the <emphasis>OpenAFS Administration Reference</emphasis>.</para>
4501
4502     <para>On platforms using the standard 'afs' initialisation script (this does not apply to Fedora or RHEL based distributions), the <emphasis role="bold">afsd</emphasis> command line in the AFS initialization script on each system type includes an
4503     <computeroutput>OPTIONS</computeroutput> variable. You can use it to set nondefault values for the command's arguments, in one
4504     of the following ways: <itemizedlist>
4505         <listitem>
4506           <para>You can create an <emphasis role="bold">afsd</emphasis> <emphasis>options file</emphasis> that sets values for
4507           arguments to the <emphasis role="bold">afsd</emphasis> command. If the file exists, its contents are automatically
4508           substituted for the <computeroutput>OPTIONS</computeroutput> variable in the AFS initialization script. The AFS
4509           distribution for some system types includes an options file; on other system types, you must create it.</para>
4510
4511           <para>You use two variables in the AFS initialization script to specify the path to the options file:
4512           <computeroutput>CONFIG</computeroutput> and <computeroutput>AFSDOPT</computeroutput>. On system types that define a
4513           conventional directory for configuration files, the <computeroutput>CONFIG</computeroutput> variable indicates it by
4514           default; otherwise, the variable indicates an appropriate location.</para>
4515
4516           <para>List the desired <emphasis role="bold">afsd</emphasis> options on a single line in the options file, separating each
4517           option with one or more spaces. The following example sets the <emphasis role="bold">-stat</emphasis> argument to 2500,
4518           the <emphasis role="bold">-daemons</emphasis> argument to 4, and the <emphasis role="bold">-volumes</emphasis> argument to
4519           100.</para>
4520
4521           <programlisting>
4522    -stat 2500 -daemons 4 -volumes 100
4523 </programlisting>
4524         </listitem>
4525
4526         <listitem>
4527           <para>On a machine that uses a disk cache, you can set the <computeroutput>OPTIONS</computeroutput> variable in the AFS
4528           initialization script to one of <computeroutput>$SMALL</computeroutput>, <computeroutput>$MEDIUM</computeroutput>, or
4529           <computeroutput>$LARGE</computeroutput>. The AFS initialization script uses one of these settings if the <emphasis
4530           role="bold">afsd</emphasis> options file named by the <computeroutput>AFSDOPT</computeroutput> variable does not exist. In
4531           the script as distributed, the <computeroutput>OPTIONS</computeroutput> variable is set to the value
4532           <computeroutput>$MEDIUM</computeroutput>.</para>
4533
4534           <note>
4535             <para>Do not set the <computeroutput>OPTIONS</computeroutput> variable to <computeroutput>$SMALL</computeroutput>,
4536             <computeroutput>$MEDIUM</computeroutput>, or <computeroutput>$LARGE</computeroutput> on a machine that uses a memory
4537             cache. The arguments it sets are appropriate only on a machine that uses a disk cache.</para>
4538           </note>
4539
4540           <para>The script (or on some system types the <emphasis role="bold">afsd</emphasis> options file named by the
4541           <computeroutput>AFSDOPT</computeroutput> variable) defines a value for each of <computeroutput>SMALL</computeroutput>,
4542           <computeroutput>MEDIUM</computeroutput>, and <computeroutput>LARGE</computeroutput> that sets <emphasis
4543           role="bold">afsd</emphasis> command arguments appropriately for client machines of different sizes: <itemizedlist>
4544               <listitem>
4545                 <para><computeroutput>SMALL</computeroutput> is suitable for a small machine that serves one or two users and has
4546                 approximately 8 MB of RAM and a 20-MB cache</para>
4547               </listitem>
4548
4549               <listitem>
4550                 <para><computeroutput>MEDIUM</computeroutput> is suitable for a medium-sized machine that serves two to six users
4551                 and has 16 MB of RAM and a 40-MB cache</para>
4552               </listitem>
4553
4554               <listitem>
4555                 <para><computeroutput>LARGE</computeroutput> is suitable for a large machine that serves five to ten users and has
4556                 32 MB of RAM and a 100-MB cache</para>
4557               </listitem>
4558             </itemizedlist></para>
4559         </listitem>
4560
4561         <listitem>
4562           <para>You can choose not to create an <emphasis role="bold">afsd</emphasis> options file and to set the
4563           <computeroutput>OPTIONS</computeroutput> variable in the initialization script to a null value rather than to the default
4564           <computeroutput>$MEDIUM</computeroutput> value. You can then either set arguments directly on the <emphasis
4565           role="bold">afsd</emphasis> command line in the script, or set no arguments (and so accept default values for all Cache
4566           Manager parameters).</para>
4567         </listitem>
4568       </itemizedlist>
4569
4570       <note>
4571       <para>If you are running on a Fedora or RHEL based system, the
4572       openafs-client initialization script behaves differently from that
4573       described above. It sources /etc/sysconfig/openafs, in which the
4574       AFSD_ARGS variable may be set to contain any, or all, of the afsd options
4575       detailed. Note that this script does not support setting an OPTIONS
4576       variable, or the SMALL, MEDIUM and LARGE methods of defining cache size
4577       </para>
4578       </note>
4579
4580  <orderedlist>
4581         <listitem>
4582           <para>Create the local directory on which to mount the AFS filespace, by convention <emphasis role="bold">/afs</emphasis>.
4583           If the directory already exists, verify that it is empty. <programlisting>
4584    # <emphasis role="bold">mkdir /afs</emphasis>
4585 </programlisting></para>
4586         </listitem>
4587
4588         <listitem>
4589           <para>On AIX systems, add the following line to the <emphasis role="bold">/etc/vfs</emphasis> file. It enables AIX to
4590           unmount AFS correctly during shutdown. <programlisting>
4591    afs     4     none     none
4592 </programlisting></para>
4593         </listitem>
4594
4595         <listitem>
4596           <para>On non-package based Linux systems, copy the <emphasis role="bold">afsd</emphasis> options file from the <emphasis
4597           role="bold">/usr/vice/etc</emphasis> directory to the <emphasis role="bold">/etc/sysconfig</emphasis> directory, removing
4598           the <emphasis role="bold">.conf</emphasis> extension as you do so. <programlisting>
4599    # <emphasis role="bold">cp /usr/vice/etc/afs.conf /etc/sysconfig/afs</emphasis>
4600 </programlisting></para>
4601         </listitem>
4602
4603         <listitem>
4604           <para>Edit the machine's AFS initialization script or <emphasis role="bold">afsd</emphasis> options file to set
4605           appropriate values for <emphasis role="bold">afsd</emphasis> command parameters. The script resides in the indicated
4606           location on each system type: <itemizedlist>
4607               <listitem>
4608                 <para>On AIX systems, <emphasis role="bold">/etc/rc.afs</emphasis></para>
4609               </listitem>
4610
4611               <listitem>
4612                 <para>On HP-UX systems, <emphasis role="bold">/sbin/init.d/afs</emphasis></para>
4613               </listitem>
4614
4615               <listitem>
4616                 <para>On IRIX systems, <emphasis role="bold">/etc/init.d/afs</emphasis></para>
4617               </listitem>
4618
4619                   <listitem>
4620                 <para>On Fedora and RHEL systems, <emphasis role="bold">/etc/sysconfg/openafs</emphasis></para>
4621               </listitem>
4622
4623               <listitem>
4624                 <para>On non-package based Linux systems, <emphasis role="bold">/etc/sysconfig/afs</emphasis> (the <emphasis
4625                 role="bold">afsd</emphasis> options file)</para>
4626               </listitem>
4627
4628               <listitem>
4629                 <para>On Solaris systems, <emphasis role="bold">/etc/init.d/afs</emphasis></para>
4630               </listitem>
4631             </itemizedlist></para>
4632
4633           <para>Use one of the methods described in the introduction to this section to add the following flags to the <emphasis
4634           role="bold">afsd</emphasis> command line. If you intend for the machine to remain an AFS client, also set any
4635           performance-related arguments you wish. <itemizedlist>
4636               <listitem>
4637                 <para>Add the <emphasis role="bold">-memcache</emphasis> flag if the machine is to use a memory cache.</para>
4638               </listitem>
4639
4640               <listitem>
4641                 <para>Add the <emphasis role="bold">-verbose</emphasis> flag to display a trace of the Cache Manager's
4642                 initialization on the standard output stream.</para>
4643               </listitem>
4644             </itemizedlist></para>
4645         </listitem>
4646       </orderedlist>
4647       <note><para>In order to successfully complete the instructions in the
4648       remainder of this guide, it is important that the machine does not have
4649       a synthetic root (as discussed in <link linkend="HDRWQ91">Enabling Access
4650       to Foreign Cells</link>). As some distributions ship with this enabled, it
4651       may be necessary to remove any occurences of the
4652       <emphasis role="bold">-dynroot</emphasis> and
4653       <emphasis role="bold">-afsdb</emphasis> options from both the AFS
4654       initialisation script and options file. If this functionality is
4655       required it may be renabled as detailed in
4656       <link linkend="HDRWQ91">Enabling Access to Foreign Cells</link>.
4657       </para></note>
4658       </para>
4659
4660     <indexterm>
4661       <primary>overview</primary>
4662
4663       <secondary>completing installation of first machine</secondary>
4664     </indexterm>
4665
4666     <indexterm>
4667       <primary>first AFS machine</primary>
4668
4669       <secondary>completion of installation</secondary>
4670     </indexterm>
4671   </sect1>
4672
4673   <sect1 id="HDRWQ71">
4674     <title>Overview: Completing the Installation of the First AFS Machine</title>
4675
4676     <para>The machine is now configured as an AFS file server and client machine. In this final phase of the installation, you
4677     initialize the Cache Manager and then create the upper levels of your AFS filespace, among other procedures. The procedures are:
4678     <orderedlist>
4679         <listitem>
4680           <para>Verify that the initialization script works correctly, and incorporate it into the operating system's startup and
4681           shutdown sequence</para>
4682         </listitem>
4683
4684         <listitem>
4685           <para>Create and mount top-level volumes</para>
4686         </listitem>
4687
4688         <listitem>
4689           <para>Create and mount volumes to store system binaries in AFS</para>
4690         </listitem>
4691
4692         <listitem>
4693           <para>Enable access to foreign cells</para>
4694         </listitem>
4695
4696         <listitem>
4697           <para>Institute additional security measures</para>
4698         </listitem>
4699
4700         <listitem>
4701           <para>Remove client functionality if desired</para>
4702         </listitem>
4703       </orderedlist></para>
4704
4705     <indexterm>
4706       <primary>AFS initialization script</primary>
4707
4708       <secondary>verifying on first AFS machine</secondary>
4709     </indexterm>
4710
4711     <indexterm>
4712       <primary>AFS initialization script</primary>
4713
4714       <secondary>running</secondary>
4715
4716       <tertiary>first AFS machine</tertiary>
4717     </indexterm>
4718
4719     <indexterm>
4720       <primary>first AFS machine</primary>
4721
4722       <secondary>AFS initialization script</secondary>
4723
4724       <tertiary>running/verifying</tertiary>
4725     </indexterm>
4726
4727     <indexterm>
4728       <primary>running AFS init. script</primary>
4729
4730       <secondary>first AFS machine</secondary>
4731     </indexterm>
4732
4733     <indexterm>
4734       <primary>invoking AFS init. script</primary>
4735
4736       <see>running</see>
4737     </indexterm>
4738   </sect1>
4739
4740   <sect1 id="HDRWQ72">
4741     <title>Verifying the AFS Initialization Script</title>
4742
4743     <para>At this point you run the AFS initialization script to verify that it correctly invokes all of the necessary programs and
4744     AFS processes, and that they start correctly. The following are the relevant commands: <itemizedlist>
4745         <listitem>
4746           <para>The command that dynamically loads AFS modifications into the kernel, on some system types (not applicable if the
4747           kernel has AFS modifications built in)</para>
4748         </listitem>
4749
4750         <listitem>
4751           <para>The <emphasis role="bold">bosserver</emphasis> command, which starts the BOS Server; it in turn starts the server
4752           processes for which you created entries in the <emphasis role="bold">/usr/afs/local/BosConfig</emphasis> file</para>
4753         </listitem>
4754
4755         <listitem>
4756           <para>The <emphasis role="bold">afsd</emphasis> command, which initializes the Cache Manager</para>
4757         </listitem>
4758       </itemizedlist></para>
4759
4760     <para>On system types that use a dynamic loader program, you must reboot the machine before running the initialization script,
4761     so that it can freshly load AFS modifications into the kernel.</para>
4762
4763     <para>If there are problems during the initialization, attempt to resolve them. The OpenAFS mailing lists can provide assistance if necessary.
4764
4765      <orderedlist>
4766         <indexterm>
4767           <primary>commands</primary>
4768
4769           <secondary>bos shutdown</secondary>
4770         </indexterm>
4771
4772         <indexterm>
4773           <primary>bos commands</primary>
4774
4775           <secondary>shutdown</secondary>
4776         </indexterm>
4777
4778         <listitem>
4779           <para>Issue the <emphasis role="bold">bos shutdown</emphasis> command to shut down the AFS server processes other than the
4780           BOS Server. Include the <emphasis role="bold">-wait</emphasis> flag to delay return of the command shell prompt until all
4781           processes shut down completely. <programlisting>
4782    # <emphasis role="bold">/usr/afs/bin/bos shutdown</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis
4783                 role="bold">-wait</emphasis>
4784 </programlisting></para>
4785         </listitem>
4786
4787         <listitem>
4788           <para>Issue the <emphasis role="bold">ps</emphasis> command to learn the <emphasis role="bold">bosserver</emphasis>
4789           process's process ID number (PID), and then the <emphasis role="bold">kill</emphasis> command to stop it. <programlisting>
4790    # <emphasis role="bold">ps</emphasis> <replaceable>appropriate_ps_options</replaceable> <emphasis role="bold">| grep bosserver</emphasis>
4791    # <emphasis role="bold">kill</emphasis> <replaceable>bosserver_PID</replaceable>
4792 </programlisting></para>
4793         </listitem>
4794
4795         <listitem>
4796           <para>Issue the appropriate commands to run the AFS initialization script for this system type.</para>
4797
4798           <indexterm>
4799             <primary>AIX</primary>
4800
4801             <secondary>AFS initialization script</secondary>
4802
4803             <tertiary>on first AFS machine</tertiary>
4804           </indexterm>
4805
4806           <para><emphasis role="bold">On AIX systems:</emphasis> <orderedlist>
4807               <listitem>
4808                 <para>Reboot the machine and log in again as the local superuser <emphasis role="bold">root</emphasis>.
4809                 <programlisting>
4810    # <emphasis role="bold">cd /</emphasis>
4811    # <emphasis role="bold">shutdown -r now</emphasis>
4812    login: <emphasis role="bold">root</emphasis>
4813    Password: <replaceable>root_password</replaceable>
4814 </programlisting></para>
4815               </listitem>
4816
4817               <listitem>
4818                 <para>Run the AFS initialization script. <programlisting>
4819    # <emphasis role="bold">/etc/rc.afs</emphasis>
4820 </programlisting></para>
4821               </listitem>
4822             </orderedlist></para>
4823
4824           <indexterm>
4825             <primary>HP-UX</primary>
4826
4827             <secondary>AFS initialization script</secondary>
4828
4829             <tertiary>on first AFS machine</tertiary>
4830           </indexterm>
4831
4832           <para><emphasis role="bold">On HP-UX systems:</emphasis> <orderedlist>
4833               <listitem>
4834                 <para>Run the AFS initialization script. <programlisting>
4835    # <emphasis role="bold">/sbin/init.d/afs  start</emphasis>
4836 </programlisting></para>
4837               </listitem>
4838             </orderedlist></para>
4839
4840           <indexterm>
4841             <primary>IRIX</primary>
4842
4843             <secondary>AFS initialization script</secondary>
4844
4845             <tertiary>on first AFS machine</tertiary>
4846           </indexterm>
4847
4848           <indexterm>
4849             <primary>afsclient variable (IRIX)</primary>
4850
4851             <secondary>first AFS machine</secondary>
4852           </indexterm>
4853
4854           <indexterm>
4855             <primary>variables</primary>
4856
4857             <secondary>afsclient (IRIX)</secondary>
4858
4859             <tertiary>first AFS machine</tertiary>
4860           </indexterm>
4861
4862           <indexterm>
4863             <primary>IRIX</primary>
4864
4865             <secondary>afsclient variable</secondary>
4866
4867             <tertiary>first AFS machine</tertiary>
4868           </indexterm>
4869
4870           <indexterm>
4871             <primary>afsserver variable (IRIX)</primary>
4872
4873             <secondary>first AFS machine</secondary>
4874           </indexterm>
4875
4876           <indexterm>
4877             <primary>variables</primary>
4878
4879             <secondary>afsserver (IRIX)</secondary>
4880
4881             <tertiary>first AFS machine</tertiary>
4882           </indexterm>
4883
4884           <indexterm>
4885             <primary>IRIX</primary>
4886
4887             <secondary>afsserver variable</secondary>
4888
4889             <tertiary>first AFS machine</tertiary>
4890           </indexterm>
4891
4892           <para><emphasis role="bold">On IRIX systems:</emphasis> <orderedlist>
4893               <listitem>
4894                 <para>If you have configured the machine to use the <emphasis role="bold">ml</emphasis> dynamic loader program,
4895                 reboot the machine and log in again as the local superuser <emphasis role="bold">root</emphasis>. <programlisting>
4896    # <emphasis role="bold">cd /</emphasis>
4897    # <emphasis role="bold">shutdown -i6 -g0 -y</emphasis>
4898    login: <emphasis role="bold">root</emphasis>
4899    Password: <replaceable>root_password</replaceable>
4900 </programlisting></para>
4901               </listitem>
4902
4903               <listitem>
4904                 <para>Issue the <emphasis role="bold">chkconfig</emphasis> command to activate the <emphasis
4905                 role="bold">afsserver</emphasis> and <emphasis role="bold">afsclient</emphasis> configuration variables.
4906                 <programlisting>
4907    # <emphasis role="bold">/etc/chkconfig -f afsserver on</emphasis>
4908    # <emphasis role="bold">/etc/chkconfig -f afsclient on</emphasis>
4909 </programlisting></para>
4910               </listitem>
4911
4912               <listitem>
4913                 <para>Run the AFS initialization script. <programlisting>
4914    # <emphasis role="bold">/etc/init.d/afs  start</emphasis>
4915 </programlisting></para>
4916               </listitem>
4917             </orderedlist></para>
4918
4919           <indexterm>
4920             <primary>Linux</primary>
4921
4922             <secondary>AFS initialization script</secondary>
4923
4924             <tertiary>on first AFS machine</tertiary>
4925           </indexterm>
4926
4927           <para><emphasis role="bold">On Linux systems:</emphasis> <orderedlist>
4928               <listitem>
4929                 <para>Reboot the machine and log in again as the local superuser <emphasis role="bold">root</emphasis>.
4930                 <programlisting>
4931    # <emphasis role="bold">cd /</emphasis>
4932    # <emphasis role="bold">shutdown -r now</emphasis>
4933    login: <emphasis role="bold">root</emphasis>
4934    Password: <replaceable>root_password</replaceable>
4935 </programlisting></para>
4936               </listitem>
4937
4938               <listitem>
4939                 <para>Run the AFS initialization scripts.
4940 <programlisting>
4941    # <emphasis role="bold">/etc/rc.d/init.d/openafs-client  start</emphasis>
4942    # <emphasis role="bold">/etc/rc.d/init.d/openafs-server  start</emphasis>
4943 </programlisting></para>
4944               </listitem>
4945             </orderedlist></para>
4946
4947           <indexterm>
4948             <primary>Solaris</primary>
4949
4950             <secondary>AFS initialization script</secondary>
4951
4952             <tertiary>on first AFS machine</tertiary>
4953           </indexterm>
4954
4955           <para><emphasis role="bold">On Solaris systems:</emphasis> <orderedlist>
4956               <listitem>
4957                 <para>Reboot the machine and log in again as the local superuser <emphasis role="bold">root</emphasis>.
4958                 <programlisting>
4959    # <emphasis role="bold">cd /</emphasis>
4960    # <emphasis role="bold">shutdown -i6 -g0 -y</emphasis>
4961    login: <emphasis role="bold">root</emphasis>
4962    Password: <replaceable>root_password</replaceable>
4963 </programlisting></para>
4964               </listitem>
4965
4966               <listitem>
4967                 <para>Run the AFS initialization script. <programlisting>
4968    # <emphasis role="bold">/etc/init.d/afs  start</emphasis>
4969 </programlisting></para>
4970               </listitem>
4971             </orderedlist></para>
4972         </listitem>
4973
4974         <listitem>
4975           <para>Wait for the message that confirms that Cache Manager initialization is complete.</para>
4976
4977           <para>On machines that use a disk cache, it can take a while to initialize the Cache Manager for the first time, because
4978           the <emphasis role="bold">afsd</emphasis> program must create all of the <emphasis
4979           role="bold">V</emphasis><replaceable>n</replaceable> files in the cache directory. Subsequent Cache Manager
4980           initializations do not take nearly as long, because the <emphasis role="bold">V</emphasis><replaceable>n</replaceable>
4981           files already exist.</para>
4982         </listitem>
4983         <listitem>
4984
4985           <indexterm>
4986             <primary>commands</primary>
4987             <secondary>aklog</secondary>
4988           </indexterm>
4989
4990           <indexterm>
4991             <primary>aklog command</primary>
4992           </indexterm>
4993
4994           <para>If you are working with an existing cell which uses
4995           <emphasis role="bold">kaserver</emphasis> for authentication,
4996           please recall the note in
4997           <link linkend="KAS003">Using this Appendix</link> detailing the
4998           substitution of <emphasis role="bold">kinit</emphasis> and
4999           <emphasis role="bold">aklog</emphasis> with
5000           <emphasis role="bold">klog</emphasis>.</para>
5001
5002           <para>As a basic test of correct AFS functioning, issue the
5003           <emphasis role="bold">kinit</emphasis> and
5004           <emphasis role="bold">aklog</emphasis> commands to authenticate
5005           as the <emphasis role="bold">admin</emphasis> user.
5006           Provide the password (<replaceable>admin_passwd</replaceable>) you
5007           defined in <link linkend="HDRWQ53">Initializing Cell Security</link>.</para>
5008
5009           <programlisting>
5010    # <emphasis role="bold">kinit admin</emphasis>
5011    Password:  <replaceable>admin_passwd</replaceable>
5012    # <emphasis role="bold">aklog</emphasis>
5013 </programlisting>
5014
5015           <indexterm>
5016             <primary>commands</primary>
5017
5018             <secondary>tokens</secondary>
5019           </indexterm>
5020
5021           <indexterm>
5022             <primary>tokens command</primary>
5023           </indexterm>
5024         </listitem>
5025
5026         <listitem>
5027           <para>Issue the <emphasis role="bold">tokens</emphasis> command to
5028           verify that the <emphasis role="bold">aklog</emphasis>
5029           command worked correctly. If it did, the output looks similar to the following example for the <emphasis
5030           role="bold">example.com</emphasis> cell, where <emphasis role="bold">admin</emphasis>'s AFS UID is 1. If the output does not
5031           seem correct, resolve the problem. Changes to the AFS initialization script are possibly necessary. The OpenAFS mailing lists can provide assistance as necessary. <programlisting>
5032    # <emphasis role="bold">tokens</emphasis>
5033    Tokens held by the Cache Manager:
5034    User's (AFS ID 1) tokens for afs@example.com [Expires May 22 11:52]
5035        --End of list--
5036 </programlisting></para>
5037         </listitem>
5038
5039         <listitem>
5040           <para>Issue the <emphasis role="bold">bos status</emphasis> command to verify that the output for each process reads
5041           <computeroutput>Currently running normally</computeroutput>. <programlisting>
5042    # <emphasis role="bold">/usr/afs/bin/bos status</emphasis> &lt;<replaceable>machine name</replaceable>&gt;
5043 </programlisting> <indexterm>
5044               <primary>fs commands</primary>
5045
5046               <secondary>checkvolumes</secondary>
5047             </indexterm> <indexterm>
5048               <primary>commands</primary>
5049
5050               <secondary>fs checkvolumes</secondary>
5051             </indexterm></para>
5052         </listitem>
5053
5054         <listitem>
5055           <para>Change directory to the local file system root (<emphasis role="bold">/</emphasis>) and issue the <emphasis
5056           role="bold">fs checkvolumes</emphasis> command. <programlisting>
5057    # <emphasis role="bold">cd /</emphasis>
5058    # <emphasis role="bold">/usr/afs/bin/fs checkvolumes</emphasis>
5059 </programlisting></para>
5060         </listitem>
5061       </orderedlist></para>
5062
5063     <indexterm>
5064       <primary>AFS initialization script</primary>
5065
5066       <secondary>adding to machine startup sequence</secondary>
5067
5068       <tertiary>first AFS machine</tertiary>
5069     </indexterm>
5070
5071     <indexterm>
5072       <primary>installing</primary>
5073
5074       <secondary>AFS initialization script</secondary>
5075
5076       <tertiary>first AFS machine</tertiary>
5077     </indexterm>
5078
5079     <indexterm>
5080       <primary>first AFS machine</primary>
5081
5082       <secondary>AFS initialization script</secondary>
5083
5084       <tertiary>activating</tertiary>
5085     </indexterm>
5086
5087     <indexterm>
5088       <primary>activating AFS init. script</primary>
5089
5090       <see>installing</see>
5091     </indexterm>
5092   </sect1>
5093
5094   <sect1 id="HDRWQ73">
5095     <title>Activating the AFS Initialization Script</title>
5096
5097     <para>Now that you have confirmed that the AFS initialization script works correctly, take the action necessary to have it run
5098     automatically at each reboot. Proceed to the instructions for your system type: <itemizedlist>
5099         <listitem>
5100           <para><link linkend="HDRWQ74">Activating the Script on AIX Systems</link></para>
5101         </listitem>
5102
5103         <listitem>
5104           <para><link linkend="HDRWQ76">Activating the Script on HP-UX Systems</link></para>
5105         </listitem>
5106
5107         <listitem>
5108           <para><link linkend="HDRWQ77">Activating the Script on IRIX Systems</link></para>
5109         </listitem>
5110
5111         <listitem>
5112           <para><link linkend="HDRWQ78">Activating the Script on Linux Systems</link></para>
5113         </listitem>
5114
5115         <listitem>
5116           <para><link linkend="HDRWQ79">Activating the Script on Solaris Systems</link></para>
5117         </listitem>
5118       </itemizedlist></para>
5119
5120     <indexterm>
5121       <primary>AIX</primary>
5122
5123       <secondary>AFS initialization script</secondary>
5124
5125       <tertiary>on first AFS machine</tertiary>
5126     </indexterm>
5127
5128     <sect2 id="HDRWQ74">
5129       <title>Activating the Script on AIX Systems</title>
5130
5131       <orderedlist>
5132         <listitem>
5133           <para>Edit the AIX initialization file, <emphasis role="bold">/etc/inittab</emphasis>, adding the following line to invoke
5134           the AFS initialization script. Place it just after the line that starts NFS daemons. <programlisting>
5135    rcafs:2:wait:/etc/rc.afs &gt; /dev/console 2&gt;&amp;1 # Start AFS services
5136 </programlisting></para>
5137         </listitem>
5138
5139         <listitem>
5140           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
5141           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc</emphasis> directories. If you want to avoid
5142           potential confusion by guaranteeing that they are always the same, create a link between them. You can always retrieve the
5143           original script from the AFS CD-ROM if necessary. <programlisting>
5144    # <emphasis role="bold">cd  /usr/vice/etc</emphasis>
5145    # <emphasis role="bold">rm  rc.afs</emphasis>
5146    # <emphasis role="bold">ln -s  /etc/rc.afs</emphasis>
5147 </programlisting></para>
5148         </listitem>
5149
5150         <listitem>
5151           <para>Proceed to <link linkend="HDRWQ80">Configuring the Top Levels of the AFS Filespace</link>.</para>
5152         </listitem>
5153       </orderedlist>
5154
5155       <indexterm>
5156         <primary>HP-UX</primary>
5157
5158         <secondary>AFS initialization script</secondary>
5159
5160         <tertiary>on first AFS machine</tertiary>
5161       </indexterm>
5162     </sect2>
5163
5164     <sect2 id="HDRWQ76">
5165       <title>Activating the Script on HP-UX Systems</title>
5166
5167       <orderedlist>
5168         <listitem>
5169           <para>Change to the <emphasis role="bold">/sbin/init.d</emphasis> directory and issue the <emphasis role="bold">ln
5170           -s</emphasis> command to create symbolic links that incorporate the AFS initialization script into the HP-UX startup and
5171           shutdown sequence. <programlisting>
5172    # <emphasis role="bold">cd /sbin/init.d</emphasis>
5173    # <emphasis role="bold">ln -s ../init.d/afs /sbin/rc2.d/S460afs</emphasis>
5174    # <emphasis role="bold">ln -s ../init.d/afs /sbin/rc2.d/K800afs</emphasis>
5175 </programlisting></para>
5176         </listitem>
5177
5178         <listitem>
5179           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
5180           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/sbin/init.d</emphasis> directories. If you want
5181           to avoid potential confusion by guaranteeing that they are always the same, create a link between them. You can always
5182           retrieve the original script from the AFS CD-ROM if necessary. <programlisting>
5183    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
5184    # <emphasis role="bold">rm afs.rc</emphasis>
5185    # <emphasis role="bold">ln -s  /sbin/init.d/afs  afs.rc</emphasis>
5186 </programlisting></para>
5187         </listitem>
5188
5189         <listitem>
5190           <para>Proceed to <link linkend="HDRWQ80">Configuring the Top Levels of the AFS Filespace</link>.</para>
5191         </listitem>
5192       </orderedlist>
5193
5194       <indexterm>
5195         <primary>IRIX</primary>
5196
5197         <secondary>AFS initialization script</secondary>
5198
5199         <tertiary>on first AFS machine</tertiary>
5200       </indexterm>
5201     </sect2>
5202
5203     <sect2 id="HDRWQ77">
5204       <title>Activating the Script on IRIX Systems</title>
5205
5206       <orderedlist>
5207         <listitem>
5208           <para>Change to the <emphasis role="bold">/etc/init.d</emphasis> directory and issue the <emphasis role="bold">ln
5209           -s</emphasis> command to create symbolic links that incorporate the AFS initialization script into the IRIX startup and
5210           shutdown sequence. <programlisting>
5211    # <emphasis role="bold">cd /etc/init.d</emphasis>
5212    # <emphasis role="bold">ln -s ../init.d/afs /etc/rc2.d/S35afs</emphasis>
5213    # <emphasis role="bold">ln -s ../init.d/afs /etc/rc0.d/K35afs</emphasis>
5214 </programlisting></para>
5215         </listitem>
5216
5217         <listitem>
5218           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
5219           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc/init.d</emphasis> directories. If you want
5220           to avoid potential confusion by guaranteeing that they are always the same, create a link between them. You can always
5221           retrieve the original script from the AFS CD-ROM if necessary. <programlisting>
5222    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
5223    # <emphasis role="bold">rm afs.rc</emphasis>
5224    # <emphasis role="bold">ln -s  /etc/init.d/afs  afs.rc</emphasis>
5225 </programlisting></para>
5226         </listitem>
5227
5228         <listitem>
5229           <para>Proceed to <link linkend="HDRWQ80">Configuring the Top Levels of the AFS Filespace</link>.</para>
5230         </listitem>
5231       </orderedlist>
5232
5233       <indexterm>
5234         <primary>Linux</primary>
5235
5236         <secondary>AFS initialization script</secondary>
5237
5238         <tertiary>on first AFS machine</tertiary>
5239       </indexterm>
5240     </sect2>
5241
5242     <sect2 id="HDRWQ78">
5243       <title>Activating the Script on Linux Systems</title>
5244
5245       <orderedlist>
5246         <listitem>
5247           <para>Issue the <emphasis role="bold">chkconfig</emphasis> command to activate the <emphasis role="bold">openafs-client</emphasis> and <emphasis role="bold">openafs-server</emphasis>
5248           configuration variables. Based on the instruction in the AFS initialization file that begins with the string
5249           <computeroutput>#chkconfig</computeroutput>, the command automatically creates the symbolic links that incorporate the
5250           script into the Linux startup and shutdown sequence. <programlisting>
5251    # <emphasis role="bold">/sbin/chkconfig  --add openafs-client</emphasis>
5252    # <emphasis role="bold">/sbin/chkconfig  --add openafs-server</emphasis>
5253 </programlisting></para>
5254         </listitem>
5255
5256         <listitem>
5257           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
5258           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc/rc.d/init.d</emphasis> directories, and
5259           copies of the <emphasis role="bold">afsd</emphasis> options file in both the <emphasis
5260           role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc/sysconfig</emphasis> directories. If you want to avoid
5261           potential confusion by guaranteeing that the two copies of each file are always the same, create a link between them. You
5262           can always retrieve the original script or options file from the AFS CD-ROM if necessary. <programlisting>
5263    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
5264    # <emphasis role="bold">rm afs.rc afs.conf</emphasis>
5265    # <emphasis role="bold">ln -s  /etc/rc.d/init.d/afs  afs.rc</emphasis>
5266    # <emphasis role="bold">ln -s  /etc/sysconfig/afs  afs.conf</emphasis>
5267 </programlisting></para>
5268         </listitem>
5269
5270         <listitem>
5271           <para>Proceed to <link linkend="HDRWQ80">Configuring the Top Levels of the AFS Filespace</link>.</para>
5272         </listitem>
5273       </orderedlist>
5274
5275       <indexterm>
5276         <primary>Solaris</primary>
5277
5278         <secondary>AFS initialization script</secondary>
5279
5280         <tertiary>on first AFS machine</tertiary>
5281       </indexterm>
5282     </sect2>
5283
5284     <sect2 id="HDRWQ79">
5285       <title>Activating the Script on Solaris Systems</title>
5286
5287       <orderedlist>
5288         <listitem>
5289           <para>Change to the <emphasis role="bold">/etc/init.d</emphasis> directory and issue the <emphasis role="bold">ln
5290           -s</emphasis> command to create symbolic links that incorporate the AFS initialization script into the Solaris startup and
5291           shutdown sequence. <programlisting>
5292    # <emphasis role="bold">cd /etc/init.d</emphasis>
5293    # <emphasis role="bold">ln -s ../init.d/afs /etc/rc3.d/S99afs</emphasis>
5294    # <emphasis role="bold">ln -s ../init.d/afs /etc/rc0.d/K66afs</emphasis>
5295 </programlisting></para>
5296         </listitem>
5297
5298         <listitem>
5299           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
5300           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc/init.d</emphasis> directories. If you want
5301           to avoid potential confusion by guaranteeing that they are always the same, create a link between them. You can always
5302           retrieve the original script from the AFS CD-ROM if necessary. <programlisting>
5303    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
5304    # <emphasis role="bold">rm afs.rc</emphasis>
5305    # <emphasis role="bold">ln -s  /etc/init.d/afs  afs.rc</emphasis>
5306 </programlisting></para>
5307         </listitem>
5308       </orderedlist>
5309
5310       <indexterm>
5311         <primary>AFS filespace</primary>
5312
5313         <secondary>configuring top levels</secondary>
5314       </indexterm>
5315
5316       <indexterm>
5317         <primary>configuring</primary>
5318
5319         <secondary>AFS filespace (top levels)</secondary>
5320       </indexterm>
5321     </sect2>
5322   </sect1>
5323
5324   <sect1 id="HDRWQ80">
5325     <title>Configuring the Top Levels of the AFS Filespace</title>
5326
5327     <para>If you have not previously run AFS in your cell, you now configure the top levels of your cell's AFS filespace. If you
5328     have run a previous version of AFS, the filespace is already configured. Proceed to <link linkend="HDRWQ83">Storing AFS Binaries
5329     in AFS</link>. <indexterm>
5330         <primary>root.cell volume</primary>
5331
5332         <secondary>creating and replicating</secondary>
5333       </indexterm> <indexterm>
5334         <primary>volume</primary>
5335
5336         <secondary>creating</secondary>
5337
5338         <tertiary>root.cell</tertiary>
5339       </indexterm> <indexterm>
5340         <primary>creating</primary>
5341
5342         <secondary>root.cell volume</secondary>
5343       </indexterm></para>
5344
5345     <para>You created the <emphasis role="bold">root.afs</emphasis> volume in <link linkend="HDRWQ60">Starting the File Server,
5346     Volume Server, and Salvager</link>, and the Cache Manager mounted it automatically on the local <emphasis
5347     role="bold">/afs</emphasis> directory when you ran the AFS initialization script in <link linkend="HDRWQ72">Verifying the AFS
5348     Initialization Script</link>. You now set the access control list (ACL) on the <emphasis role="bold">/afs</emphasis> directory;
5349     creating, mounting, and setting the ACL are the three steps required when creating any volume.</para>
5350
5351     <para>After setting the ACL on the <emphasis role="bold">root.afs</emphasis> volume, you create your cell's <emphasis
5352     role="bold">root.cell</emphasis> volume, mount it as a subdirectory of the <emphasis role="bold">/afs</emphasis> directory, and
5353     set the ACL. Create both a read/write and a regular mount point for the <emphasis role="bold">root.cell</emphasis> volume. The
5354     read/write mount point enables you to access the read/write version of replicated volumes when necessary. Creating both mount
5355     points essentially creates separate read-only and read-write copies of your filespace, and enables the Cache Manager to traverse
5356     the filespace on a read-only path or read/write path as appropriate. For further discussion of these concepts, see the chapter
5357     in the <emphasis>OpenAFS Administration Guide</emphasis> about administering volumes. <indexterm>
5358         <primary>root.afs volume</primary>
5359
5360         <secondary>replicating</secondary>
5361       </indexterm> <indexterm>
5362         <primary>volume</primary>
5363
5364         <secondary>replicating root.afs and root.cell</secondary>
5365       </indexterm> <indexterm>
5366         <primary>replicating volumes</primary>
5367       </indexterm></para>
5368
5369     <para>Then replicate both the <emphasis role="bold">root.afs</emphasis> and <emphasis role="bold">root.cell</emphasis> volumes.
5370     This is required if you want to replicate any other volumes in your cell, because all volumes mounted above a replicated volume
5371     must themselves be replicated in order for the Cache Manager to access the replica.</para>
5372
5373     <para>When the <emphasis role="bold">root.afs</emphasis> volume is replicated, the Cache Manager is programmed to access its
5374     read-only version (<emphasis role="bold">root.afs.readonly</emphasis>) whenever possible. To make changes to the contents of the
5375     <emphasis role="bold">root.afs</emphasis> volume (when, for example, you mount another cell's <emphasis
5376     role="bold">root.cell</emphasis> volume at the second level in your filespace), you must mount the <emphasis
5377     role="bold">root.afs</emphasis> volume temporarily, make the changes, release the volume and remove the temporary mount point.
5378     For instructions, see <link linkend="HDRWQ91">Enabling Access to Foreign Cells</link>. <indexterm>
5379         <primary>fs commands</primary>
5380
5381         <secondary>setacl</secondary>
5382       </indexterm> <indexterm>
5383         <primary>commands</primary>
5384
5385         <secondary>fs setacl</secondary>
5386       </indexterm> <indexterm>
5387         <primary>access control list (ACL), setting</primary>
5388       </indexterm> <indexterm>
5389         <primary>setting</primary>
5390
5391         <secondary>ACL</secondary>
5392       </indexterm> <orderedlist>
5393         <listitem>
5394           <para>Issue the <emphasis role="bold">fs setacl</emphasis> command to edit the ACL on the <emphasis
5395           role="bold">/afs</emphasis> directory. Add an entry that grants the <emphasis role="bold">l</emphasis> (<emphasis
5396           role="bold">lookup</emphasis>) and <emphasis role="bold">r</emphasis> (<emphasis role="bold">read</emphasis>) permissions
5397           to the <emphasis role="bold">system:anyuser</emphasis> group, to enable all AFS users who can reach your cell to traverse
5398           through the directory. If you prefer to enable access only to locally authenticated users, substitute the <emphasis
5399           role="bold">system:authuser</emphasis> group.</para>
5400
5401           <para>Note that there is already an ACL entry that grants all seven access rights to the <emphasis
5402           role="bold">system:administrators</emphasis> group. It is a default entry that AFS places on every new volume's root
5403           directory.</para>
5404
5405           <programlisting>
5406    # <emphasis role="bold">/usr/afs/bin/fs setacl /afs system:anyuser rl</emphasis>
5407 </programlisting>
5408
5409           <indexterm>
5410             <primary>commands</primary>
5411
5412             <secondary>vos create</secondary>
5413
5414             <tertiary>root.cell volume</tertiary>
5415           </indexterm>
5416
5417           <indexterm>
5418             <primary>vos commands</primary>
5419
5420             <secondary>create</secondary>
5421
5422             <tertiary>root.cell volume</tertiary>
5423           </indexterm>
5424
5425           <indexterm>
5426             <primary>fs commands</primary>
5427
5428             <secondary>mkmount</secondary>
5429           </indexterm>
5430
5431           <indexterm>
5432             <primary>commands</primary>
5433
5434             <secondary>fs mkmount</secondary>
5435           </indexterm>
5436
5437           <indexterm>
5438             <primary>mount point</primary>
5439           </indexterm>
5440
5441           <indexterm>
5442             <primary>creating</primary>
5443
5444             <secondary>mount point</secondary>
5445           </indexterm>
5446
5447           <indexterm>
5448             <primary>volume</primary>
5449
5450             <secondary>mounting</secondary>
5451           </indexterm>
5452         </listitem>
5453
5454         <listitem>
5455           <para><anchor id="LIWQ81" />Issue the <emphasis role="bold">vos create</emphasis> command to create the <emphasis
5456           role="bold">root.cell</emphasis> volume. Then issue the <emphasis role="bold">fs mkmount</emphasis> command to mount it as
5457           a subdirectory of the <emphasis role="bold">/afs</emphasis> directory, where it serves as the root of your cell's local
5458           AFS filespace. Finally, issue the <emphasis role="bold">fs setacl</emphasis> command to create an ACL entry for the
5459           <emphasis role="bold">system:anyuser</emphasis> group (or <emphasis role="bold">system:authuser</emphasis> group).</para>
5460
5461           <para>For the <replaceable>partition name</replaceable> argument, substitute the name of one of the machine's AFS server
5462           partitions (such as <emphasis role="bold">/vicepa</emphasis>). For the <replaceable>cellname</replaceable> argument,
5463           substitute your cell's fully-qualified Internet domain name (such as <emphasis role="bold">abc.com</emphasis>).</para>
5464
5465           <programlisting>
5466    # <emphasis role="bold">/usr/afs/bin/vos create</emphasis>  &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <emphasis
5467               role="bold">root.cell</emphasis>
5468    # <emphasis role="bold">/usr/afs/bin/fs mkmount /afs/</emphasis><replaceable>cellname</replaceable>  <emphasis role="bold">root.cell</emphasis>
5469    # <emphasis role="bold">/usr/afs/bin/fs setacl /afs/</emphasis><replaceable>cellname</replaceable>  <emphasis role="bold">system:anyuser rl</emphasis>
5470 </programlisting>
5471
5472           <indexterm>
5473             <primary>creating</primary>
5474
5475             <secondary>symbolic link</secondary>
5476
5477             <tertiary>for abbreviated cell name</tertiary>
5478           </indexterm>
5479
5480           <indexterm>
5481             <primary>symbolic link</primary>
5482
5483             <secondary>for abbreviated cell name</secondary>
5484           </indexterm>
5485
5486           <indexterm>
5487             <primary>cell name</primary>
5488
5489             <secondary>symbolic link for abbreviated</secondary>
5490           </indexterm>
5491         </listitem>
5492
5493         <listitem>
5494           <para><emphasis role="bold">(Optional)</emphasis> Create a symbolic link to a shortened cell name, to reduce the length of
5495           pathnames for users in the local cell. For example, in the <emphasis role="bold">abc.com</emphasis> cell, <emphasis
5496           role="bold">/afs/abc</emphasis> is a link to <emphasis role="bold">/afs/abc.com</emphasis>. <programlisting>
5497    # <emphasis role="bold">cd /afs</emphasis>
5498    # <emphasis role="bold">ln -s</emphasis>  <replaceable>full_cellname</replaceable>  <replaceable>short_cellname</replaceable>
5499 </programlisting> <indexterm>
5500               <primary>read/write mount point for root.afs volume</primary>
5501             </indexterm> <indexterm>
5502               <primary>root.afs volume</primary>
5503
5504               <secondary>read/write mount point</secondary>
5505             </indexterm> <indexterm>
5506               <primary>creating</primary>
5507
5508               <secondary>read/write mount point</secondary>
5509             </indexterm></para>
5510         </listitem>
5511
5512         <listitem>
5513           <para>Issue the <emphasis role="bold">fs mkmount</emphasis> command to create a read/write mount point for the <emphasis
5514           role="bold">root.cell</emphasis> volume (you created a regular mount point in Step <link
5515           linkend="LIWQ81">2</link>).</para>
5516
5517           <para>By convention, the name of a read/write mount point begins with a period, both to distinguish it from the regular
5518           mount point and to make it visible only when the <emphasis role="bold">-a</emphasis> flag is used on the <emphasis
5519           role="bold">ls</emphasis> command.</para>
5520
5521           <para>Change directory to <emphasis role="bold">/usr/afs/bin</emphasis> to make it easier to access the command
5522           binaries.</para>
5523
5524           <programlisting>
5525    # <emphasis role="bold">cd /usr/afs/bin</emphasis>
5526    # <emphasis role="bold">./fs mkmount   /afs/.</emphasis><replaceable>cellname</replaceable>   <emphasis role="bold">root.cell -rw</emphasis>
5527 </programlisting>
5528
5529           <indexterm>
5530             <primary>commands</primary>
5531
5532             <secondary>vos addsite</secondary>
5533           </indexterm>
5534
5535           <indexterm>
5536             <primary>vos commands</primary>
5537
5538             <secondary>addsite</secondary>
5539           </indexterm>
5540
5541           <indexterm>
5542             <primary>volume</primary>
5543
5544             <secondary>defining replication site</secondary>
5545           </indexterm>
5546
5547           <indexterm>
5548             <primary>defining</primary>
5549
5550             <secondary>replication site for volume</secondary>
5551           </indexterm>
5552         </listitem>
5553
5554         <listitem>
5555           <para><anchor id="LIWQ82" />Issue the <emphasis role="bold">vos addsite</emphasis> command to define a replication site
5556           for both the <emphasis role="bold">root.afs</emphasis> and <emphasis role="bold">root.cell</emphasis> volumes. In each
5557           case, substitute for the <replaceable>partition name</replaceable> argument the partition where the volume's read/write
5558           version resides. When you install additional file server machines, it is a good idea to create replication sites on them
5559           as well. <programlisting>
5560    # <emphasis role="bold">./vos addsite</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <emphasis
5561                 role="bold">root.afs</emphasis>
5562    # <emphasis role="bold">./vos addsite</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <emphasis
5563                 role="bold">root.cell</emphasis>
5564 </programlisting> <indexterm>
5565               <primary>fs commands</primary>
5566
5567               <secondary>examine</secondary>
5568             </indexterm> <indexterm>
5569               <primary>commands</primary>
5570
5571               <secondary>fs examine</secondary>
5572             </indexterm></para>
5573         </listitem>
5574
5575         <listitem>
5576           <para>Issue the <emphasis role="bold">fs examine</emphasis> command to verify that the Cache Manager can access both the
5577           <emphasis role="bold">root.afs</emphasis> and <emphasis role="bold">root.cell</emphasis> volumes, before you attempt to
5578           replicate them. The output lists each volume's name, volumeID number, quota, size, and the size of the partition that
5579           houses them. If you get an error message instead, do not continue before taking corrective action. <programlisting>
5580    # <emphasis role="bold">./fs examine /afs</emphasis>
5581    # <emphasis role="bold">./fs examine /afs/</emphasis><replaceable>cellname</replaceable>
5582 </programlisting> <indexterm>
5583               <primary>commands</primary>
5584
5585               <secondary>vos release</secondary>
5586             </indexterm> <indexterm>
5587               <primary>vos commands</primary>
5588
5589               <secondary>release</secondary>
5590             </indexterm> <indexterm>
5591               <primary>volume</primary>
5592
5593               <secondary>releasing replicated</secondary>
5594             </indexterm> <indexterm>
5595               <primary>releasing replicated volume</primary>
5596             </indexterm></para>
5597         </listitem>
5598
5599         <listitem>
5600           <para>Issue the <emphasis role="bold">vos release</emphasis> command to release a replica of the <emphasis
5601           role="bold">root.afs</emphasis> and <emphasis role="bold">root.cell</emphasis> volumes to the sites you defined in Step
5602           <link linkend="LIWQ82">5</link>. <programlisting>
5603    # <emphasis role="bold">./vos release root.afs</emphasis>
5604    # <emphasis role="bold">./vos release root.cell</emphasis>
5605 </programlisting> <indexterm>
5606               <primary>fs commands</primary>
5607
5608               <secondary>checkvolumes</secondary>
5609             </indexterm> <indexterm>
5610               <primary>commands</primary>
5611
5612               <secondary>fs checkvolumes</secondary>
5613             </indexterm></para>
5614         </listitem>
5615
5616         <listitem>
5617           <para>Issue the <emphasis role="bold">fs checkvolumes</emphasis> to force the Cache Manager to notice that you have
5618           released read-only versions of the volumes, then issue the <emphasis role="bold">fs examine</emphasis> command again. This
5619           time its output mentions the read-only version of the volumes (<emphasis role="bold">root.afs.readonly</emphasis> and
5620           <emphasis role="bold">root.cell.readonly</emphasis>) instead of the read/write versions, because of the Cache Manager's
5621           bias to access the read-only version of the <emphasis role="bold">root.afs</emphasis> volume if it exists.
5622           <programlisting>
5623    # <emphasis role="bold">./fs checkvolumes</emphasis>
5624    # <emphasis role="bold">./fs examine /afs</emphasis>
5625    # <emphasis role="bold">./fs examine /afs/</emphasis><replaceable>cellname</replaceable>
5626 </programlisting></para>
5627         </listitem>
5628       </orderedlist></para>
5629
5630     <indexterm>
5631       <primary>storing</primary>
5632
5633       <secondary>AFS binaries in volumes</secondary>
5634     </indexterm>
5635
5636     <indexterm>
5637       <primary>creating</primary>
5638
5639       <secondary>volume</secondary>
5640
5641       <tertiary>for AFS binaries</tertiary>
5642     </indexterm>
5643
5644     <indexterm>
5645       <primary>volume</primary>
5646
5647       <secondary>for AFS binaries</secondary>
5648     </indexterm>
5649
5650     <indexterm>
5651       <primary>binaries</primary>
5652
5653       <secondary>storing AFS in volume</secondary>
5654     </indexterm>
5655
5656     <indexterm>
5657       <primary>usr/afsws directory</primary>
5658     </indexterm>
5659
5660     <indexterm>
5661       <primary>directories</primary>
5662
5663       <secondary>/usr/afsws</secondary>
5664     </indexterm>
5665   </sect1>
5666
5667   <sect1 id="HDRWQ83">
5668     <title>Storing AFS Binaries in AFS</title>
5669
5670     <note><para>Sites with existing binary distribution mechanisms, including
5671     those which use packaging systems such as RPM, may wish to skip this step,
5672     and use tools native to their operating system to manage AFS configuration
5673     information.</para></note>
5674
5675     <para>In the conventional configuration, you make AFS client binaries and configuration files available in the subdirectories of
5676     the <emphasis role="bold">/usr/afsws</emphasis> directory on client machines (<emphasis role="bold">afsws</emphasis> is an
5677     acronym for <emphasis role="bold">AFS w</emphasis><emphasis>ork</emphasis><emphasis
5678     role="bold">s</emphasis><emphasis>tation</emphasis>). You can conserve local disk space by creating <emphasis
5679     role="bold">/usr/afsws</emphasis> as a link to an AFS volume that houses the AFS client binaries and configuration files for
5680     this system type.</para>
5681
5682     <para>In this section you create the necessary volumes. The conventional location to which to link <emphasis
5683     role="bold">/usr/afsws</emphasis> is <emphasis role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
5684     role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/usr/afsws</emphasis>, where
5685     <replaceable>sysname</replaceable> is the appropriate system type name as specified in the <emphasis>OpenAFS Release
5686     Notes</emphasis>. The instructions in <link linkend="HDRWQ133">Installing Additional Client Machines</link> assume that you have
5687     followed the instructions in this section.</para>
5688
5689     <para>If you have previously run AFS in the cell, the volumes possibly already exist. If so, you need to perform Step <link
5690     linkend="LIWQ86">8</link> only.</para>
5691
5692     <para>The current working directory is still <emphasis role="bold">/usr/afs/bin</emphasis>, which houses the <emphasis
5693     role="bold">fs</emphasis> and <emphasis role="bold">vos</emphasis> command suite binaries. In the following commands, it is
5694     possible you still need to specify the pathname to the commands, depending on how your PATH environment variable is set.
5695     <orderedlist>
5696         <indexterm>
5697           <primary>commands</primary>
5698
5699           <secondary>vos create</secondary>
5700
5701           <tertiary>volume for AFS binaries</tertiary>
5702         </indexterm>
5703
5704         <indexterm>
5705           <primary>vos commands</primary>
5706
5707           <secondary>create</secondary>
5708
5709           <tertiary>volume for AFS binaries</tertiary>
5710         </indexterm>
5711
5712         <listitem>
5713           <para><anchor id="LIWQ84" />Issue the <emphasis role="bold">vos create</emphasis> command to create volumes for storing
5714           the AFS client binaries for this system type. The following example instruction creates volumes called
5715           <replaceable>sysname</replaceable>, <replaceable>sysname</replaceable>.<emphasis role="bold">usr</emphasis>, and
5716           <replaceable>sysname</replaceable>.<emphasis role="bold">usr.afsws</emphasis>. Refer to the <emphasis>OpenAFS Release
5717           Notes</emphasis> to learn the proper value of <replaceable>sysname</replaceable> for this system type. <programlisting>
5718    # <emphasis role="bold">vos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <replaceable>sysname</replaceable>
5719    # <emphasis role="bold">vos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <replaceable>sysname</replaceable><emphasis
5720                 role="bold">.usr</emphasis>
5721    # <emphasis role="bold">vos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <replaceable>sysname</replaceable><emphasis
5722                 role="bold">.usr.afsws</emphasis>
5723 </programlisting></para>
5724         </listitem>
5725
5726         <listitem>
5727           <para>Issue the <emphasis role="bold">fs mkmount</emphasis> command to mount the newly created volumes. Because the
5728           <emphasis role="bold">root.cell</emphasis> volume is replicated, you must precede the <emphasis>cellname</emphasis> part
5729           of the pathname with a period to specify the read/write mount point, as shown. Then issue the <emphasis role="bold">vos
5730           release</emphasis> command to release a new replica of the <emphasis role="bold">root.cell</emphasis> volume, and the
5731           <emphasis role="bold">fs checkvolumes</emphasis> command to force the local Cache Manager to access them. <programlisting>
5732    # <emphasis role="bold">fs mkmount -dir /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable> <emphasis
5733                 role="bold">-vol</emphasis> <replaceable>sysname</replaceable>
5734    # <emphasis role="bold">fs mkmount -dir /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis
5735                 role="bold">/usr</emphasis>  <emphasis role="bold">-vol</emphasis> <replaceable>sysname</replaceable><emphasis
5736                 role="bold">.usr</emphasis>
5737    # <emphasis role="bold">fs mkmount -dir /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis
5738                 role="bold">/usr/afsws</emphasis> <emphasis role="bold">-vol</emphasis> <replaceable>sysname</replaceable><emphasis
5739                 role="bold">.usr.afsws</emphasis>
5740    # <emphasis role="bold">vos release root.cell</emphasis>
5741    # <emphasis role="bold">fs checkvolumes</emphasis>
5742 </programlisting></para>
5743         </listitem>
5744
5745         <listitem>
5746           <para>Issue the <emphasis role="bold">fs setacl</emphasis> command to grant the <emphasis role="bold">l</emphasis>
5747           (<emphasis role="bold">lookup</emphasis>) and <emphasis role="bold">r</emphasis> (<emphasis role="bold">read</emphasis>)
5748           permissions to the <emphasis role="bold">system:anyuser</emphasis> group on each new directory's ACL. <programlisting>
5749    # <emphasis role="bold">cd /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable>
5750    # <emphasis role="bold">fs setacl  -dir  .  usr  usr/afsws  -acl  system:anyuser rl</emphasis>
5751 </programlisting> <indexterm>
5752               <primary>commands</primary>
5753
5754               <secondary>fs setquota</secondary>
5755             </indexterm> <indexterm>
5756               <primary>fs commands</primary>
5757
5758               <secondary>setquota</secondary>
5759             </indexterm> <indexterm>
5760               <primary>quota for volume</primary>
5761             </indexterm> <indexterm>
5762               <primary>volume</primary>
5763
5764               <secondary>setting quota</secondary>
5765             </indexterm> <indexterm>
5766               <primary>setting</primary>
5767
5768               <secondary>volume quota</secondary>
5769             </indexterm></para>
5770         </listitem>
5771
5772         <listitem>
5773           <para><anchor id="LIWQ85" />Issue the <emphasis role="bold">fs setquota</emphasis> command to set an unlimited quota on
5774           the volume mounted at the <emphasis role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
5775           role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/usr/afsws</emphasis> directory. This
5776           enables you to copy all of the appropriate files from the CD-ROM into the volume without exceeding the volume's
5777           quota.</para>
5778
5779           <para>If you wish, you can set the volume's quota to a finite value after you complete the copying operation. At that
5780           point, use the <emphasis role="bold">vos examine</emphasis> command to determine how much space the volume is occupying.
5781           Then issue the <emphasis role="bold">fs setquota</emphasis> command to set a quota that is slightly larger.</para>
5782
5783           <programlisting>
5784    # <emphasis role="bold">fs setquota /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis
5785               role="bold">/usr/afsws  0</emphasis>
5786 </programlisting>
5787         </listitem>
5788
5789         <listitem>
5790           <para>Unpack the distribution tarball into the <emphasis role="bold">/tmp/afsdist</emphasis> directory,
5791           if it is not already. <indexterm>
5792               <primary>copying</primary>
5793
5794               <secondary>AFS binaries into volume</secondary>
5795             </indexterm> <indexterm>
5796               <primary>CD-ROM</primary>
5797
5798               <secondary>copying AFS binaries into volume</secondary>
5799             </indexterm> <indexterm>
5800               <primary>first AFS machine</primary>
5801
5802               <secondary>copying</secondary>
5803
5804               <tertiary>AFS binaries into volume</tertiary>
5805             </indexterm></para>
5806         </listitem>
5807
5808         <listitem>
5809           <para>Copy the contents of the indicated directories from the
5810           distribution into the <emphasis
5811           role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
5812           role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/usr/afsws</emphasis> directory.
5813           <programlisting>
5814    # <emphasis role="bold">cd /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis
5815                 role="bold">/usr/afsws</emphasis>
5816    # <emphasis role="bold">cp -rp /tmp/afsdist/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/bin  .</emphasis>
5817    # <emphasis role="bold">cp -rp /tmp/afsdist/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/etc  .</emphasis>
5818    # <emphasis role="bold">cp -rp /tmp/afsdist/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/include  .</emphasis>
5819    # <emphasis role="bold">cp -rp /tmp/afsdist/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/lib  .</emphasis>
5820 </programlisting>
5821 <indexterm>
5822               <primary>creating</primary>
5823
5824               <secondary>symbolic link</secondary>
5825
5826               <tertiary>to AFS binaries</tertiary>
5827             </indexterm> <indexterm>
5828               <primary>symbolic link</primary>
5829
5830               <secondary>to AFS binaries from local disk</secondary>
5831             </indexterm></para>
5832         </listitem>
5833
5834         <listitem>
5835           <para><anchor id="LIWQ86" />Create <emphasis role="bold">/usr/afsws</emphasis> on the local disk as a symbolic link to the
5836           directory <emphasis role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
5837           role="bold">/@sys/usr/afsws</emphasis>. You can specify the actual system name instead of <emphasis
5838           role="bold">@sys</emphasis> if you wish, but the advantage of using <emphasis role="bold">@sys</emphasis> is that it
5839           remains valid if you upgrade this machine to a different system type. <programlisting>
5840    # <emphasis role="bold">ln -s /afs/</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/@sys/usr/afsws  /usr/afsws</emphasis>
5841 </programlisting> <indexterm>
5842               <primary>PATH environment variable for users</primary>
5843             </indexterm> <indexterm>
5844               <primary>variables</primary>
5845
5846               <secondary>PATH, setting for users</secondary>
5847             </indexterm></para>
5848         </listitem>
5849
5850         <listitem>
5851           <para><emphasis role="bold">(Optional)</emphasis> To enable users to issue commands from the AFS suites (such as <emphasis
5852           role="bold">fs</emphasis>) without having to specify a pathname to their binaries, include the <emphasis
5853           role="bold">/usr/afsws/bin</emphasis> and <emphasis role="bold">/usr/afsws/etc</emphasis> directories in the PATH
5854           environment variable you define in each user's shell initialization file (such as <emphasis
5855           role="bold">.cshrc</emphasis>).</para>
5856         </listitem>
5857       </orderedlist></para>
5858
5859     <indexterm>
5860       <primary>storing</primary>
5861
5862       <secondary>AFS documentation in volumes</secondary>
5863     </indexterm>
5864
5865     <indexterm>
5866       <primary>creating</primary>
5867
5868       <secondary>volume</secondary>
5869
5870       <tertiary>for AFS documentation</tertiary>
5871     </indexterm>
5872
5873     <indexterm>
5874       <primary>volume</primary>
5875
5876       <secondary>for AFS documentation</secondary>
5877     </indexterm>
5878
5879     <indexterm>
5880       <primary>documentation, creating volume for AFS</primary>
5881     </indexterm>
5882
5883     <indexterm>
5884       <primary>usr/afsdoc directory</primary>
5885     </indexterm>
5886
5887     <indexterm>
5888       <primary>directories</primary>
5889
5890       <secondary>/usr/afsdoc</secondary>
5891     </indexterm>
5892   </sect1>
5893
5894   <sect1 id="HDRWQ87">
5895     <title>Storing AFS Documents in AFS</title>
5896
5897     <para>The AFS distribution includes the following documents: <itemizedlist>
5898         <listitem>
5899           <para><emphasis>OpenAFS Release Notes</emphasis></para>
5900         </listitem>
5901
5902         <listitem>
5903           <para><emphasis>OpenAFS Quick Beginnings</emphasis></para>
5904         </listitem>
5905
5906         <listitem>
5907           <para><emphasis>OpenAFS User Guide</emphasis></para>
5908         </listitem>
5909
5910         <listitem>
5911           <para><emphasis>OpenAFS Administration Reference</emphasis></para>
5912         </listitem>
5913
5914         <listitem>
5915           <para><emphasis>OpenAFS Administration Guide</emphasis></para>
5916         </listitem>
5917       </itemizedlist></para>
5918
5919     <note><para>OpenAFS Documentation is not currently provided with all
5920     distributions, but may be downloaded separately from the OpenAFS
5921     website</para></note>
5922
5923     <para>The OpenAFS Documentation Distribution has a directory for each
5924     document format provided. The different formats are suitable for online
5925     viewing, printing, or both.</para>
5926
5927     <para>This section explains how to create and mount a volume to house the documents, making them available to your users. The
5928     recommended mount point for the volume is <emphasis role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
5929     role="bold">/afsdoc</emphasis>. If you wish, you can create a link to the mount point on each client machine's local disk,
5930     called <emphasis role="bold">/usr/afsdoc</emphasis>. Alternatively, you can create a link to the mount point in each user's home
5931     directory. You can also choose to permit users to access only certain documents (most probably, the <emphasis>OpenAFS User
5932     Guide</emphasis>) by creating different mount points or setting different ACLs on different document directories.</para>
5933
5934     <para>The current working directory is still <emphasis role="bold">/usr/afs/bin</emphasis>, which houses the <emphasis
5935     role="bold">fs</emphasis> and <emphasis role="bold">vos</emphasis> command suite binaries you use to create and mount volumes.
5936     In the following commands, it is possible you still need to specify the pathname to the commands, depending on how your PATH
5937     environment variable is set. <orderedlist>
5938         <indexterm>
5939           <primary>commands</primary>
5940
5941           <secondary>vos create</secondary>
5942
5943           <tertiary>volume for AFS documentation</tertiary>
5944         </indexterm>
5945
5946         <indexterm>
5947           <primary>vos commands</primary>
5948
5949           <secondary>create</secondary>
5950
5951           <tertiary>volume for AFS documentation</tertiary>
5952         </indexterm>
5953
5954         <listitem>
5955           <para>Issue the <emphasis role="bold">vos create</emphasis> command to create a volume for storing the AFS documentation.
5956           Include the <emphasis role="bold">-maxquota</emphasis> argument to set an unlimited quota on the volume. This enables you
5957           to copy all of the appropriate files from the CD-ROM into the volume without exceeding the volume's quota.</para>
5958
5959           <para>If you wish, you can set the volume's quota to a finite value after you complete the copying operations. At that
5960           point, use the <emphasis role="bold">vos examine</emphasis> command to determine how much space the volume is occupying.
5961           Then issue the <emphasis role="bold">fs setquota</emphasis> command to set a quota that is slightly larger.</para>
5962
5963           <programlisting>
5964    # <emphasis role="bold">vos create</emphasis>  &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt;  <emphasis
5965               role="bold">afsdoc  -maxquota  0</emphasis>
5966 </programlisting>
5967         </listitem>
5968
5969         <listitem>
5970           <para>Issue the <emphasis role="bold">fs mkmount</emphasis> command to mount the new volume. Because the <emphasis
5971           role="bold">root.cell</emphasis> volume is replicated, you must precede the <emphasis>cellname</emphasis> with a period to
5972           specify the read/write mount point, as shown. Then issue the <emphasis role="bold">vos release</emphasis> command to
5973           release a new replica of the <emphasis role="bold">root.cell</emphasis> volume, and the <emphasis role="bold">fs
5974           checkvolumes</emphasis> command to force the local Cache Manager to access them. <programlisting>
5975    # <emphasis role="bold">fs mkmount -dir /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/afsdoc</emphasis> <emphasis
5976                 role="bold">-vol</emphasis> <emphasis role="bold">afsdoc</emphasis>
5977    # <emphasis role="bold">vos release root.cell</emphasis>
5978    # <emphasis role="bold">fs checkvolumes</emphasis>
5979 </programlisting></para>
5980         </listitem>
5981
5982         <listitem>
5983           <para>Issue the <emphasis role="bold">fs setacl</emphasis> command to grant the <emphasis role="bold">rl</emphasis>
5984           permissions to the <emphasis role="bold">system:anyuser</emphasis> group on the new directory's ACL. <programlisting>
5985    # <emphasis role="bold">cd /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/afsdoc</emphasis>
5986    # <emphasis role="bold">fs setacl  .  system:anyuser rl</emphasis>
5987 </programlisting></para>
5988         </listitem>
5989
5990         <listitem>
5991           <para>Unpack the OpenAFS documentation distribution into the
5992           <emphasis role="bold">/tmp/afsdocs</emphasis> directory. You may use
5993           a different directory, in which case the location you use should be
5994           subsituted in the following examples. For instructions on unpacking
5995           the distribution, consult the documentation for your operating
5996           system's <emphasis role="bold">tar</emphasis> command.
5997           <indexterm>
5998               <primary>copying</primary>
5999
6000               <secondary>AFS documentation from distribution</secondary>
6001             </indexterm> <indexterm>
6002               <primary>OpenAFS Distribution</primary>
6003
6004               <secondary>copying AFS documentation from</secondary>
6005             </indexterm> <indexterm>
6006               <primary>first AFS machine</primary>
6007
6008               <secondary>copying</secondary>
6009
6010               <tertiary>AFS documentation from OpenAFS distribution</tertiary>
6011             </indexterm> <indexterm>
6012               <primary>index.htm file</primary>
6013             </indexterm> <indexterm>
6014               <primary>files</primary>
6015
6016               <secondary>index.htm</secondary>
6017             </indexterm></para>
6018         </listitem>
6019
6020         <listitem>
6021           <para>Copy the AFS documents in one or more formats from the unpacked distribution into subdirectories of the <emphasis
6022           role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/afsdoc</emphasis> directory. Repeat
6023           the commands for each format. <programlisting>
6024    # <emphasis role="bold">mkdir</emphasis> <replaceable>format_name</replaceable>
6025    # <emphasis role="bold">cd</emphasis> <replaceable>format_name</replaceable>
6026    # <emphasis role="bold">cp -rp /tmp/afsdocs/</emphasis><replaceable>format</replaceable>  <emphasis role="bold">.</emphasis>
6027 </programlisting></para>
6028
6029           <para>If you choose to store the HTML version of the documents in AFS, note that in addition to a subdirectory for each
6030           document there are several files with a <emphasis role="bold">.gif</emphasis> extension, which enable readers to move
6031           easily between sections of a document. The file called <emphasis role="bold">index.htm</emphasis> is an introductory HTML
6032           page that contains a hyperlink to each of the documents. For online viewing to work properly, these files must remain in
6033           the top-level HTML directory (the one named, for example, <emphasis
6034           role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/afsdoc/html</emphasis>).</para>
6035         </listitem>
6036
6037         <listitem>
6038           <para><emphasis role="bold">(Optional)</emphasis> If you believe it is helpful to your users to access the AFS documents
6039           in a certain format via a local disk directory, create <emphasis role="bold">/usr/afsdoc</emphasis> on the local disk as a
6040           symbolic link to the documentation directory in AFS (<emphasis
6041           role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
6042           role="bold">/afsdoc/</emphasis><replaceable>format_name</replaceable>). <programlisting>
6043    # <emphasis role="bold">ln -s /afs/</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/afsdoc/</emphasis><replaceable>format_name</replaceable> <emphasis
6044                 role="bold">/usr/afsdoc</emphasis>
6045 </programlisting></para>
6046
6047           <para>An alternative is to create a link in each user's home directory to the <emphasis
6048           role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
6049           role="bold">/afsdoc/</emphasis><replaceable>format_name</replaceable> directory.</para>
6050         </listitem>
6051       </orderedlist></para>
6052
6053     <indexterm>
6054       <primary>storing</primary>
6055
6056       <secondary>system binaries in volumes</secondary>
6057     </indexterm>
6058
6059     <indexterm>
6060       <primary>creating</primary>
6061
6062       <secondary>volume</secondary>
6063
6064       <tertiary>for system binaries</tertiary>
6065     </indexterm>
6066
6067     <indexterm>
6068       <primary>volume</primary>
6069
6070       <secondary>for system binaries</secondary>
6071     </indexterm>
6072
6073     <indexterm>
6074       <primary>binaries</primary>
6075
6076       <secondary>storing system in volumes</secondary>
6077     </indexterm>
6078   </sect1>
6079
6080   <sect1 id="HDRWQ88">
6081     <title>Storing System Binaries in AFS</title>
6082
6083     <para>You can also choose to store other system binaries in AFS volumes, such as the standard UNIX programs conventionally
6084     located in local disk directories such as <emphasis role="bold">/etc</emphasis>, <emphasis role="bold">/bin</emphasis>, and
6085     <emphasis role="bold">/lib</emphasis>. Storing such binaries in an AFS volume not only frees local disk space, but makes it
6086     easier to update binaries on all client machines.</para>
6087
6088     <para>The following is a suggested scheme for storing system binaries in AFS. It does not include instructions, but you can use
6089     the instructions in <link linkend="HDRWQ83">Storing AFS Binaries in AFS</link> (which are for AFS-specific binaries) as a
6090     template.</para>
6091
6092     <para>Some files must remain on the local disk for use when AFS is inaccessible (during bootup and file server or network
6093     outages). The required binaries include the following: <itemizedlist>
6094         <listitem>
6095           <para>A text editor, network commands, and so on</para>
6096         </listitem>
6097
6098         <listitem>
6099           <para>Files used during the boot sequence before the <emphasis role="bold">afsd</emphasis> program runs, such as
6100           initialization and configuration files, and binaries for commands that mount file systems</para>
6101         </listitem>
6102
6103         <listitem>
6104           <para>Files used by dynamic kernel loader programs</para>
6105         </listitem>
6106       </itemizedlist></para>
6107
6108     <para>In most cases, it is more secure to enable only locally authenticated users to access system binaries, by granting the
6109     <emphasis role="bold">l</emphasis> (<emphasis role="bold">lookup</emphasis>) and <emphasis role="bold">r</emphasis> (<emphasis
6110     role="bold">read</emphasis>) permissions to the <emphasis role="bold">system:authuser</emphasis> group on the ACLs of
6111     directories that contain the binaries. If users need to access a binary while unauthenticated, however, the ACL on its directory
6112     must grant those permissions to the <emphasis role="bold">system:anyuser</emphasis> group.</para>
6113
6114     <para>The following chart summarizes the suggested volume and mount point names for storing system binaries. It uses a separate
6115     volume for each directory. You already created a volume called <replaceable>sysname</replaceable> for this machine's system type
6116     when you followed the instructions in <link linkend="HDRWQ83">Storing AFS Binaries in AFS</link>.</para>
6117
6118     <para>You can name volumes in any way you wish, and mount them at other locations than those suggested here. However, this
6119     scheme has several advantages: <itemizedlist>
6120         <listitem>
6121           <para>Volume names clearly identify volume contents</para>
6122         </listitem>
6123
6124         <listitem>
6125           <para>Using the <replaceable>sysname</replaceable> prefix on every volume makes it is easy to back up all of the volumes
6126           together, because the AFS Backup System enables you to define sets of volumes based on a string included in all of their
6127           names</para>
6128         </listitem>
6129
6130         <listitem>
6131           <para>It makes it easy to track related volumes, keeping them together on the same file server machine if desired</para>
6132         </listitem>
6133
6134         <listitem>
6135           <para>There is a clear relationship between volume name and mount point name</para>
6136         </listitem>
6137       </itemizedlist></para>
6138
6139     <informaltable frame="none">
6140       <tgroup cols="2">
6141         <colspec colwidth="50*" />
6142
6143         <colspec colwidth="50*" />
6144
6145         <thead>
6146           <row>
6147             <entry><emphasis role="bold">Volume Name</emphasis></entry>
6148
6149             <entry><emphasis role="bold">Mount Point</emphasis></entry>
6150           </row>
6151         </thead>
6152
6153         <tbody>
6154           <row>
6155             <entry><replaceable>sysname</replaceable></entry>
6156
6157             <entry><emphasis
6158             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable></entry>
6159           </row>
6160
6161           <row>
6162             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">bin</emphasis></entry>
6163
6164             <entry><emphasis
6165             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6166             role="bold">/bin</emphasis></entry>
6167           </row>
6168
6169           <row>
6170             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">etc</emphasis></entry>
6171
6172             <entry><emphasis
6173             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6174             role="bold">/etc</emphasis></entry>
6175           </row>
6176
6177           <row>
6178             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr</emphasis></entry>
6179
6180             <entry><emphasis
6181             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6182             role="bold">/usr</emphasis></entry>
6183           </row>
6184
6185           <row>
6186             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.afsws</emphasis></entry>
6187
6188             <entry><emphasis
6189             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6190             role="bold">/usr/afsws</emphasis></entry>
6191           </row>
6192
6193           <row>
6194             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.bin</emphasis></entry>
6195
6196             <entry><emphasis
6197             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6198             role="bold">/usr/bin</emphasis></entry>
6199           </row>
6200
6201           <row>
6202             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.etc</emphasis></entry>
6203
6204             <entry><emphasis
6205             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6206             role="bold">/usr/etc</emphasis></entry>
6207           </row>
6208
6209           <row>
6210             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.inc</emphasis></entry>
6211
6212             <entry><emphasis
6213             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6214             role="bold">/usr/include</emphasis></entry>
6215           </row>
6216
6217           <row>
6218             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.lib</emphasis></entry>
6219
6220             <entry><emphasis
6221             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6222             role="bold">/usr/lib</emphasis></entry>
6223           </row>
6224
6225           <row>
6226             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.loc</emphasis></entry>
6227
6228             <entry><emphasis
6229             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6230             role="bold">/usr/local</emphasis></entry>
6231           </row>
6232
6233           <row>
6234             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.man</emphasis></entry>
6235
6236             <entry><emphasis
6237             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6238             role="bold">/usr/man</emphasis></entry>
6239           </row>
6240
6241           <row>
6242             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.sys</emphasis></entry>
6243
6244             <entry><emphasis
6245             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6246             role="bold">/usr/sys</emphasis></entry>
6247           </row>
6248         </tbody>
6249       </tgroup>
6250     </informaltable>
6251
6252     <indexterm>
6253       <primary>foreign cell, enabling access</primary>
6254     </indexterm>
6255
6256     <indexterm>
6257       <primary>cell</primary>
6258
6259       <secondary>enabling access to foreign</secondary>
6260     </indexterm>
6261
6262     <indexterm>
6263       <primary>access</primary>
6264
6265       <secondary>to local and foreign cells</secondary>
6266     </indexterm>
6267
6268     <indexterm>
6269       <primary>AFS filespace</primary>
6270
6271       <secondary>enabling access to foreign cells</secondary>
6272     </indexterm>
6273
6274     <indexterm>
6275       <primary>root.cell volume</primary>
6276
6277       <secondary>mounting for foreign cells in local filespace</secondary>
6278     </indexterm>
6279
6280     <indexterm>
6281       <primary>database server machine</primary>
6282
6283       <secondary>entry in client CellServDB file</secondary>
6284
6285       <tertiary>for foreign cell</tertiary>
6286     </indexterm>
6287
6288     <indexterm>
6289       <primary>CellServDB file (client)</primary>
6290
6291       <secondary>adding entry</secondary>
6292
6293       <tertiary>for foreign cell</tertiary>
6294     </indexterm>
6295   </sect1>
6296
6297   <sect1 id="HDRWQ91">
6298     <title>Enabling Access to Foreign Cells</title>
6299
6300     <para>With current OpenAFS releases, there exist a number of mechanisms for
6301     providing access to foreign cells. You may add mount points in your AFS
6302     filespace for each foreign cell you wish users to access, or you can
6303     enable a 'synthetic' AFS root, which contains mountpoints for either all
6304     AFS cells defined in the client machine's local
6305     <emphasis role="bold">/usr/vice/etc/CellServDB</emphasis>, or for all cells
6306     providing location information in the DNS.
6307     </para>
6308
6309     <sect2>
6310     <title>Enabling a Synthetic AFS root</title>
6311
6312     <para>When a synthetic root is enabled, the client cache machine creates its
6313     own root.afs volume, rather than using the one provided with your cell. This
6314     allows clients to access all cells in the
6315     <emphasis role="bold">CellServDB</emphasis> file and, optionally, all cells
6316     registered in the DNS, without requiring system administrator action to
6317     enable this access. Using a synthetic root has the additional advantage that
6318     it allows a client to start its AFS service without a network available, as
6319     it is no longer necessary to contact a fileserver to obtain the root volume.
6320     </para>
6321
6322     <para>OpenAFS supports two complimentary mechanisms for creating the
6323     synthetic root. Starting the cache manager with the
6324     <emphasis role="bold">-dynroot</emphasis> option adds all cells listed
6325     in <emphasis role="bold">/usr/vice/etc/CellServDB</emphasis> to the client's
6326     AFS root. Adding the <emphasis role="bold">-afsdb</emphasis> option in
6327     addition to this enables DNS lookups for any cells that are not found in
6328     the client's CellServDB file. Both of these options are added to the AFS
6329     initialisation script, or options file, as detailed in
6330     <link linkend="HDRWQ70">Configuring the Cache Manager</link>.</para>
6331     </sect2>
6332     <sect2>
6333       <title>Adding foreign cells to a conventional root volume</title>
6334
6335     <para>In this section you create a mount point in your AFS filespace for the <emphasis role="bold">root.cell</emphasis> volume
6336     of each foreign cell that you want to enable your users to access. For users working on a client machine to access the cell,
6337     there must in addition be an entry for it in the client machine's local <emphasis
6338     role="bold">/usr/vice/etc/CellServDB</emphasis> file. (The instructions in <link linkend="HDRWQ66">Creating the Client
6339     CellServDB File</link> suggest that you use the <emphasis role="bold">CellServDB.sample</emphasis> file included in the AFS
6340     distribution as the basis for your cell's client <emphasis role="bold">CellServDB</emphasis> file. The sample file lists all of
6341     the cells that had agreed to participate in the AFS global namespace at the time your AFS CD-ROM was created. As mentioned in
6342     that section, the AFS Product Support group also maintains a copy of the file, updating it as necessary.)</para>
6343
6344     <para>The chapter in the <emphasis>OpenAFS Administration Guide</emphasis> about cell administration and configuration issues
6345     discusses the implications of participating in the global AFS namespace. The chapter about administering client machines
6346     explains how to maintain knowledge of foreign cells on client machines, and includes suggestions for maintaining a central
6347     version of the file in AFS. <orderedlist>
6348         <listitem>
6349           <para>Issue the <emphasis role="bold">fs mkmount</emphasis> command to mount each foreign cell's <emphasis
6350           role="bold">root.cell</emphasis> volume on a directory called <emphasis
6351           role="bold">/afs/</emphasis><replaceable>foreign_cell</replaceable>. Because the <emphasis role="bold">root.afs</emphasis>
6352           volume is replicated, you must create a temporary mount point for its read/write version in a directory to which you have
6353           write access (such as your cell's <emphasis role="bold">/afs/.</emphasis><replaceable>cellname</replaceable> directory).
6354           Create the mount points, issue the <emphasis role="bold">vos release</emphasis> command to release new replicas to the
6355           read-only sites for the <emphasis role="bold">root.afs</emphasis> volume, and issue the <emphasis role="bold">fs
6356           checkvolumes</emphasis> command to force the local Cache Manager to access the new replica.</para>
6357
6358           <note>
6359             <para>You need to issue the <emphasis role="bold">fs mkmount</emphasis> command only once for each foreign cell's
6360             <emphasis role="bold">root.cell</emphasis> volume. You do not need to repeat the command on each client machine.</para>
6361           </note>
6362
6363           <para>Substitute your cell's name for <replaceable>cellname</replaceable>.</para>
6364
6365           <programlisting>
6366    # <emphasis role="bold">cd /afs/.</emphasis><replaceable>cellname</replaceable>
6367    # <emphasis role="bold">/usr/afs/bin/fs  mkmount  temp  root.afs</emphasis>
6368 </programlisting>
6369
6370           <para>Repeat the <emphasis role="bold">fs mkmount</emphasis> command for each foreign cell you wish to mount at this
6371           time.</para>
6372
6373           <programlisting>
6374    # <emphasis role="bold">/usr/afs/bin/fs mkmount temp/</emphasis><replaceable>foreign_cell</replaceable> <emphasis role="bold">root.cell -c</emphasis> <replaceable>foreign_cell</replaceable>
6375 </programlisting>
6376
6377           <para>Issue the following commands only once.</para>
6378
6379           <programlisting>
6380    # <emphasis role="bold">/usr/afs/bin/fs rmmount temp</emphasis>
6381    # <emphasis role="bold">/usr/afs/bin/vos release root.afs</emphasis>
6382    # <emphasis role="bold">/usr/afs/bin/fs checkvolumes</emphasis>
6383 </programlisting>
6384
6385           <indexterm>
6386             <primary>fs commands</primary>
6387
6388             <secondary>newcell</secondary>
6389           </indexterm>
6390
6391           <indexterm>
6392             <primary>commands</primary>
6393
6394             <secondary>fs newcell</secondary>
6395           </indexterm>
6396         </listitem>
6397
6398         <listitem>
6399           <para><anchor id="LIWQ92" />If this machine is going to remain an AFS client after you complete the installation, verify
6400           that the local <emphasis role="bold">/usr/vice/etc/CellServDB</emphasis> file includes an entry for each foreign
6401           cell.</para>
6402
6403           <para>For each cell that does not already have an entry, complete the following instructions: <orderedlist>
6404               <listitem>
6405                 <para>Create an entry in the <emphasis role="bold">CellServDB</emphasis> file. Be sure to comply with the formatting
6406                 instructions in <link linkend="HDRWQ66">Creating the Client CellServDB File</link>.</para>
6407               </listitem>
6408
6409               <listitem>
6410                 <para>Issue the <emphasis role="bold">fs newcell</emphasis> command to add an entry for the cell directly to the
6411                 list that the Cache Manager maintains in kernel memory. Provide each database server machine's fully qualified
6412                 hostname. <programlisting>
6413    # <emphasis role="bold">/usr/afs/bin/fs newcell</emphasis> &lt;<replaceable>foreign_cell</replaceable>&gt; &lt;<replaceable>dbserver1&gt;</replaceable>    \
6414             [&lt;<replaceable>dbserver2&gt;</replaceable>] [&lt;<replaceable>dbserver3&gt;</replaceable>]
6415 </programlisting></para>
6416               </listitem>
6417
6418               <listitem>
6419                 <para>If you plan to maintain a central version of the <emphasis role="bold">CellServDB</emphasis> file (the
6420                 conventional location is <emphasis role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
6421                 role="bold">/common/etc/CellServDB</emphasis>), create it now as a copy of the local <emphasis
6422                 role="bold">/usr/vice/etc/CellServDB</emphasis> file. Verify that it includes an entry for each foreign cell you
6423                 want your users to be able to access. <programlisting>
6424    # <emphasis role="bold">mkdir common</emphasis>
6425    # <emphasis role="bold">mkdir common/etc</emphasis>
6426    # <emphasis role="bold">cp  /usr/vice/etc/CellServDB  common/etc</emphasis>
6427    # <emphasis role="bold">/usr/afs/bin/vos release root.cell</emphasis>
6428 </programlisting></para>
6429               </listitem>
6430             </orderedlist></para>
6431         </listitem>
6432
6433         <listitem>
6434           <para>Issue the <emphasis role="bold">ls</emphasis> command to verify that the new cell's mount point is visible in your
6435           filespace. The output lists the directories at the top level of the new cell's AFS filespace. <programlisting>
6436    # <emphasis role="bold">ls /afs/</emphasis><replaceable>foreign_cell</replaceable>
6437 </programlisting></para>
6438         </listitem>
6439
6440         <listitem>
6441           <para>If you wish to participate in the global AFS namespace, and only
6442           intend running one database server, please
6443           register your cell with grand.central.org at this time.
6444           To do so, email the <emphasis role="bold">CellServDB</emphasis> fragment
6445           describing your cell, together with a contact name and email address
6446           for any queries, to cellservdb@grand.central.org. If you intend
6447           on deploying multiple database servers, please wait until you have
6448           installed all of them before registering your cell.</para>
6449         </listitem>
6450         <listitem>
6451           <para>If you wish to allow your cell to be located through DNS lookups,
6452           at this time you should also add the necessary configuration to your
6453           DNS.</para>
6454
6455           <para>AFS database servers may be located by creating AFSDB records
6456           in the DNS for the domain name corresponding to the name of your cell.
6457           It's outside the scope of this guide to give an indepth description of
6458           managing, or configuring, your site's DNS. You should consult the
6459           documentation for your DNS server for further details on AFSDB
6460           records.</para>
6461         </listitem>
6462       </orderedlist></para>
6463     </sect2>
6464   </sect1>
6465
6466   <sect1 id="HDRWQ93">
6467     <title>Improving Cell Security</title>
6468
6469     <indexterm>
6470       <primary>cell</primary>
6471
6472       <secondary>improving security</secondary>
6473     </indexterm>
6474
6475     <indexterm>
6476       <primary>security</primary>
6477
6478       <secondary>improving</secondary>
6479     </indexterm>
6480
6481     <indexterm>
6482       <primary>root superuser</primary>
6483
6484       <secondary>controlling access</secondary>
6485     </indexterm>
6486
6487     <indexterm>
6488       <primary>access</primary>
6489
6490       <secondary>to root and admin accounts</secondary>
6491     </indexterm>
6492
6493     <indexterm>
6494       <primary>admin account</primary>
6495
6496       <secondary>controlling access to</secondary>
6497     </indexterm>
6498
6499     <indexterm>
6500       <primary>AFS filespace</primary>
6501
6502       <secondary>controlling access by root superuser</secondary>
6503     </indexterm>
6504
6505     <para>This section discusses ways to improve the security of AFS data
6506     in your cell. Also see the chapter in the <emphasis>OpenAFS
6507     Administration Guide</emphasis> about configuration and administration
6508     issues.</para>
6509
6510     <sect2 id="HDRWQ94">
6511       <title>Controlling root Access</title>
6512
6513       <para>As on any machine, it is important to prevent unauthorized users from logging onto an AFS server or client machine as
6514       the local superuser <emphasis role="bold">root</emphasis>. Take care to keep the <emphasis role="bold">root</emphasis>
6515       password secret.</para>
6516
6517       <para>The local <emphasis role="bold">root</emphasis> superuser does not have special access to AFS data through the Cache
6518       Manager (as members of the <emphasis role="bold">system:administrators</emphasis> group do), but it does have the following
6519       privileges: <itemizedlist>
6520           <listitem>
6521             <para>On client machines, the ability to issue commands from the <emphasis role="bold">fs</emphasis> suite that affect
6522             AFS performance</para>
6523           </listitem>
6524
6525           <listitem>
6526             <para>On server machines, the ability to disable authorization checking, or to install rogue process binaries</para>
6527           </listitem>
6528         </itemizedlist></para>
6529     </sect2>
6530
6531     <sect2 id="HDRWQ95">
6532       <title>Controlling System Administrator Access</title>
6533
6534       <para>Following are suggestions for managing AFS administrative privilege: <itemizedlist>
6535           <listitem>
6536             <para>Create an administrative account for each administrator named
6537             something like
6538             <replaceable>username</replaceable><emphasis role="bold">.admin</emphasis>.
6539             Administrators authenticate under these identities only when
6540             performing administrative tasks, and destroy the administrative
6541             tokens immediately after finishing the task (either by issuing the
6542             <emphasis role="bold">unlog</emphasis> command, or the
6543             <emphasis role="bold">kinit</emphasis> and
6544             <emphasis role="bold">aklog</emphasis> commands to adopt their
6545             regular identity).</para>
6546           </listitem>
6547
6548           <listitem>
6549             <para>Set a short ticket lifetime for administrator accounts (for example, 20 minutes) by using the
6550             facilities of your KDC. For instance, with a MIT Kerberos KDC, this
6551             can be performed using the
6552             <emphasis role="bold">--max-ticket-life</emphasis> argument to
6553             the <emphasis role="bold">kadmin modify_principal</emphasis>
6554             command. Do not however, use a short lifetime for users
6555             who issue long-running <emphasis role="bold">backup</emphasis> commands.</para>
6556           </listitem>
6557
6558           <listitem>
6559             <para>Limit the number of system administrators in your cell, especially those who belong to the <emphasis
6560             role="bold">system:administrators</emphasis> group. By default they have all ACL rights on all directories in the local
6561             AFS filespace, and therefore must be trusted not to examine private files.</para>
6562           </listitem>
6563
6564           <listitem>
6565             <para>Limit the use of system administrator accounts on machines in public areas. It is especially important not to
6566             leave such machines unattended without first destroying the administrative tokens.</para>
6567           </listitem>
6568
6569           <listitem>
6570             <para>Limit the use by administrators of standard UNIX commands that make connections to remote machines (such as the
6571             <emphasis role="bold">telnet</emphasis> utility). Many of these programs send passwords across the network without
6572             encrypting them.</para>
6573           </listitem>
6574         </itemizedlist></para>
6575
6576       <indexterm>
6577         <primary>BOS Server</primary>
6578
6579         <secondary>checking mode bits on AFS directories</secondary>
6580       </indexterm>
6581
6582       <indexterm>
6583         <primary>mode bits on local AFS directories</primary>
6584       </indexterm>
6585
6586       <indexterm>
6587         <primary>UNIX mode bits on local AFS directories</primary>
6588       </indexterm>
6589     </sect2>
6590
6591     <sect2 id="HDRWQ96">
6592       <title>Protecting Sensitive AFS Directories</title>
6593
6594       <para>Some subdirectories of the <emphasis role="bold">/usr/afs</emphasis> directory contain files crucial to cell security.
6595       Unauthorized users must not read or write to these files because of the potential for misuse of the information they
6596       contain.</para>
6597
6598       <para>As the BOS Server initializes for the first time on a server machine, it creates several files and directories (as
6599       mentioned in <link linkend="HDRWQ50">Starting the BOS Server</link>). It sets their owner to the local superuser <emphasis
6600       role="bold">root</emphasis> and sets their mode bits to enable writing by the owner only; in some cases, it also restricts
6601       reading.</para>
6602
6603       <para>At each subsequent restart, the BOS Server checks that the owner and mode bits on these files are still set
6604       appropriately. If they are not, it write the following message to the <emphasis role="bold">/usr/afs/logs/BosLog</emphasis>
6605       file:</para>
6606
6607       <programlisting>
6608    Bosserver reports inappropriate access on server directories
6609 </programlisting>
6610
6611       <para>The BOS Server does not reset the mode bits, which enables you to set alternate values if you wish.</para>
6612
6613       <para>The following charts lists the expected mode bit settings. A question mark indicates that the BOS Server does not check
6614       that mode bit.</para>
6615
6616       <informaltable frame="none">
6617         <tgroup cols="2">
6618           <colspec colwidth="30*" />
6619
6620           <colspec colwidth="70*" />
6621
6622           <tbody>
6623             <row>
6624               <entry><emphasis role="bold">/usr/afs</emphasis></entry>
6625
6626               <entry><computeroutput>drwxr</computeroutput>?<computeroutput>xr-x</computeroutput></entry>
6627             </row>
6628
6629             <row>
6630               <entry><emphasis role="bold">/usr/afs/backup</emphasis></entry>
6631
6632               <entry><computeroutput>drwx</computeroutput>???<computeroutput>---</computeroutput></entry>
6633             </row>
6634
6635             <row>
6636               <entry><emphasis role="bold">/usr/afs/bin</emphasis></entry>
6637
6638               <entry><computeroutput>drwxr</computeroutput>?<computeroutput>xr-x</computeroutput></entry>
6639             </row>
6640
6641             <row>
6642               <entry><emphasis role="bold">/usr/afs/db</emphasis></entry>
6643
6644               <entry><computeroutput>drwx</computeroutput>???<computeroutput>---</computeroutput></entry>
6645             </row>
6646
6647             <row>
6648               <entry><emphasis role="bold">/usr/afs/etc</emphasis></entry>
6649
6650               <entry><computeroutput>drwxr</computeroutput>?<computeroutput>xr-x</computeroutput></entry>
6651             </row>
6652
6653             <row>
6654               <entry><emphasis role="bold">/usr/afs/etc/KeyFile</emphasis></entry>
6655
6656               <entry><computeroutput>-rw</computeroutput>????<computeroutput>---</computeroutput></entry>
6657             </row>
6658
6659             <row>
6660               <entry><emphasis role="bold">/usr/afs/etc/UserList</emphasis></entry>
6661
6662               <entry><computeroutput>-rw</computeroutput>?????<computeroutput>--</computeroutput></entry>
6663             </row>
6664
6665             <row>
6666               <entry><emphasis role="bold">/usr/afs/local</emphasis></entry>
6667
6668               <entry><computeroutput>drwx</computeroutput>???<computeroutput>---</computeroutput></entry>
6669             </row>
6670
6671             <row>
6672               <entry><emphasis role="bold">/usr/afs/logs</emphasis></entry>
6673
6674               <entry><computeroutput>drwxr</computeroutput>?<computeroutput>xr-x</computeroutput></entry>
6675             </row>
6676           </tbody>
6677         </tgroup>
6678       </informaltable>
6679
6680       <indexterm>
6681         <primary>first AFS machine</primary>
6682
6683         <secondary>client functionality</secondary>
6684
6685         <tertiary>removing</tertiary>
6686       </indexterm>
6687
6688       <indexterm>
6689         <primary>removing</primary>
6690
6691         <secondary>client functionality from first AFS machine</secondary>
6692       </indexterm>
6693     </sect2>
6694   </sect1>
6695
6696   <sect1 id="HDRWQ98">
6697     <title>Removing Client Functionality</title>
6698
6699     <para>Follow the instructions in this section only if you do not wish this machine to remain an AFS client. Removing client
6700     functionality means that you cannot use this machine to access AFS files. <orderedlist>
6701         <listitem>
6702           <para>Remove the files from the <emphasis role="bold">/usr/vice/etc</emphasis> directory. The command does not remove the
6703           directory for files used by the dynamic kernel loader program, if it exists on this system type. Those files are still
6704           needed on a server-only machine. <programlisting>
6705    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
6706    # <emphasis role="bold">rm  *</emphasis>
6707    # <emphasis role="bold">rm -rf  C</emphasis>
6708 </programlisting></para>
6709         </listitem>
6710
6711         <listitem>
6712           <para>Create symbolic links to the <emphasis role="bold">ThisCell</emphasis> and <emphasis
6713           role="bold">CellServDB</emphasis> files in the <emphasis role="bold">/usr/afs/etc</emphasis> directory. This makes it
6714           possible to issue commands from the AFS command suites (such as <emphasis role="bold">bos</emphasis> and <emphasis
6715           role="bold">fs</emphasis>) on this machine. <programlisting>
6716    # <emphasis role="bold">ln -s /usr/afs/etc/ThisCell ThisCell</emphasis>
6717    # <emphasis role="bold">ln -s /usr/afs/etc/CellServDB CellServDB</emphasis>
6718 </programlisting></para>
6719         </listitem>
6720
6721         <listitem>
6722           <para>On IRIX systems, issue the <emphasis role="bold">chkconfig</emphasis> command to deactivate the <emphasis
6723           role="bold">afsclient</emphasis> configuration variable. <programlisting>
6724    # <emphasis role="bold">/etc/chkconfig -f afsclient off</emphasis>
6725 </programlisting></para>
6726         </listitem>
6727
6728         <listitem>
6729           <para>Reboot the machine. Most system types use the <emphasis role="bold">shutdown</emphasis> command, but the appropriate
6730           options vary. <programlisting>
6731    # <emphasis role="bold">cd /</emphasis>
6732    # <emphasis role="bold">shutdown</emphasis> <replaceable>appropriate_options</replaceable>
6733 </programlisting></para>
6734         </listitem>
6735       </orderedlist></para>
6736   </sect1>
6737 </chapter>