doc/xml/QuickStartUnix/auqbg007.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <chapter id="HDRWQ133">
   3   <title>Installing Additional Client Machines</title>
   4
   5   <indexterm>
   6     <primary>instructions</primary>
   7
   8     <secondary>client machine</secondary>
   9   </indexterm>
  10
  11   <indexterm>
  12     <primary>installing</primary>
  13
  14     <secondary>client functionality</secondary>
  15
  16     <tertiary>client machine</tertiary>
  17   </indexterm>
  18
  19   <para>This chapter describes how to install AFS client machines after you have installed the first AFS machine. Some parts of the
  20   installation differ depending on whether or not the new client is of the same AFS system type (uses the same AFS binaries) as a
  21   previously installed client machine. <indexterm>
  22       <primary>overview</primary>
  23
  24       <secondary>installing client machine</secondary>
  25     </indexterm></para>
  26
  27   <sect1 id="Header_116">
  28     <title>Summary of Procedures</title>
  29
  30     <orderedlist>
  31       <listitem>
  32         <para>Incorporate AFS into the machine's kernel</para>
  33       </listitem>
  34
  35       <listitem>
  36         <para>Define the machine's cell membership</para>
  37       </listitem>
  38
  39       <listitem>
  40         <para>Define cache location and size</para>
  41       </listitem>
  42
  43       <listitem>
  44         <para>Create the <emphasis role="bold">/usr/vice/etc/CellServDB</emphasis> file, which determines which foreign cells the
  45         client can access in addition to the local cell</para>
  46       </listitem>
  47
  48       <listitem>
  49         <para>Create the <emphasis role="bold">/afs</emphasis> directory and start the Cache Manager</para>
  50       </listitem>
  51
  52       <listitem>
  53         <para>Create and mount volumes for housing AFS client binaries (necessary only for clients of a new system type)</para>
  54       </listitem>
  55
  56       <listitem>
  57         <para>Create a link from the local <emphasis role="bold">/usr/afsws</emphasis> directory to the AFS directory housing the
  58         AFS client binaries</para>
  59       </listitem>
  60
  61       <listitem>
  62         <para>Modify the machine's authentication system to enable AFS users to obtain tokens at login</para>
  63       </listitem>
  64     </orderedlist>
  65
  66     <indexterm>
  67       <primary>CD-ROM</primary>
  68
  69       <secondary>creating /cdrom directory</secondary>
  70
  71       <tertiary>client machine</tertiary>
  72     </indexterm>
  73
  74     <indexterm>
  75       <primary>cdrom directory</primary>
  76
  77       <secondary>client machine</secondary>
  78     </indexterm>
  79
  80     <indexterm>
  81       <primary>client machine</primary>
  82
  83       <secondary>/cdrom directory</secondary>
  84     </indexterm>
  85
  86     <indexterm>
  87       <primary>creating</primary>
  88
  89       <secondary>/cdrom directory</secondary>
  90
  91       <tertiary>client machine</tertiary>
  92     </indexterm>
  93
  94     <indexterm>
  95       <primary>usr/vice/etc directory</primary>
  96
  97       <secondary>client machine</secondary>
  98     </indexterm>
  99
 100     <indexterm>
 101       <primary>client machine</primary>
 102
 103       <secondary>/usr/vice/etc directory</secondary>
 104     </indexterm>
 105
 106     <indexterm>
 107       <primary>creating</primary>
 108
 109       <secondary>/usr/vice/etc directory</secondary>
 110
 111       <tertiary>client machine</tertiary>
 112     </indexterm>
 113   </sect1>
 114
 115   <sect1 id="HDRWQ134">
 116     <title>Creating AFS Directories on the Local Disk</title>
 117
 118     <para>Create the <emphasis role="bold">/usr/vice/etc</emphasis> directory on the local disk, to house client binaries and
 119     configuration files. Subsequent instructions copy files from the AFS CD-ROM into them. Create the <emphasis
 120     role="bold">/cdrom</emphasis> directory as a mount point for the CD-ROM, if it does not already exist.</para>
 121
 122     <programlisting>
 123    # <emphasis role="bold">mkdir /usr/vice</emphasis>
 124    # <emphasis role="bold">mkdir /usr/vice/etc</emphasis>
 125    # <emphasis role="bold">mkdir /cdrom</emphasis>
 126 </programlisting>
 127   </sect1>
 128
 129   <sect1 id="HDRWQ135">
 130     <title>Performing Platform-Specific Procedures</title>
 131
 132     <para>Every AFS client machine's kernel must incorporate AFS modifications. Some system types use a dynamic kernel loader
 133     program, whereas on other system types you build AFS modifications into a static kernel. Some system types support both
 134     methods.</para>
 135
 136     <para>Also modify the machine's authentication system so that users obtain an AFS token as they log into the local file system.
 137     Using AFS is simpler and more convenient for your users if you make the modifications on all client machines. Otherwise, users
 138     must perform a two-step login procedure (login to the local file system and then issue the <emphasis role="bold">klog</emphasis>
 139     command). For further discussion of AFS authentication, see the chapter in the <emphasis>OpenAFS Administration Guide</emphasis>
 140     about cell configuration and administration issues.</para>
 141
 142     <para>For convenience, the following sections group the two procedures by system type. Proceed to the appropriate section.
 143     <itemizedlist>
 144         <listitem>
 145           <para><link linkend="HDRWQ136">Getting Started on AIX Systems</link></para>
 146         </listitem>
 147
 148         <listitem>
 149           <para><link linkend="HDRWQ138">Getting Started on HP-UX Systems</link></para>
 150         </listitem>
 151
 152         <listitem>
 153           <para><link linkend="HDRWQ139">Getting Started on IRIX Systems</link></para>
 154         </listitem>
 155
 156         <listitem>
 157           <para><link linkend="HDRWQ143">Getting Started on Linux Systems</link></para>
 158         </listitem>
 159
 160         <listitem>
 161           <para><link linkend="HDRWQ144">Getting Started on Solaris Systems</link></para>
 162         </listitem>
 163       </itemizedlist></para>
 164
 165     <indexterm>
 166       <primary>incorporating AFS kernel extensions</primary>
 167
 168       <secondary>client machine</secondary>
 169
 170       <tertiary>AIX</tertiary>
 171     </indexterm>
 172
 173     <indexterm>
 174       <primary>AFS kernel extensions</primary>
 175
 176       <secondary>on client machine</secondary>
 177
 178       <tertiary>AIX</tertiary>
 179     </indexterm>
 180
 181     <indexterm>
 182       <primary>client machine</primary>
 183
 184       <secondary>AFS kernel extensions</secondary>
 185
 186       <tertiary>on AIX</tertiary>
 187     </indexterm>
 188
 189     <indexterm>
 190       <primary>AIX</primary>
 191
 192       <secondary>AFS kernel extensions</secondary>
 193
 194       <tertiary>on client machine</tertiary>
 195     </indexterm>
 196
 197     <indexterm>
 198       <primary>enabling AFS login</primary>
 199
 200       <secondary>client machine</secondary>
 201
 202       <tertiary>AIX</tertiary>
 203     </indexterm>
 204
 205     <indexterm>
 206       <primary>AFS login</primary>
 207
 208       <secondary>on client machine</secondary>
 209
 210       <tertiary>AIX</tertiary>
 211     </indexterm>
 212
 213     <indexterm>
 214       <primary>client machine</primary>
 215
 216       <secondary>AFS login</secondary>
 217
 218       <tertiary>on AIX</tertiary>
 219     </indexterm>
 220
 221     <indexterm>
 222       <primary>AIX</primary>
 223
 224       <secondary>AFS login</secondary>
 225
 226       <tertiary>on client machine</tertiary>
 227     </indexterm>
 228
 229     <indexterm>
 230       <primary>secondary authentication system (AIX)</primary>
 231
 232       <secondary>client machine</secondary>
 233     </indexterm>
 234   </sect1>
 235
 236   <sect1 id="HDRWQ136">
 237     <title>Getting Started on AIX Systems</title>
 238
 239     <para>In this section you load AFS into the AIX kernel. Then incorporate AFS modifications into the machine's secondary
 240     authentication system, if you wish to enable AFS login.</para>
 241
 242     <sect2 id="Header_120">
 243       <title>Loading AFS into the AIX Kernel</title>
 244
 245       <para>The AIX kernel extension facility is the dynamic kernel loader provided by IBM Corporation. AIX does not support
 246       incorporation of AFS modifications during a kernel build.</para>
 247
 248       <para>For AFS to function correctly, the kernel extension facility must run each time the machine reboots, so the AFS
 249       initialization script (included in the AFS distribution) invokes it automatically. In this section you copy the script to the
 250       conventional location and edit it to select the appropriate options depending on whether NFS is also to run.</para>
 251
 252       <para>After editing the script, you run it to incorporate AFS into the kernel. In a later section you verify that the script
 253       correctly initializes the Cache Manager, then configure the AIX <emphasis role="bold">inittab</emphasis> file so that the
 254       script runs automatically at reboot. <orderedlist>
 255           <listitem>
 256             <para>Mount the AFS CD-ROM for AIX on the local <emphasis role="bold">/cdrom</emphasis> directory. For instructions on
 257             mounting CD-ROMs (either locally or remotely via NFS), see your AIX documentation. Then change directory as indicated.
 258             <programlisting>
 259    # <emphasis role="bold">cd  /cdrom/rs_aix42/root.client/usr/vice/etc</emphasis>
 260 </programlisting></para>
 261           </listitem>
 262
 263           <listitem>
 264             <para>Copy the AFS kernel library files to the local <emphasis role="bold">/usr/vice/etc/dkload</emphasis> directory,
 265             and the AFS initialization script to the <emphasis role="bold">/etc</emphasis> directory. <programlisting>
 266    # <emphasis role="bold">cp -rp  dkload  /usr/vice/etc</emphasis>
 267    # <emphasis role="bold">cp -p  rc.afs  /etc/rc.afs</emphasis>
 268 </programlisting></para>
 269           </listitem>
 270
 271           <listitem>
 272             <para>Edit the <emphasis role="bold">/etc/rc.afs</emphasis> script, setting the <computeroutput>NFS</computeroutput>
 273             variable as indicated.</para>
 274
 275             <para>If the machine is not to function as an NFS/AFS Translator, set the <computeroutput>NFS</computeroutput> variable
 276             as follows.</para>
 277
 278             <programlisting>
 279    NFS=$NFS_NONE
 280 </programlisting>
 281
 282             <para>If the machine is to function as an NFS/AFS Translator and is running AIX 4.2.1 or higher, set the
 283             <computeroutput>NFS</computeroutput> variable as follows. Note that NFS must already be loaded into the kernel, which
 284             happens automatically on systems running AIX 4.1.1 and later, as long as the file <emphasis
 285             role="bold">/etc/exports</emphasis> exists.</para>
 286
 287             <programlisting>
 288    NFS=$NFS_IAUTH
 289 </programlisting>
 290           </listitem>
 291
 292           <listitem>
 293             <para>Invoke the <emphasis role="bold">/etc/rc.afs</emphasis> script to load AFS modifications into the kernel. You can
 294             ignore any error messages about the inability to start the BOS Server or the Cache Manager or AFS client.
 295             <programlisting>
 296    # <emphasis role="bold">/etc/rc.afs</emphasis>
 297 </programlisting></para>
 298           </listitem>
 299         </orderedlist></para>
 300     </sect2>
 301
 302     <sect2 id="Header_121">
 303       <title>Enabling AFS Login on AIX Systems</title>
 304
 305       <para>Now incorporate AFS into the AIX secondary authentication system. <orderedlist>
 306           <listitem>
 307             <para>Issue the <emphasis role="bold">ls</emphasis> command to verify that the <emphasis
 308             role="bold">afs_dynamic_auth</emphasis> and <emphasis role="bold">afs_dynamic_kerbauth</emphasis> programs are installed
 309             in the local <emphasis role="bold">/usr/vice/etc</emphasis> directory. <programlisting>
 310    # <emphasis role="bold">ls /usr/vice/etc</emphasis>
 311 </programlisting></para>
 312
 313             <para>If the files do not exist, mount the AFS CD-ROM for AIX (if it is not already), change directory as indicated, and
 314             copy them.</para>
 315
 316             <programlisting>
 317    # <emphasis role="bold">cd /cdrom/rs_aix42/root.client/usr/vice/etc</emphasis>
 318    # <emphasis role="bold">cp  -p  afs_dynamic*  /usr/vice/etc</emphasis>
 319 </programlisting>
 320           </listitem>
 321
 322           <listitem>
 323             <para>Edit the local <emphasis role="bold">/etc/security/user</emphasis> file, making changes to the indicated stanzas:
 324             <itemizedlist>
 325                 <listitem>
 326                   <para>In the default stanza, set the <computeroutput>registry</computeroutput> attribute to <emphasis
 327                   role="bold">DCE</emphasis> (not to <emphasis role="bold">AFS</emphasis>), as follows: <programlisting>
 328    registry = DCE
 329 </programlisting></para>
 330                 </listitem>
 331
 332                 <listitem>
 333                   <para>In the default stanza, set the <computeroutput>SYSTEM</computeroutput> attribute as indicated.</para>
 334
 335                   <para>If the machine is an AFS client only, set the following value:</para>
 336
 337                   <programlisting>
 338    SYSTEM = "AFS OR (AFS[UNAVAIL] AND compat[SUCCESS])"
 339 </programlisting>
 340
 341                   <para>If the machine is both an AFS and a DCE client, set the following value (it must appear on a single line in
 342                   the file):</para>
 343
 344                   <programlisting>
 345    SYSTEM = "DCE OR DCE[UNAVAIL] OR AFS OR (AFS[UNAVAIL]  \
 346        AND compat[SUCCESS])"
 347 </programlisting>
 348                 </listitem>
 349
 350                 <listitem>
 351                   <para>In the <computeroutput>root</computeroutput> stanza, set the <computeroutput>registry</computeroutput>
 352                   attribute as follows. It enables the local superuser <emphasis role="bold">root</emphasis> to log into the local
 353                   file system only, based on the password listed in the local password file. <programlisting>
 354    root:
 355          registry = files
 356 </programlisting></para>
 357                 </listitem>
 358               </itemizedlist></para>
 359           </listitem>
 360
 361           <listitem>
 362             <para>Edit the local <emphasis role="bold">/etc/security/login.cfg</emphasis> file, creating or editing the indicated
 363             stanzas: <itemizedlist>
 364                 <listitem>
 365                   <para>In the <computeroutput>DCE</computeroutput> stanza, set the <computeroutput>program</computeroutput>
 366                   attribute as follows.</para>
 367
 368                   <para>If you use the AFS Authentication Server (<emphasis role="bold">kaserver</emphasis> process):</para>
 369
 370                   <programlisting>
 371    DCE:
 372         program = /usr/vice/etc/afs_dynamic_auth
 373 </programlisting>
 374
 375                   <para>If you use a Kerberos implementation of AFS authentication:</para>
 376
 377                   <programlisting>
 378    DCE:
 379         program = /usr/vice/etc/afs_dynamic_kerbauth
 380 </programlisting>
 381                 </listitem>
 382
 383                 <listitem>
 384                   <para>In the <computeroutput>AFS</computeroutput> stanza, set the <computeroutput>program</computeroutput>
 385                   attribute as follows.</para>
 386
 387                   <para>If you use the AFS Authentication Server (<emphasis role="bold">kaserver</emphasis> process):</para>
 388
 389                   <programlisting>
 390    AFS:
 391         program = /usr/vice/etc/afs_dynamic_auth
 392 </programlisting>
 393
 394                   <para>If you use a Kerberos implementation of AFS authentication:</para>
 395
 396                   <programlisting>
 397    AFS:
 398         program = /usr/vice/etc/afs_dynamic_kerbauth
 399 </programlisting>
 400                 </listitem>
 401               </itemizedlist></para>
 402           </listitem>
 403
 404           <listitem>
 405             <para>Proceed to <link linkend="HDRWQ145">Loading and Creating Client Files</link>.</para>
 406           </listitem>
 407         </orderedlist></para>
 408
 409       <indexterm>
 410         <primary>incorporating AFS kernel extensions</primary>
 411
 412         <secondary>client machine</secondary>
 413
 414         <tertiary>HP-UX</tertiary>
 415       </indexterm>
 416
 417       <indexterm>
 418         <primary>AFS kernel extensions</primary>
 419
 420         <secondary>on client machine</secondary>
 421
 422         <tertiary>HP-UX</tertiary>
 423       </indexterm>
 424
 425       <indexterm>
 426         <primary>client machine</primary>
 427
 428         <secondary>AFS kernel extensions</secondary>
 429
 430         <tertiary>on HP-UX</tertiary>
 431       </indexterm>
 432
 433       <indexterm>
 434         <primary>HP-UX</primary>
 435
 436         <secondary>AFS-modified kernel</secondary>
 437
 438         <tertiary>on client machine</tertiary>
 439       </indexterm>
 440
 441       <indexterm>
 442         <primary>enabling AFS login</primary>
 443
 444         <secondary>client machine</secondary>
 445
 446         <tertiary>HP-UX</tertiary>
 447       </indexterm>
 448
 449       <indexterm>
 450         <primary>AFS login</primary>
 451
 452         <secondary>on client machine</secondary>
 453
 454         <tertiary>HP-UX</tertiary>
 455       </indexterm>
 456
 457       <indexterm>
 458         <primary>client machine</primary>
 459
 460         <secondary>AFS login</secondary>
 461
 462         <tertiary>on HP-UX</tertiary>
 463       </indexterm>
 464
 465       <indexterm>
 466         <primary>HP-UX</primary>
 467
 468         <secondary>AFS login</secondary>
 469
 470         <tertiary>on client machine</tertiary>
 471       </indexterm>
 472
 473       <indexterm>
 474         <primary>PAM</primary>
 475
 476         <secondary>on HP-UX</secondary>
 477
 478         <tertiary>client machine</tertiary>
 479       </indexterm>
 480     </sect2>
 481   </sect1>
 482
 483   <sect1 id="HDRWQ138">
 484     <title>Getting Started on HP-UX Systems</title>
 485
 486     <para>In this section you build AFS into the HP-UX kernel. Then incorporate AFS modifications into the machine's Pluggable
 487     Authentication Module (PAM) system, if you wish to enable AFS login.</para>
 488
 489     <sect2 id="Header_126">
 490       <title>Building AFS into the HP-UX Kernel</title>
 491
 492       <para>On HP-UX systems, you must build AFS modifications into a new static kernel; HP-UX does not support dynamic loading. If
 493       the machine's hardware and software configuration exactly matches another HP-UX machine on which AFS is already built into the
 494       kernel, you can choose to copy the kernel from that machine to this one. In general, however, it is better to build AFS
 495       modifications into the kernel on each machine according to the following instructions. <orderedlist>
 496           <listitem>
 497             <para>Move the existing kernel-related files to a safe location. <programlisting>
 498    # <emphasis role="bold">cp /stand/vmunix /stand/vmunix.noafs</emphasis>
 499    # <emphasis role="bold">cp /stand/system /stand/system.noafs</emphasis>
 500 </programlisting></para>
 501           </listitem>
 502
 503           <listitem>
 504             <para>Mount the AFS CD-ROM for HP-UX on the local <emphasis role="bold">/cdrom</emphasis> directory. For instructions on
 505             mounting CD-ROMs (either locally or remotely via NFS), see your HP-UX documentation. Then change directory as indicated.
 506             <programlisting>
 507    # <emphasis role="bold">cd /cdrom/hp_ux110/root.client</emphasis>
 508 </programlisting></para>
 509           </listitem>
 510
 511           <listitem>
 512             <para>Copy the AFS initialization file to the local directory for initialization files (by convention, <emphasis
 513             role="bold">/sbin/init.d</emphasis> on HP-UX machines). Note the removal of the <emphasis role="bold">.rc</emphasis>
 514             extension as you copy the file. <programlisting>
 515    # <emphasis role="bold">cp usr/vice/etc/afs.rc  /sbin/init.d/afs</emphasis>
 516 </programlisting></para>
 517           </listitem>
 518
 519           <listitem>
 520             <para>Copy the file <emphasis role="bold">afs.driver</emphasis> to the local <emphasis
 521             role="bold">/usr/conf/master.d</emphasis> directory, changing its name to <emphasis role="bold">afs</emphasis> as you
 522             do. <programlisting>
 523    # <emphasis role="bold">cp  usr/vice/etc/afs.driver  /usr/conf/master.d/afs</emphasis>
 524 </programlisting></para>
 525           </listitem>
 526
 527           <listitem>
 528             <para>Copy the AFS kernel module to the local <emphasis role="bold">/usr/conf/lib</emphasis> directory.</para>
 529
 530             <para>If the machine's kernel supports NFS server functionality:</para>
 531
 532             <programlisting>
 533    # <emphasis role="bold">cp bin/libafs.a /usr/conf/lib</emphasis>
 534 </programlisting>
 535
 536             <para>If the machine's kernel does not support NFS server functionality, change the file's name as you copy it:</para>
 537
 538             <programlisting>
 539    # <emphasis role="bold">cp bin/libafs.nonfs.a /usr/conf/lib/libafs.a</emphasis>
 540 </programlisting>
 541           </listitem>
 542
 543           <listitem>
 544             <para>Incorporate the AFS driver into the kernel, either using the <emphasis role="bold">SAM</emphasis> program or a
 545             series of individual commands. <itemizedlist>
 546                 <listitem>
 547                   <para>To use the <emphasis role="bold">SAM</emphasis> program: <orderedlist>
 548                       <listitem>
 549                         <para>Invoke the <emphasis role="bold">SAM</emphasis> program, specifying the hostname of the local machine
 550                         as <replaceable>local_hostname</replaceable>. The <emphasis role="bold">SAM</emphasis> graphical user
 551                         interface pops up. <programlisting>
 552    # <emphasis role="bold">sam -display</emphasis> <replaceable>local_hostname</replaceable><emphasis role="bold">:0</emphasis>
 553 </programlisting></para>
 554                       </listitem>
 555
 556                       <listitem>
 557                         <para>Choose the <emphasis role="bold">Kernel Configuration</emphasis> icon, then the <emphasis
 558                         role="bold">Drivers</emphasis> icon. From the list of drivers, select <emphasis
 559                         role="bold">afs</emphasis>.</para>
 560                       </listitem>
 561
 562                       <listitem>
 563                         <para>Open the pull-down <emphasis role="bold">Actions</emphasis> menu and choose the <emphasis
 564                         role="bold">Add Driver to Kernel</emphasis> option.</para>
 565                       </listitem>
 566
 567                       <listitem>
 568                         <para>Open the <emphasis role="bold">Actions</emphasis> menu again and choose the <emphasis
 569                         role="bold">Create a New Kernel</emphasis> option.</para>
 570                       </listitem>
 571
 572                       <listitem>
 573                         <para>Confirm your choices by choosing <emphasis role="bold">Yes</emphasis> and <emphasis
 574                         role="bold">OK</emphasis> when prompted by subsequent pop-up windows. The <emphasis
 575                         role="bold">SAM</emphasis> program builds the kernel and reboots the system.</para>
 576                       </listitem>
 577
 578                       <listitem>
 579                         <para>Login again as the superuser <emphasis role="bold">root</emphasis>. <programlisting>
 580    login: <emphasis role="bold">root</emphasis>
 581    Password: <replaceable>root_password</replaceable>
 582 </programlisting></para>
 583                       </listitem>
 584                     </orderedlist></para>
 585                 </listitem>
 586
 587                 <listitem>
 588                   <para>To use individual commands: <orderedlist>
 589                       <listitem>
 590                         <para>Edit the file <emphasis role="bold">/stand/system</emphasis>, adding an entry for <emphasis
 591                         role="bold">afs</emphasis> to the <computeroutput>Subsystems</computeroutput> section.</para>
 592                       </listitem>
 593
 594                       <listitem>
 595                         <para>Change to the <emphasis role="bold">/stand/build</emphasis> directory and issue the <emphasis
 596                         role="bold">mk_kernel</emphasis> command to build the kernel. <programlisting>
 597    # <emphasis role="bold">cd /stand/build</emphasis>
 598    # <emphasis role="bold">mk_kernel</emphasis>
 599 </programlisting></para>
 600                       </listitem>
 601
 602                       <listitem>
 603                         <para>Move the new kernel to the standard location (<emphasis role="bold">/stand/vmunix</emphasis>), reboot
 604                         the machine to start using it, and login again as the superuser <emphasis role="bold">root</emphasis>.
 605                         <programlisting>
 606    # <emphasis role="bold">mv /stand/build/vmunix_test /stand/vmunix</emphasis>
 607    # <emphasis role="bold">cd /</emphasis>
 608    # <emphasis role="bold">shutdown -r now</emphasis>
 609    login: <emphasis role="bold">root</emphasis>
 610    Password: <replaceable>root_password</replaceable>
 611 </programlisting></para>
 612                       </listitem>
 613                     </orderedlist></para>
 614                 </listitem>
 615               </itemizedlist></para>
 616           </listitem>
 617         </orderedlist></para>
 618     </sect2>
 619
 620     <sect2 id="Header_127">
 621       <title>Enabling AFS Login on HP-UX Systems</title>
 622
 623       <para>At this point you incorporate AFS into the operating system's Pluggable Authentication Module (PAM) scheme. PAM
 624       integrates all authentication mechanisms on the machine, including login, to provide the security infrastructure for
 625       authenticated access to and from the machine.</para>
 626
 627       <para>Explaining PAM is beyond the scope of this document. It is assumed that you understand the syntax and meanings of
 628       settings in the PAM configuration file (for example, how the <computeroutput>other</computeroutput> entry works, the effect of
 629       marking an entry as <computeroutput>required</computeroutput>, <computeroutput>optional</computeroutput>, or
 630       <computeroutput>sufficient</computeroutput>, and so on).</para>
 631
 632       <para>The following instructions explain how to alter the entries in the PAM configuration file for each service for which you
 633       wish to use AFS authentication. Other configurations possibly also work, but the instructions specify the recommended and
 634       tested configuration.</para>
 635
 636       <note>
 637         <para>The instructions specify that you mark each entry as <computeroutput>optional</computeroutput>. However, marking some
 638         modules as optional can mean that they grant access to the corresponding service even when the user does not meet all of the
 639         module's requirements. In some operating system revisions, for example, if you mark as optional the module that controls
 640         login via a dial-up connection, it allows users to login without providing a password. See the <emphasis>OpenAFS Release
 641         Notes</emphasis> for a discussion of any limitations that apply to this operating system.</para>
 642
 643         <para>Also, with some operating system versions you must install patches for PAM to interact correctly with certain
 644         authentication programs. For details, see the <emphasis>OpenAFS Release Notes</emphasis>.</para>
 645       </note>
 646
 647       <para>The recommended AFS-related entries in the PAM configuration file make use of one or more of the following three
 648       attributes. <variablelist>
 649           <varlistentry>
 650             <term><emphasis role="bold"><computeroutput>try_first_pass</computeroutput></emphasis></term>
 651
 652             <listitem>
 653               <para>This is a standard PAM attribute that can be included on entries after the first one for a service; it directs
 654               the module to use the password that was provided to the first module. For the AFS module, it means that AFS
 655               authentication succeeds if the password provided to the module listed first is the user's correct AFS password. For
 656               further discussion of this attribute and its alternatives, see the operating system's PAM documentation.</para>
 657             </listitem>
 658           </varlistentry>
 659
 660           <varlistentry>
 661             <term><emphasis role="bold"><computeroutput>ignore_root</computeroutput></emphasis></term>
 662
 663             <listitem>
 664               <para>This attribute, specific to the AFS PAM module, directs it to ignore not only the local superuser <emphasis
 665               role="bold">root</emphasis>, but also any user with UID 0 (zero).</para>
 666             </listitem>
 667           </varlistentry>
 668
 669           <varlistentry>
 670             <term><emphasis role="bold"><computeroutput>setenv_password_expires</computeroutput></emphasis></term>
 671
 672             <listitem>
 673               <para>This attribute, specific to the AFS PAM module, sets the environment variable PASSWORD_EXPIRES to the expiration
 674               date of the user's AFS password, which is recorded in the Authentication Database.</para>
 675             </listitem>
 676           </varlistentry>
 677         </variablelist></para>
 678
 679       <para>Perform the following steps to enable AFS login. <orderedlist>
 680           <listitem>
 681             <para>Mount the AFS CD-ROM for HP-UX on the <emphasis role="bold">/cdrom</emphasis> directory, if it is not already.
 682             Then change directory as indicated. <programlisting>
 683    # <emphasis role="bold">cd /usr/lib/security</emphasis>
 684 </programlisting></para>
 685           </listitem>
 686
 687           <listitem>
 688             <para>Copy the AFS authentication library file to the <emphasis role="bold">/usr/lib/security</emphasis> directory. Then
 689             create a symbolic link to it whose name does not mention the version. Omitting the version eliminates the need to edit
 690             the PAM configuration file if you later update the library file.</para>
 691
 692             <para>If you use the AFS Authentication Server (<emphasis role="bold">kaserver</emphasis> process) in the cell:</para>
 693
 694             <programlisting>
 695    # <emphasis role="bold">cp /cdrom/hp_ux110/lib/pam_afs.so.1  .</emphasis>
 696    # <emphasis role="bold">ln -s  pam_afs.so.1  pam_afs.so</emphasis>
 697 </programlisting>
 698
 699             <para>If you use a Kerberos implementation of AFS authentication:</para>
 700
 701             <programlisting>
 702    # <emphasis role="bold">cp /cdrom/hp_ux110/lib/pam_afs.krb.so.1   .</emphasis>
 703    # <emphasis role="bold">ln -s pam_afs.krb.so.1 pam_afs.so</emphasis>
 704 </programlisting>
 705           </listitem>
 706
 707           <listitem>
 708             <para>Edit the <computeroutput>Authentication management</computeroutput> section of the HP-UX PAM configuration file,
 709             <emphasis role="bold">/etc/pam.conf</emphasis> by convention. The entries in this section have the value
 710             <computeroutput>auth</computeroutput> in their second field.</para>
 711
 712             <para>First edit the standard entries, which refer to the HP-UX PAM module (usually, the file <emphasis
 713             role="bold">/usr/lib/security/libpam_unix.1</emphasis>) in their fourth field. For each service for which you want to
 714             use AFS authentication, edit the third field of its entry to read <computeroutput>optional</computeroutput>. The
 715             <emphasis role="bold">pam.conf</emphasis> file in the HP-UX distribution usually includes standard entries for the
 716             <emphasis role="bold">login</emphasis> and <emphasis role="bold">ftp</emphasis> services, for instance.</para>
 717
 718             <para>If there are services for which you want to use AFS authentication, but for which the <emphasis
 719             role="bold">pam.conf</emphasis> file does not already include a standard entry, you must create that entry and place the
 720             value <computeroutput>optional</computeroutput> in its third field. For instance, the HP-UX <emphasis
 721             role="bold">pam.conf</emphasis> file does not usually include standard entries for the <emphasis
 722             role="bold">remsh</emphasis> or <emphasis role="bold">telnet</emphasis> services.</para>
 723
 724             <para>Then create an AFS-related entry for each service, placing it immediately below the standard entry. The following
 725             example shows what the <computeroutput>Authentication Management</computeroutput> section looks like after you have you
 726             edited or created entries for the services mentioned previously. Note that the example AFS entries appear on two lines
 727             only for legibility.</para>
 728
 729             <programlisting>
 730    login   auth  optional  /usr/lib/security/libpam_unix.1
 731    login   auth  optional  /usr/lib/security/pam_afs.so      \
 732          try_first_pass  ignore_root  setenv_password_expires
 733    ftp     auth  optional  /usr/lib/security/libpam_unix.1
 734    ftp     auth  optional  /usr/lib/security/pam_afs.so      \
 735          try_first_pass  ignore_root
 736    remsh   auth  optional  /usr/lib/security/libpam_unix.1
 737    remsh   auth  optional  /usr/lib/security/pam_afs.so      \
 738          try_first_pass  ignore_root
 739    telnet  auth  optional  /usr/lib/security/libpam_unix.1
 740    telnet  auth  optional  /usr/lib/security/pam_afs.so      \
 741          try_first_pass  ignore_root  setenv_password_expires
 742 </programlisting>
 743           </listitem>
 744
 745           <listitem>
 746             <para>If you use the Common Desktop Environment (CDE) on the machine and want users to obtain an AFS token as they log
 747             in, also add or edit the following four entries in the <computeroutput>Authentication management</computeroutput>
 748             section. Note that the AFS-related entries appear on two lines here only for legibility. <programlisting>
 749    dtlogin   auth  optional  /usr/lib/security/libpam_unix.1
 750    dtlogin   auth  optional  /usr/lib/security/pam_afs.so     \
 751          try_first_pass  ignore_root
 752    dtaction  auth  optional  /usr/lib/security/libpam_unix.1
 753    dtaction  auth  optional  /usr/lib/security/pam_afs.so     \
 754          try_first_pass  ignore_root
 755 </programlisting></para>
 756           </listitem>
 757
 758           <listitem>
 759             <para>Proceed to <link linkend="HDRWQ145">Loading and Creating Client Files</link>.</para>
 760           </listitem>
 761         </orderedlist></para>
 762
 763       <indexterm>
 764         <primary>incorporating AFS kernel extensions</primary>
 765
 766         <secondary>client machine</secondary>
 767
 768         <tertiary>IRIX</tertiary>
 769       </indexterm>
 770
 771       <indexterm>
 772         <primary>AFS kernel extensions</primary>
 773
 774         <secondary>on client machine</secondary>
 775
 776         <tertiary>IRIX</tertiary>
 777       </indexterm>
 778
 779       <indexterm>
 780         <primary>client machine</primary>
 781
 782         <secondary>AFS kernel extensions</secondary>
 783
 784         <tertiary>on IRIX</tertiary>
 785       </indexterm>
 786     </sect2>
 787   </sect1>
 788
 789   <sect1 id="HDRWQ139">
 790     <title>Getting Started on IRIX Systems</title>
 791
 792     <para>In this section you incorporate AFS into the IRIX kernel, choosing one of two methods: <itemizedlist>
 793         <listitem>
 794           <para>Dynamic loading using the <emphasis role="bold">ml</emphasis> program distributed by Silicon Graphics, Incorporated
 795           (SGI).</para>
 796         </listitem>
 797
 798         <listitem>
 799           <para>Building a new static kernel.</para>
 800         </listitem>
 801       </itemizedlist></para>
 802
 803     <para>Then see <link linkend="HDRWQ142">Enabling AFS Login on IRIX Systems</link> to read about integrated AFS login on IRIX
 804     systems.</para>
 805
 806     <para>In preparation for either dynamic loading or kernel building, perform the following procedures: <orderedlist>
 807         <listitem>
 808           <para>Mount the AFS CD-ROM for IRIX on the <emphasis role="bold">/cdrom</emphasis> directory. For instructions on mounting
 809           CD-ROMs (either locally or remotely via NFS), see your IRIX documentation. Then change directory as indicated.
 810           <programlisting>
 811    # <emphasis role="bold">cd  /cdrom/sgi_65/root.client</emphasis>
 812 </programlisting></para>
 813         </listitem>
 814
 815         <listitem>
 816           <para>Copy the AFS initialization script to the local directory for initialization files (by convention, <emphasis
 817           role="bold">/etc/init.d</emphasis> on IRIX machines). Note the removal of the <emphasis role="bold">.rc</emphasis>
 818           extension as you copy the script. <programlisting>
 819    # <emphasis role="bold">cp -p   usr/vice/etc/afs.rc  /etc/init.d/afs</emphasis>
 820 </programlisting></para>
 821         </listitem>
 822
 823         <listitem>
 824           <para>Issue the <emphasis role="bold">uname -m</emphasis> command to determine the machine's CPU board type. The <emphasis
 825           role="bold">IP</emphasis><replaceable>xx</replaceable> value in the output must match one of the supported CPU board types
 826           listed in the <emphasis>OpenAFS Release Notes</emphasis> for the current version of AFS. <programlisting>
 827    # <emphasis role="bold">uname -m</emphasis>
 828 </programlisting></para>
 829         </listitem>
 830
 831         <listitem>
 832           <para>Proceed to either <link linkend="HDRWQ140">Loading AFS into the IRIX Kernel</link> or <link
 833           linkend="HDRWQ141">Building AFS into the IRIX Kernel</link>.</para>
 834         </listitem>
 835       </orderedlist></para>
 836
 837     <indexterm>
 838       <primary>IRIX</primary>
 839
 840       <secondary>AFS kernel extensions</secondary>
 841
 842       <tertiary>on client machine</tertiary>
 843     </indexterm>
 844
 845     <indexterm>
 846       <primary>afsml variable (IRIX)</primary>
 847
 848       <secondary>client machine</secondary>
 849     </indexterm>
 850
 851     <indexterm>
 852       <primary>variables</primary>
 853
 854       <secondary>afsml (IRIX)</secondary>
 855
 856       <tertiary>client machine</tertiary>
 857     </indexterm>
 858
 859     <indexterm>
 860       <primary>IRIX</primary>
 861
 862       <secondary>afsml variable</secondary>
 863
 864       <tertiary>client machine</tertiary>
 865     </indexterm>
 866
 867     <indexterm>
 868       <primary>afsxnfs variable (IRIX)</primary>
 869
 870       <secondary>client machine</secondary>
 871     </indexterm>
 872
 873     <indexterm>
 874       <primary>variables</primary>
 875
 876       <secondary>afsxnfs (IRIX)</secondary>
 877
 878       <tertiary>client machine</tertiary>
 879     </indexterm>
 880
 881     <indexterm>
 882       <primary>IRIX</primary>
 883
 884       <secondary>afsxnfs variable</secondary>
 885
 886       <tertiary>client machine</tertiary>
 887     </indexterm>
 888
 889     <sect2 id="HDRWQ140">
 890       <title>Loading AFS into the IRIX Kernel</title>
 891
 892       <para>The <emphasis role="bold">ml</emphasis> program is the dynamic kernel loader provided by SGI for IRIX systems. If you
 893       use it rather than building AFS modifications into a static kernel, then for AFS to function correctly the <emphasis
 894       role="bold">ml</emphasis> program must run each time the machine reboots. Therefore, the AFS initialization script (included
 895       on the AFS CD-ROM) invokes it automatically when the <emphasis role="bold">afsml</emphasis> configuration variable is
 896       activated. In this section you activate the variable and run the script.</para>
 897
 898       <para>In a later section you verify that the script correctly initializes the Cache Manager, then create the links that
 899       incorporate AFS into the IRIX startup and shutdown sequence. <orderedlist>
 900           <listitem>
 901             <para>Create the local <emphasis role="bold">/usr/vice/etc/sgiload</emphasis> directory to house the AFS kernel library
 902             file. <programlisting>
 903    # <emphasis role="bold">mkdir /usr/vice/etc/sgiload</emphasis>
 904 </programlisting></para>
 905           </listitem>
 906
 907           <listitem>
 908             <para>Copy the appropriate AFS kernel library file to the <emphasis role="bold">/usr/vice/etc/sgiload</emphasis>
 909             directory. The <emphasis role="bold">IP</emphasis><replaceable>xx</replaceable> portion of the library file name must
 910             match the value previously returned by the <emphasis role="bold">uname -m</emphasis> command. Also choose the file
 911             appropriate to whether the machine's kernel supports NFS server functionality (NFS must be supported for the machine to
 912             act as an NFS/AFS Translator). Single- and multiprocessor machines use the same library file.</para>
 913
 914             <para>(You can choose to copy all of the kernel library files into the <emphasis
 915             role="bold">/usr/vice/etc/sgiload</emphasis> directory, but they require a significant amount of space.)</para>
 916
 917             <para>If the machine's kernel supports NFS server functionality:</para>
 918
 919             <programlisting>
 920    # <emphasis role="bold">cp -p  usr/vice/etc/sgiload/libafs.IP</emphasis><replaceable>xx</replaceable><emphasis role="bold">.o  /usr/vice/etc/sgiload</emphasis>
 921 </programlisting>
 922
 923             <para>If the machine's kernel does not support NFS server functionality:</para>
 924
 925             <programlisting>
 926    # <emphasis role="bold">cp -p  usr/vice/etc/sgiload/libafs.IP</emphasis><replaceable>xx</replaceable><emphasis role="bold">.nonfs.o</emphasis>   \
 927                    <emphasis role="bold">/usr/vice/etc/sgiload</emphasis>
 928 </programlisting>
 929           </listitem>
 930
 931           <listitem>
 932             <para>Issue the <emphasis role="bold">chkconfig</emphasis> command to activate the <emphasis
 933             role="bold">afsml</emphasis> configuration variable. <programlisting>
 934    # <emphasis role="bold">/etc/chkconfig -f afsml on</emphasis>
 935 </programlisting></para>
 936
 937             <para>If the machine is to function as an NFS/AFS Translator and the kernel supports NFS server functionality, activate
 938             the <emphasis role="bold">afsxnfs</emphasis> variable.</para>
 939
 940             <programlisting>
 941    # <emphasis role="bold">/etc/chkconfig -f afsxnfs on</emphasis>
 942 </programlisting>
 943           </listitem>
 944
 945           <listitem>
 946             <para>Run the <emphasis role="bold">/etc/init.d/afs</emphasis> script to load AFS extensions into the kernel. The script
 947             invokes the <emphasis role="bold">ml</emphasis> command, automatically determining which kernel library file to use
 948             based on this machine's CPU type and the activation state of the <emphasis role="bold">afsxnfs</emphasis>
 949             variable.</para>
 950
 951             <para>You can ignore any error messages about the inability to start the BOS Server or the Cache Manager or AFS
 952             client.</para>
 953
 954             <programlisting>
 955    # <emphasis role="bold">/etc/init.d/afs start</emphasis>
 956 </programlisting>
 957           </listitem>
 958
 959           <listitem>
 960             <para>Proceed to <link linkend="HDRWQ142">Enabling AFS Login on IRIX Systems</link>.</para>
 961           </listitem>
 962         </orderedlist></para>
 963
 964       <indexterm>
 965         <primary>IRIX</primary>
 966
 967         <secondary>AFS-modified kernel</secondary>
 968
 969         <tertiary>on client machine</tertiary>
 970       </indexterm>
 971     </sect2>
 972
 973     <sect2 id="HDRWQ141">
 974       <title>Building AFS into the IRIX Kernel</title>
 975
 976       <para>If you prefer to build a kernel, and the machine's hardware and software configuration exactly matches another IRIX
 977       machine on which AFS is already built into the kernel, you can choose to copy the kernel from that machine to this one. In
 978       general, however, it is better to build AFS modifications into the kernel on each machine according to the following
 979       instructions. <orderedlist>
 980           <listitem>
 981             <para>Copy the kernel initialization file <emphasis role="bold">afs.sm</emphasis> to the local <emphasis
 982             role="bold">/var/sysgen/system</emphasis> directory, and the kernel master file <emphasis role="bold">afs</emphasis> to
 983             the local <emphasis role="bold">/var/sysgen/master.d</emphasis> directory. <programlisting>
 984    # <emphasis role="bold">cp -p  bin/afs.sm  /var/sysgen/system</emphasis>
 985    # <emphasis role="bold">cp -p  bin/afs  /var/sysgen/master.d</emphasis>
 986 </programlisting></para>
 987           </listitem>
 988
 989           <listitem>
 990             <para>Copy the appropriate AFS kernel library file to the local file <emphasis
 991             role="bold">/var/sysgen/boot/afs.a</emphasis>; the <emphasis role="bold">IP</emphasis><replaceable>xx</replaceable>
 992             portion of the library file name must match the value previously returned by the <emphasis role="bold">uname
 993             -m</emphasis> command. Also choose the file appropriate to whether the machine's kernel supports NFS server
 994             functionality (NFS must be supported for the machine to act as an NFS/AFS Translator). Single- and multiprocessor
 995             machines use the same library file.</para>
 996
 997             <para>If the machine's kernel supports NFS server functionality:</para>
 998
 999             <programlisting>
1000    # <emphasis role="bold">cp -p   bin/libafs.IP</emphasis><replaceable>xx</replaceable><emphasis role="bold">.a   /var/sysgen/boot/afs.a</emphasis>
1001 </programlisting>
1002
1003             <para>If the machine's kernel does not support NFS server functionality:</para>
1004
1005             <programlisting>
1006    # <emphasis role="bold">cp -p  bin/libafs.IP</emphasis><replaceable>xx</replaceable><emphasis role="bold">.nonfs.a  /var/sysgen/boot/afs.a</emphasis>
1007 </programlisting>
1008           </listitem>
1009
1010           <listitem>
1011             <para>Issue the <emphasis role="bold">chkconfig</emphasis> command to deactivate the <emphasis
1012             role="bold">afsml</emphasis> configuration variable. <programlisting>
1013    # <emphasis role="bold">/etc/chkconfig -f afsml off</emphasis>
1014 </programlisting></para>
1015
1016             <para>If the machine is to function as an NFS/AFS Translator and the kernel supports NFS server functionality, activate
1017             the <emphasis role="bold">afsxnfs</emphasis> variable.</para>
1018
1019             <programlisting>
1020    # <emphasis role="bold">/etc/chkconfig -f afsxnfs on</emphasis>
1021 </programlisting>
1022           </listitem>
1023
1024           <listitem>
1025             <para>Copy the existing kernel file, <emphasis role="bold">/unix</emphasis>, to a safe location. Compile the new kernel,
1026             which is created in the file <emphasis role="bold">/unix.install</emphasis>. It overwrites the existing <emphasis
1027             role="bold">/unix</emphasis> file when the machine reboots in the next step. <programlisting>
1028    # <emphasis role="bold">cp /unix /unix_noafs</emphasis>
1029    # <emphasis role="bold">autoconfig</emphasis>
1030 </programlisting></para>
1031           </listitem>
1032
1033           <listitem>
1034             <para>Reboot the machine to start using the new kernel, and login again as the superuser <emphasis
1035             role="bold">root</emphasis>. <programlisting>
1036    # <emphasis role="bold">cd /</emphasis>
1037    # <emphasis role="bold">shutdown -i6 -g0 -y</emphasis>
1038    login: <emphasis role="bold">root</emphasis>
1039    Password: <replaceable>root_password</replaceable>
1040 </programlisting></para>
1041           </listitem>
1042
1043           <listitem>
1044             <para>Proceed to <link linkend="HDRWQ142">Enabling AFS Login on IRIX Systems</link>.</para>
1045           </listitem>
1046         </orderedlist></para>
1047
1048       <indexterm>
1049         <primary>enabling AFS login</primary>
1050
1051         <secondary>client machine</secondary>
1052
1053         <tertiary>IRIX</tertiary>
1054       </indexterm>
1055
1056       <indexterm>
1057         <primary>AFS login</primary>
1058
1059         <secondary>on client machine</secondary>
1060
1061         <tertiary>IRIX</tertiary>
1062       </indexterm>
1063
1064       <indexterm>
1065         <primary>client machine</primary>
1066
1067         <secondary>AFS login</secondary>
1068
1069         <tertiary>on IRIX</tertiary>
1070       </indexterm>
1071     </sect2>
1072
1073     <sect2 id="HDRWQ142">
1074       <title>Enabling AFS Login on IRIX Systems</title>
1075
1076       <para>The standard IRIX command-line <emphasis role="bold">login</emphasis> program and the graphical <emphasis
1077       role="bold">xdm</emphasis> login program both automatically grant an AFS token when AFS is incorporated into the machine's
1078       kernel. However, some IRIX distributions use another login utility by default, and it does not necessarily incorporate the
1079       required AFS modifications. If that is the case, you must disable the default utility if you want AFS users to obtain AFS
1080       tokens at login. For further discussion, see the <emphasis>OpenAFS Release Notes</emphasis>.</para>
1081
1082       <para>If you configure the machine to use an AFS-modified login utility, then the <emphasis
1083       role="bold">afsauthlib.so</emphasis> and <emphasis role="bold">afskauthlib.so</emphasis> files (included in the AFS
1084       distribution) must reside in the <emphasis role="bold">/usr/vice/etc</emphasis> directory. Issue the <emphasis
1085       role="bold">ls</emphasis> command to verify.</para>
1086
1087       <programlisting>
1088    # <emphasis role="bold">ls /usr/vice/etc</emphasis>
1089 </programlisting>
1090
1091       <para>If the files do not exist, mount the AFS CD-ROM for IRIX (if it is not already), change directory as indicated, and copy
1092       them.</para>
1093
1094       <programlisting>
1095    # <emphasis role="bold">cd /cdrom/sgi_65/root.client/usr/vice/etc</emphasis>
1096    # <emphasis role="bold">cp  -p  *authlib*  /usr/vice/etc</emphasis>
1097 </programlisting>
1098
1099       <para>After taking any necessary action, proceed to <link linkend="HDRWQ145">Loading and Creating Client Files</link>.
1100       <indexterm>
1101           <primary>incorporating AFS kernel extensions</primary>
1102
1103           <secondary>client machine</secondary>
1104
1105           <tertiary>Linux</tertiary>
1106         </indexterm> <indexterm>
1107           <primary>AFS kernel extensions</primary>
1108
1109           <secondary>on client machine</secondary>
1110
1111           <tertiary>Linux</tertiary>
1112         </indexterm> <indexterm>
1113           <primary>client machine</primary>
1114
1115           <secondary>AFS kernel extensions</secondary>
1116
1117           <tertiary>on Linux</tertiary>
1118         </indexterm> <indexterm>
1119           <primary>Linux</primary>
1120
1121           <secondary>AFS kernel extensions</secondary>
1122
1123           <tertiary>on client machine</tertiary>
1124         </indexterm> <indexterm>
1125           <primary>enabling AFS login</primary>
1126
1127           <secondary>client machine</secondary>
1128
1129           <tertiary>Linux</tertiary>
1130         </indexterm> <indexterm>
1131           <primary>AFS login</primary>
1132
1133           <secondary>on client machine</secondary>
1134
1135           <tertiary>Linux</tertiary>
1136         </indexterm> <indexterm>
1137           <primary>client machine</primary>
1138
1139           <secondary>AFS login</secondary>
1140
1141           <tertiary>on Linux</tertiary>
1142         </indexterm> <indexterm>
1143           <primary>Linux</primary>
1144
1145           <secondary>AFS login</secondary>
1146
1147           <tertiary>on client machine</tertiary>
1148         </indexterm> <indexterm>
1149           <primary>PAM</primary>
1150
1151           <secondary>on Linux</secondary>
1152
1153           <tertiary>client machine</tertiary>
1154         </indexterm></para>
1155     </sect2>
1156   </sect1>
1157
1158   <sect1 id="HDRWQ143">
1159     <title>Getting Started on Linux Systems</title>
1160
1161     <para>In this section you load AFS into the Linux kernel. Then incorporate AFS modifications into the machine's Pluggable
1162     Authentication Module (PAM) system, if you wish to enable AFS login.</para>
1163
1164     <sect2 id="Header_133">
1165       <title>Loading AFS into the Linux Kernel</title>
1166
1167       <para>The <emphasis role="bold">insmod</emphasis> program is the dynamic kernel loader for Linux. Linux does not support
1168       incorporation of AFS modifications during a kernel build.</para>
1169
1170       <para>For AFS to function correctly, the <emphasis role="bold">insmod</emphasis> program must run each time the machine
1171       reboots, so the AFS initialization script (included on the AFS CD-ROM) invokes it automatically. The script also includes
1172       commands that select the appropriate AFS library file automatically. In this section you run the script.</para>
1173
1174       <para>In a later section you also verify that the script correctly initializes the Cache Manager, then activate a
1175       configuration variable, which results in the script being incorporated into the Linux startup and shutdown sequence.
1176       <orderedlist>
1177           <listitem>
1178             <para>Mount the AFS CD-ROM for Linux on the local <emphasis role="bold">/cdrom</emphasis> directory. For instructions on
1179             mounting CD-ROMs (either locally or remotely via NFS), see your Linux documentation. Then change directory as indicated.
1180             <programlisting>
1181    # <emphasis role="bold">cd  /cdrom/i386_linux22/root.client/usr/vice/etc</emphasis>
1182 </programlisting></para>
1183           </listitem>
1184
1185           <listitem>
1186             <para>Copy the AFS kernel library files to the local <emphasis role="bold">/usr/vice/etc/modload</emphasis> directory.
1187             The filenames for the libraries have the format <emphasis
1188             role="bold">libafs-</emphasis><replaceable>version</replaceable><emphasis role="bold">.o</emphasis>, where
1189             <replaceable>version</replaceable> indicates the kernel build level. The string <emphasis role="bold">.mp</emphasis> in
1190             the <replaceable>version</replaceable> indicates that the file is appropriate for machines running a multiprocessor
1191             kernel. <programlisting>
1192    # <emphasis role="bold">cp -rp  modload  /usr/vice/etc</emphasis>
1193 </programlisting></para>
1194           </listitem>
1195
1196           <listitem>
1197             <para>Copy the AFS initialization script to the local directory for initialization files (by convention, <emphasis
1198             role="bold">/etc/rc.d/init.d</emphasis> on Linux machines). Note the removal of the <emphasis role="bold">.rc</emphasis>
1199             extension as you copy the script. <programlisting>
1200    # <emphasis role="bold">cp -p   afs.rc  /etc/rc.d/init.d/afs</emphasis>
1201 </programlisting></para>
1202           </listitem>
1203
1204           <listitem>
1205             <para>Run the AFS initialization script to load AFS extensions into the kernel. You can ignore any error messages about
1206             the inability to start the BOS Server or the Cache Manager or AFS client. <programlisting>
1207    # <emphasis role="bold">/etc/rc.d/init.d/afs  start</emphasis>
1208 </programlisting></para>
1209           </listitem>
1210         </orderedlist></para>
1211     </sect2>
1212
1213     <sect2 id="Header_134">
1214       <title>Enabling AFS Login on Linux Systems</title>
1215
1216       <para>At this point you incorporate AFS into the operating system's Pluggable Authentication Module (PAM) scheme. PAM
1217       integrates all authentication mechanisms on the machine, including login, to provide the security infrastructure for
1218       authenticated access to and from the machine.</para>
1219
1220       <para>Explaining PAM is beyond the scope of this document. It is assumed that you understand the syntax and meanings of
1221       settings in the PAM configuration file (for example, how the <computeroutput>other</computeroutput> entry works, the effect of
1222       marking an entry as <computeroutput>required</computeroutput>, <computeroutput>optional</computeroutput>, or
1223       <computeroutput>sufficient</computeroutput>, and so on).</para>
1224
1225       <para>The following instructions explain how to alter the entries in the PAM configuration file for each service for which you
1226       wish to use AFS authentication. Other configurations possibly also work, but the instructions specify the recommended and
1227       tested configuration.</para>
1228
1229       <para>The recommended AFS-related entries in the PAM configuration file make use of one or more of the following three
1230       attributes. <variablelist>
1231           <title>Authentication Management</title>
1232
1233           <varlistentry>
1234             <term><emphasis role="bold"><computeroutput>try_first_pass</computeroutput></emphasis></term>
1235
1236             <listitem>
1237               <para>This is a standard PAM attribute that can be included on entries after the first one for a service; it directs
1238               the module to use the password that was provided to the first module. For the AFS module, it means that AFS
1239               authentication succeeds if the password provided to the module listed first is the user's correct AFS password. For
1240               further discussion of this attribute and its alternatives, see the operating system's PAM documentation.</para>
1241             </listitem>
1242           </varlistentry>
1243
1244           <varlistentry>
1245             <term><emphasis role="bold"><computeroutput>ignore_root</computeroutput></emphasis></term>
1246
1247             <listitem>
1248               <para>This attribute, specific to the AFS PAM module, directs it to ignore not only the local superuser <emphasis
1249               role="bold">root</emphasis>, but also any user with UID 0 (zero).</para>
1250             </listitem>
1251           </varlistentry>
1252
1253           <varlistentry>
1254             <term><emphasis role="bold"><computeroutput>ignore_uid </computeroutput><emphasis>uid</emphasis></emphasis></term>
1255
1256             <listitem>
1257               <para>This option is an extension of the "ignore_root" switch. The additional parameter is a limit. Users with a uid
1258               up to the given parameter are ignored by <emphasis>pam_afs.so</emphasis>. Thus, a system administrator still has the
1259               opportunity to add local user accounts to his system by choosing between "low" and "high" user ids. An example
1260               /etc/passwd file for "ignore_uid 100" may have entries like these: <programlisting>
1261         .
1262         .
1263 afsuserone:x:99:100::/afs/afscell/u/afsuserone:/bin/bash
1264 afsusertwo:x:100:100::/afs/afscell/u/afsusertwo:/bin/bash
1265 localuserone:x:101:100::/home/localuserone:/bin/bash
1266 localusertwo:x:102:100::/home/localusertwo:/bin/bash
1267         .
1268         .
1269 </programlisting> AFS accounts should be locked in the file /etc/shadow like this: <programlisting>
1270         .
1271         .
1272 afsuserone:!!:11500:0:99999:7:::
1273 afsusertwo:!!:11500:0:99999:7:::
1274 localuserone:&lt;thelocaluserone'skey&gt;:11500:0:99999:7:::
1275 localusertwo:&lt;thelocalusertwo'skey&gt;:11500:0:99999:7:::
1276         .
1277         .
1278 </programlisting> There is no need to store a local key in this file since the AFS password is sent and verfied at the AFS cell
1279               server!</para>
1280             </listitem>
1281           </varlistentry>
1282
1283           <varlistentry>
1284             <term><emphasis role="bold"><computeroutput>setenv_password_expires</computeroutput></emphasis></term>
1285
1286             <listitem>
1287               <para>This attribute, specific to the AFS PAM module, sets the environment variable PASSWORD_EXPIRES to the expiration
1288               date of the user's AFS password, which is recorded in the Authentication Database.</para>
1289             </listitem>
1290           </varlistentry>
1291
1292           <varlistentry>
1293             <term><emphasis role="bold"><computeroutput>set_token</computeroutput></emphasis></term>
1294
1295             <listitem>
1296               <para>Some applications don't call <emphasis>pam_setcred()</emphasis> in order to retrieve the appropriate credentials
1297               (here the AFS token) for their session. This switch sets the credentials already in
1298               <emphasis>pam_sm_authenticate()</emphasis> obsoleting a call to <emphasis>pam_setcred()</emphasis>. <emphasis
1299               role="bold">Caution: Don't use this switch for applications which do call
1300               <emphasis>pam_setcred()</emphasis>!</emphasis> One example for an application not calling
1301               <emphasis>pam_setcred()</emphasis> are older versions of the samba server. Nevertheless, using applications with
1302               working pam session management is recommended as this setup conforms better with the PAM definitions.</para>
1303             </listitem>
1304           </varlistentry>
1305
1306           <varlistentry>
1307             <term><emphasis role="bold"><computeroutput>refresh_token</computeroutput></emphasis></term>
1308
1309             <listitem>
1310               <para>This options is identical to "set_token" except that no new PAG is generated. This is necessary to handle
1311               processes like xlock or xscreensaver. It is not enough to give the screen and the keyboard free for the user who
1312               reactivated his screen typing in the correct AFS password, but one may also need fresh tokens with full livetime in
1313               order to work on, and the new token must be refreshed in the already existing PAG for the processes that have been
1314               started. This is achieved using this option.</para>
1315             </listitem>
1316           </varlistentry>
1317
1318           <varlistentry>
1319             <term><emphasis role="bold"><computeroutput>use_klog</computeroutput></emphasis></term>
1320
1321             <listitem>
1322               <para>Activating this switch the authentication is done by calling the external program "klog". One program requiring
1323               this is for example <emphasis>kdm</emphasis> of KDE 2.x.</para>
1324             </listitem>
1325           </varlistentry>
1326
1327           <varlistentry>
1328             <term><emphasis role="bold"><computeroutput>dont_fork</computeroutput></emphasis></term>
1329
1330             <listitem>
1331               <para>Usually, the password verification and the establishment of the token is performed in a sub process. Using this
1332               option pam_afs does not fork and performs all actions in a single process. <emphasis role="bold">Only use this options
1333               in case you notice serious problems caused by the sub process.</emphasis> This option has been developed in respect to
1334               the "mod_auth_pam"-project (see also <ulink url="http://pam.sourceforge.net/mod_auth_pam/">mod_auth_pam</ulink>). The
1335               mod_auth_pam module enables PAM authentication for the apache http server package.</para>
1336             </listitem>
1337           </varlistentry>
1338         </variablelist> <variablelist>
1339           <title>Session Management</title>
1340
1341           <varlistentry>
1342             <term><emphasis role="bold"><computeroutput>no_unlog</computeroutput></emphasis></term>
1343
1344             <listitem>
1345               <para>Normally the tokens are deleted (in memory) after the session ends. Using this options the tokens are left
1346               untouched. <emphasis role="bold">This behaviour has been the default in pam_afs until openafs-1.1.1!</emphasis></para>
1347             </listitem>
1348           </varlistentry>
1349
1350           <varlistentry>
1351             <term><emphasis role="bold"><computeroutput>remainlifetime</computeroutput> <emphasis>sec</emphasis></emphasis></term>
1352
1353             <listitem>
1354               <para>The tokens are kept active for <emphasis>sec</emphasis> seconds before they are deleted. X display managers i.e.
1355               are used to inform the applications started in the X session before the logout and then end themselves. If the token
1356               was deleted immediately the applications would have no chance to write back their settings to i.e. the user's AFS home
1357               space. This option may help to avoid the problem.</para>
1358             </listitem>
1359           </varlistentry>
1360         </variablelist></para>
1361
1362       <para>Perform the following steps to enable AFS login. <orderedlist>
1363           <listitem>
1364             <para>Mount the AFS CD-ROM for Linux on the <emphasis role="bold">/cdrom</emphasis> directory, if it is not already.
1365             Then change to the directory for PAM modules, which depends on which Linux distribution you are using.</para>
1366
1367             <para>If you are using a Linux distribution from Red Hat Software:</para>
1368
1369             <programlisting>
1370    # <emphasis role="bold">cd /lib/security</emphasis>
1371 </programlisting>
1372
1373             <para>If you are using another Linux distribution:</para>
1374
1375             <programlisting>
1376    # <emphasis role="bold">cd /usr/lib/security</emphasis>
1377 </programlisting>
1378           </listitem>
1379
1380           <listitem>
1381             <para>Copy the appropriate AFS authentication library file to the directory to which you changed in the previous step.
1382             Create a symbolic link whose name does not mention the version. Omitting the version eliminates the need to edit the PAM
1383             configuration file if you later update the library file.</para>
1384
1385             <para>If you use the AFS Authentication Server (<emphasis role="bold">kaserver</emphasis> process):</para>
1386
1387             <programlisting>
1388    # <emphasis role="bold">cp /cdrom/i386_linux22/lib/pam_afs.so.1  .</emphasis>
1389    # <emphasis role="bold">ln -s pam_afs.so.1 pam_afs.so</emphasis>
1390 </programlisting>
1391
1392             <para>If you use a Kerberos implementation of AFS authentication:</para>
1393
1394             <programlisting>
1395    # <emphasis role="bold">cp /cdrom/i386_linux22/lib/pam_afs.krb.so.1   .</emphasis>
1396    # <emphasis role="bold">ln -s pam_afs.krb.so.1 pam_afs.so</emphasis>
1397 </programlisting>
1398           </listitem>
1399
1400           <listitem>
1401             <para>For each service with which you want to use AFS authentication, insert an entry for the AFS PAM module into the
1402             <computeroutput>auth</computeroutput> section of the service's PAM configuration file. (Linux uses a separate
1403             configuration file for each service, unlike some other operating systems which list all services in a single file.) Mark
1404             the entry as <computeroutput>sufficient</computeroutput> in the second field.</para>
1405
1406             <para>Place the AFS entry below any entries that impose conditions under which you want the service to fail for a user
1407             who does not meet the entry's requirements. Mark these entries <computeroutput>required</computeroutput>. Place the AFS
1408             entry above any entries that need to execute only if AFS authentication fails.</para>
1409
1410             <para>Insert the following AFS entry if using the Red Hat distribution:</para>
1411
1412             <programlisting>
1413    auth  sufficient  /lib/security/pam_afs.so   try_first_pass  ignore_root
1414 </programlisting>
1415
1416             <para>Insert the following AFS entry if using another distribution:</para>
1417
1418             <programlisting>
1419    auth  sufficient  /usr/lib/security/pam_afs.so  try_first_pass  ignore_root
1420 </programlisting>
1421
1422             <para>Check the PAM config files also for "session" entries. If there are lines beginning with "session" then please
1423             insert this line too:</para>
1424
1425             <programlisting>
1426    session  optional  /lib/security/pam_afs.so
1427 </programlisting>
1428
1429             <para>or</para>
1430
1431             <programlisting>
1432    session  optional  /usr/lib/security/pam_afs.so
1433 </programlisting>
1434
1435             <para>This guarantees that the user's tokens are deleted from memory after his session ends so that no other user
1436             coincidently gets those tokens without authorization! The following examples illustrate the recommended configuration of
1437             the configuration file for several services: <variablelist>
1438                 <title>Authentication Management</title>
1439
1440                 <varlistentry>
1441                   <term>(<emphasis role="bold">/etc/pam.d/login</emphasis>)</term>
1442
1443                   <listitem>
1444                     <para><programlisting>
1445    #%PAM-1.0
1446    auth      required   /lib/security/pam_securetty.so
1447    auth      required   /lib/security/pam_nologin.so
1448    auth      sufficient /lib/security/pam_afs.so try_first_pass ignore_root
1449    #                                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1450    #This enables AFS authentication for every user but root
1451    auth      required   /lib/security/pam_pwdb.so shadow nullok
1452    account   required   /lib/security/pam_pwdb.so
1453    password  required   /lib/security/pam_cracklib.so
1454    password  required   /lib/security/pam_pwdb.so shadow nullok use_authtok
1455    session   optional   /lib/security/pam_afs.so
1456    #Make sure tokens are deleted after the user logs out
1457    session   required   /lib/security/pam_pwdb.so
1458 </programlisting></para>
1459                   </listitem>
1460                 </varlistentry>
1461
1462                 <varlistentry>
1463                   <term>(<emphasis role="bold">/etc/pam.d/samba</emphasis>)</term>
1464
1465                   <listitem>
1466                     <para><programlisting>
1467    auth       required     /lib/security/pam_afs.so ignore_uid 100 set_token
1468    #                                                ^^^^^^^^^^^^^^^^^^^^^^^^
1469    #Here, users with uid&gt;100 are considered to belong to the AFS and users
1470    #with uid&lt;=100 are ignored by pam_afs. The token is retrieved already in
1471    #pam_sm_authenticate() (this is an example pam config for a samba version
1472    #that does not call pam_setcred(), it also does no sense to include session
1473    #entries here since they would be ignored by this version of samba ).
1474    account    required     /lib/security/pam_pwdb.so
1475 </programlisting></para>
1476                   </listitem>
1477                 </varlistentry>
1478
1479                 <varlistentry>
1480                   <term>(<emphasis role="bold">/etc/pam.d/xscreensaver</emphasis>)</term>
1481
1482                   <listitem>
1483                     <para><programlisting>
1484    auth       sufficient   /lib/security/pam_afs.so ignore_uid 100 refresh_token
1485    #                                                               ^^^^^^^^^^^^^
1486    #Avoid generating a new PAG for the new tokens, use the already existing PAG and
1487    #establish a fresh token in it.
1488    auth       required     /lib/security/pam_pwdb.so try_first_pass
1489 </programlisting></para>
1490                   </listitem>
1491                 </varlistentry>
1492
1493                 <varlistentry>
1494                   <term>(<emphasis role="bold">/etc/pam.d/httpd</emphasis>)</term>
1495
1496                   <listitem>
1497                     <para><programlisting>
1498    auth       required   /lib/security/pam_afs.so ignore_uid 100 dont_fork
1499    #                                                             ^^^^^^^^^
1500    #Don't fork for the verification of the password.
1501 </programlisting></para>
1502                   </listitem>
1503                 </varlistentry>
1504               </variablelist> <variablelist>
1505                 <title>Session Management</title>
1506
1507                 <varlistentry>
1508                   <term>(<emphasis role="bold">/etc/pam.d/su</emphasis>)</term>
1509
1510                   <listitem>
1511                     <para><programlisting>
1512    auth       sufficient   /lib/security/pam_afs.so ignore_uid 100
1513    auth       required     /lib/security/pam_pwdb.so try_first_pass
1514    account    required     /lib/security/pam_pwdb.so
1515    password   required     /lib/security/pam_cracklib.so
1516    password   required     /lib/security/pam_pwdb.so use_authtok
1517    session    required     /lib/security/pam_pwdb.so
1518    session    optional     /lib/security/pam_afs.so no_unlog
1519    #                                                ^^^^^^^^
1520    #Don't delete the token in this case, since the user may still
1521    #need it (for example if somebody logs in and changes to root
1522    #afterwards he may still want to access his home space in AFS).
1523    session    required     /lib/security/pam_login_access.so
1524    session    optional     /lib/security/pam_xauth.so
1525 </programlisting></para>
1526                   </listitem>
1527                 </varlistentry>
1528
1529                 <varlistentry>
1530                   <term>(<emphasis role="bold">/etc/pam.d/xdm</emphasis>)</term>
1531
1532                   <listitem>
1533                     <para><programlisting>
1534    auth       required     /lib/security/pam_nologin.so
1535    auth       required     /lib/security/pam_login_access.so
1536    auth       sufficient   /lib/security/pam_afs.so ignore_uid 100 use_klog
1537    auth       required     /lib/security/pam_pwdb.so try_first_pass
1538    account    required     /lib/security/pam_pwdb.so
1539    password   required     /lib/security/pam_cracklib.so
1540    password   required     /lib/security/pam_pwdb.so shadow nullok use_authtok
1541    session    optional     /lib/security/pam_afs.so remainlifetime 10
1542    #                                                ^^^^^^^^^^^^^^^^^
1543    #Wait 10 seconds before deleting the AFS tokens in order to give
1544    #the programs of the X session some time to save their settings
1545    #to AFS.
1546    session    required     /lib/security/pam_pwdb.so
1547 </programlisting></para>
1548                   </listitem>
1549                 </varlistentry>
1550               </variablelist></para>
1551           </listitem>
1552
1553           <listitem>
1554             <para>Proceed to <link linkend="HDRWQ145">Loading and Creating Client Files</link>.</para>
1555           </listitem>
1556         </orderedlist></para>
1557
1558       <indexterm>
1559         <primary>incorporating AFS kernel extensions</primary>
1560
1561         <secondary>client machine</secondary>
1562
1563         <tertiary>Solaris</tertiary>
1564       </indexterm>
1565
1566       <indexterm>
1567         <primary>AFS kernel extensions</primary>
1568
1569         <secondary>on client machine</secondary>
1570
1571         <tertiary>Solaris</tertiary>
1572       </indexterm>
1573
1574       <indexterm>
1575         <primary>client machine</primary>
1576
1577         <secondary>AFS kernel extensions</secondary>
1578
1579         <tertiary>on Solaris</tertiary>
1580       </indexterm>
1581
1582       <indexterm>
1583         <primary>Solaris</primary>
1584
1585         <secondary>AFS kernel extensions</secondary>
1586
1587         <tertiary>on client machine</tertiary>
1588       </indexterm>
1589
1590       <indexterm>
1591         <primary>enabling AFS login</primary>
1592
1593         <secondary>client machine</secondary>
1594
1595         <tertiary>Solaris</tertiary>
1596       </indexterm>
1597
1598       <indexterm>
1599         <primary>AFS login</primary>
1600
1601         <secondary>on client machine</secondary>
1602
1603         <tertiary>Solaris</tertiary>
1604       </indexterm>
1605
1606       <indexterm>
1607         <primary>client machine</primary>
1608
1609         <secondary>AFS login</secondary>
1610
1611         <tertiary>on Solaris</tertiary>
1612       </indexterm>
1613
1614       <indexterm>
1615         <primary>Solaris</primary>
1616
1617         <secondary>AFS login</secondary>
1618
1619         <tertiary>on client machine</tertiary>
1620       </indexterm>
1621
1622       <indexterm>
1623         <primary>PAM</primary>
1624
1625         <secondary>on Solaris</secondary>
1626
1627         <tertiary>client machine</tertiary>
1628       </indexterm>
1629
1630       <indexterm>
1631         <primary>Solaris</primary>
1632
1633         <secondary>file systems clean-up script</secondary>
1634
1635         <tertiary>on client machine</tertiary>
1636       </indexterm>
1637
1638       <indexterm>
1639         <primary>file systems clean-up script (Solaris)</primary>
1640
1641         <secondary>client machine</secondary>
1642       </indexterm>
1643
1644       <indexterm>
1645         <primary>scripts</primary>
1646
1647         <secondary>file systems clean-up (Solaris)</secondary>
1648
1649         <tertiary>client machine</tertiary>
1650       </indexterm>
1651     </sect2>
1652   </sect1>
1653
1654   <sect1 id="HDRWQ144">
1655     <title>Getting Started on Solaris Systems</title>
1656
1657     <para>In this section you load AFS into the Solaris kernel. Then incorporate AFS modifications into the machine's Pluggable
1658     Authentication Module (PAM) system, if you wish to enable AFS login.</para>
1659
1660     <sect2 id="Header_136">
1661       <title>Loading AFS into the Solaris Kernel</title>
1662
1663       <para>The <emphasis role="bold">modload</emphasis> program is the dynamic kernel loader provided by Sun Microsystems for
1664       Solaris systems. Solaris does not support incorporation of AFS modifications during a kernel build.</para>
1665
1666       <para>For AFS to function correctly, the <emphasis role="bold">modload</emphasis> program must run each time the machine
1667       reboots, so the AFS initialization script (included on the AFS CD-ROM) invokes it automatically. In this section you copy the
1668       appropriate AFS library file to the location where the <emphasis role="bold">modload</emphasis> program accesses it and then
1669       run the script.</para>
1670
1671       <para>In a later section you verify that the script correctly initializes the Cache Manager, then create the links that
1672       incorporate AFS into the Solaris startup and shutdown sequence. <orderedlist>
1673           <listitem>
1674             <para>Mount the AFS CD-ROM for Solaris on the <emphasis role="bold">/cdrom</emphasis> directory. For instructions on
1675             mounting CD-ROMs (either locally or remotely via NFS), see your Solaris documentation. Then change directory as
1676             indicated. <programlisting>
1677    # <emphasis role="bold">cd  /cdrom/sun4x_56/root.client/usr/vice/etc</emphasis>
1678 </programlisting></para>
1679           </listitem>
1680
1681           <listitem>
1682             <para>Copy the AFS initialization script to the local directory for initialization files (by convention, <emphasis
1683             role="bold">/etc/init.d</emphasis> on Solaris machines). Note the removal of the <emphasis role="bold">.rc</emphasis>
1684             extension as you copy the script. <programlisting>
1685    # <emphasis role="bold">cp -p  afs.rc  /etc/init.d/afs</emphasis>
1686 </programlisting></para>
1687           </listitem>
1688
1689           <listitem>
1690             <para>Copy the appropriate AFS kernel library file to the local file <emphasis
1691             role="bold">/kernel/fs/afs</emphasis>.</para>
1692
1693             <para>If the machine is running Solaris 2.6 or the 32-bit version of Solaris 7, its kernel supports NFS server
1694             functionality, and the <emphasis role="bold">nfsd</emphasis> process is running:</para>
1695
1696             <programlisting>
1697    # <emphasis role="bold">cp -p modload/libafs.o /kernel/fs/afs</emphasis>
1698 </programlisting>
1699
1700             <para>If the machine is running Solaris 2.6 or the 32-bit version of Solaris 7, and its kernel does not support NFS
1701             server functionality or the <emphasis role="bold">nfsd</emphasis> process is not running:</para>
1702
1703             <programlisting>
1704    # <emphasis role="bold">cp -p modload/libafs.nonfs.o /kernel/fs/afs</emphasis>
1705 </programlisting>
1706
1707             <para>If the machine is running the 64-bit version of Solaris 7, its kernel supports NFS server functionality, and the
1708             <emphasis role="bold">nfsd</emphasis> process is running:</para>
1709
1710             <programlisting>
1711    # <emphasis role="bold">cp -p modload/libafs64.o /kernel/fs/sparcv9/afs</emphasis>
1712 </programlisting>
1713
1714             <para>If the machine is running the 64-bit version of Solaris 7, and its kernel does not support NFS server
1715             functionality or the <emphasis role="bold">nfsd</emphasis> process is not running:</para>
1716
1717             <programlisting>
1718    # <emphasis role="bold">cp -p modload/libafs64.nonfs.o /kernel/fs/sparcv9/afs</emphasis>
1719 </programlisting>
1720           </listitem>
1721
1722           <listitem>
1723             <para>Run the AFS initialization script to load AFS modifications into the kernel. You can ignore any error messages
1724             about the inability to start the BOS Server or the Cache Manager or AFS client. <programlisting>
1725    # <emphasis role="bold">/etc/init.d/afs start</emphasis>
1726 </programlisting></para>
1727
1728             <para>When an entry called <computeroutput>afs</computeroutput> does not already exist in the local <emphasis
1729             role="bold">/etc/name_to_sysnum</emphasis> file, the script automatically creates it and reboots the machine to start
1730             using the new version of the file. If this happens, log in again as the superuser <emphasis role="bold">root</emphasis>
1731             after the reboot and run the initialization script again. This time the required entry exists in the <emphasis
1732             role="bold">/etc/name_to_sysnum</emphasis> file, and the <emphasis role="bold">modload</emphasis> program runs.</para>
1733
1734             <programlisting>
1735    login: <emphasis role="bold">root</emphasis>
1736    Password: <replaceable>root_password</replaceable>
1737    # <emphasis role="bold">/etc/init.d/afs start</emphasis>
1738 </programlisting>
1739           </listitem>
1740         </orderedlist></para>
1741     </sect2>
1742
1743     <sect2 id="Header_137">
1744       <title>Enabling AFS Login on Solaris Systems</title>
1745
1746       <para>At this point you incorporate AFS into the operating system's Pluggable Authentication Module (PAM) scheme. PAM
1747       integrates all authentication mechanisms on the machine, including login, to provide the security infrastructure for
1748       authenticated access to and from the machine.</para>
1749
1750       <para>Explaining PAM is beyond the scope of this document. It is assumed that you understand the syntax and meanings of
1751       settings in the PAM configuration file (for example, how the <computeroutput>other</computeroutput> entry works, the effect of
1752       marking an entry as <computeroutput>required</computeroutput>, <computeroutput>optional</computeroutput>, or
1753       <computeroutput>sufficient</computeroutput>, and so on).</para>
1754
1755       <para>The following instructions explain how to alter the entries in the PAM configuration file for each service for which you
1756       wish to use AFS authentication. Other configurations possibly also work, but the instructions specify the recommended and
1757       tested configuration.</para>
1758
1759       <note>
1760         <para>The instructions specify that you mark each entry as <computeroutput>optional</computeroutput>. However, marking some
1761         modules as optional can mean that they grant access to the corresponding service even when the user does not meet all of the
1762         module's requirements. In some operating system revisions, for example, if you mark as optional the module that controls
1763         login via a dial-up connection, it allows users to login without providing a password. See the <emphasis>OpenAFS Release
1764         Notes</emphasis> for a discussion of any limitations that apply to this operating system.</para>
1765
1766         <para>Also, with some operating system versions you must install patches for PAM to interact correctly with certain
1767         authentication programs. For details, see the <emphasis>OpenAFS Release Notes</emphasis>.</para>
1768       </note>
1769
1770       <para>The recommended AFS-related entries in the PAM configuration file make use of one or more of the following three
1771       attributes. <variablelist>
1772           <title>Authentication Management</title>
1773
1774           <varlistentry>
1775             <term><emphasis role="bold"><computeroutput>try_first_pass</computeroutput></emphasis></term>
1776
1777             <listitem>
1778               <para>This is a standard PAM attribute that can be included on entries after the first one for a service; it directs
1779               the module to use the password that was provided to the first module. For the AFS module, it means that AFS
1780               authentication succeeds if the password provided to the module listed first is the user's correct AFS password. For
1781               further discussion of this attribute and its alternatives, see the operating system's PAM documentation.</para>
1782             </listitem>
1783           </varlistentry>
1784
1785           <varlistentry>
1786             <term><emphasis role="bold"><computeroutput>ignore_root</computeroutput></emphasis></term>
1787
1788             <listitem>
1789               <para>This attribute, specific to the AFS PAM module, directs it to ignore not only the local superuser <emphasis
1790               role="bold">root</emphasis>, but also any user with UID 0 (zero).</para>
1791             </listitem>
1792           </varlistentry>
1793
1794           <varlistentry>
1795             <term><emphasis role="bold"><computeroutput>setenv_password_expires</computeroutput></emphasis></term>
1796
1797             <listitem>
1798               <para>This attribute, specific to the AFS PAM module, sets the environment variable PASSWORD_EXPIRES to the expiration
1799               date of the user's AFS password, which is recorded in the Authentication Database.</para>
1800             </listitem>
1801           </varlistentry>
1802         </variablelist></para>
1803
1804       <para>Perform the following steps to enable AFS login. <orderedlist>
1805           <listitem>
1806             <para>Mount the AFS CD-ROM for Solaris on the <emphasis role="bold">/cdrom</emphasis> directory, if it is not already.
1807             Then change directory as indicated. <programlisting>
1808    # <emphasis role="bold">cd /usr/lib/security</emphasis>
1809 </programlisting></para>
1810           </listitem>
1811
1812           <listitem>
1813             <para>Copy the AFS authentication library file to the <emphasis role="bold">/usr/lib/security</emphasis> directory. Then
1814             create a symbolic link to it whose name does not mention the version. Omitting the version eliminates the need to edit
1815             the PAM configuration file if you later update the library file.</para>
1816
1817             <para>If you use the AFS Authentication Server (<emphasis role="bold">kaserver</emphasis> process):</para>
1818
1819             <programlisting>
1820    # <emphasis role="bold">cp /cdrom/sun4x_56/lib/pam_afs.so.1 .</emphasis>
1821    # <emphasis role="bold">ln -s pam_afs.so.1 pam_afs.so</emphasis>
1822 </programlisting>
1823
1824             <para>If you use a Kerberos implementation of AFS authentication:</para>
1825
1826             <programlisting>
1827    # <emphasis role="bold">cp /cdrom/sun4x_56/lib/pam_afs.krb.so.1 .</emphasis>
1828    # <emphasis role="bold">ln -s pam_afs.krb.so.1 pam_afs.so</emphasis>
1829 </programlisting>
1830           </listitem>
1831
1832           <listitem>
1833             <para>Edit the <computeroutput>Authentication management</computeroutput> section of the Solaris PAM configuration file,
1834             <emphasis role="bold">/etc/pam.conf</emphasis> by convention. The entries in this section have the value
1835             <computeroutput>auth</computeroutput> in their second field.</para>
1836
1837             <para>First edit the standard entries, which refer to the Solaris PAM module (usually, the file <emphasis
1838             role="bold">/usr/lib/security/pam_unix.so.1</emphasis>) in their fourth field. For each service for which you want to
1839             use AFS authentication, edit the third field of its entry to read <computeroutput>optional</computeroutput>. The
1840             <emphasis role="bold">pam.conf</emphasis> file in the Solaris distribution usually includes standard entries for the
1841             <emphasis role="bold">login</emphasis>, <emphasis role="bold">rlogin</emphasis>, and <emphasis
1842             role="bold">rsh</emphasis> services, for instance.</para>
1843
1844             <para>If there are services for which you want to use AFS authentication, but for which the <emphasis
1845             role="bold">pam.conf</emphasis> file does not already include a standard entry, you must create that entry and place the
1846             value <computeroutput>optional</computeroutput> in its third field. For instance, the Solaris <emphasis
1847             role="bold">pam.conf</emphasis> file does not usually include standard entries for the <emphasis
1848             role="bold">ftp</emphasis> or <emphasis role="bold">telnet</emphasis> services.</para>
1849
1850             <para>Then create an AFS-related entry for each service, placing it immediately below the standard entry. The following
1851             example shows what the <computeroutput>Authentication Management</computeroutput> section looks like after you have you
1852             edited or created entries for the services mentioned previously. Note that the example AFS entries appear on two lines
1853             only for legibility.</para>
1854
1855             <programlisting>
1856    login   auth  optional  /usr/lib/security/pam_unix.so.1
1857    login   auth  optional  /usr/lib/security/pam_afs.so       \
1858          try_first_pass  ignore_root  setenv_password_expires
1859    rlogin  auth  optional  /usr/lib/security/pam_unix.so.1
1860    rlogin  auth  optional  /usr/lib/security/pam_afs.so       \
1861          try_first_pass  ignore_root  setenv_password_expires
1862    rsh     auth  optional  /usr/lib/security/pam_unix.so.1
1863    rsh     auth  optional  /usr/lib/security/pam_afs.so       \
1864          try_first_pass  ignore_root
1865    ftp     auth  optional  /usr/lib/security/pam_unix.so.1
1866    ftp     auth  optional  /usr/lib/security/pam_afs.so       \
1867          try_first_pass  ignore_root
1868    telnet  auth  optional  /usr/lib/security/pam_unix.so.1
1869    telnet  auth  optional  /usr/lib/security/pam_afs.so       \
1870          try_first_pass  ignore_root  setenv_password_expires
1871 </programlisting>
1872           </listitem>
1873
1874           <listitem>
1875             <para>If you use the Common Desktop Environment (CDE) on the machine and want users to obtain an AFS token as they log
1876             in, also add or edit the following four entries in the <computeroutput>Authentication management</computeroutput>
1877             section. Note that the AFS-related entries appear on two lines here only for legibility. <programlisting>
1878    dtlogin   auth  optional  /usr/lib/security/pam_unix.so.1
1879    dtlogin   auth  optional  /usr/lib/security/pam_afs.so     \
1880          try_first_pass  ignore_root
1881    dtsession  auth  optional /usr/lib/security/pam_unix.so.1
1882    dtsession  auth  optional /usr/lib/security/pam_afs.so     \
1883          try_first_pass  ignore_root
1884 </programlisting></para>
1885           </listitem>
1886
1887           <listitem>
1888             <para>Some Solaris distributions include a script that locates and removes unneeded files from various file systems. Its
1889             conventional location is <emphasis role="bold">/usr/lib/fs/nfs/nfsfind</emphasis>. The script generally uses an argument
1890             to the <emphasis role="bold">find</emphasis> command to define which file systems to search. In this step you modify the
1891             command to exclude the <emphasis role="bold">/afs</emphasis> directory. Otherwise, the command traverses the AFS
1892             filespace of every cell that is accessible from the machine, which can take many hours. The following alterations are
1893             possibilities, but you must verify that they are appropriate for your cell.</para>
1894
1895             <para>The first possible alteration is to add the <emphasis role="bold">-local</emphasis> flag to the existing command,
1896             so that it looks like the following:</para>
1897
1898             <programlisting>
1899    find $dir -local -name .nfs\* -mtime +7 -mount -exec rm -f {} \;
1900 </programlisting>
1901
1902             <para>Another alternative is to exclude any directories whose names begin with the lowercase letter <emphasis
1903             role="bold">a</emphasis> or a non-alphabetic character.</para>
1904
1905             <programlisting>
1906    find /[A-Zb-z]*  <replaceable>remainder of existing command</replaceable>
1907 </programlisting>
1908
1909             <para>Do not use the following command, which still searches under the <emphasis role="bold">/afs</emphasis> directory,
1910             looking for a subdirectory of type <emphasis role="bold">4.2</emphasis>.</para>
1911
1912             <programlisting>
1913    find / -fstype 4.2     /* <replaceable>do not use</replaceable> */
1914 </programlisting>
1915           </listitem>
1916
1917           <listitem>
1918             <para>Proceed to <link linkend="HDRWQ145">Loading and Creating Client Files</link>.</para>
1919           </listitem>
1920         </orderedlist></para>
1921
1922       <indexterm>
1923         <primary>CD-ROM</primary>
1924
1925         <secondary>copying client files from</secondary>
1926
1927         <tertiary>client machine</tertiary>
1928       </indexterm>
1929
1930       <indexterm>
1931         <primary>client machine</primary>
1932
1933         <secondary>copying client files to local disk</secondary>
1934       </indexterm>
1935
1936       <indexterm>
1937         <primary>copying</primary>
1938
1939         <secondary>client files to local disk</secondary>
1940
1941         <tertiary>client machine</tertiary>
1942       </indexterm>
1943
1944       <indexterm>
1945         <primary>cell name</primary>
1946
1947         <secondary>setting in client ThisCell file</secondary>
1948
1949         <tertiary>client machine</tertiary>
1950       </indexterm>
1951
1952       <indexterm>
1953         <primary>setting</primary>
1954
1955         <secondary>cell name in client ThisCell file</secondary>
1956
1957         <tertiary>client machine</tertiary>
1958       </indexterm>
1959
1960       <indexterm>
1961         <primary>client machine</primary>
1962
1963         <secondary>cell membership</secondary>
1964       </indexterm>
1965
1966       <indexterm>
1967         <primary>client machine</primary>
1968
1969         <secondary>ThisCell file</secondary>
1970       </indexterm>
1971
1972       <indexterm>
1973         <primary>ThisCell file (client)</primary>
1974
1975         <secondary>client machine</secondary>
1976       </indexterm>
1977
1978       <indexterm>
1979         <primary>CellServDB file (client)</primary>
1980
1981         <secondary>creating</secondary>
1982
1983         <tertiary>on client machine</tertiary>
1984       </indexterm>
1985
1986       <indexterm>
1987         <primary>database server machine</primary>
1988
1989         <secondary>entry in client CellServDB file</secondary>
1990
1991         <tertiary>on client machine</tertiary>
1992       </indexterm>
1993
1994       <indexterm>
1995         <primary>creating</primary>
1996
1997         <secondary>CellServDB file (client)</secondary>
1998
1999         <tertiary>client machine</tertiary>
2000       </indexterm>
2001
2002       <indexterm>
2003         <primary>client machine</primary>
2004
2005         <secondary>CellServDB file</secondary>
2006
2007         <tertiary>creating during initial installation</tertiary>
2008       </indexterm>
2009     </sect2>
2010   </sect1>
2011
2012   <sect1 id="HDRWQ145">
2013     <title>Loading and Creating Client Files</title>
2014
2015     <para>Now copy files from the AFS CD-ROM to the <emphasis role="bold">/usr/vice/etc</emphasis> directory. On some platforms that
2016     use a dynamic loader program to incorporate AFS modifications into the kernel, you have already copied over some the files.
2017     Copying them again does no harm.</para>
2018
2019     <para>Every AFS client machine has a copy of the <emphasis role="bold">/usr/vice/etc/ThisCell</emphasis> file on its local disk
2020     to define the machine's cell membership for the AFS client programs that run on it. Among other functions, this file determines
2021     the following: <itemizedlist>
2022         <listitem>
2023           <para>The cell in which users authenticate when they log onto the machine, assuming it is using an AFS-modified login
2024           utility</para>
2025         </listitem>
2026
2027         <listitem>
2028           <para>The cell in which users authenticate by default when they issue the <emphasis role="bold">klog</emphasis>
2029           command</para>
2030         </listitem>
2031
2032         <listitem>
2033           <para>The cell membership of the AFS server processes that the AFS command interpreters on this machine contact by
2034           default</para>
2035         </listitem>
2036       </itemizedlist></para>
2037
2038     <para>Similarly, the <emphasis role="bold">/usr/vice/etc/CellServDB</emphasis> file on a client machine's local disk lists the
2039     database server machines in each cell that the local Cache Manager can contact. If there is no entry in the file for a cell, or
2040     the list of database server machines is wrong, then users working on this machine cannot access the cell. The chapter in the
2041     <emphasis>OpenAFS Administration Guide</emphasis> about administering client machines explains how to maintain the file after
2042     creating it. A version of the client <emphasis role="bold">CellServDB</emphasis> file was created during the installation of
2043     your cell's first machine (in <link linkend="HDRWQ66">Creating the Client CellServDB File</link>). It is probably also
2044     appropriate for use on this machine.</para>
2045
2046     <para>Remember that the Cache Manager consults the <emphasis role="bold">/usr/vice/etc/CellServDB</emphasis> file only at
2047     reboot, when it copies the information into the kernel. For the Cache Manager to perform properly, the <emphasis
2048     role="bold">CellServDB</emphasis> file must be accurate at all times. Refer to the chapter in the <emphasis>OpenAFS
2049     Administration Guide</emphasis> about administering client machines for instructions on updating this file, with or without
2050     rebooting. <orderedlist>
2051         <listitem>
2052           <para>On the local <emphasis role="bold">/cdrom</emphasis> directory, mount the AFS CD-ROM for this machine's system type,
2053           if it is not already. For instructions on mounting CD-ROMs (either locally or remotely via NFS), consult the operating
2054           system documentation.</para>
2055         </listitem>
2056
2057         <listitem>
2058           <para>Copy files to the local <emphasis role="bold">/usr/vice/etc</emphasis> directory.</para>
2059
2060           <para>This step places a copy of the AFS initialization script (and related files, if applicable) into the <emphasis
2061           role="bold">/usr/vice/etc</emphasis> directory. In the preceding instructions for incorporating AFS into the kernel, you
2062           copied the script directly to the operating system's conventional location for initialization files. When you incorporate
2063           AFS into the machine's startup sequence in a later step, you can choose to link the two files.</para>
2064
2065           <para>On some system types that use a dynamic kernel loader program, you previously copied AFS library files into a
2066           subdirectory of the <emphasis role="bold">/usr/vice/etc</emphasis> directory. On other system types, you copied the
2067           appropriate AFS library file directly to the directory where the operating system accesses it. The following commands do
2068           not copy or recopy the AFS library files into the <emphasis role="bold">/usr/vice/etc</emphasis> directory, because on
2069           some system types the library files consume a large amount of space. If you want to copy them, add the <emphasis
2070           role="bold">-r</emphasis> flag to the first <emphasis role="bold">cp</emphasis> command and skip the second <emphasis
2071           role="bold">cp</emphasis> command.</para>
2072
2073           <programlisting>
2074    # <emphasis role="bold">cd /cdrom/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/root.client/usr/vice/etc</emphasis>
2075    # <emphasis role="bold">cp -p  *  /usr/vice/etc</emphasis>
2076    # <emphasis role="bold">cp -rp  C  /usr/vice/etc</emphasis>
2077 </programlisting>
2078         </listitem>
2079
2080         <listitem>
2081           <para>Create the <emphasis role="bold">/usr/vice/etc/ThisCell</emphasis> file. <programlisting>
2082    # <emphasis role="bold">echo "</emphasis><replaceable>cellname</replaceable><emphasis role="bold">" &gt; /usr/vice/etc/ThisCell</emphasis>
2083 </programlisting></para>
2084         </listitem>
2085
2086         <listitem>
2087           <para>Create the <emphasis role="bold">/usr/vice/etc/CellServDB</emphasis> file. Use a network file transfer program such
2088           as <emphasis role="bold">ftp</emphasis> or NFS to copy it from one of the following sources, which are listed in
2089           decreasing order of preference: <itemizedlist>
2090               <listitem>
2091                 <para>Your cell's central <emphasis role="bold">CellServDB</emphasis> source file (the conventional location is
2092                 <emphasis role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
2093                 role="bold">/common/etc/CellServDB</emphasis>)</para>
2094               </listitem>
2095
2096               <listitem>
2097                 <para>The global <emphasis role="bold">CellServDB</emphasis> file maintained by the AFS Product Support group</para>
2098               </listitem>
2099
2100               <listitem>
2101                 <para>An existing client machine in your cell</para>
2102               </listitem>
2103
2104               <listitem>
2105                 <para>The <emphasis role="bold">CellServDB.sample</emphasis> file included in the
2106                 <replaceable>sysname</replaceable><emphasis role="bold">/root.client/usr/vice/etc</emphasis> directory of each AFS
2107                 CD-ROM; add an entry for the local cell by following the instructions in <link linkend="HDRWQ66">Creating the Client
2108                 CellServDB File</link></para>
2109               </listitem>
2110             </itemizedlist></para>
2111         </listitem>
2112       </orderedlist></para>
2113
2114     <indexterm>
2115       <primary>client cache</primary>
2116
2117       <see>cache</see>
2118     </indexterm>
2119
2120     <indexterm>
2121       <primary>AFS cache</primary>
2122
2123       <see>cache</see>
2124     </indexterm>
2125
2126     <indexterm>
2127       <primary>disk cache</primary>
2128
2129       <see>cache</see>
2130     </indexterm>
2131
2132     <indexterm>
2133       <primary>memory cache</primary>
2134
2135       <see>cache</see>
2136     </indexterm>
2137
2138     <indexterm>
2139       <primary>cache</primary>
2140
2141       <secondary>requirements</secondary>
2142     </indexterm>
2143
2144     <indexterm>
2145       <primary>cache</primary>
2146
2147       <secondary>choosing size</secondary>
2148     </indexterm>
2149
2150     <indexterm>
2151       <primary>requirements</primary>
2152
2153       <secondary>cache</secondary>
2154     </indexterm>
2155
2156     <indexterm>
2157       <primary>usr/vice/etc/cacheinfo</primary>
2158
2159       <see>cacheinfo file</see>
2160     </indexterm>
2161
2162     <indexterm>
2163       <primary>cacheinfo file</primary>
2164     </indexterm>
2165
2166     <indexterm>
2167       <primary>files</primary>
2168
2169       <secondary>cacheinfo</secondary>
2170     </indexterm>
2171
2172     <indexterm>
2173       <primary>usr/vice/cache directory</primary>
2174     </indexterm>
2175
2176     <indexterm>
2177       <primary>directories</primary>
2178
2179       <secondary>/usr/vice/cache</secondary>
2180     </indexterm>
2181
2182     <indexterm>
2183       <primary>cache</primary>
2184
2185       <secondary>configuring</secondary>
2186
2187       <tertiary>client machine</tertiary>
2188     </indexterm>
2189
2190     <indexterm>
2191       <primary>configuring</primary>
2192
2193       <secondary>cache</secondary>
2194
2195       <tertiary>client machine</tertiary>
2196     </indexterm>
2197
2198     <indexterm>
2199       <primary>setting</primary>
2200
2201       <secondary>cache size and location</secondary>
2202
2203       <tertiary>client machine</tertiary>
2204     </indexterm>
2205
2206     <indexterm>
2207       <primary>client machine</primary>
2208
2209       <secondary>cache size and location</secondary>
2210     </indexterm>
2211   </sect1>
2212
2213   <sect1 id="HDRWQ146">
2214     <title>Configuring the Cache</title>
2215
2216     <para>The Cache Manager uses a cache on the local disk or in machine memory to store local copies of files fetched from file
2217     server machines. As the <emphasis role="bold">afsd</emphasis> program initializes the Cache Manager, it sets basic cache
2218     configuration parameters according to definitions in the local <emphasis role="bold">/usr/vice/etc/cacheinfo</emphasis> file.
2219     The file has three fields: <orderedlist>
2220         <listitem>
2221           <para>The first field names the local directory on which to mount the AFS filespace. The conventional location is the
2222           <emphasis role="bold">/afs</emphasis> directory.</para>
2223         </listitem>
2224
2225         <listitem>
2226           <para>The second field defines the local disk directory to use for the disk cache. The conventional location is the
2227           <emphasis role="bold">/usr/vice/cache</emphasis> directory, but you can specify an alternate directory if another
2228           partition has more space available. There must always be a value in this field, but the Cache Manager ignores it if the
2229           machine uses a memory cache.</para>
2230         </listitem>
2231
2232         <listitem>
2233           <para>The third field specifies the number of kilobyte (1024 byte) blocks to allocate for the cache.</para>
2234         </listitem>
2235       </orderedlist></para>
2236
2237     <para>The values you define must meet the following requirements. <itemizedlist>
2238         <listitem>
2239           <para>On a machine using a disk cache, the Cache Manager expects always to be able to use the amount of space specified in
2240           the third field. Failure to meet this requirement can cause serious problems, some of which can be repaired only by
2241           rebooting. You must prevent non-AFS processes from filling up the cache partition. The simplest way is to devote a
2242           partition to the cache exclusively.</para>
2243         </listitem>
2244
2245         <listitem>
2246           <para>The amount of space available in memory or on the partition housing the disk cache directory imposes an absolute
2247           limit on cache size.</para>
2248         </listitem>
2249
2250         <listitem>
2251           <para>The maximum supported cache size can vary in each AFS release; see the <emphasis>OpenAFS Release Notes</emphasis>
2252           for the current version.</para>
2253         </listitem>
2254
2255         <listitem>
2256           <para>For a disk cache, you cannot specify a value in the third field that exceeds 95% of the space available on the
2257           partition mounted at the directory named in the second field. If you violate this restriction, the <emphasis
2258           role="bold">afsd</emphasis> program exits without starting the Cache Manager and prints an appropriate message on the
2259           standard output stream. A value of 90% is more appropriate on most machines. Some operating systems (such as AIX) do not
2260           automatically reserve some space to prevent the partition from filling completely; for them, a smaller value (say, 80% to
2261           85% of the space available) is more appropriate.</para>
2262         </listitem>
2263
2264         <listitem>
2265           <para>For a memory cache, you must leave enough memory for other processes and applications to run. If you try to allocate
2266           more memory than is actually available, the <emphasis role="bold">afsd</emphasis> program exits without initializing the
2267           Cache Manager and produces the following message on the standard output stream. <programlisting>
2268    afsd: memCache allocation failure at <replaceable>number</replaceable> KB
2269 </programlisting></para>
2270
2271           <para>The <replaceable>number</replaceable> value is how many kilobytes were allocated just before the failure, and so
2272           indicates the approximate amount of memory available.</para>
2273         </listitem>
2274       </itemizedlist></para>
2275
2276     <para>Within these hard limits, the factors that determine appropriate cache size include the number of users working on the
2277     machine, the size of the files with which they work, and (for a memory cache) the number of processes that run on the machine.
2278     The higher the demand from these factors, the larger the cache needs to be to maintain good performance.</para>
2279
2280     <para>Disk caches smaller than 10 MB do not generally perform well. Machines serving multiple users usually perform better with
2281     a cache of at least 60 to 70 MB. The point at which enlarging the cache further does not really improve performance depends on
2282     the factors mentioned previously and is difficult to predict.</para>
2283
2284     <para>Memory caches smaller than 1 MB are nonfunctional, and the performance of caches smaller than 5 MB is usually
2285     unsatisfactory. Suitable upper limits are similar to those for disk caches but are probably determined more by the demands on
2286     memory from other sources on the machine (number of users and processes). Machines running only a few processes possibly can use
2287     a smaller memory cache.</para>
2288
2289     <sect2 id="HDRWQ147">
2290       <title>Configuring a Disk Cache</title>
2291
2292       <note>
2293         <para>Not all file system types that an operating system supports are necessarily supported for use as the cache partition.
2294         For possible restrictions, see the <emphasis>OpenAFS Release Notes</emphasis>.</para>
2295       </note>
2296
2297       <para>To configure the disk cache, perform the following procedures: <orderedlist>
2298           <listitem>
2299             <para>Create the local directory to use for caching. The following instruction shows the conventional location,
2300             <emphasis role="bold">/usr/vice/cache</emphasis>. If you are devoting a partition exclusively to caching, as
2301             recommended, you must also configure it, make a file system on it, and mount it at the directory created in this step.
2302             <programlisting>
2303    # <emphasis role="bold">mkdir /usr/vice/cache</emphasis>
2304 </programlisting></para>
2305           </listitem>
2306
2307           <listitem>
2308             <para>Create the <emphasis role="bold">cacheinfo</emphasis> file to define the configuration parameters discussed
2309             previously. The following instruction shows the standard mount location, <emphasis role="bold">/afs</emphasis>, and the
2310             standard cache location, <emphasis role="bold">/usr/vice/cache</emphasis>. <programlisting>
2311    # <emphasis role="bold">echo "/afs:/usr/vice/cache:</emphasis><replaceable>#blocks</replaceable><emphasis role="bold">" &gt; /usr/vice/etc/cacheinfo</emphasis>
2312 </programlisting></para>
2313
2314             <para>The following example defines the disk cache size as 50,000 KB:</para>
2315
2316             <programlisting>
2317    # <emphasis role="bold">echo "/afs:/usr/vice/cache:50000" &gt; /usr/vice/etc/cacheinfo</emphasis>
2318 </programlisting>
2319           </listitem>
2320         </orderedlist></para>
2321     </sect2>
2322
2323     <sect2 id="HDRWQ148">
2324       <title>Configuring a Memory Cache</title>
2325
2326       <para>To configure a memory cache, create the <emphasis role="bold">cacheinfo</emphasis> file to define the configuration
2327       parameters discussed previously. The following instruction shows the standard mount location, <emphasis
2328       role="bold">/afs</emphasis>, and the standard cache location, <emphasis role="bold">/usr/vice/cache</emphasis> (though the
2329       exact value of the latter is irrelevant for a memory cache).</para>
2330
2331       <programlisting>
2332    # <emphasis role="bold">echo "/afs:/usr/vice/cache:</emphasis><replaceable>#blocks</replaceable><emphasis role="bold">" &gt; /usr/vice/etc/cacheinfo</emphasis>
2333 </programlisting>
2334
2335       <para>The following example allocates 25,000 KB of memory for the cache.</para>
2336
2337       <programlisting>
2338    # <emphasis role="bold">echo "/afs:/usr/vice/cache:25000" &gt; /usr/vice/etc/cacheinfo</emphasis>
2339 </programlisting>
2340
2341       <indexterm>
2342         <primary>afs (/afs) directory</primary>
2343
2344         <secondary>creating</secondary>
2345
2346         <tertiary>client machine</tertiary>
2347       </indexterm>
2348
2349       <indexterm>
2350         <primary>afs (/afs) directory</primary>
2351
2352         <secondary>as root of AFS filespace</secondary>
2353       </indexterm>
2354
2355       <indexterm>
2356         <primary>AFS filespace</primary>
2357
2358         <secondary>root at /afs directory</secondary>
2359       </indexterm>
2360
2361       <indexterm>
2362         <primary>directories</primary>
2363
2364         <secondary>/afs</secondary>
2365       </indexterm>
2366
2367       <indexterm>
2368         <primary>afsd</primary>
2369
2370         <secondary>options file (Linux)</secondary>
2371       </indexterm>
2372
2373       <indexterm>
2374         <primary>files</primary>
2375
2376         <secondary>afsd options file (Linux)</secondary>
2377       </indexterm>
2378
2379       <indexterm>
2380         <primary>files</primary>
2381
2382         <secondary>afs</secondary>
2383
2384         <tertiary>afsd options file (Linux)</tertiary>
2385       </indexterm>
2386
2387       <indexterm>
2388         <primary>afs file</primary>
2389
2390         <secondary>afsd options file (Linux)</secondary>
2391       </indexterm>
2392
2393       <indexterm>
2394         <primary>etc/sysconfig/afs</primary>
2395
2396         <see>afs file</see>
2397       </indexterm>
2398
2399       <indexterm>
2400         <primary>Linux</primary>
2401
2402         <secondary>afsd options file</secondary>
2403       </indexterm>
2404
2405       <indexterm>
2406         <primary>client machine</primary>
2407
2408         <secondary>afsd options file (Linux)</secondary>
2409       </indexterm>
2410
2411       <indexterm>
2412         <primary>afsd</primary>
2413
2414         <secondary>command in AFS init. script</secondary>
2415       </indexterm>
2416
2417       <indexterm>
2418         <primary>commands</primary>
2419
2420         <secondary>afsd</secondary>
2421       </indexterm>
2422
2423       <indexterm>
2424         <primary>OPTIONS variable in AFS initialization file</primary>
2425       </indexterm>
2426
2427       <indexterm>
2428         <primary>files</primary>
2429
2430         <secondary>AFS initialization</secondary>
2431
2432         <see>AFS initialization script</see>
2433       </indexterm>
2434
2435       <indexterm>
2436         <primary>scripts</primary>
2437
2438         <secondary>AFS initialization</secondary>
2439
2440         <see>AFS initialization script</see>
2441       </indexterm>
2442
2443       <indexterm>
2444         <primary>AFS initialization script</primary>
2445
2446         <secondary>setting afsd parameters</secondary>
2447
2448         <tertiary>client machine</tertiary>
2449       </indexterm>
2450
2451       <indexterm>
2452         <primary>client machine</primary>
2453
2454         <secondary>afsd command parameters</secondary>
2455       </indexterm>
2456
2457       <indexterm>
2458         <primary>variables</primary>
2459
2460         <secondary>OPTIONS (in AFS initialization file)</secondary>
2461       </indexterm>
2462
2463       <indexterm>
2464         <primary>environment variables</primary>
2465
2466         <see>variables</see>
2467       </indexterm>
2468
2469       <indexterm>
2470         <primary>Cache Manager</primary>
2471
2472         <secondary>client machine</secondary>
2473       </indexterm>
2474
2475       <indexterm>
2476         <primary>configuring</primary>
2477
2478         <secondary>Cache Manager</secondary>
2479
2480         <tertiary>client machine</tertiary>
2481       </indexterm>
2482
2483       <indexterm>
2484         <primary>client machine</primary>
2485
2486         <secondary>Cache Manager</secondary>
2487       </indexterm>
2488
2489       <indexterm>
2490         <primary>files</primary>
2491
2492         <secondary>vfs (AIX)</secondary>
2493       </indexterm>
2494
2495       <indexterm>
2496         <primary>vfs file</primary>
2497       </indexterm>
2498
2499       <indexterm>
2500         <primary>etc/vfs file</primary>
2501       </indexterm>
2502
2503       <indexterm>
2504         <primary>AIX</primary>
2505
2506         <secondary>editing /etc/vfs file</secondary>
2507       </indexterm>
2508
2509       <indexterm>
2510         <primary>client machine</primary>
2511
2512         <secondary>vfs file (AIX)</secondary>
2513       </indexterm>
2514     </sect2>
2515   </sect1>
2516
2517   <sect1 id="HDRWQ149">
2518     <title>Configuring the Cache Manager</title>
2519
2520     <para>By convention, the Cache Manager mounts the AFS filespace on the local <emphasis role="bold">/afs</emphasis> directory. In
2521     this section you create that directory.</para>
2522
2523     <para>The <emphasis role="bold">afsd</emphasis> program sets several cache configuration parameters as it initializes the Cache
2524     Manager, and starts daemons that improve performance. You can use the <emphasis role="bold">afsd</emphasis> command's arguments
2525     to override the parameters' default values and to change the number of some of the daemons. Depending on the machine's cache
2526     size, its amount of RAM, and how many people work on it, you can sometimes improve Cache Manager performance by overriding the
2527     default values. For a discussion of all of the <emphasis role="bold">afsd</emphasis> command's arguments, see its reference page
2528     in the <emphasis>OpenAFS Administration Reference</emphasis>.</para>
2529
2530     <para>The <emphasis role="bold">afsd</emphasis> command line in the AFS initialization script on each system type includes an
2531     <computeroutput>OPTIONS</computeroutput> variable. You can use it to set nondefault values for the command's arguments, in one
2532     of the following ways: <itemizedlist>
2533         <listitem>
2534           <para>You can create an <emphasis role="bold">afsd</emphasis> <emphasis>options file</emphasis> that sets values for
2535           arguments to the <emphasis role="bold">afsd</emphasis> command. If the file exists, its contents are automatically
2536           substituted for the <computeroutput>OPTIONS</computeroutput> variable in the AFS initialization script. The AFS
2537           distribution for some system types includes an options file; on other system types, you must create it.</para>
2538
2539           <para>You use two variables in the AFS initialization script to specify the path to the options file:
2540           <computeroutput>CONFIG</computeroutput> and <computeroutput>AFSDOPT</computeroutput>. On system types that define a
2541           conventional directory for configuration files, the <computeroutput>CONFIG</computeroutput> variable indicates it by
2542           default; otherwise, the variable indicates an appropriate location.</para>
2543
2544           <para>List the desired <emphasis role="bold">afsd</emphasis> options on a single line in the options file, separating each
2545           option with one or more spaces. The following example sets the <emphasis role="bold">-stat</emphasis> argument to 2500,
2546           the <emphasis role="bold">-daemons</emphasis> argument to 4, and the <emphasis role="bold">-volumes</emphasis> argument to
2547           100.</para>
2548
2549           <programlisting>
2550    -stat 2500 -daemons 4 -volumes 100
2551 </programlisting>
2552         </listitem>
2553
2554         <listitem>
2555           <para>On a machine that uses a disk cache, you can set the <computeroutput>OPTIONS</computeroutput> variable in the AFS
2556           initialization script to one of <computeroutput>$SMALL</computeroutput>, <computeroutput>$MEDIUM</computeroutput>, or
2557           <computeroutput>$LARGE</computeroutput>. The AFS initialization script uses one of these settings if the <emphasis
2558           role="bold">afsd</emphasis> options file named by the <computeroutput>AFSDOPT</computeroutput> variable does not exist. In
2559           the script as distributed, the <computeroutput>OPTIONS</computeroutput> variable is set to the value
2560           <computeroutput>$MEDIUM</computeroutput>.</para>
2561
2562           <note>
2563             <para>Do not set the <computeroutput>OPTIONS</computeroutput> variable to <computeroutput>$SMALL</computeroutput>,
2564             <computeroutput>$MEDIUM</computeroutput>, or <computeroutput>$LARGE</computeroutput> on a machine that uses a memory
2565             cache. The arguments it sets are appropriate only on a machine that uses a disk cache.</para>
2566           </note>
2567
2568           <para>The script (or on some system types the <emphasis role="bold">afsd</emphasis> options file named by the
2569           <computeroutput>AFSDOPT</computeroutput> variable) defines a value for each of <computeroutput>SMALL</computeroutput>,
2570           <computeroutput>MEDIUM</computeroutput>, and <computeroutput>LARGE</computeroutput> that sets <emphasis
2571           role="bold">afsd</emphasis> command arguments appropriately for client machines of different sizes: <itemizedlist>
2572               <listitem>
2573                 <para><computeroutput>SMALL</computeroutput> is suitable for a small machine that serves one or two users and has
2574                 approximately 8 MB of RAM and a 20-MB cache</para>
2575               </listitem>
2576
2577               <listitem>
2578                 <para><computeroutput>MEDIUM</computeroutput> is suitable for a medium-sized machine that serves two to six users
2579                 and has 16 MB of RAM and a 40-MB cache</para>
2580               </listitem>
2581
2582               <listitem>
2583                 <para><computeroutput>LARGE</computeroutput> is suitable for a large machine that serves five to ten users and has
2584                 32 MB of RAM and a 100-MB cache</para>
2585               </listitem>
2586             </itemizedlist></para>
2587         </listitem>
2588
2589         <listitem>
2590           <para>You can choose not to create an <emphasis role="bold">afsd</emphasis> options file and to set the
2591           <computeroutput>OPTIONS</computeroutput> variable in the initialization script to a null value rather than to the default
2592           <computeroutput>$MEDIUM</computeroutput> value. You can then either set arguments directly on the <emphasis
2593           role="bold">afsd</emphasis> command line in the script, or set no arguments (and so accept default values for all Cache
2594           Manager parameters).</para>
2595         </listitem>
2596       </itemizedlist> <orderedlist>
2597         <listitem>
2598           <para>Create the local directory on which to mount the AFS filespace, by convention <emphasis role="bold">/afs</emphasis>.
2599           If the directory already exists, verify that it is empty. <programlisting>
2600    # <emphasis role="bold">mkdir /afs</emphasis>
2601 </programlisting></para>
2602         </listitem>
2603
2604         <listitem>
2605           <para>On AIX systems, add the following line to the <emphasis role="bold">/etc/vfs</emphasis> file. It enables AIX to
2606           unmount AFS correctly during shutdown. <programlisting>
2607    afs     4     none     none
2608 </programlisting></para>
2609         </listitem>
2610
2611         <listitem>
2612           <para>On Linux systems, copy the <emphasis role="bold">afsd</emphasis> options file from the <emphasis
2613           role="bold">/usr/vice/etc</emphasis> directory to the <emphasis role="bold">/etc/sysconfig</emphasis> directory, removing
2614           the <emphasis role="bold">.conf</emphasis> extension as you do so. <programlisting>
2615    # <emphasis role="bold">cp /usr/vice/etc/afs.conf /etc/sysconfig/afs</emphasis>
2616 </programlisting></para>
2617         </listitem>
2618
2619         <listitem>
2620           <para>Edit the machine's AFS initialization script or <emphasis role="bold">afsd</emphasis> options file to set
2621           appropriate values for <emphasis role="bold">afsd</emphasis> command parameters. The appropriate file for each system type
2622           is as follows: <itemizedlist>
2623               <listitem>
2624                 <para>On AIX systems, <emphasis role="bold">/etc/rc.afs</emphasis></para>
2625               </listitem>
2626
2627               <listitem>
2628                 <para>On HP-UX systems, <emphasis role="bold">/sbin/init.d/afs</emphasis></para>
2629               </listitem>
2630
2631               <listitem>
2632                 <para>On IRIX systems, <emphasis role="bold">/etc/init.d/afs</emphasis></para>
2633               </listitem>
2634
2635               <listitem>
2636                 <para>On Linux systems, <emphasis role="bold">/etc/sysconfig/afs</emphasis> (the <emphasis
2637                 role="bold">afsd</emphasis> options file)</para>
2638               </listitem>
2639
2640               <listitem>
2641                 <para>On Solaris systems, <emphasis role="bold">/etc/init.d/afs</emphasis></para>
2642               </listitem>
2643             </itemizedlist></para>
2644
2645           <para>Use one of the methods described in the introduction to this section to add the following flags to the <emphasis
2646           role="bold">afsd</emphasis> command line. Also set any performance-related arguments you wish. <itemizedlist>
2647               <listitem>
2648                 <para>Add the <emphasis role="bold">-memcache</emphasis> flag if the machine is to use a memory cache.</para>
2649               </listitem>
2650
2651               <listitem>
2652                 <para>Add the <emphasis role="bold">-verbose</emphasis> flag to display a trace of the Cache Manager's
2653                 initialization on the standard output stream.</para>
2654               </listitem>
2655             </itemizedlist></para>
2656         </listitem>
2657       </orderedlist></para>
2658
2659     <indexterm>
2660       <primary>AFS initialization script</primary>
2661
2662       <secondary>running</secondary>
2663
2664       <tertiary>client machine</tertiary>
2665     </indexterm>
2666
2667     <indexterm>
2668       <primary>client machine</primary>
2669
2670       <secondary>AFS initialization script</secondary>
2671     </indexterm>
2672
2673     <indexterm>
2674       <primary>running AFS init. script</primary>
2675
2676       <secondary>client machine</secondary>
2677     </indexterm>
2678
2679     <indexterm>
2680       <primary>installing</primary>
2681
2682       <secondary>AFS initialization script</secondary>
2683
2684       <tertiary>client machine</tertiary>
2685     </indexterm>
2686
2687     <indexterm>
2688       <primary>AFS initialization script</primary>
2689
2690       <secondary>adding to machine startup sequence</secondary>
2691
2692       <tertiary>client machine</tertiary>
2693     </indexterm>
2694   </sect1>
2695
2696   <sect1 id="HDRWQ150">
2697     <title>Starting the Cache Manager and Installing the AFS Initialization Script</title>
2698
2699     <para>In this section you run the AFS initialization script to start the Cache Manager. If the script works correctly, perform
2700     the steps that incorporate it into the machine's startup and shutdown sequence. If there are problems during the initialization,
2701     attempt to resolve them. The AFS Product Support group can provide assistance if necessary.</para>
2702
2703     <para>On machines that use a disk cache, it can take a while for the <emphasis role="bold">afsd</emphasis> program to run the
2704     first time on a machine, because it must create all of the <emphasis role="bold">V</emphasis><replaceable>n</replaceable> files
2705     in the cache directory. Subsequent Cache Manager initializations do not take nearly as long, because the <emphasis
2706     role="bold">V</emphasis><replaceable>n</replaceable> files already exist.</para>
2707
2708     <para>On system types that use a dynamic loader program, you must reboot the machine before running the initialization script,
2709     so that it can freshly load AFS modifications into the kernel.</para>
2710
2711     <para>Proceed to the instructions for your system type:</para>
2712
2713     <itemizedlist>
2714       <listitem>
2715         <para><link linkend="HDRWQ151">Running the Script on AIX Systems</link></para>
2716       </listitem>
2717
2718       <listitem>
2719         <para><link linkend="HDRWQ153">Running the Script on HP-UX Systems</link></para>
2720       </listitem>
2721
2722       <listitem>
2723         <para><link linkend="HDRWQ154">Running the Script on IRIX Systems</link></para>
2724       </listitem>
2725
2726       <listitem>
2727         <para><link linkend="HDRWQ155">Running the Script on Linux Systems</link></para>
2728       </listitem>
2729
2730       <listitem>
2731         <para><link linkend="HDRWQ156">Running the Script on Solaris Systems</link></para>
2732       </listitem>
2733     </itemizedlist>
2734
2735     <indexterm>
2736       <primary>AIX</primary>
2737
2738       <secondary>AFS initialization script</secondary>
2739
2740       <tertiary>on client machine</tertiary>
2741     </indexterm>
2742
2743     <indexterm>
2744       <primary>rc.afs file (AFS init. file for AIX)</primary>
2745     </indexterm>
2746
2747     <indexterm>
2748       <primary>files</primary>
2749
2750       <secondary>rc.afs</secondary>
2751     </indexterm>
2752
2753     <indexterm>
2754       <primary>etc/rc.afs</primary>
2755
2756       <see>rc.afs file</see>
2757     </indexterm>
2758
2759     <sect2 id="HDRWQ151">
2760       <title>Running the Script on AIX Systems</title>
2761
2762       <orderedlist>
2763         <listitem>
2764           <para>Reboot the machine and log in again as the local superuser <emphasis role="bold">root</emphasis>. <programlisting>
2765    # <emphasis role="bold">cd /</emphasis>
2766    # <emphasis role="bold">shutdown -r now</emphasis>
2767    login: <emphasis role="bold">root</emphasis>
2768    Password: <replaceable>root_password</replaceable>
2769 </programlisting></para>
2770         </listitem>
2771
2772         <listitem>
2773           <para>Run the AFS initialization script. <programlisting>
2774    # <emphasis role="bold">/etc/rc.afs</emphasis>
2775 </programlisting></para>
2776         </listitem>
2777
2778         <listitem>
2779           <para>Edit the AIX initialization file, <emphasis role="bold">/etc/inittab</emphasis>, adding the following line to invoke
2780           the AFS initialization script. Place it just after the line that starts NFS daemons. <programlisting>
2781    rcafs:2:wait:/etc/rc.afs &gt; /dev/console 2&gt;&amp;1 # Start AFS services
2782 </programlisting></para>
2783         </listitem>
2784
2785         <listitem>
2786           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
2787           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc</emphasis> directories. If you want to avoid
2788           potential confusion by guaranteeing that they are always the same, create a link between them. You can always retrieve the
2789           original script from the AFS CD-ROM if necessary. <programlisting>
2790    # <emphasis role="bold">cd  /usr/vice/etc</emphasis>
2791    # <emphasis role="bold">rm  rc.afs</emphasis>
2792    # <emphasis role="bold">ln -s  /etc/rc.afs</emphasis>
2793 </programlisting></para>
2794         </listitem>
2795
2796         <listitem>
2797           <para>If a volume for housing AFS binaries for this machine's system type does not already exist, proceed to <link
2798           linkend="HDRWQ157">Setting Up Volumes and Loading Binaries into AFS</link>. Otherwise, the installation is
2799           complete.</para>
2800         </listitem>
2801       </orderedlist>
2802
2803       <indexterm>
2804         <primary>afs file</primary>
2805
2806         <secondary>AFS initialization file</secondary>
2807       </indexterm>
2808
2809       <indexterm>
2810         <primary>files</primary>
2811
2812         <secondary>afs</secondary>
2813
2814         <tertiary>AFS initialization file</tertiary>
2815       </indexterm>
2816
2817       <indexterm>
2818         <primary>HP-UX</primary>
2819
2820         <secondary>AFS initialization script</secondary>
2821
2822         <tertiary>on client machine</tertiary>
2823       </indexterm>
2824     </sect2>
2825
2826     <sect2 id="HDRWQ153">
2827       <title>Running the Script on HP-UX Systems</title>
2828
2829       <orderedlist>
2830         <listitem>
2831           <para>Run the AFS initialization script. <programlisting>
2832    # <emphasis role="bold">/sbin/init.d/afs  start</emphasis>
2833 </programlisting></para>
2834         </listitem>
2835
2836         <listitem>
2837           <para>Change to the <emphasis role="bold">/sbin/init.d</emphasis> directory and issue the <emphasis role="bold">ln
2838           -s</emphasis> command to create symbolic links that incorporate the AFS initialization script into the HP-UX startup and
2839           shutdown sequence. <programlisting>
2840    # <emphasis role="bold">cd /sbin/init.d</emphasis>
2841    # <emphasis role="bold">ln -s ../init.d/afs /sbin/rc2.d/S460afs</emphasis>
2842    # <emphasis role="bold">ln -s ../init.d/afs /sbin/rc2.d/K800afs</emphasis>
2843 </programlisting></para>
2844         </listitem>
2845
2846         <listitem>
2847           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
2848           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/sbin/init.d</emphasis> directories. If you want
2849           to avoid potential confusion by guaranteeing that they are always the same, create a link between them. You can always
2850           retrieve the original script from the AFS CD-ROM if necessary. <programlisting>
2851    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
2852    # <emphasis role="bold">rm afs.rc</emphasis>
2853    # <emphasis role="bold">ln -s  /sbin/init.d/afs  afs.rc</emphasis>
2854 </programlisting></para>
2855         </listitem>
2856
2857         <listitem>
2858           <para>If a volume for housing AFS binaries for this machine's system type does not already exist, proceed to <link
2859           linkend="HDRWQ157">Setting Up Volumes and Loading Binaries into AFS</link>. Otherwise, the installation is
2860           complete.</para>
2861         </listitem>
2862       </orderedlist>
2863
2864       <indexterm>
2865         <primary>afs file</primary>
2866
2867         <secondary>AFS initialization file</secondary>
2868       </indexterm>
2869
2870       <indexterm>
2871         <primary>files</primary>
2872
2873         <secondary>afs</secondary>
2874
2875         <tertiary>AFS initialization file</tertiary>
2876       </indexterm>
2877
2878       <indexterm>
2879         <primary>IRIX</primary>
2880
2881         <secondary>AFS initialization script</secondary>
2882
2883         <tertiary>on client machine</tertiary>
2884       </indexterm>
2885
2886       <indexterm>
2887         <primary>etc/init.d/afs</primary>
2888
2889         <see>afs file</see>
2890       </indexterm>
2891
2892       <indexterm>
2893         <primary>afsclient variable (IRIX)</primary>
2894
2895         <secondary>client machine</secondary>
2896       </indexterm>
2897
2898       <indexterm>
2899         <primary>variables</primary>
2900
2901         <secondary>afsclient (IRIX)</secondary>
2902
2903         <tertiary>client machine</tertiary>
2904       </indexterm>
2905
2906       <indexterm>
2907         <primary>IRIX</primary>
2908
2909         <secondary>afsclient variable</secondary>
2910
2911         <tertiary>client machine</tertiary>
2912       </indexterm>
2913     </sect2>
2914
2915     <sect2 id="HDRWQ154">
2916       <title>Running the Script on IRIX Systems</title>
2917
2918       <orderedlist>
2919         <listitem>
2920           <para>If you have configured the machine to use the <emphasis role="bold">ml</emphasis> dynamic loader program, reboot the
2921           machine and log in again as the local superuser <emphasis role="bold">root</emphasis>. <programlisting>
2922    # <emphasis role="bold">cd /</emphasis>
2923    # <emphasis role="bold">shutdown -i6 -g0 -y</emphasis>
2924    login: <emphasis role="bold">root</emphasis>
2925    Password: <replaceable>root_password</replaceable>
2926 </programlisting></para>
2927         </listitem>
2928
2929         <listitem>
2930           <para>Issue the <emphasis role="bold">chkconfig</emphasis> command to activate the <emphasis
2931           role="bold">afsclient</emphasis> configuration variable. <programlisting>
2932    # <emphasis role="bold">/etc/chkconfig -f afsclient on</emphasis>
2933 </programlisting></para>
2934         </listitem>
2935
2936         <listitem>
2937           <para>Run the AFS initialization script. <programlisting>
2938    # <emphasis role="bold">/etc/init.d/afs  start</emphasis>
2939 </programlisting></para>
2940         </listitem>
2941
2942         <listitem>
2943           <para>Change to the <emphasis role="bold">/etc/init.d</emphasis> directory and issue the <emphasis role="bold">ln
2944           -s</emphasis> command to create symbolic links that incorporate the AFS initialization script into the IRIX startup and
2945           shutdown sequence. <programlisting>
2946    # <emphasis role="bold">cd /etc/init.d</emphasis>
2947    # <emphasis role="bold">ln -s ../init.d/afs /etc/rc2.d/S35afs</emphasis>
2948    # <emphasis role="bold">ln -s ../init.d/afs /etc/rc0.d/K35afs</emphasis>
2949 </programlisting></para>
2950         </listitem>
2951
2952         <listitem>
2953           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
2954           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc/init.d</emphasis> directories. If you want
2955           to avoid potential confusion by guaranteeing that they are always the same, create a link between them. You can always
2956           retrieve the original script from the AFS CD-ROM if necessary. <programlisting>
2957    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
2958    # <emphasis role="bold">rm afs.rc</emphasis>
2959    # <emphasis role="bold">ln -s  /etc/init.d/afs  afs.rc</emphasis>
2960 </programlisting></para>
2961         </listitem>
2962
2963         <listitem>
2964           <para>If a volume for housing AFS binaries for this machine's system type does not already exist, proceed to <link
2965           linkend="HDRWQ157">Setting Up Volumes and Loading Binaries into AFS</link>. Otherwise, the installation is
2966           complete.</para>
2967         </listitem>
2968       </orderedlist>
2969
2970       <indexterm>
2971         <primary>afs file</primary>
2972
2973         <secondary>AFS initialization file</secondary>
2974       </indexterm>
2975
2976       <indexterm>
2977         <primary>files</primary>
2978
2979         <secondary>afs</secondary>
2980
2981         <tertiary>AFS initialization file</tertiary>
2982       </indexterm>
2983
2984       <indexterm>
2985         <primary>etc/rc.d/init.d/afs</primary>
2986
2987         <see>afs file</see>
2988       </indexterm>
2989
2990       <indexterm>
2991         <primary>Linux</primary>
2992
2993         <secondary>AFS initialization script</secondary>
2994
2995         <tertiary>on client machine</tertiary>
2996       </indexterm>
2997     </sect2>
2998
2999     <sect2 id="HDRWQ155">
3000       <title>Running the Script on Linux Systems</title>
3001
3002       <orderedlist>
3003         <listitem>
3004           <para>Reboot the machine and log in again as the local superuser <emphasis role="bold">root</emphasis>. <programlisting>
3005    # <emphasis role="bold">cd /</emphasis>
3006    # <emphasis role="bold">shutdown -r now</emphasis>
3007    login: <emphasis role="bold">root</emphasis>
3008    Password: <replaceable>root_password</replaceable>
3009 </programlisting></para>
3010         </listitem>
3011
3012         <listitem>
3013           <para>Run the AFS initialization script. <programlisting>
3014    # <emphasis role="bold">/etc/rc.d/init.d/afs  start</emphasis>
3015 </programlisting></para>
3016         </listitem>
3017
3018         <listitem>
3019           <para>Issue the <emphasis role="bold">chkconfig</emphasis> command to activate the <emphasis role="bold">afs</emphasis>
3020           configuration variable. Based on the instruction in the AFS initialization file that begins with the string
3021           <computeroutput>#chkconfig</computeroutput>, the command automatically creates the symbolic links that incorporate the
3022           script into the Linux startup and shutdown sequence. <programlisting>
3023    # <emphasis role="bold">/sbin/chkconfig  --add afs</emphasis>
3024 </programlisting></para>
3025         </listitem>
3026
3027         <listitem>
3028           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
3029           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc/rc.d/init.d</emphasis> directories, and
3030           copies of the <emphasis role="bold">afsd</emphasis> options file in both the <emphasis
3031           role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc/sysconfig</emphasis> directories. If you want to avoid
3032           potential confusion by guaranteeing that the two copies of each file are always the same, create a link between them. You
3033           can always retrieve the original script or options file from the AFS CD-ROM if necessary. <programlisting>
3034    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
3035    # <emphasis role="bold">rm afs.rc afs.conf</emphasis>
3036    # <emphasis role="bold">ln -s  /etc/rc.d/init.d/afs  afs.rc</emphasis>
3037    # <emphasis role="bold">ln -s  /etc/sysconfig/afs  afs.conf</emphasis>
3038 </programlisting></para>
3039         </listitem>
3040
3041         <listitem>
3042           <para>If a volume for housing AFS binaries for this machine's system type does not already exist, proceed to <link
3043           linkend="HDRWQ157">Setting Up Volumes and Loading Binaries into AFS</link>. Otherwise, the installation is
3044           complete.</para>
3045         </listitem>
3046       </orderedlist>
3047
3048       <indexterm>
3049         <primary>afs file</primary>
3050
3051         <secondary>AFS initialization file</secondary>
3052       </indexterm>
3053
3054       <indexterm>
3055         <primary>files</primary>
3056
3057         <secondary>afs</secondary>
3058
3059         <tertiary>AFS initialization file</tertiary>
3060       </indexterm>
3061
3062       <indexterm>
3063         <primary>Solaris</primary>
3064
3065         <secondary>AFS initialization script</secondary>
3066
3067         <tertiary>on client machine</tertiary>
3068       </indexterm>
3069     </sect2>
3070
3071     <sect2 id="HDRWQ156">
3072       <title>Running the Script on Solaris Systems</title>
3073
3074       <orderedlist>
3075         <listitem>
3076           <para>Reboot the machine and log in again as the local superuser <emphasis role="bold">root</emphasis>. <programlisting>
3077    # <emphasis role="bold">cd /</emphasis>
3078    # <emphasis role="bold">shutdown -i6 -g0 -y</emphasis>
3079    login: <emphasis role="bold">root</emphasis>
3080    Password: <replaceable>root_password</replaceable>
3081 </programlisting></para>
3082         </listitem>
3083
3084         <listitem>
3085           <para>Run the AFS initialization script. <programlisting>
3086    # <emphasis role="bold">/etc/init.d/afs  start</emphasis>
3087 </programlisting></para>
3088         </listitem>
3089
3090         <listitem>
3091           <para>Change to the <emphasis role="bold">/etc/init.d</emphasis> directory and issue the <emphasis role="bold">ln
3092           -s</emphasis> command to create symbolic links that incorporate the AFS initialization script into the Solaris startup and
3093           shutdown sequence. <programlisting>
3094    # <emphasis role="bold">cd /etc/init.d</emphasis>
3095    # <emphasis role="bold">ln -s ../init.d/afs /etc/rc3.d/S99afs</emphasis>
3096    # <emphasis role="bold">ln -s ../init.d/afs /etc/rc0.d/K66afs</emphasis>
3097 </programlisting></para>
3098         </listitem>
3099
3100         <listitem>
3101           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
3102           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc/init.d</emphasis> directories. If you want
3103           to avoid potential confusion by guaranteeing that they are always the same, create a link between them. You can always
3104           retrieve the original script from the AFS CD-ROM if necessary. <programlisting>
3105    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
3106    # <emphasis role="bold">rm afs.rc</emphasis>
3107    # <emphasis role="bold">ln -s  /etc/init.d/afs  afs.rc</emphasis>
3108 </programlisting></para>
3109         </listitem>
3110
3111         <listitem>
3112           <para>If a volume for housing AFS binaries for this machine's system type does not already exist, proceed to <link
3113           linkend="HDRWQ157">Setting Up Volumes and Loading Binaries into AFS</link>. Otherwise, the installation is
3114           complete.</para>
3115         </listitem>
3116       </orderedlist>
3117
3118       <indexterm>
3119         <primary>storing</primary>
3120
3121         <secondary>AFS binaries in volumes</secondary>
3122       </indexterm>
3123
3124       <indexterm>
3125         <primary>creating</primary>
3126
3127         <secondary>volume</secondary>
3128
3129         <tertiary>for AFS binaries</tertiary>
3130       </indexterm>
3131
3132       <indexterm>
3133         <primary>volume</primary>
3134
3135         <secondary>for AFS binaries</secondary>
3136       </indexterm>
3137
3138       <indexterm>
3139         <primary>binaries</primary>
3140
3141         <secondary>storing AFS in volume</secondary>
3142       </indexterm>
3143
3144       <indexterm>
3145         <primary>usr/afsws directory</primary>
3146       </indexterm>
3147
3148       <indexterm>
3149         <primary>directories</primary>
3150
3151         <secondary>/usr/afsws</secondary>
3152       </indexterm>
3153     </sect2>
3154   </sect1>
3155
3156   <sect1 id="HDRWQ157">
3157     <title>Setting Up Volumes and Loading Binaries into AFS</title>
3158
3159     <para>In this section, you link <emphasis role="bold">/usr/afsws</emphasis> on the local disk to the directory in AFS that
3160     houses AFS binaries for this system type. The conventional name for the AFS directory is <emphasis
3161     role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
3162     role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/usr/afsws</emphasis>.</para>
3163
3164     <para>If this machine is an existing system type, the AFS directory presumably already exists. You can simply create a link from
3165     the local <emphasis role="bold">/usr/afsws</emphasis> directory to it. Follow the instructions in <link
3166     linkend="HDRWQ158">Linking /usr/afsws on an Existing System Type</link>.</para>
3167
3168     <para>If this machine is a new system type (there are no AFS machines of this type in your cell), you must first create and
3169     mount volumes to store its AFS binaries, and then create the link from <emphasis role="bold">/usr/afsws</emphasis> to the new
3170     directory. See <link linkend="HDRWQ159">Creating Binary Volumes for a New System Type</link>.</para>
3171
3172     <para>You can also store UNIX system binaries (the files normally stored in local disk directories such as <emphasis
3173     role="bold">/bin</emphasis>, <emphasis role="bold">/etc</emphasis>, and <emphasis role="bold">/lib</emphasis>) in volumes
3174     mounted under <emphasis role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
3175     role="bold">/</emphasis><replaceable>sysname</replaceable>. See <link linkend="HDRWQ88">Storing System Binaries in AFS</link>
3176     .</para>
3177
3178     <sect2 id="HDRWQ158">
3179       <title>Linking /usr/afsws on an Existing System Type</title>
3180
3181       <para>If this client machine is an existing system type, there is already a volume mounted in the AFS filespace that houses
3182       AFS client binaries for it. <orderedlist>
3183           <listitem>
3184             <para>Create <emphasis role="bold">/usr/afsws</emphasis> on the local disk as a symbolic link to the directory <emphasis
3185             role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/@sys/usr/afsws</emphasis>. You can
3186             specify the actual system name instead of <emphasis role="bold">@sys</emphasis> if you wish, but the advantage of using
3187             <emphasis role="bold">@sys</emphasis> is that it remains valid if you upgrade this machine to a different system type.
3188             <programlisting>
3189    # <emphasis role="bold">ln -s /afs/</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/@sys/usr/afsws  /usr/afsws</emphasis>
3190 </programlisting></para>
3191           </listitem>
3192
3193           <listitem>
3194             <para><emphasis role="bold">(Optional)</emphasis> If you believe it is helpful to your users to access the AFS documents
3195             in a certain format via a local disk directory, create <emphasis role="bold">/usr/afsdoc</emphasis> on the local disk as
3196             a symbolic link to the documentation directory in AFS (<emphasis
3197             role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
3198             role="bold">/afsdoc/</emphasis><replaceable>format_name</replaceable>). <programlisting>
3199    # <emphasis role="bold">ln -s /afs/</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/afsdoc/</emphasis><replaceable>format_name</replaceable> <emphasis
3200                   role="bold">/usr/afsdoc</emphasis>
3201 </programlisting></para>
3202
3203             <para>An alternative is to create a link in each user's home directory to the <emphasis
3204             role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
3205             role="bold">/afsdoc/</emphasis><replaceable>format_name</replaceable> directory.</para>
3206           </listitem>
3207         </orderedlist></para>
3208     </sect2>
3209
3210     <sect2 id="HDRWQ159">
3211       <title>Creating Binary Volumes for a New System Type</title>
3212
3213       <para>If this client machine is a new system type, you must create and mount volumes for its binaries before you can link the
3214       local <emphasis role="bold">/usr/afsws</emphasis> directory to an AFS directory.</para>
3215
3216       <para>To create and mount the volumes, you use the <emphasis role="bold">klog</emphasis> command to authenticate as an
3217       administrator and then issue commands from the <emphasis role="bold">vos</emphasis> and <emphasis role="bold">fs</emphasis>
3218       command suites. However, the command binaries are not yet available on this machine (by convention, they are accessible via
3219       the <emphasis role="bold">/usr/afsws</emphasis> link that you are about to create). You have two choices: <itemizedlist>
3220           <listitem>
3221             <para>Perform all steps except the last one (Step <link linkend="LIWQ162">10</link>) on an existing AFS machine. On a
3222             file server machine, the <emphasis role="bold">klog</emphasis>, <emphasis role="bold">fs</emphasis> and <emphasis
3223             role="bold">vos</emphasis> binaries reside in the <emphasis role="bold">/usr/afs/bin</emphasis> directory. On client
3224             machines, the <emphasis role="bold">klog</emphasis> and <emphasis role="bold">fs</emphasis> binaries reside in the
3225             <emphasis role="bold">/usr/afsws/bin</emphasis> directory and the <emphasis role="bold">vos</emphasis> binary in the
3226             <emphasis role="bold">/usr/afsws/etc</emphasis> directory. Depending on how your PATH environment variable is set, you
3227             possibly need to precede the command names with a pathname.</para>
3228
3229             <para>If you work on another AFS machine, be sure to substitute the new system type name for the
3230             <replaceable>sysname</replaceable> argument in the following commands, not the system type of the machine on which you
3231             are issuing the commands.</para>
3232           </listitem>
3233
3234           <listitem>
3235             <para>Copy the necessary command binaries to a temporary location on the local disk, which enables you to perform the
3236             steps on the local machine. The following procedure installs them in the <emphasis role="bold">/tmp</emphasis> directory
3237             and removes them at the end. Depending on how your PATH environment variable is set, you possibly need to precede the
3238             command names with a pathname.</para>
3239           </listitem>
3240         </itemizedlist></para>
3241
3242       <para>Perform the following steps to create a volume for housing AFS binaries. <orderedlist>
3243           <listitem>
3244             <para>Working either on the local machine or another AFS machine, mount the AFS CD-ROM for the new system type on the
3245             <emphasis role="bold">/cdrom</emphasis> directory, if it is not already. For instructions on mounting CD-ROMs (either
3246             locally or remotely via NFS), consult the operating system documentation.</para>
3247           </listitem>
3248
3249           <listitem>
3250             <para>If working on the local machine, copy the necessary binaries to a temporary location on the local disk. Substitute
3251             a different directory name for <emphasis role="bold">/tmp</emphasis> if you wish. <programlisting>
3252    # <emphasis role="bold">cd  /cdrom/</emphasis><replaceable>new_sysname</replaceable><emphasis role="bold">/root.server/usr/afs/bin</emphasis>
3253    # <emphasis role="bold">cp -p  klog  /tmp</emphasis>
3254    # <emphasis role="bold">cp -p  fs  /tmp</emphasis>
3255    # <emphasis role="bold">cp -p  vos  /tmp</emphasis>
3256 </programlisting></para>
3257           </listitem>
3258
3259           <listitem>
3260             <para>Authenticate as the user <emphasis role="bold">admin</emphasis>. <programlisting>
3261    # <emphasis role="bold">klog admin</emphasis>
3262    Password: <replaceable>admin_password</replaceable>
3263 </programlisting></para>
3264           </listitem>
3265
3266           <listitem>
3267             <para><anchor id="LIWQ160" />Issue the <emphasis role="bold">vos create</emphasis> command to create volumes for storing
3268             the AFS client binaries for this system type. The following example instruction creates volumes called
3269             <replaceable>sysname</replaceable>, <replaceable>sysname</replaceable>.<emphasis role="bold">usr</emphasis>, and
3270             <replaceable>sysname</replaceable>.<emphasis role="bold">usr.afsws</emphasis>. Refer to the <emphasis>OpenAFS Release
3271             Notes</emphasis> to learn the proper value of <replaceable>sysname</replaceable> for this system type. <programlisting>
3272    # <emphasis role="bold">vos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <replaceable>sysname</replaceable>
3273    # <emphasis role="bold">vos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <replaceable>sysname</replaceable><emphasis
3274                   role="bold">.usr</emphasis>
3275    # <emphasis role="bold">vos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <replaceable>sysname</replaceable><emphasis
3276                   role="bold">.usr.afsws</emphasis>
3277 </programlisting></para>
3278           </listitem>
3279
3280           <listitem>
3281             <para>Issue the <emphasis role="bold">fs mkmount</emphasis> command to mount the newly created volumes. Because the
3282             <emphasis role="bold">root.cell</emphasis> volume is replicated, you must precede the <emphasis>cellname</emphasis> part
3283             of the pathname with a period to specify the read/write mount point, as shown. Then issue the <emphasis role="bold">vos
3284             release</emphasis> command to release a new replica of the <emphasis role="bold">root.cell</emphasis> volume, and the
3285             <emphasis role="bold">fs checkvolumes</emphasis> command to force the local Cache Manager to access them.
3286             <programlisting>
3287    # <emphasis role="bold">fs mkmount -dir /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable> <emphasis
3288                   role="bold">-vol</emphasis> <replaceable>sysname</replaceable>
3289    # <emphasis role="bold">fs mkmount -dir /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis
3290                   role="bold">/usr</emphasis>  <emphasis role="bold">-vol</emphasis> <replaceable>sysname</replaceable><emphasis
3291                   role="bold">.usr</emphasis>
3292    # <emphasis role="bold">fs mkmount -dir /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis
3293                   role="bold">/usr/afsws</emphasis> <emphasis role="bold">-vol</emphasis> <replaceable>sysname</replaceable><emphasis
3294                   role="bold">.usr.afsws</emphasis>
3295    # <emphasis role="bold">vos release root.cell</emphasis>
3296    # <emphasis role="bold">fs checkvolumes</emphasis>
3297 </programlisting></para>
3298           </listitem>
3299
3300           <listitem>
3301             <para>Issue the <emphasis role="bold">fs setacl</emphasis> command to grant the <emphasis role="bold">l</emphasis>
3302             (<emphasis role="bold">lookup</emphasis>) and <emphasis role="bold">r</emphasis> (<emphasis role="bold">read</emphasis>)
3303             permissions to the <emphasis role="bold">system:anyuser</emphasis> group on each new directory's ACL. <programlisting>
3304    # <emphasis role="bold">cd /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable>
3305    # <emphasis role="bold">fs setacl  -dir  .  usr  usr/afsws  -acl  system:anyuser rl</emphasis>
3306 </programlisting></para>
3307           </listitem>
3308
3309           <listitem>
3310             <para>Issue the <emphasis role="bold">fs setquota</emphasis> command to set an unlimited quota on the volume mounted at
3311             the <emphasis role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
3312             role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/usr/afsws</emphasis> directory. This
3313             enables you to copy all of the appropriate files from the CD-ROM into the volume without exceeding the volume's
3314             quota.</para>
3315
3316             <para>If you wish, you can set the volume's quota to a finite value after you complete the copying operation. At that
3317             point, use the <emphasis role="bold">vos examine</emphasis> command to determine how much space the volume is occupying.
3318             Then issue the <emphasis role="bold">fs setquota</emphasis> command to set a quota that is slightly larger.</para>
3319
3320             <programlisting>
3321    # <emphasis role="bold">fs setquota /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis
3322                 role="bold">/usr/afsws  0</emphasis>
3323 </programlisting>
3324           </listitem>
3325
3326           <listitem>
3327             <para><anchor id="LIWQ161" />Copy the contents of the indicated directories from the CD-ROM into the <emphasis
3328             role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
3329             role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/usr/afsws</emphasis> directory.
3330             <programlisting>
3331    # <emphasis role="bold">cd /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis
3332                   role="bold">/usr/afsws</emphasis>
3333    # <emphasis role="bold">cp -rp /cdrom/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/bin  .</emphasis>
3334    # <emphasis role="bold">cp -rp /cdrom/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/etc  .</emphasis>
3335    # <emphasis role="bold">cp -rp /cdrom/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/include  .</emphasis>
3336    # <emphasis role="bold">cp -rp /cdrom/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/lib  .</emphasis>
3337 </programlisting></para>
3338           </listitem>
3339
3340           <listitem>
3341             <para>Issue the <emphasis role="bold">fs setacl</emphasis> command to set the ACL on each directory appropriately. To
3342             comply with the terms of your AFS License agreement, you must prevent unauthorized users from accessing AFS software. To
3343             enable access for locally authenticated users only, set the ACL on the <emphasis role="bold">etc</emphasis>, <emphasis
3344             role="bold">include</emphasis>, and <emphasis role="bold">lib</emphasis> subdirectories to grant the <emphasis
3345             role="bold">l</emphasis> and <emphasis role="bold">r</emphasis> permissions to the <emphasis
3346             role="bold">system:authuser</emphasis> group rather than the <emphasis role="bold">system:anyuser</emphasis> group. The
3347             <emphasis role="bold">system:anyuser</emphasis> group must retain the <emphasis role="bold">l</emphasis> and <emphasis
3348             role="bold">r</emphasis> permissions on the <emphasis role="bold">bin</emphasis> subdirectory to enable unauthenticated
3349             users to access the <emphasis role="bold">klog</emphasis> binary. To ensure that unauthorized users are not accessing
3350             AFS software, check periodically that the ACLs on these directories are set properly. <programlisting>
3351    # <emphasis role="bold">cd /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis
3352                   role="bold">/usr/afsws</emphasis>
3353    # <emphasis role="bold">fs setacl  -dir etc include lib  -acl  system:authuser rl</emphasis>  \
3354               <emphasis role="bold">system:anyuser none</emphasis>
3355 </programlisting></para>
3356           </listitem>
3357
3358           <listitem>
3359             <para><anchor id="LIWQ162" />Perform this step on the new client machine even if you have performed the previous steps
3360             on another machine. Create <emphasis role="bold">/usr/afsws</emphasis> on the local disk as a symbolic link to the
3361             directory <emphasis role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
3362             role="bold">/@sys/usr/afsws</emphasis>. You can specify the actual system name instead of <emphasis
3363             role="bold">@sys</emphasis> if you wish, but the advantage of using <emphasis role="bold">@sys</emphasis> is that it
3364             remains valid if you upgrade this machine to a different system type. <programlisting>
3365    # <emphasis role="bold">ln -s /afs/</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/@sys/usr/afsws  /usr/afsws</emphasis>
3366 </programlisting></para>
3367           </listitem>
3368
3369           <listitem>
3370             <para><emphasis role="bold">(Optional)</emphasis> To enable users to issue commands from the AFS suites (such as
3371             <emphasis role="bold">fs</emphasis>) without having to specify a pathname to their binaries, include the <emphasis
3372             role="bold">/usr/afsws/bin</emphasis> and <emphasis role="bold">/usr/afsws/etc</emphasis> directories in the PATH
3373             environment variable you define in each user's shell initialization file (such as <emphasis
3374             role="bold">.cshrc</emphasis>).</para>
3375           </listitem>
3376
3377           <listitem>
3378             <para><emphasis role="bold">(Optional)</emphasis> If you believe it is helpful to your users to access the AFS documents
3379             in a certain format via a local disk directory, create <emphasis role="bold">/usr/afsdoc</emphasis> on the local disk as
3380             a symbolic link to the documentation directory in AFS (<emphasis
3381             role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
3382             role="bold">/afsdoc/</emphasis><replaceable>format_name</replaceable>). <programlisting>
3383    # <emphasis role="bold">ln -s /afs/</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/afsdoc/</emphasis><replaceable>format_name</replaceable> <emphasis
3384                   role="bold">/usr/afsdoc</emphasis>
3385 </programlisting></para>
3386
3387             <para>An alternative is to create a link in each user's home directory to the <emphasis
3388             role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
3389             role="bold">/afsdoc/</emphasis><replaceable>format_name</replaceable> directory.</para>
3390           </listitem>
3391
3392           <listitem>
3393             <para><emphasis role="bold">(Optional)</emphasis> If working on the local machine, remove the AFS binaries from the
3394             temporary location. They are now accessible in the <emphasis role="bold">/usr/afsws</emphasis> directory.
3395             <programlisting>
3396    # <emphasis role="bold">cd  /tmp</emphasis>
3397    # <emphasis role="bold">rm  klog  fs  vos</emphasis>
3398 </programlisting></para>
3399           </listitem>
3400         </orderedlist></para>
3401     </sect2>
3402   </sect1>
3403 </chapter>