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