doc: fixes for the xsltproc -> fop -> pdf toolchain
[openafs.git] / doc / xml / QuickStartUnix / auqbg005.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <chapter id="HDRWQ17">
3   <title>Installing the First AFS Machine</title>
4
5   <para>
6   <indexterm>
7     <primary>file server machine</primary>
8
9     <seealso>first AFS machine</seealso>
10
11     <seealso>file server machine, additional</seealso>
12   </indexterm>
13
14   <indexterm>
15     <primary>instructions</primary>
16
17     <secondary>first AFS machine</secondary>
18   </indexterm>
19
20   <indexterm>
21     <primary>installing</primary>
22
23     <secondary>first AFS machine</secondary>
24   </indexterm>
25
26   This chapter describes how to install the first AFS machine in your cell, configuring it as both a file server machine and a
27   client machine. After completing all procedures in this chapter, you can remove the client functionality if you wish, as described
28   in <link linkend="HDRWQ98">Removing Client Functionality</link>.</para>
29
30   <para>To install additional file server machines after completing this chapter, see <link linkend="HDRWQ99">Installing Additional
31   Server Machines</link>.</para>
32
33   <para>To install additional client machines after completing this chapter, see <link linkend="HDRWQ133">Installing Additional
34   Client Machines</link>. <indexterm>
35       <primary>requirements</primary>
36
37       <secondary>first AFS machine</secondary>
38     </indexterm></para>
39
40   <sect1 id="Header_29">
41     <title>Requirements and Configuration Decisions</title>
42
43     <para>The instructions in this chapter assume that you meet the following requirements. 
44       <itemizedlist>
45         <listitem>
46           <para>You are logged onto the machine's console as the local superuser <emphasis role="bold">root</emphasis></para>
47         </listitem>
48
49         <listitem>
50           <para>A standard version of one of the operating systems supported by the current version of AFS is running on the
51           machine</para>
52         </listitem>
53
54         <listitem>
55           <para>You have either installed the provided OpenAFS packages for 
56           your system, have access to a binary distribution tarball, or have 
57           successfully built OpenAFS from source</para>
58         </listitem>
59
60         <listitem>
61           <para>You have a Kerberos v5 realm running for your site. If you are
62           working with an existing cell which uses 
63           <emphasis role="bold">kaserver</emphasis> or Kerberos v4 for
64           authentication, please see 
65           <link linkend="KAS001">kaserver and Legacy Kerberos v4 Authentication</link>
66           for the modifications required to this installation procedure.</para>
67         </listitem>
68
69         <listitem>
70           <para>You have a NTP, or similar, time service deployed to ensure 
71           rough clock syncronistation between your clients and servers. If you
72           wish to use AFS's built in timeservice (which is deprecated) please
73           see Appendix B for the necessary modifications to this installation
74           procedure.</para>
75         </listitem>
76       </itemizedlist></para>
77
78     <para>You must make the following configuration decisions while installing the first AFS machine. To speed the installation
79     itself, it is best to make the decisions before beginning. See the chapter in the <emphasis>OpenAFS Administration
80     Guide</emphasis> about issues in cell administration and configuration for detailed guidelines. <indexterm>
81         <primary>cell name</primary>
82
83         <secondary>choosing</secondary>
84       </indexterm> <indexterm>
85         <primary>AFS filespace</primary>
86
87         <secondary>deciding how to configure</secondary>
88       </indexterm> <indexterm>
89         <primary>filespace</primary>
90
91         <see>AFS filespace</see>
92       </indexterm> <itemizedlist>
93         <listitem>
94           <para>Select the first AFS machine</para>
95         </listitem>
96
97         <listitem>
98           <para>Select the cell name</para>
99         </listitem>
100
101         <listitem>
102           <para>Decide which partitions or logical volumes to configure as AFS server partitions, and choose the directory names on
103           which to mount them</para>
104         </listitem>
105
106         <listitem>
107           <para>Decide how big to make the client cache</para>
108         </listitem>
109
110         <listitem>
111           <para>Decide how to configure the top levels of your cell's AFS filespace</para>
112         </listitem>
113       </itemizedlist></para>
114
115     <para>This chapter is divided into three large sections corresponding to the three parts of installing the first AFS machine.
116     Perform all of the steps in the order they appear. Each functional section begins with a summary of the procedures to perform.
117     The sections are as follows: <itemizedlist>
118         <listitem>
119           <para>Installing server functionality (begins in <link linkend="HDRWQ18">Overview: Installing Server
120           Functionality</link>)</para>
121         </listitem>
122
123         <listitem>
124           <para>Installing client functionality (begins in <link linkend="HDRWQ63">Overview: Installing Client
125           Functionality</link>)</para>
126         </listitem>
127
128         <listitem>
129           <para>Configuring your cell's filespace, establishing further security mechanisms, and enabling access to foreign cells
130           (begins in <link linkend="HDRWQ71">Overview: Completing the Installation of the First AFS Machine</link>)</para>
131         </listitem>
132       </itemizedlist></para>
133
134     <indexterm>
135       <primary>overview</primary>
136
137       <secondary>installing server functionality on first AFS machine</secondary>
138     </indexterm>
139
140     <indexterm>
141       <primary>first AFS machine</primary>
142
143       <secondary>server functionality</secondary>
144     </indexterm>
145
146     <indexterm>
147       <primary>installing</primary>
148
149       <secondary>server functionality</secondary>
150
151       <tertiary>first AFS machine</tertiary>
152     </indexterm>
153   </sect1>
154
155   <sect1 id="HDRWQ18">
156     <title>Overview: Installing Server Functionality</title>
157
158     <para>In the first phase of installing your cell's first AFS machine, you install file server and database server functionality
159     by performing the following procedures: 
160     <orderedlist>
161         <listitem>
162           <para>Choose which machine to install as the first AFS machine</para>
163         </listitem>
164
165         <listitem>
166           <para>Create AFS-related directories on the local disk</para>
167         </listitem>
168
169         <listitem>
170           <para>Incorporate AFS modifications into the machine's kernel</para>
171         </listitem>
172
173         <listitem>
174           <para>Configure partitions or logical volumes for storing AFS volumes</para>
175         </listitem>
176
177         <listitem>
178           <para>On some system types, install and configure an AFS-modified version of the <emphasis role="bold">fsck</emphasis>
179           program</para>
180         </listitem>
181
182         <listitem>
183           <para>If the machine is to remain a client machine, incorporate AFS into its authentication system</para>
184         </listitem>
185
186         <listitem>
187           <para>Start the Basic OverSeer (BOS) Server</para>
188         </listitem>
189
190         <listitem>
191           <para>Define the cell name and the machine's cell membership</para>
192         </listitem>
193
194         <listitem>
195           <para>Start the database server processes: Backup Server, Protection Server, and Volume Location
196           (VL) Server</para>
197         </listitem>
198
199         <listitem>
200           <para>Configure initial security mechanisms</para>
201         </listitem>
202
203         <listitem>
204           <para>Start the <emphasis role="bold">fs</emphasis> process, which incorporates three component processes: the File
205           Server, Volume Server, and Salvager</para>
206         </listitem>
207
208         <listitem>
209           <para>Optionally, start the server portion of the Update Server</para>
210         </listitem>
211
212       </orderedlist></para>
213   </sect1>
214
215   <sect1 id="HDRWQ19">
216     <title>Choosing the First AFS Machine</title>
217
218     <para>The first AFS machine you install must have sufficient disk space to store AFS volumes. To take best advantage of AFS's
219     capabilities, store client-side binaries as well as user files in volumes. When you later install additional file server
220     machines in your cell, you can distribute these volumes among the different machines as you see fit.</para>
221
222     <para>These instructions configure the first AFS machine as a <emphasis>database server machine</emphasis>, the <emphasis>binary
223     distribution machine</emphasis> for its system type, and the cell's <emphasis>system control machine</emphasis>. For a
224     description of these roles, see the <emphasis>OpenAFS Administration Guide</emphasis>.</para>
225
226     <para>Installation of additional machines is simplest if the first machine has the lowest IP address of any database server
227     machine you currently plan to install. If you later install database server functionality on a machine with a lower IP address,
228     you must first update the <emphasis role="bold">/usr/vice/etc/CellServDB</emphasis> file on all of your cell's client machines.
229     For more details, see <link linkend="HDRWQ114">Installing Database Server Functionality</link>.</para>
230   </sect1>
231
232   <sect1 id="Header_32">
233     <title>Creating AFS Directories</title>
234
235     <indexterm>
236       <primary>usr/afs directory</primary>
237
238       <secondary>first AFS machine</secondary>
239     </indexterm>
240
241     <indexterm>
242       <primary>first AFS machine</primary>
243
244       <secondary>/usr/afs directory</secondary>
245     </indexterm>
246
247     <indexterm>
248       <primary>creating</primary>
249
250       <secondary>/usr/afs directory</secondary>
251
252       <tertiary>first AFS machine</tertiary>
253     </indexterm>
254
255     <indexterm>
256       <primary>usr/vice/etc directory</primary>
257
258       <secondary>first AFS machine</secondary>
259     </indexterm>
260
261     <indexterm>
262       <primary>first AFS machine</primary>
263
264       <secondary>/usr/vice/etc directory</secondary>
265     </indexterm>
266
267     <indexterm>
268       <primary>creating</primary>
269
270       <secondary>/usr/vice/etc directory</secondary>
271
272       <tertiary>first AFS machine</tertiary>
273     </indexterm>
274
275     <indexterm>
276       <primary>/ as start to file and directory names</primary>
277
278       <secondary>see alphabetized entries without initial slash</secondary>
279     </indexterm>
280
281     <para>If you are installing from packages (such as Debian .deb or 
282     Fedora/SuSe .rpm files), you should now install all of the available 
283     OpenAFS packages for your system type. Typically, these will include 
284     packages for client and server functionality, and a seperate package 
285     containing a suitable kernel module for your running kernel. Consult 
286     the package lists on the OpenAFS website to determine the packages 
287     appropriate for your system.</para>
288
289     <para>If you are installing from a tarfile, or from a locally compiled 
290     source tree you should create the <emphasis role="bold">/usr/afs</emphasis>
291     and <emphasis role="bold">/usr/vice/etc</emphasis> directories on the
292     local disk, to house server and client files respectively. Subsequent 
293     instructions copy files from the distribution tarfile into them. </para>
294 <programlisting>
295    # <emphasis role="bold">mkdir /usr/afs</emphasis>
296    # <emphasis role="bold">mkdir /usr/vice</emphasis>
297    # <emphasis role="bold">mkdir /usr/vice/etc</emphasis>
298 </programlisting>
299   </sect1>
300
301   <sect1 id="HDRWQ20">
302     <title>Performing Platform-Specific Procedures</title>
303
304     <para>Several of the initial procedures for installing a file server machine differ for each system type. For convenience, the
305     following sections group them together for each system type: <itemizedlist>
306         <indexterm>
307           <primary>kernel extensions</primary>
308
309           <see>AFS kernel extensions</see>
310         </indexterm>
311
312         <indexterm>
313           <primary>loading AFS kernel extensions</primary>
314
315           <see>incorporating</see>
316         </indexterm>
317
318         <indexterm>
319           <primary>building</primary>
320
321           <secondary>AFS extensions into kernel</secondary>
322
323           <see>incorporating AFS kernel extensions</see>
324         </indexterm>
325
326         <listitem>
327           <para>Incorporate AFS modifications into the kernel.</para>
328
329           <para>The kernel on every AFS client machine and, on some systems, 
330           the AFS fileservers, must incorporate AFS extensions. On machines 
331           that use a dynamic kernel module loader, it is conventional to 
332           alter the machine's initialization script to load the AFS extensions
333           at each reboot. <indexterm>
334               <primary>AFS server partition</primary>
335
336               <secondary>mounted on /vicep directory</secondary>
337             </indexterm> <indexterm>
338               <primary>partition</primary>
339
340               <see>AFS server partition</see>
341             </indexterm> <indexterm>
342               <primary>logical volume</primary>
343
344               <see>AFS server partition</see>
345             </indexterm> <indexterm>
346               <primary>requirements</primary>
347
348               <secondary>AFS server partition name and location</secondary>
349             </indexterm> <indexterm>
350               <primary>naming conventions for AFS server partition</primary>
351             </indexterm> <indexterm>
352               <primary>vicep<emphasis>xx</emphasis> directory</primary>
353
354               <see>AFS server partition</see>
355             </indexterm> <indexterm>
356               <primary>directories</primary>
357
358               <secondary>/vicep<emphasis>xx</emphasis></secondary>
359
360               <see>AFS server partition</see>
361             </indexterm></para>
362         </listitem>
363
364         <listitem>
365           <para>Configure server partitions or logical volumes to house AFS volumes.</para>
366
367           <para>Every AFS file server machine must have at least one partition or logical volume dedicated to storing AFS volumes
368           (for convenience, the documentation hereafter refers to partitions only). Each server partition is mounted at a directory
369           named <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>, where <replaceable>xx</replaceable> is one or
370           two lowercase letters. By convention, the first 26 partitions are mounted on the directories called <emphasis
371           role="bold">/vicepa</emphasis> through <emphasis role="bold">/vicepz</emphasis>, the 27th one is mounted on the <emphasis
372           role="bold">/vicepaa</emphasis> directory, and so on through <emphasis role="bold">/vicepaz</emphasis> and <emphasis
373           role="bold">/vicepba</emphasis>, continuing up to the index corresponding to the maximum number of server partitions
374           supported in the current version of AFS (which is specified in the <emphasis>OpenAFS Release Notes</emphasis>).</para>
375
376           <para>The <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable> directories must reside in the file server
377           machine's root directory, not in one of its subdirectories (for example, <emphasis role="bold">/usr/vicepa</emphasis> is
378           not an acceptable directory location).
379
380           The <emphasis role="bold">fileserver</emphasis> will refuse to
381           mount
382           any <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>
383           folders that are not separate partitions. </para>
384
385           <warning>
386             <para>The separate partition requirement may be overridden by
387               creating a file named
388               <emphasis role="bold">/vicep<replaceable>xx</replaceable>/AlwaysAttach</emphasis>;
389               however, mixed-use partitions, whether cache or fileserver,
390               have the risk that a non-AFS use will fill the partition and
391               not leave enough free space for AFS.  Even though it is
392               allowed, be wary of configuring a mixed-use partition
393               without understanding the ramifications of doing so with the
394               workload on your filesystem.
395               <indexterm>
396                 <primary>AFS server partition</primary>
397                 <secondary>AlwaysAttach</secondary>
398               </indexterm>
399             </para>
400           </warning>
401
402           <para>You can also add or remove server partitions on an existing file server machine. For instructions, see the chapter
403           in the <emphasis>OpenAFS Administration Guide</emphasis> about maintaining server machines.</para>
404
405           <note>
406             <para>Not all file system types supported by an operating system are necessarily supported as AFS server partitions. For
407             possible restrictions, see the <emphasis>OpenAFS Release Notes</emphasis>.</para>
408           </note>
409         </listitem>
410
411         <listitem>
412           <para>On system types using the <emphasis role="bold">inode</emphasis> storage format, install and configure a modified <emphasis role="bold">fsck</emphasis> program which
413           recognizes the structures that the File Server uses to organize volume data on AFS server partitions. The <emphasis
414           role="bold">fsck</emphasis> program provided with the operating system does not understand the AFS data structures, and so
415           removes them to the <emphasis role="bold">lost+found</emphasis> directory.</para>
416         </listitem>
417
418         <listitem>
419           <para>If the machine is to remain an AFS client machine, modify the machine's authentication system so that users obtain
420           an AFS token as they log into the local file system. Using AFS is simpler and more convenient for your users if you make
421           the modifications on all client machines. Otherwise, users must perform a two or three step login procedure (login to the local
422           system, then obtain Kerberos credentials, and then issue the <emphasis role="bold">aklog</emphasis> command). For further discussion of AFS
423           authentication, see the chapter in the <emphasis>OpenAFS Administration Guide</emphasis> about cell configuration and
424           administration issues.</para>
425         </listitem>
426       </itemizedlist></para>
427
428     <para>To continue, proceed to the appropriate section: <itemizedlist>
429         <listitem>
430           <para><link linkend="HDRWQ21">Getting Started on AIX Systems</link></para>
431         </listitem>
432
433         <listitem>
434           <para><link linkend="HDRWQ31">Getting Started on HP-UX Systems</link></para>
435         </listitem>
436
437         <listitem>
438           <para><link linkend="HDRWQ36">Getting Started on IRIX Systems</link></para>
439         </listitem>
440
441         <listitem>
442           <para><link linkend="HDRWQ41">Getting Started on Linux Systems</link></para>
443         </listitem>
444
445         <listitem>
446           <para><link linkend="HDRWQ45">Getting Started on Solaris Systems</link></para>
447         </listitem>
448       </itemizedlist></para>
449   </sect1>
450
451   <sect1 id="HDRWQ21">
452     <title>Getting Started on AIX Systems</title>
453
454     <para>Begin by running the AFS initialization script to call the AIX kernel extension facility, which dynamically loads AFS
455     modifications into the kernel. Then use the <emphasis role="bold">SMIT</emphasis> program to configure partitions for storing
456     AFS volumes, and replace the AIX <emphasis role="bold">fsck</emphasis> program helper with a version that correctly handles AFS
457     volumes. If the machine is to remain an AFS client machine, incorporate AFS into the AIX secondary authentication system.
458     <indexterm>
459         <primary>incorporating AFS kernel extensions</primary>
460
461         <secondary>first AFS machine</secondary>
462
463         <tertiary>AIX</tertiary>
464       </indexterm> <indexterm>
465         <primary>AFS kernel extensions</primary>
466
467         <secondary>on first AFS machine</secondary>
468
469         <tertiary>AIX</tertiary>
470       </indexterm> <indexterm>
471         <primary>first AFS machine</primary>
472
473         <secondary>AFS kernel extensions</secondary>
474
475         <tertiary>on AIX</tertiary>
476       </indexterm> <indexterm>
477         <primary>AIX</primary>
478
479         <secondary>AFS kernel extensions</secondary>
480
481         <tertiary>on first AFS machine</tertiary>
482       </indexterm></para>
483
484     <sect2 id="HDRWQ22">
485       <title>Loading AFS into the AIX Kernel</title>
486
487       <para>The AIX kernel extension facility is the dynamic kernel loader
488       provided by IBM Corporation.  AIX does not support incorporation of
489       AFS modifications during a kernel build.</para>
490
491       <para>For AFS to function correctly, the kernel extension facility must run each time the machine reboots, so the AFS
492       initialization script (included in the AFS distribution) invokes it automatically. In this section you copy the script to the
493       conventional location and edit it to select the appropriate options depending on whether NFS is also to run.</para>
494
495       <para>After editing the script, you run it to incorporate AFS into the kernel. In later sections you verify that the script
496       correctly initializes all AFS components, then configure the AIX <emphasis role="bold">inittab</emphasis> file so that the
497       script runs automatically at reboot. <orderedlist>
498           <listitem>
499             <para>Unpack the distribution tarball. The examples below assume 
500             that you have unpacked the files into the 
501             <emphasis role="bold">/tmp/afsdist</emphasis> directory. If you 
502             pick a different location, substitute this in all of the following 
503             examples. Once you have unpacked the distribution, 
504             change directory as indicated.
505 <programlisting>
506    # <emphasis role="bold">cd /tmp/afsdist/rs_aix42/root.client/usr/vice/etc</emphasis>
507 </programlisting></para>
508           </listitem>
509
510           <listitem>
511             <para>Copy the AFS kernel library files to the local <emphasis role="bold">/usr/vice/etc/dkload</emphasis> directory,
512             and the AFS initialization script to the <emphasis role="bold">/etc</emphasis> directory. <programlisting>
513    # <emphasis role="bold">cp -rp  dkload  /usr/vice/etc</emphasis>
514    # <emphasis role="bold">cp -p  rc.afs  /etc/rc.afs</emphasis>
515 </programlisting></para>
516           </listitem>
517
518           <listitem>
519             <para>Edit the <emphasis role="bold">/etc/rc.afs</emphasis> script, setting the <computeroutput>NFS</computeroutput>
520             variable as indicated.</para>
521
522             <para>If the machine is not to function as an NFS/AFS Translator, set the <computeroutput>NFS</computeroutput> variable
523             as follows.</para>
524
525             <programlisting>
526    NFS=$NFS_NONE
527 </programlisting>
528
529             <para>If the machine is to function as an NFS/AFS Translator and is running AIX 4.2.1 or higher, set the
530             <computeroutput>NFS</computeroutput> variable as follows. Note that NFS must already be loaded into the kernel, which
531             happens automatically on systems running AIX 4.1.1 and later, as long as the file <emphasis
532             role="bold">/etc/exports</emphasis> exists.</para>
533
534             <programlisting>
535    NFS=$NFS_IAUTH
536 </programlisting>
537           </listitem>
538
539           <listitem>
540             <para>Invoke the <emphasis role="bold">/etc/rc.afs</emphasis> script to load AFS modifications into the kernel. You can
541             ignore any error messages about the inability to start the BOS Server or the Cache Manager or AFS client.
542             <programlisting>
543    # <emphasis role="bold">/etc/rc.afs</emphasis>
544 </programlisting></para>
545           </listitem>
546         </orderedlist></para>
547
548       <indexterm>
549         <primary>configuring</primary>
550
551         <secondary>AFS server partition on first AFS machine</secondary>
552
553         <tertiary>AIX</tertiary>
554       </indexterm>
555
556       <indexterm>
557         <primary>AFS server partition</primary>
558
559         <secondary>configuring on first AFS machine</secondary>
560
561         <tertiary>AIX</tertiary>
562       </indexterm>
563
564       <indexterm>
565         <primary>first AFS machine</primary>
566
567         <secondary>AFS server partition</secondary>
568
569         <tertiary>on AIX</tertiary>
570       </indexterm>
571
572       <indexterm>
573         <primary>AIX</primary>
574
575         <secondary>AFS server partition</secondary>
576
577         <tertiary>on first AFS machine</tertiary>
578       </indexterm>
579     </sect2>
580
581     <sect2 id="HDRWQ23">
582       <title>Configuring Server Partitions on AIX Systems</title>
583
584       <para>Every AFS file server machine must have at least one partition or logical volume dedicated to storing AFS volumes. Each
585       server partition is mounted at a directory named <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>, where
586       <replaceable>xx</replaceable> is one or two lowercase letters. The <emphasis
587       role="bold">/vicep</emphasis><replaceable>xx</replaceable> directories must reside in the file server machine's root
588       directory, not in one of its subdirectories (for example, <emphasis role="bold">/usr/vicepa</emphasis> is not an acceptable
589       directory location). For additional information, see <link linkend="HDRWQ20">Performing Platform-Specific
590       Procedures</link>.</para>
591
592       <para>To configure server partitions on an AIX system, perform the following procedures: <orderedlist>
593           <listitem>
594             <para>Create a directory called <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable> for each AFS server
595             partition you are configuring (there must be at least one). Repeat the command for each partition. <programlisting>
596    # <emphasis role="bold">mkdir /vicep</emphasis><replaceable>xx</replaceable>
597 </programlisting></para>
598           </listitem>
599
600           <listitem>
601             <para>Use the <emphasis role="bold">SMIT</emphasis> program to create a journaling file system on each partition to be
602             configured as an AFS server partition.</para>
603           </listitem>
604
605           <listitem>
606             <para>Mount each partition at one of the <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>
607             directories. Choose one of the following three methods: <itemizedlist>
608                 <listitem>
609                   <para>Use the <emphasis role="bold">SMIT</emphasis> program</para>
610                 </listitem>
611
612                 <listitem>
613                   <para>Use the <emphasis role="bold">mount -a</emphasis> command to mount all partitions at once</para>
614                 </listitem>
615
616                 <listitem>
617                   <para>Use the <emphasis role="bold">mount</emphasis> command on each partition in turn</para>
618                 </listitem>
619               </itemizedlist></para>
620
621             <para>Also configure the partitions so that they are mounted automatically at each reboot. For more information, refer
622             to the AIX documentation.</para>
623           </listitem>
624         </orderedlist></para>
625
626       <indexterm>
627         <primary>replacing fsck program</primary>
628
629         <secondary>first AFS machine</secondary>
630
631         <tertiary>AIX</tertiary>
632       </indexterm>
633
634       <indexterm>
635         <primary>fsck program</primary>
636
637         <secondary>on first AFS machine</secondary>
638
639         <tertiary>AIX</tertiary>
640       </indexterm>
641
642       <indexterm>
643         <primary>first AFS machine</primary>
644
645         <secondary>fsck program</secondary>
646
647         <tertiary>on AIX</tertiary>
648       </indexterm>
649
650       <indexterm>
651         <primary>AIX</primary>
652
653         <secondary>fsck program</secondary>
654
655         <tertiary>on first AFS machine</tertiary>
656       </indexterm>
657     </sect2>
658
659     <sect2 id="HDRWQ24">
660       <title>Replacing the fsck Program Helper on AIX Systems</title>
661
662       <note><para>The AFS modified fsck program is not required on AIX 5.1 
663       systems, and the <emphasis role="bold">v3fshelper</emphasis> program
664       refered to below is not shipped for these systems.</para></note>
665       
666       <para>In this section, you make modifications to guarantee that the appropriate <emphasis role="bold">fsck</emphasis> program
667       runs on AFS server partitions. The <emphasis role="bold">fsck</emphasis> program provided with the operating system must never
668       run on AFS server partitions. Because it does not recognize the structures that the File Server uses to organize volume data,
669       it removes all of the data. To repeat:</para>
670
671       <para><emphasis role="bold">Never run the standard fsck program on AFS server partitions. It discards AFS
672       volumes.</emphasis></para>
673
674       <para>On AIX systems, you do not replace the <emphasis role="bold">fsck</emphasis> binary itself, but rather the
675       <emphasis>program helper</emphasis> file included in the AIX distribution as <emphasis
676       role="bold">/sbin/helpers/v3fshelper</emphasis>. <orderedlist>
677           <listitem>
678             <para>Move the AIX <emphasis role="bold">fsck</emphasis> program helper to a safe location and install the version from
679             the AFS distribution in its place. 
680 <programlisting>
681    # <emphasis role="bold">cd /sbin/helpers</emphasis>
682    # <emphasis role="bold">mv v3fshelper v3fshelper.noafs</emphasis>
683    # <emphasis role="bold">cp -p /tmp/afsdist/rs_aix42/root.server/etc/v3fshelper v3fshelper</emphasis>
684 </programlisting></para>
685           </listitem>
686
687           <listitem>
688             <para>If you plan to retain client functionality on this machine after completing the installation, proceed to <link
689             linkend="HDRWQ25">Enabling AFS Login on AIX Systems</link>. Otherwise, proceed to <link linkend="HDRWQ50">Starting the
690             BOS Server</link>.</para>
691           </listitem>
692         </orderedlist></para>
693
694       <indexterm>
695         <primary>enabling AFS login</primary>
696
697         <secondary>file server machine</secondary>
698
699         <tertiary>AIX</tertiary>
700       </indexterm>
701
702       <indexterm>
703         <primary>AFS login</primary>
704
705         <secondary>on file server machine</secondary>
706
707         <tertiary>AIX</tertiary>
708       </indexterm>
709
710       <indexterm>
711         <primary>first AFS machine</primary>
712
713         <secondary>AFS login</secondary>
714
715         <tertiary>on AIX</tertiary>
716       </indexterm>
717
718       <indexterm>
719         <primary>AIX</primary>
720
721         <secondary>AFS login</secondary>
722
723         <tertiary>on file server machine</tertiary>
724       </indexterm>
725
726       <indexterm>
727         <primary>secondary authentication system (AIX)</primary>
728
729         <secondary>server machine</secondary>
730       </indexterm>
731     </sect2>
732
733     <sect2 id="HDRWQ25">
734       <title>Enabling AFS Login on AIX Systems</title>
735
736       <note>
737         <para>If you plan to remove client functionality from this machine after completing the installation, skip this section and
738         proceed to <link linkend="HDRWQ50">Starting the BOS Server</link>.</para>
739       </note>
740
741       <para>In modern AFS installations, you should be using Kerberos v5
742       for user login, and obtaining AFS tokens following this authentication
743       step.</para>
744       
745       <para>There are currently no instructions available on configuring AIX to
746       automatically obtain AFS tokens at login. Following login, users can 
747       obtain tokens by running the <emphasis role="bold">aklog</emphasis> 
748       command</para>
749      
750       <para>Sites which still require <emphasis role="bold">kaserver</emphasis>
751       or external Kerberos v4 authentication should consult 
752       <link linkend="KAS012">Enabling kaserver based AFS login on AIX systems</link>
753       for details of how to enable AIX login.</para>
754       
755       <para>Proceed to <link linkend="HDRWQ50">Starting the BOS Server</link> 
756       (or if referring to these instructions while installing an additional 
757       file server machine, return to <link linkend="HDRWQ108">Starting Server
758       Programs</link>).</para>
759     </sect2>
760   </sect1>
761
762   <sect1 id="HDRWQ31">
763     <title>Getting Started on HP-UX Systems</title>
764
765     <para>Begin by building AFS modifications into a new kernel; HP-UX
766     does not support dynamic loading. Then create partitions for storing
767     AFS volumes, and install and configure the AFS-modified <emphasis
768     role="bold">fsck</emphasis> program to run on AFS server
769     partitions. If the machine is to remain an AFS client machine,
770     incorporate AFS into the machine's Pluggable Authentication Module
771     (PAM) scheme. <indexterm>
772         <primary>incorporating AFS kernel extensions</primary>
773
774         <secondary>first AFS machine</secondary>
775
776         <tertiary>HP-UX</tertiary>
777       </indexterm> <indexterm>
778         <primary>AFS kernel extensions</primary>
779
780         <secondary>on first AFS machine</secondary>
781
782         <tertiary>HP-UX</tertiary>
783       </indexterm> <indexterm>
784         <primary>first AFS machine</primary>
785
786         <secondary>AFS kernel extensions</secondary>
787
788         <tertiary>on HP-UX</tertiary>
789       </indexterm> <indexterm>
790         <primary>HP-UX</primary>
791
792         <secondary>AFS-modified kernel</secondary>
793
794         <tertiary>on first AFS machine</tertiary>
795       </indexterm></para>
796
797     <sect2 id="HDRWQ32">
798       <title>Building AFS into the HP-UX Kernel</title>
799
800       <para>Use the following instructions to build AFS modifications into the kernel on an HP-UX system. <orderedlist>
801           <listitem>
802             <para>Move the existing kernel-related files to a safe location. <programlisting>
803    # <emphasis role="bold">cp /stand/vmunix /stand/vmunix.noafs</emphasis>
804    # <emphasis role="bold">cp /stand/system /stand/system.noafs</emphasis>
805 </programlisting></para>
806           </listitem>
807
808           <listitem>
809             <para>Unpack the OpenAFS HP-UX distribution tarball. The examples 
810             below assume that you have unpacked the files into the 
811             <emphasis role="bold">/tmp/afsdist</emphasis> directory. If you 
812             pick a different location, substitute this in all of the following 
813             examples. Once you have unpacked the distribution, change directory 
814             as indicated.
815             <programlisting>
816    # <emphasis role="bold">cd /tmp/afsdist/hp_ux110/root.client</emphasis>
817 </programlisting></para>
818           </listitem>
819
820           <listitem>
821             <para>Copy the AFS initialization file to the local directory for initialization files (by convention, <emphasis
822             role="bold">/sbin/init.d</emphasis> on HP-UX machines). Note the removal of the <emphasis role="bold">.rc</emphasis>
823             extension as you copy the file. <programlisting>
824    # <emphasis role="bold">cp usr/vice/etc/afs.rc  /sbin/init.d/afs</emphasis>
825 </programlisting></para>
826           </listitem>
827
828           <listitem>
829             <para>Copy the file <emphasis role="bold">afs.driver</emphasis> to the local <emphasis
830             role="bold">/usr/conf/master.d</emphasis> directory, changing its name to <emphasis role="bold">afs</emphasis> as you
831             do. <programlisting>
832    # <emphasis role="bold">cp  usr/vice/etc/afs.driver  /usr/conf/master.d/afs</emphasis>
833 </programlisting></para>
834           </listitem>
835
836           <listitem>
837             <para>Copy the AFS kernel module to the local <emphasis role="bold">/usr/conf/lib</emphasis> directory.</para>
838
839             <para>If the machine's kernel supports NFS server functionality:</para>
840
841             <programlisting>
842    # <emphasis role="bold">cp bin/libafs.a /usr/conf/lib</emphasis>   
843 </programlisting>
844
845             <para>If the machine's kernel does not support NFS server functionality, change the file's name as you copy it:</para>
846
847             <programlisting>
848    # <emphasis role="bold">cp bin/libafs.nonfs.a /usr/conf/lib/libafs.a</emphasis>
849 </programlisting>
850           </listitem>
851
852           <listitem>
853             <para>Incorporate the AFS driver into the kernel, either using the <emphasis role="bold">SAM</emphasis> program or a
854             series of individual commands. <itemizedlist>
855                 <listitem>
856                   <para>To use the <emphasis role="bold">SAM</emphasis> program: <orderedlist>
857                       <listitem>
858                         <para>Invoke the <emphasis role="bold">SAM</emphasis> program, specifying the hostname of the local machine
859                         as <replaceable>local_hostname</replaceable>. The <emphasis role="bold">SAM</emphasis> graphical user
860                         interface pops up. <programlisting>
861    # <emphasis role="bold">sam -display</emphasis> <replaceable>local_hostname</replaceable><emphasis role="bold">:0</emphasis> 
862 </programlisting></para>
863                       </listitem>
864
865                       <listitem>
866                         <para>Choose the <emphasis role="bold">Kernel Configuration</emphasis> icon, then the <emphasis
867                         role="bold">Drivers</emphasis> icon. From the list of drivers, select <emphasis
868                         role="bold">afs</emphasis>.</para>
869                       </listitem>
870
871                       <listitem>
872                         <para>Open the pull-down <emphasis role="bold">Actions</emphasis> menu and choose the <emphasis
873                         role="bold">Add Driver to Kernel</emphasis> option.</para>
874                       </listitem>
875
876                       <listitem>
877                         <para>Open the <emphasis role="bold">Actions</emphasis> menu again and choose the <emphasis
878                         role="bold">Create a New Kernel</emphasis> option.</para>
879                       </listitem>
880
881                       <listitem>
882                         <para>Confirm your choices by choosing <emphasis role="bold">Yes</emphasis> and <emphasis
883                         role="bold">OK</emphasis> when prompted by subsequent pop-up windows. The <emphasis
884                         role="bold">SAM</emphasis> program builds the kernel and reboots the system.</para>
885                       </listitem>
886
887                       <listitem>
888                         <para>Login again as the superuser <emphasis role="bold">root</emphasis>. <programlisting>
889    login: <emphasis role="bold">root</emphasis>
890    Password: <replaceable>root_password</replaceable>
891 </programlisting></para>
892                       </listitem>
893                     </orderedlist></para>
894                 </listitem>
895
896                 <listitem>
897                   <para>To use individual commands: <orderedlist>
898                       <listitem>
899                         <para>Edit the file <emphasis role="bold">/stand/system</emphasis>, adding an entry for <emphasis
900                         role="bold">afs</emphasis> to the <computeroutput>Subsystems</computeroutput> section.</para>
901                       </listitem>
902
903                       <listitem>
904                         <para>Change to the <emphasis role="bold">/stand/build</emphasis> directory and issue the <emphasis
905                         role="bold">mk_kernel</emphasis> command to build the kernel. <programlisting>
906    # <emphasis role="bold">cd /stand/build</emphasis>
907    # <emphasis role="bold">mk_kernel</emphasis>
908 </programlisting></para>
909                       </listitem>
910
911                       <listitem>
912                         <para>Move the new kernel to the standard location (<emphasis role="bold">/stand/vmunix</emphasis>), reboot
913                         the machine to start using it, and login again as the superuser <emphasis role="bold">root</emphasis>.
914                         <programlisting>
915    # <emphasis role="bold">mv /stand/build/vmunix_test /stand/vmunix</emphasis>
916    # <emphasis role="bold">cd /</emphasis>
917    # <emphasis role="bold">shutdown -r now</emphasis>             
918    login: <emphasis role="bold">root</emphasis>
919    Password: <replaceable>root_password</replaceable>
920 </programlisting></para>
921                       </listitem>
922                     </orderedlist></para>
923                 </listitem>
924               </itemizedlist></para>
925           </listitem>
926         </orderedlist></para>
927
928       <indexterm>
929         <primary>configuring</primary>
930
931         <secondary>AFS server partition on first AFS machine</secondary>
932
933         <tertiary>HP-UX</tertiary>
934       </indexterm>
935
936       <indexterm>
937         <primary>AFS server partition</primary>
938
939         <secondary>configuring on first AFS machine</secondary>
940
941         <tertiary>HP-UX</tertiary>
942       </indexterm>
943
944       <indexterm>
945         <primary>first AFS machine</primary>
946
947         <secondary>AFS server partition</secondary>
948
949         <tertiary>on HP-UX</tertiary>
950       </indexterm>
951
952       <indexterm>
953         <primary>HP-UX</primary>
954
955         <secondary>AFS server partition</secondary>
956
957         <tertiary>on first AFS machine</tertiary>
958       </indexterm>
959     </sect2>
960
961     <sect2 id="HDRWQ33">
962       <title>Configuring Server Partitions on HP-UX Systems</title>
963
964       <para>Every AFS file server machine must have at least one partition or logical volume dedicated to storing AFS volumes. Each
965       server partition is mounted at a directory named <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>, where
966       <replaceable>xx</replaceable> is one or two lowercase letters. The <emphasis
967       role="bold">/vicep</emphasis><replaceable>xx</replaceable> directories must reside in the file server machine's root
968       directory, not in one of its subdirectories (for example, <emphasis role="bold">/usr/vicepa</emphasis> is not an acceptable
969       directory location). For additional information, see <link linkend="HDRWQ20">Performing Platform-Specific Procedures</link>.
970       <orderedlist>
971           <listitem>
972             <para>Create a directory called <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable> for each AFS server
973             partition you are configuring (there must be at least one). Repeat the command for each partition. <programlisting>
974    # <emphasis role="bold">mkdir /vicep</emphasis><replaceable>xx</replaceable>
975 </programlisting></para>
976           </listitem>
977
978           <listitem>
979             <para>Use the <emphasis role="bold">SAM</emphasis> program to create a file system on each partition. For instructions,
980             consult the HP-UX documentation.</para>
981           </listitem>
982
983           <listitem>
984             <para>On some HP-UX systems that use logical volumes, the <emphasis role="bold">SAM</emphasis> program automatically
985             mounts the partitions. If it has not, mount each partition by issuing either the <emphasis role="bold">mount
986             -a</emphasis> command to mount all partitions at once or the <emphasis role="bold">mount</emphasis> command to mount
987             each partition in turn.</para>
988           </listitem>
989         </orderedlist></para>
990
991       <indexterm>
992         <primary>replacing fsck program</primary>
993
994         <secondary>first AFS machine</secondary>
995
996         <tertiary>HP-UX</tertiary>
997       </indexterm>
998
999       <indexterm>
1000         <primary>fsck program</primary>
1001
1002         <secondary>on first AFS machine</secondary>
1003
1004         <tertiary>HP-UX</tertiary>
1005       </indexterm>
1006
1007       <indexterm>
1008         <primary>first AFS machine</primary>
1009
1010         <secondary>fsck program</secondary>
1011
1012         <tertiary>on HP-UX</tertiary>
1013       </indexterm>
1014
1015       <indexterm>
1016         <primary>HP-UX</primary>
1017
1018         <secondary>fsck program</secondary>
1019
1020         <tertiary>on first AFS machine</tertiary>
1021       </indexterm>
1022     </sect2>
1023
1024     <sect2 id="HDRWQ34">
1025       <title>Configuring the AFS-modified fsck Program on HP-UX Systems</title>
1026
1027       <para>In this section, you make modifications to guarantee that the appropriate <emphasis role="bold">fsck</emphasis> program
1028       runs on AFS server partitions. The <emphasis role="bold">fsck</emphasis> program provided with the operating system must never
1029       run on AFS server partitions. Because it does not recognize the structures that the File Server uses to organize volume data,
1030       it removes all of the data. To repeat:</para>
1031
1032       <para><emphasis role="bold">Never run the standard fsck program on AFS server partitions. It discards AFS
1033       volumes.</emphasis></para>
1034
1035       <para>On HP-UX systems, there are several configuration files to install in addition to the AFS-modified <emphasis
1036       role="bold">fsck</emphasis> program (the <emphasis role="bold">vfsck</emphasis> binary). <orderedlist>
1037           <listitem>
1038             <para>Create the command configuration file <emphasis role="bold">/sbin/lib/mfsconfig.d/afs</emphasis>. Use a text
1039             editor to place the indicated two lines in it: <programlisting>
1040    format_revision 1
1041    fsck            0        m,P,p,d,f,b:c:y,n,Y,N,q,
1042 </programlisting></para>
1043           </listitem>
1044
1045           <listitem>
1046             <para>Create and change directory to an AFS-specific command directory called <emphasis
1047             role="bold">/sbin/fs/afs</emphasis>. <programlisting>
1048    # <emphasis role="bold">mkdir /sbin/fs/afs</emphasis>
1049    # <emphasis role="bold">cd  /sbin/fs/afs</emphasis>
1050 </programlisting></para>
1051           </listitem>
1052
1053           <listitem>
1054             <para>Copy the AFS-modified version of the <emphasis role="bold">fsck</emphasis> program (the <emphasis
1055             role="bold">vfsck</emphasis> binary) and related files from the distribution directory to the new AFS-specific command
1056             directory. <programlisting>
1057    # <emphasis role="bold">cp -p /tmp/afsdist/hp_ux110/root.server/etc/*  .</emphasis>
1058 </programlisting></para>
1059           </listitem>
1060
1061           <listitem>
1062             <para>Change the <emphasis role="bold">vfsck</emphasis> binary's name to <emphasis role="bold">fsck</emphasis> and set
1063             the mode bits appropriately on all of the files in the <emphasis role="bold">/sbin/fs/afs</emphasis> directory.
1064             <programlisting>
1065    # <emphasis role="bold">mv  vfsck  fsck</emphasis>
1066    # <emphasis role="bold">chmod  755  *</emphasis>
1067 </programlisting></para>
1068           </listitem>
1069
1070           <listitem>
1071             <para>Edit the <emphasis role="bold">/etc/fstab</emphasis> file, changing the file system type for each AFS server
1072             partition from <computeroutput>hfs</computeroutput> to <computeroutput>afs</computeroutput>. This ensures that the
1073             AFS-modified <emphasis role="bold">fsck</emphasis> program runs on the appropriate partitions.</para>
1074
1075             <para>The sixth line in the following example of an edited file shows an AFS server partition, <emphasis
1076             role="bold">/vicepa</emphasis>.</para>
1077
1078             <programlisting>
1079    /dev/vg00/lvol1 / hfs defaults 0 1
1080    /dev/vg00/lvol4 /opt hfs defaults 0 2
1081    /dev/vg00/lvol5 /tmp hfs defaults 0 2
1082    /dev/vg00/lvol6 /usr hfs defaults 0 2
1083    /dev/vg00/lvol8 /var hfs defaults 0 2
1084    /dev/vg00/lvol9 /vicepa afs defaults 0 2
1085    /dev/vg00/lvol7 /usr/vice/cache hfs defaults 0 2
1086 </programlisting>
1087           </listitem>
1088
1089           <listitem>
1090             <para>If you plan to retain client functionality on this machine after completing the installation, proceed to <link
1091             linkend="HDRWQ35">Enabling AFS Login on HP-UX Systems</link>. Otherwise, proceed to <link linkend="HDRWQ50">Starting the
1092             BOS Server</link>.</para>
1093           </listitem>
1094         </orderedlist></para>
1095
1096       <indexterm>
1097         <primary>enabling AFS login</primary>
1098
1099         <secondary>file server machine</secondary>
1100
1101         <tertiary>HP-UX</tertiary>
1102       </indexterm>
1103
1104       <indexterm>
1105         <primary>AFS login</primary>
1106
1107         <secondary>on file server machine</secondary>
1108
1109         <tertiary>HP-UX</tertiary>
1110       </indexterm>
1111
1112       <indexterm>
1113         <primary>first AFS machine</primary>
1114
1115         <secondary>AFS login</secondary>
1116
1117         <tertiary>on HP-UX</tertiary>
1118       </indexterm>
1119
1120       <indexterm>
1121         <primary>HP-UX</primary>
1122
1123         <secondary>AFS login</secondary>
1124
1125         <tertiary>on file server machine</tertiary>
1126       </indexterm>
1127
1128       <indexterm>
1129         <primary>PAM</primary>
1130
1131         <secondary>on HP-UX</secondary>
1132
1133         <tertiary>file server machine</tertiary>
1134       </indexterm>
1135
1136       <indexterm>
1137         <primary>Pluggable Authentication Module</primary>
1138
1139         <see>PAM</see>
1140       </indexterm>
1141     </sect2>
1142
1143     <sect2 id="HDRWQ35">
1144       <title>Enabling AFS Login on HP-UX Systems</title>
1145
1146       <note><para>If you plan to remove client functionality from this machine after completing the installation, skip this section and proceed to <link linkend="HDRWQ50">Starting the BOS Server</link>.</para></note>
1147
1148       <para>At this point you incorporate AFS into the operating system's
1149       Pluggable Authentication Module (PAM) scheme. PAM integrates all
1150       authentication mechanisms on the machine, including login, to
1151       provide the security infrastructure for authenticated access to and
1152       from the machine.</para>
1153
1154       <para>In modern AFS installations, you should be using Kerberos v5
1155       for user login, and obtaining AFS tokens subsequent to this
1156       authentication step. OpenAFS does not currently distribute a PAM
1157       module allowing AFS tokens to be automatically gained at
1158       login. Whilst there are a number of third party modules providing
1159       this functionality, it is not know if these have been tested with
1160       HP/UX.</para>
1161       
1162       <para>Following login, users can obtain tokens by running the
1163       <emphasis role="bold">aklog</emphasis> command</para>
1164
1165       <para>Sites which still require <emphasis
1166       role="bold">kaserver</emphasis> or external Kerberos v4
1167       authentication should consult <link linkend="KAS013">Enabling
1168       kaserver based AFS login on HP-UX systems</link> for details of how
1169       to enable HP-UX login.</para>
1170
1171       <para>Proceed to <link linkend="HDRWQ50">Starting the BOS
1172       Server</link> (or if referring to these instructions while
1173       installing an additional file server machine, return to <link
1174       linkend="HDRWQ108">Starting Server Programs</link>).</para>
1175     </sect2>
1176   </sect1>
1177
1178   <sect1 id="HDRWQ36">
1179     <title>Getting Started on IRIX Systems</title>
1180
1181     <indexterm>
1182       <primary>incorporating AFS kernel extensions</primary>
1183
1184       <secondary>first AFS machine</secondary>
1185
1186       <tertiary>IRIX</tertiary>
1187     </indexterm>
1188
1189     <indexterm>
1190       <primary>AFS kernel extensions</primary>
1191
1192       <secondary>on first AFS machine</secondary>
1193
1194       <tertiary>IRIX</tertiary>
1195     </indexterm>
1196
1197     <indexterm>
1198       <primary>first AFS machine</primary>
1199
1200       <secondary>AFS kernel extensions</secondary>
1201
1202       <tertiary>on IRIX</tertiary>
1203     </indexterm>
1204
1205     <indexterm>
1206       <primary>replacing fsck program</primary>
1207
1208       <secondary>not necessary on IRIX</secondary>
1209     </indexterm>
1210
1211     <indexterm>
1212       <primary>fsck program</primary>
1213
1214       <secondary>on first AFS machine</secondary>
1215
1216       <tertiary>IRIX</tertiary>
1217     </indexterm>
1218
1219     <indexterm>
1220       <primary>first AFS machine</primary>
1221
1222       <secondary>fsck program</secondary>
1223
1224       <tertiary>on IRIX</tertiary>
1225     </indexterm>
1226
1227     <indexterm>
1228       <primary>IRIX</primary>
1229
1230       <secondary>fsck program replacement not necessary</secondary>
1231     </indexterm>
1232
1233     <para>To incorporate AFS into the kernel on IRIX systems, choose one of two methods: <itemizedlist>
1234         <listitem>
1235           <para>Run the AFS initialization script to invoke the <emphasis role="bold">ml</emphasis> program distributed by Silicon
1236           Graphics, Incorporated (SGI), which dynamically loads AFS modifications into the kernel</para>
1237         </listitem>
1238
1239         <listitem>
1240           <para>Build a new static kernel</para>
1241         </listitem>
1242       </itemizedlist></para>
1243
1244     <para>Then create partitions for storing AFS volumes. You do not need to replace the IRIX <emphasis role="bold">fsck</emphasis>
1245     program because SGI has already modified it to handle AFS volumes properly. If the machine is to remain an AFS client machine,
1246     verify that the IRIX login utility installed on the machine grants an AFS token.</para>
1247
1248     <para>In preparation for either dynamic loading or kernel building, perform the following procedures: <orderedlist>
1249         <listitem>
1250           <para>Unpack the OpenAFS IRIX distribution tarball. The examples
1251           below assume that you have unpacked the files into the 
1252           <emphasis role="bold">/tmp/afsdist</emphasis> directory. If you
1253           pick a different location, substitue this in all of the following
1254           examples. Once you have unpacked the distribution, change directory
1255           as indicated.
1256 <programlisting>
1257    # <emphasis role="bold">cd  /tmp/afsdist/sgi_65/root.client</emphasis>
1258 </programlisting></para>
1259         </listitem>
1260
1261         <listitem>
1262           <para>Copy the AFS initialization script to the local directory for initialization files (by convention, <emphasis
1263           role="bold">/etc/init.d</emphasis> on IRIX machines). Note the removal of the <emphasis role="bold">.rc</emphasis>
1264           extension as you copy the script. <programlisting>
1265    # <emphasis role="bold">cp -p   usr/vice/etc/afs.rc  /etc/init.d/afs</emphasis>
1266 </programlisting></para>
1267         </listitem>
1268
1269         <listitem>
1270           <para>Issue the <emphasis role="bold">uname -m</emphasis> command to determine the machine's CPU board type. The <emphasis
1271           role="bold">IP</emphasis><replaceable>xx</replaceable> value in the output must match one of the supported CPU board types
1272           listed in the <emphasis>OpenAFS Release Notes</emphasis> for the current version of AFS. <programlisting>
1273    # <emphasis role="bold">uname -m</emphasis>
1274 </programlisting></para>
1275         </listitem>
1276
1277         <listitem>
1278           <para>Proceed to either <link linkend="HDRWQ37">Loading AFS into the IRIX Kernel</link> or <link
1279           linkend="HDRWQ38">Building AFS into the IRIX Kernel</link>.</para>
1280         </listitem>
1281       </orderedlist></para>
1282
1283     <indexterm>
1284       <primary>IRIX</primary>
1285
1286       <secondary>AFS kernel extensions</secondary>
1287
1288       <tertiary>on first AFS machine</tertiary>
1289     </indexterm>
1290
1291     <indexterm>
1292       <primary>afsml variable (IRIX)</primary>
1293
1294       <secondary>first AFS machine</secondary>
1295     </indexterm>
1296
1297     <indexterm>
1298       <primary>variables</primary>
1299
1300       <secondary>afsml (IRIX)</secondary>
1301
1302       <tertiary>first AFS machine</tertiary>
1303     </indexterm>
1304
1305     <indexterm>
1306       <primary>IRIX</primary>
1307
1308       <secondary>afsml variable</secondary>
1309
1310       <tertiary>first AFS machine</tertiary>
1311     </indexterm>
1312
1313     <indexterm>
1314       <primary>afsxnfs variable (IRIX)</primary>
1315
1316       <secondary>first AFS machine</secondary>
1317     </indexterm>
1318
1319     <indexterm>
1320       <primary>variables</primary>
1321
1322       <secondary>afsxnfs (IRIX)</secondary>
1323
1324       <tertiary>first AFS machine</tertiary>
1325     </indexterm>
1326
1327     <indexterm>
1328       <primary>IRIX</primary>
1329
1330       <secondary>afsxnfs variable</secondary>
1331
1332       <tertiary>first AFS machine</tertiary>
1333     </indexterm>
1334
1335     <sect2 id="HDRWQ37">
1336       <title>Loading AFS into the IRIX Kernel</title>
1337
1338       <para>The <emphasis role="bold">ml</emphasis> program is the dynamic kernel loader provided by SGI for IRIX systems. If you
1339       use it rather than building AFS modifications into a static kernel, then for AFS to function correctly the <emphasis
1340       role="bold">ml</emphasis> program must run each time the machine reboots. Therefore, the AFS initialization script (included
1341       on the AFS CD-ROM) invokes it automatically when the <emphasis role="bold">afsml</emphasis> configuration variable is
1342       activated. In this section you activate the variable and run the script.</para>
1343
1344       <para>In later sections you verify that the script correctly initializes all AFS components, then create the links that
1345       incorporate AFS into the IRIX startup and shutdown sequence. <orderedlist>
1346           <listitem>
1347             <para>Create the local <emphasis role="bold">/usr/vice/etc/sgiload</emphasis> directory to house the AFS kernel library
1348             file. <programlisting>
1349    # <emphasis role="bold">mkdir /usr/vice/etc/sgiload</emphasis>
1350 </programlisting></para>
1351           </listitem>
1352
1353           <listitem>
1354             <para>Copy the appropriate AFS kernel library file to the <emphasis role="bold">/usr/vice/etc/sgiload</emphasis>
1355             directory. The <emphasis role="bold">IP</emphasis><replaceable>xx</replaceable> portion of the library file name must
1356             match the value previously returned by the <emphasis role="bold">uname -m</emphasis> command. Also choose the file
1357             appropriate to whether the machine's kernel supports NFS server functionality (NFS must be supported for the machine to
1358             act as an NFS/AFS Translator). Single- and multiprocessor machines use the same library file.</para>
1359
1360             <para>(You can choose to copy all of the kernel library files into the <emphasis
1361             role="bold">/usr/vice/etc/sgiload</emphasis> directory, but they require a significant amount of space.)</para>
1362
1363             <para>If the machine's kernel supports NFS server functionality:</para>
1364
1365             <programlisting>
1366    # <emphasis role="bold">cp -p  usr/vice/etc/sgiload/libafs.IP</emphasis><replaceable>xx</replaceable><emphasis role="bold">.o  /usr/vice/etc/sgiload</emphasis>   
1367 </programlisting>
1368
1369             <para>If the machine's kernel does not support NFS server functionality:</para>
1370
1371             <programlisting>
1372    # <emphasis role="bold">cp -p  usr/vice/etc/sgiload/libafs.IP</emphasis><replaceable>xx</replaceable><emphasis role="bold">.nonfs.o</emphasis>   \
1373                    <emphasis role="bold">/usr/vice/etc/sgiload</emphasis>
1374 </programlisting>
1375           </listitem>
1376
1377           <listitem>
1378             <para>Issue the <emphasis role="bold">chkconfig</emphasis> command to activate the <emphasis
1379             role="bold">afsml</emphasis> configuration variable. <programlisting>
1380    # <emphasis role="bold">/etc/chkconfig -f afsml on</emphasis>   
1381 </programlisting></para>
1382
1383             <para>If the machine is to function as an NFS/AFS Translator and the kernel supports NFS server functionality, activate
1384             the <emphasis role="bold">afsxnfs</emphasis> variable.</para>
1385
1386             <programlisting>
1387    # <emphasis role="bold">/etc/chkconfig -f afsxnfs on</emphasis>
1388 </programlisting>
1389           </listitem>
1390
1391           <listitem>
1392             <para>Run the <emphasis role="bold">/etc/init.d/afs</emphasis> script to load AFS extensions into the kernel. The script
1393             invokes the <emphasis role="bold">ml</emphasis> command, automatically determining which kernel library file to use
1394             based on this machine's CPU type and the activation state of the <emphasis role="bold">afsxnfs</emphasis>
1395             variable.</para>
1396
1397             <para>You can ignore any error messages about the inability to start the BOS Server or the Cache Manager or AFS
1398             client.</para>
1399
1400             <programlisting>
1401    # <emphasis role="bold">/etc/init.d/afs start</emphasis>
1402 </programlisting>
1403           </listitem>
1404
1405           <listitem>
1406             <para>Proceed to <link linkend="HDRWQ39">Configuring Server Partitions on IRIX Systems</link>.</para>
1407           </listitem>
1408         </orderedlist></para>
1409
1410       <indexterm>
1411         <primary>IRIX</primary>
1412
1413         <secondary>AFS-modified kernel</secondary>
1414
1415         <tertiary>on first AFS machine</tertiary>
1416       </indexterm>
1417     </sect2>
1418
1419     <sect2 id="HDRWQ38">
1420       <title>Building AFS into the IRIX Kernel</title>
1421
1422       <para>Use the following instructions to build AFS modifications into the kernel on an IRIX system. <orderedlist>
1423           <listitem>
1424             <para>Copy the kernel initialization file <emphasis role="bold">afs.sm</emphasis> to the local <emphasis
1425             role="bold">/var/sysgen/system</emphasis> directory, and the kernel master file <emphasis role="bold">afs</emphasis> to
1426             the local <emphasis role="bold">/var/sysgen/master.d</emphasis> directory. <programlisting>
1427    # <emphasis role="bold">cp -p  bin/afs.sm  /var/sysgen/system</emphasis>
1428    # <emphasis role="bold">cp -p  bin/afs  /var/sysgen/master.d</emphasis>
1429 </programlisting></para>
1430           </listitem>
1431
1432           <listitem>
1433             <para>Copy the appropriate AFS kernel library file to the local file <emphasis
1434             role="bold">/var/sysgen/boot/afs.a</emphasis>; the <emphasis role="bold">IP</emphasis><replaceable>xx</replaceable>
1435             portion of the library file name must match the value previously returned by the <emphasis role="bold">uname
1436             -m</emphasis> command. Also choose the file appropriate to whether the machine's kernel supports NFS server
1437             functionality (NFS must be supported for the machine to act as an NFS/AFS Translator). Single- and multiprocessor
1438             machines use the same library file.</para>
1439
1440             <para>If the machine's kernel supports NFS server functionality:</para>
1441
1442             <programlisting>
1443    # <emphasis role="bold">cp -p   bin/libafs.IP</emphasis><replaceable>xx</replaceable><emphasis role="bold">.a   /var/sysgen/boot/afs.a</emphasis>   
1444 </programlisting>
1445
1446             <para>If the machine's kernel does not support NFS server functionality:</para>
1447
1448             <programlisting>
1449    # <emphasis role="bold">cp -p  bin/libafs.IP</emphasis><replaceable>xx</replaceable><emphasis role="bold">.nonfs.a  /var/sysgen/boot/afs.a</emphasis>
1450 </programlisting>
1451           </listitem>
1452
1453           <listitem>
1454             <para>Issue the <emphasis role="bold">chkconfig</emphasis> command to deactivate the <emphasis
1455             role="bold">afsml</emphasis> configuration variable. <programlisting>
1456    # <emphasis role="bold">/etc/chkconfig -f afsml off</emphasis>   
1457 </programlisting></para>
1458
1459             <para>If the machine is to function as an NFS/AFS Translator and the kernel supports NFS server functionality, activate
1460             the <emphasis role="bold">afsxnfs</emphasis> variable.</para>
1461
1462             <programlisting>
1463    # <emphasis role="bold">/etc/chkconfig -f afsxnfs on</emphasis>
1464 </programlisting>
1465           </listitem>
1466
1467           <listitem>
1468             <para>Copy the existing kernel file, <emphasis role="bold">/unix</emphasis>, to a safe location. Compile the new kernel,
1469             which is created in the file <emphasis role="bold">/unix.install</emphasis>. It overwrites the existing <emphasis
1470             role="bold">/unix</emphasis> file when the machine reboots in the next step. <programlisting>
1471    # <emphasis role="bold">cp /unix /unix_noafs</emphasis>
1472    # <emphasis role="bold">autoconfig</emphasis>
1473 </programlisting></para>
1474           </listitem>
1475
1476           <listitem>
1477             <para>Reboot the machine to start using the new kernel, and login again as the superuser <emphasis
1478             role="bold">root</emphasis>. <programlisting>
1479    # <emphasis role="bold">cd /</emphasis>
1480    # <emphasis role="bold">shutdown -i6 -g0 -y</emphasis>
1481    login: <emphasis role="bold">root</emphasis>
1482    Password: <replaceable>root_password</replaceable>
1483 </programlisting></para>
1484           </listitem>
1485         </orderedlist></para>
1486
1487       <indexterm>
1488         <primary>configuring</primary>
1489
1490         <secondary>AFS server partition on first AFS machine</secondary>
1491
1492         <tertiary>IRIX</tertiary>
1493       </indexterm>
1494
1495       <indexterm>
1496         <primary>AFS server partition</primary>
1497
1498         <secondary>configuring on first AFS machine</secondary>
1499
1500         <tertiary>IRIX</tertiary>
1501       </indexterm>
1502
1503       <indexterm>
1504         <primary>first AFS machine</primary>
1505
1506         <secondary>AFS server partition</secondary>
1507
1508         <tertiary>on IRIX</tertiary>
1509       </indexterm>
1510
1511       <indexterm>
1512         <primary>IRIX</primary>
1513
1514         <secondary>AFS server partition</secondary>
1515
1516         <tertiary>on first AFS machine</tertiary>
1517       </indexterm>
1518     </sect2>
1519
1520     <sect2 id="HDRWQ39">
1521       <title>Configuring Server Partitions on IRIX Systems</title>
1522
1523       <para>Every AFS file server machine must have at least one partition or logical volume dedicated to storing AFS volumes. Each
1524       server partition is mounted at a directory named <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>, where
1525       <replaceable>xx</replaceable> is one or two lowercase letters. The <emphasis
1526       role="bold">/vicep</emphasis><replaceable>xx</replaceable> directories must reside in the file server machine's root
1527       directory, not in one of its subdirectories (for example, <emphasis role="bold">/usr/vicepa</emphasis> is not an acceptable
1528       directory location). For additional information, see <link linkend="HDRWQ20">Performing Platform-Specific
1529       Procedures</link>.</para>
1530
1531       <para>AFS supports use of both EFS and XFS partitions for housing AFS volumes. SGI encourages use of XFS partitions.
1532       <orderedlist>
1533           <listitem>
1534             <para>Create a directory called <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable> for each AFS server
1535             partition you are configuring (there must be at least one). Repeat the command for each partition. <programlisting>
1536    # <emphasis role="bold">mkdir /vicep</emphasis><replaceable>xx</replaceable>
1537 </programlisting></para>
1538           </listitem>
1539
1540           <listitem>
1541             <para>Add a line with the following format to the file systems registry file, <emphasis
1542             role="bold">/etc/fstab</emphasis>, for each partition (or logical volume created with the XLV volume manager) to be
1543             mounted on one of the directories created in the previous step.</para>
1544
1545             <para>For an XFS partition or logical volume:</para>
1546
1547             <programlisting>
1548    /dev/dsk/<replaceable>disk</replaceable>  /vicep<replaceable>xx</replaceable>  xfs  rw,raw=/dev/rdsk/<replaceable>disk</replaceable>  0  0   
1549 </programlisting>
1550
1551             <para>For an EFS partition:</para>
1552
1553             <programlisting>
1554    /dev/dsk/<replaceable>disk</replaceable>  /vicep<replaceable>xx</replaceable>  efs  rw,raw=/dev/rdsk/<replaceable>disk</replaceable>  0  0   
1555 </programlisting>
1556
1557             <para>The following are examples of an entry for each file system type:</para>
1558
1559             <programlisting>
1560    /dev/dsk/dks0d2s6 /vicepa  xfs rw,raw=/dev/rdsk/dks0d2s6  0 0
1561    /dev/dsk/dks0d3s1 /vicepb  efs rw,raw=/dev/rdsk/dks0d3s1  0 0
1562 </programlisting>
1563           </listitem>
1564
1565           <listitem>
1566             <para>Create a file system on each partition that is to be mounted on a <emphasis
1567             role="bold">/vicep</emphasis><replaceable>xx</replaceable> directory. The following commands are probably appropriate,
1568             but consult the IRIX documentation for more information. In both cases, <replaceable>raw_device</replaceable> is a raw
1569             device name like <emphasis role="bold">/dev/rdsk/dks0d0s0</emphasis> for a single disk partition or <emphasis
1570             role="bold">/dev/rxlv/xlv0</emphasis> for a logical volume.</para>
1571
1572             <para>For XFS file systems, include the indicated options to configure the partition or logical volume with inodes large
1573             enough to accommodate AFS-specific information:</para>
1574
1575             <programlisting>
1576    # <emphasis role="bold">mkfs -t xfs -i size=512 -l size=4000b</emphasis> <replaceable>raw_device</replaceable>   
1577 </programlisting>
1578
1579             <para>For EFS file systems:</para>
1580
1581             <programlisting>
1582    # <emphasis role="bold">mkfs -t efs</emphasis> <replaceable>raw_device</replaceable>
1583 </programlisting>
1584           </listitem>
1585
1586           <listitem>
1587             <para>Mount each partition by issuing either the <emphasis role="bold">mount -a</emphasis> command to mount all
1588             partitions at once or the <emphasis role="bold">mount</emphasis> command to mount each partition in turn.</para>
1589           </listitem>
1590
1591           <listitem>
1592             <para><emphasis role="bold">(Optional)</emphasis> If you have configured partitions or logical volumes to use XFS, issue
1593             the following command to verify that the inodes are configured properly (are large enough to accommodate AFS-specific
1594             information). If the configuration is correct, the command returns no output. Otherwise, it specifies the command to run
1595             in order to configure each partition or logical volume properly. <programlisting>
1596    # <emphasis role="bold">/usr/afs/bin/xfs_size_check</emphasis>
1597 </programlisting></para>
1598           </listitem>
1599
1600           <listitem>
1601             <para>If you plan to retain client functionality on this machine after completing the installation, proceed to <link
1602             linkend="HDRWQ40">Enabling AFS Login on IRIX Systems</link>. Otherwise, proceed to <link linkend="HDRWQ50">Starting the
1603             BOS Server</link>.</para>
1604           </listitem>
1605         </orderedlist></para>
1606
1607       <indexterm>
1608         <primary>enabling AFS login</primary>
1609
1610         <secondary>file server machine</secondary>
1611
1612         <tertiary>IRIX</tertiary>
1613       </indexterm>
1614
1615       <indexterm>
1616         <primary>AFS login</primary>
1617
1618         <secondary>on file server machine</secondary>
1619
1620         <tertiary>IRIX</tertiary>
1621       </indexterm>
1622
1623       <indexterm>
1624         <primary>first AFS machine</primary>
1625
1626         <secondary>AFS login</secondary>
1627
1628         <tertiary>on IRIX</tertiary>
1629       </indexterm>
1630
1631       <indexterm>
1632         <primary>IRIX</primary>
1633
1634         <secondary>AFS login</secondary>
1635       </indexterm>
1636     </sect2>
1637
1638     <sect2 id="HDRWQ40">
1639       <title>Enabling AFS Login on IRIX Systems</title>
1640
1641       <note>
1642         <para>If you plan to remove client functionality from this machine after completing the installation, skip this section and
1643         proceed to <link linkend="HDRWQ50">Starting the BOS Server</link>.</para>
1644       </note>
1645
1646       <para>Whilst the standard IRIX command-line 
1647       <emphasis role="bold">login</emphasis> program and the 
1648       graphical <emphasis role="bold">xdm</emphasis> login program both have
1649       the ability to grant AFS tokens, this ability relies upon the deprecated
1650       kaserver authentication system.</para>
1651         
1652       <para>Users who have been successfully authenticated via Kerberos 5
1653       authentication may obtain AFS tokens following login by running the
1654       <emphasis role="bold">aklog</emphasis> command.</para>
1655
1656       <para>Sites which still require <emphasis role="bold">kaserver</emphasis>
1657       or external Kerberos v4 authentication should consult 
1658       <link linkend="KAS014">Enabling kaserver based AFS Login on IRIX Systems</link>
1659       for details of how to enable IRIX login.</para>       
1660
1661       <para>After taking any necessary action, proceed to 
1662       <link linkend="HDRWQ50">Starting the BOS Server</link>.</para>
1663     </sect2>
1664   </sect1>
1665
1666   <sect1 id="HDRWQ41">
1667     <title>Getting Started on Linux Systems</title>
1668
1669     <indexterm>
1670       <primary>replacing fsck program</primary>
1671
1672       <secondary>not necessary on Linux</secondary>
1673     </indexterm>
1674
1675     <indexterm>
1676       <primary>fsck program</primary>
1677
1678       <secondary>on first AFS machine</secondary>
1679
1680       <tertiary>Linux</tertiary>
1681     </indexterm>
1682
1683     <indexterm>
1684       <primary>first AFS machine</primary>
1685
1686       <secondary>fsck program</secondary>
1687
1688       <tertiary>on Linux</tertiary>
1689     </indexterm>
1690
1691     <indexterm>
1692       <primary>Linux</primary>
1693
1694       <secondary>fsck program replacement not necessary</secondary>
1695     </indexterm>
1696
1697     <para>Since this guide was originally written, the procedure for starting 
1698     OpenAFS has diverged significantly between different Linux distributions. 
1699     The instructions that follow are appropriate for both the Fedora and 
1700     RedHat Enterprise Linux packages distributed by OpenAFS. Additional 
1701     instructions are provided for those building from source.</para>
1702
1703     <para>Begin by running the AFS client startup scripts, which call the
1704     <emphasis role="bold">modprobe</emphasis> program to dynamically
1705     load the AFS modifications into the kernel. Then create partitions for
1706     storing AFS volumes. You do not need to replace the Linux <emphasis
1707     role="bold">fsck</emphasis> program. If the machine is to remain an
1708     AFS client machine, incorporate AFS into the machine's Pluggable
1709     Authentication Module (PAM) scheme. <indexterm>
1710         <primary>incorporating AFS kernel extensions</primary>
1711
1712         <secondary>first AFS machine</secondary>
1713
1714         <tertiary>Linux</tertiary>
1715       </indexterm> <indexterm>
1716         <primary>AFS kernel extensions</primary>
1717
1718         <secondary>on first AFS machine</secondary>
1719
1720         <tertiary>Linux</tertiary>
1721       </indexterm> <indexterm>
1722         <primary>first AFS machine</primary>
1723
1724         <secondary>AFS kernel extensions</secondary>
1725
1726         <tertiary>on Linux</tertiary>
1727       </indexterm> <indexterm>
1728         <primary>Linux</primary>
1729
1730         <secondary>AFS kernel extensions</secondary>
1731
1732         <tertiary>on first AFS machine</tertiary>
1733       </indexterm></para>
1734
1735     <sect2 id="HDRWQ42">
1736       <title>Loading AFS into the Linux Kernel</title>
1737
1738       <para>The <emphasis role="bold">modprobe</emphasis> program is the dynamic kernel loader for Linux. Linux does not support
1739       incorporation of AFS modifications during a kernel build.</para>
1740
1741       <para>For AFS to function correctly, the <emphasis role="bold">modprobe</emphasis> program must run each time the machine
1742       reboots, so your distribution's AFS initialization script invokes it automatically. The script also includes
1743       commands that select the appropriate AFS library file automatically. In this section you run the script.</para>
1744
1745       <para>In later sections you verify that the script correctly initializes all AFS components, then activate a configuration
1746       variable, which results in the script being incorporated into the Linux startup and shutdown sequence.</para> 
1747       
1748       <para>The procedure for starting up OpenAFS depends upon your distribution</para>
1749       <sect3>
1750         <title>Fedora and RedHat Enterprise Linux</title>
1751         <para>OpenAFS provides RPMS for all current Fedora and RedHat Enterprise Linux (RHEL) releases on the OpenAFS web site and the OpenAFS yum repository.
1752         <orderedlist>
1753           <listitem>
1754             <para>Browse to
1755             http://dl.openafs.org/dl/openafs/<replaceable>VERSION</replaceable>,
1756             where VERSION is the latest stable release of
1757             OpenAFS. Download the
1758             openafs-repository-<replaceable>VERSION</replaceable>.noarch.rpm
1759             file for Fedora systems or the
1760             openafs-repository-rhel-<replaceable>VERSION</replaceable>.noarch.rpm
1761             file for RedHat-based systems.
1762             </para>
1763           </listitem>
1764           <listitem>
1765             <para>Install the downloaded RPM file using the following command:
1766               <programlisting>
1767                 # rpm -U openafs-repository*.rpm
1768               </programlisting>
1769             </para>
1770           </listitem>
1771           <listitem>
1772             <para>Install the RPM set for your operating system using the yum command as follows:
1773               <programlisting>
1774                 # yum -y install openafs-client openafs-server openafs-krb5 kmod-openafs
1775               </programlisting>
1776
1777             </para>
1778             <para>Alternatively, you may use dynamically-compiled kernel
1779               modules if you have the kernel headers, a compiler, and the
1780               dkms package from
1781               <ulink url="http://fedoraproject.org/wiki/EPEL"><citetitle>EPEL</citetitle></ulink> installed. 
1782
1783             </para>
1784             <para>To use dynamically-compiled kernel modules instead of statically compiled modules, use the following command instead of the kmod-openafs as shown above:
1785               <programlisting>
1786                 # yum install openafs-client openafs-server openafs-krb5 dkms-openafs
1787               </programlisting>
1788             </para>
1789           </listitem>
1790 <!-- If you do this with current RHEL and Fedora releases you end up with
1791      a dynroot'd client running - this breaks setting up the root.afs volume
1792      as described later in this guide
1793           <listitem>
1794             <para>Run the AFS initialization script to load AFS extensions into 
1795             the kernel. You can ignore any error messages about the inability 
1796             to start the BOS Server or the Cache Manager or AFS client.</para>
1797 <programlisting>
1798    # <emphasis role="bold">/etc/rc.d/init.d/openafs-client  start</emphasis>
1799 </programlisting>
1800           </listitem>
1801 -->
1802         </orderedlist>
1803       </para>
1804       </sect3>
1805       <sect3>
1806          <title>Systems packaged as tar files</title>
1807          <para>If you are running a system where the OpenAFS Binary Distribution
1808          is provided as a tar file, or where you have built the system from
1809          source yourself, you need to install the relevant components by hand
1810          </para>
1811          <orderedlist>
1812            
1813           <listitem>
1814             <para>Unpack the distribution tarball. The examples below assume
1815             that you have unpacked the files into the
1816             <emphasis role="bold">/tmp/afsdist</emphasis> directory. If you
1817             pick a different location, substitute this in all of the following
1818             examples. Once you have unpacked the distribution,
1819             change directory as indicated.
1820 <programlisting>
1821   # <emphasis role="bold">cd /tmp/afsdist/linux/root.client/usr/vice/etc</emphasis>
1822 </programlisting></para>
1823           </listitem>
1824           
1825           <listitem>
1826             <para>Copy the AFS kernel library files to the local <emphasis role="bold">/usr/vice/etc/modload</emphasis> directory.
1827             The filenames for the libraries have the format <emphasis
1828             role="bold">libafs-</emphasis><replaceable>version</replaceable><emphasis role="bold">.o</emphasis>, where
1829             <replaceable>version</replaceable> indicates the kernel build level. The string <emphasis role="bold">.mp</emphasis> in
1830             the <replaceable>version</replaceable> indicates that the file is appropriate for machines running a multiprocessor
1831             kernel. <programlisting>
1832    # <emphasis role="bold">cp -rp  modload  /usr/vice/etc</emphasis>
1833 </programlisting></para>
1834           </listitem>
1835
1836           <listitem>
1837             <para>Copy the AFS initialization script to the local directory for initialization files (by convention, <emphasis
1838             role="bold">/etc/rc.d/init.d</emphasis> on Linux machines). Note the removal of the <emphasis role="bold">.rc</emphasis>
1839             extension as you copy the script. <programlisting>
1840    # <emphasis role="bold">cp -p   afs.rc  /etc/rc.d/init.d/afs</emphasis> 
1841 </programlisting></para>
1842           </listitem>
1843
1844 <!-- I don't think we need to do this for Linux, and it complicates things if
1845      dynroot is enabled ...
1846           <listitem>
1847             <para>Run the AFS initialization script to load AFS extensions into the kernel. You can ignore any error messages about
1848             the inability to start the BOS Server or the Cache Manager or AFS client.</para>
1849 <programlisting>
1850    # <emphasis role="bold">/etc/rc.d/init.d/afs start</emphasis>
1851 </programlisting>
1852           </listitem>
1853 -->
1854         </orderedlist>
1855
1856       <indexterm>
1857         <primary>configuring</primary>
1858    
1859         <secondary>AFS server partition on first AFS machine</secondary>
1860
1861         <tertiary>Linux</tertiary>
1862       </indexterm>
1863
1864       <indexterm>
1865         <primary>AFS server partition</primary>
1866
1867         <secondary>configuring on first AFS machine</secondary>
1868
1869         <tertiary>Linux</tertiary>
1870       </indexterm>
1871
1872       <indexterm>
1873         <primary>first AFS machine</primary>
1874
1875         <secondary>AFS server partition</secondary>
1876
1877         <tertiary>on Linux</tertiary>
1878       </indexterm>
1879
1880       <indexterm>
1881         <primary>Linux</primary>
1882
1883         <secondary>AFS server partition</secondary>
1884
1885         <tertiary>on first AFS machine</tertiary>
1886       </indexterm>
1887     </sect3>
1888     </sect2>
1889
1890     <sect2 id="HDRWQ43">
1891       <title>Configuring Server Partitions on Linux Systems</title>
1892
1893       <para>Every AFS file server machine must have at least one partition or logical volume dedicated to storing AFS volumes. Each
1894       server partition is mounted at a directory named <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>, where
1895       <replaceable>xx</replaceable> is one or two lowercase letters. The <emphasis
1896       role="bold">/vicep</emphasis><replaceable>xx</replaceable> directories must reside in the file server machine's root
1897       directory, not in one of its subdirectories (for example, <emphasis role="bold">/usr/vicepa</emphasis> is not an acceptable
1898       directory location). For additional information, see <link linkend="HDRWQ20">Performing Platform-Specific Procedures</link>.
1899       <orderedlist>
1900           <listitem>
1901             <para>Create a directory called <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable> for each AFS server
1902             partition you are configuring (there must be at least one). Repeat the command for each partition. <programlisting>
1903    # <emphasis role="bold">mkdir /vicep</emphasis><replaceable>xx</replaceable>
1904 </programlisting></para>
1905           </listitem>
1906
1907           <listitem>
1908             <para>Add a line with the following format to the file systems registry file, <emphasis
1909             role="bold">/etc/fstab</emphasis>, for each directory just created. The entry maps the directory name to the disk
1910             partition to be mounted on it. <programlisting>
1911    /dev/<replaceable>disk</replaceable>  /vicep<replaceable>xx</replaceable>  ext2  defaults  0  2   
1912 </programlisting></para>
1913
1914             <para>The following is an example for the first partition being configured.</para>
1915
1916             <programlisting>
1917    /dev/sda8 /vicepa ext2 defaults 0 2
1918 </programlisting>
1919           </listitem>
1920
1921           <listitem>
1922             <para>Create a file system on each partition that is to be mounted at a <emphasis
1923             role="bold">/vicep</emphasis><replaceable>xx</replaceable> directory. The following command is probably appropriate, but
1924             consult the Linux documentation for more information. <programlisting>
1925    # <emphasis role="bold">mkfs -v /dev/</emphasis><replaceable>disk</replaceable>
1926 </programlisting></para>
1927           </listitem>
1928
1929           <listitem>
1930             <para>Mount each partition by issuing either the <emphasis role="bold">mount -a</emphasis> command to mount all
1931             partitions at once or the <emphasis role="bold">mount</emphasis> command to mount each partition in turn.</para>
1932           </listitem>
1933
1934           <listitem>
1935             <para>If you plan to retain client functionality on this machine after completing the installation, proceed to <link
1936             linkend="HDRWQ44">Enabling AFS Login on Linux Systems</link>. Otherwise, proceed to <link linkend="HDRWQ50">Starting the
1937             BOS Server</link>.</para>
1938           </listitem>
1939         </orderedlist></para>
1940
1941       <indexterm>
1942         <primary>enabling AFS login</primary>
1943
1944         <secondary>file server machine</secondary>
1945
1946         <tertiary>Linux</tertiary>
1947       </indexterm>
1948
1949       <indexterm>
1950         <primary>AFS login</primary>
1951
1952         <secondary>on file server machine</secondary>
1953
1954         <tertiary>Linux</tertiary>
1955       </indexterm>
1956
1957       <indexterm>
1958         <primary>first AFS machine</primary>
1959
1960         <secondary>AFS login</secondary>
1961
1962         <tertiary>on Linux</tertiary>
1963       </indexterm>
1964
1965       <indexterm>
1966         <primary>Linux</primary>
1967
1968         <secondary>AFS login</secondary>
1969
1970         <tertiary>on file server machine</tertiary>
1971       </indexterm>
1972
1973       <indexterm>
1974         <primary>PAM</primary>
1975
1976         <secondary>on Linux</secondary>
1977
1978         <tertiary>file server machine</tertiary>
1979       </indexterm>
1980     </sect2>
1981
1982     <sect2 id="HDRWQ44">
1983       <title>Enabling AFS Login on Linux Systems</title>
1984
1985       <note>
1986         <para>If you plan to remove client functionality from this machine
1987         after completing the installation, skip this section and proceed
1988         to <link linkend="HDRWQ50">Starting the BOS Server</link>.</para>
1989       </note>
1990
1991       <para>At this point you incorporate AFS into the operating system's
1992       Pluggable Authentication Module (PAM) scheme.  PAM integrates all
1993       authentication mechanisms on the machine, including login, to provide
1994       the security infrastructure for authenticated access to and from the
1995       machine.</para>
1996
1997       <para>You should first configure your system to obtain Kerberos v5
1998       tickets as part of the authentication process, and then run an AFS PAM
1999       module to obtain tokens from those tickets after authentication.  Many
2000       Linux distributions come with a Kerberos v5 PAM module (usually called
2001       pam-krb5 or pam_krb5), or you can download and install <ulink
2002       url="http://www.eyrie.org/~eagle/software/pam-krb5">Russ Allbery's
2003       Kerberos v5 PAM module</ulink>, which is tested regularly with AFS.
2004       See the instructions of whatever PAM module you use for how to
2005       configure it.</para>
2006
2007       <para>Some Kerberos v5 PAM modules do come with native AFS support
2008       (usually requiring the Heimdal Kerberos implementation rather than the
2009       MIT Kerberos implementation).  If you are using one of those PAM
2010       modules, you can configure it to obtain AFS tokens.  It's more common,
2011       however, to separate the AFS token acquisition into a separate PAM
2012       module.</para>
2013
2014       <para>The recommended AFS PAM module is <ulink
2015       url="http://www.eyrie.org/~eagle/software/pam-afs-session/">Russ
2016       Allbery's pam-afs-session module</ulink>.  It should work with any of
2017       the Kerberos v5 PAM modules.  To add it to the PAM configuration, you
2018       often only need to add configuration to the session group:</para>
2019
2020       <example>
2021         <title>Linux PAM session example</title>
2022         <literallayout>session  required  pam_afs_session.so</literallayout>
2023       </example>
2024
2025       <para>If you also want to obtain AFS tokens for <command>scp</command>
2026       and similar commands that don't open a session, you will also need to
2027       add the AFS PAM module to the auth group so that the PAM
2028       <function>setcred</function> call will obtain tokens.  The
2029       <literal>pam_afs_session</literal> module will always return success
2030       for authentication so that it can be added to the auth group only for
2031       <function>setcred</function>, so make sure that it's not marked as
2032       <literal>sufficient</literal>.</para>
2033
2034       <example>
2035         <title>Linux PAM auth example</title>
2036 <literallayout>auth  [success=ok default=1]  pam_krb5.so
2037 auth  [default=done]          pam_afs_session.so
2038 auth  required                pam_unix.so try_first_pass</literallayout>
2039       </example>
2040
2041       <para>This example will work if you want to try Kerberos v5 first and
2042       then fall back to regular Unix authentication.
2043       <literal>success=ok</literal> for the Kerberos PAM module followed by
2044       <literal>default=done</literal> for the AFS PAM module will cause a
2045       successful Kerberos login to run the AFS PAM module and then skip the
2046       Unix authentication module.  <literal>default=1</literal> on the
2047       Kerberos PAM module causes failure of that module to skip the next
2048       module (the AFS PAM module) and fall back to the Unix module.  If you
2049       want to try Unix authentication first and rearrange the order, be sure
2050       to use <literal>default=die</literal> instead.</para>
2051
2052       <para>The PAM configuration is stored in different places in different
2053       Linux distributions.  On Red Hat, look in
2054       <filename>/etc/pam.d/system-auth</filename>.  On Debian and
2055       derivatives, look in <filename>/etc/pam.d/common-session</filename>
2056       and <filename>/etc/pam.d/common-auth</filename>.</para>
2057
2058       <para>For additional configuration examples and the configuration
2059       options of the AFS PAM module, see its documentation.  For more
2060       details on the available options for the PAM configuration, see the
2061       Linux PAM documentation.</para>
2062
2063       <para>Sites which still require <command>kaserver</command> or
2064       external Kerberos v4 authentication should consult <link
2065       linkend="KAS015">Enabling kaserver based AFS Login on Linux
2066       Systems</link> for details of how to enable AFS login on Linux.</para>
2067       
2068       <para>Proceed to <link linkend="HDRWQ50">Starting the BOS
2069       Server</link> (or if referring to these instructions while installing
2070       an additional file server machine, return to <link
2071       linkend="HDRWQ108">Starting Server Programs</link>).</para>
2072     </sect2>
2073   </sect1>
2074
2075   <sect1 id="HDRWQ45">
2076     <title>Getting Started on Solaris Systems</title>
2077
2078     <para>Begin by running the AFS initialization script to call the <emphasis role="bold">modload</emphasis> program distributed by
2079     Sun Microsystems, which dynamically loads AFS modifications into the kernel. Then create partitions for storing AFS volumes, and
2080     install and configure the AFS-modified <emphasis role="bold">fsck</emphasis> program to run on AFS server partitions. If the
2081     machine is to remain an AFS client machine, incorporate AFS into the machine's Pluggable Authentication Module (PAM) scheme.
2082     <indexterm>
2083         <primary>incorporating AFS kernel extensions</primary>
2084
2085         <secondary>first AFS machine</secondary>
2086
2087         <tertiary>Solaris</tertiary>
2088       </indexterm> <indexterm>
2089         <primary>AFS kernel extensions</primary>
2090
2091         <secondary>on first AFS machine</secondary>
2092
2093         <tertiary>Solaris</tertiary>
2094       </indexterm> <indexterm>
2095         <primary>first AFS machine</primary>
2096
2097         <secondary>AFS kernel extensions</secondary>
2098
2099         <tertiary>on Solaris</tertiary>
2100       </indexterm> <indexterm>
2101         <primary>Solaris</primary>
2102
2103         <secondary>AFS kernel extensions</secondary>
2104
2105         <tertiary>on first AFS machine</tertiary>
2106       </indexterm></para>
2107
2108     <sect2 id="HDRWQ46">
2109       <title>Loading AFS into the Solaris Kernel</title>
2110
2111       <para>The <emphasis role="bold">modload</emphasis> program is the dynamic kernel loader provided by Sun Microsystems for
2112       Solaris systems. Solaris does not support incorporation of AFS modifications during a kernel build.</para>
2113
2114       <para>For AFS to function correctly, the <emphasis role="bold">modload</emphasis> program must run each time the machine
2115       reboots, so the AFS initialization script (included on the AFS CD-ROM) invokes it automatically. In this section you copy the
2116       appropriate AFS library file to the location where the <emphasis role="bold">modload</emphasis> program accesses it and then
2117       run the script.</para>
2118
2119       <para>In later sections you verify that the script correctly initializes all AFS components, then create the links that
2120       incorporate AFS into the Solaris startup and shutdown sequence. <orderedlist>
2121           <listitem>
2122             <para>Unpack the OpenAFS Solaris distribution tarball. The examples
2123             below assume that you have unpacked the files into the 
2124             <emphasis role="bold">/tmp/afsdist</emphasis> directory. If you 
2125             pick a diferent location, substitute this in all of the following
2126             exmaples. Once you have unpacked the distribution, change directory
2127             as indicated. 
2128 <programlisting>
2129    # <emphasis role="bold">cd  /tmp/afsdist/sun4x_56/root.client/usr/vice/etc</emphasis>
2130 </programlisting></para>
2131           </listitem>
2132
2133           <listitem>
2134             <para>Copy the AFS initialization script to the local directory for initialization files (by convention, <emphasis
2135             role="bold">/etc/init.d</emphasis> on Solaris machines). Note the removal of the <emphasis role="bold">.rc</emphasis>
2136             extension as you copy the script. <programlisting>
2137    # <emphasis role="bold">cp -p  afs.rc  /etc/init.d/afs</emphasis>
2138 </programlisting></para>
2139           </listitem>
2140
2141           <listitem>
2142             <para>Copy the appropriate AFS kernel library file to the local file <emphasis
2143             role="bold">/kernel/fs/afs</emphasis>.</para>
2144
2145             <para>If the machine is running Solaris 2.6 or the 32-bit version of Solaris 7, its kernel supports NFS server
2146             functionality, and the <emphasis role="bold">nfsd</emphasis> process is running:</para>
2147
2148             <programlisting>
2149    # <emphasis role="bold">cp -p modload/libafs.o /kernel/fs/afs</emphasis>   
2150 </programlisting>
2151
2152             <para>If the machine is running Solaris 2.6 or the 32-bit version of Solaris 7, and its kernel does not support NFS
2153             server functionality or the <emphasis role="bold">nfsd</emphasis> process is not running:</para>
2154
2155             <programlisting>
2156    # <emphasis role="bold">cp -p modload/libafs.nonfs.o /kernel/fs/afs</emphasis>   
2157 </programlisting>
2158
2159             <para>If the machine is running the 64-bit version of Solaris 7, its kernel supports NFS server functionality, and the
2160             <emphasis role="bold">nfsd</emphasis> process is running:</para>
2161
2162             <programlisting>
2163    # <emphasis role="bold">cp -p modload/libafs64.o /kernel/fs/sparcv9/afs</emphasis>   
2164 </programlisting>
2165
2166             <para>If the machine is running the 64-bit version of Solaris 7, and its kernel does not support NFS server
2167             functionality or the <emphasis role="bold">nfsd</emphasis> process is not running:</para>
2168
2169             <programlisting>
2170    # <emphasis role="bold">cp -p modload/libafs64.nonfs.o /kernel/fs/sparcv9/afs</emphasis>
2171 </programlisting>
2172           </listitem>
2173
2174           <listitem>
2175             <para>Run the AFS initialization script to load AFS modifications into the kernel. You can ignore any error messages
2176             about the inability to start the BOS Server or the Cache Manager or AFS client. <programlisting>
2177    # <emphasis role="bold">/etc/init.d/afs start</emphasis>   
2178 </programlisting></para>
2179
2180             <para>When an entry called <computeroutput>afs</computeroutput> does not already exist in the local <emphasis
2181             role="bold">/etc/name_to_sysnum</emphasis> file, the script automatically creates it and reboots the machine to start
2182             using the new version of the file. If this happens, log in again as the superuser <emphasis role="bold">root</emphasis>
2183             after the reboot and run the initialization script again. This time the required entry exists in the <emphasis
2184             role="bold">/etc/name_to_sysnum</emphasis> file, and the <emphasis role="bold">modload</emphasis> program runs.</para>
2185
2186             <programlisting>
2187    login: <emphasis role="bold">root</emphasis>
2188    Password: <replaceable>root_password</replaceable>
2189    # <emphasis role="bold">/etc/init.d/afs start</emphasis>
2190 </programlisting>
2191           </listitem>
2192         </orderedlist></para>
2193
2194       <indexterm>
2195         <primary>replacing fsck program</primary>
2196
2197         <secondary>first AFS machine</secondary>
2198
2199         <tertiary>Solaris</tertiary>
2200       </indexterm>
2201
2202       <indexterm>
2203         <primary>fsck program</primary>
2204
2205         <secondary>on first AFS machine</secondary>
2206
2207         <tertiary>Solaris</tertiary>
2208       </indexterm>
2209
2210       <indexterm>
2211         <primary>first AFS machine</primary>
2212
2213         <secondary>fsck program</secondary>
2214
2215         <tertiary>on Solaris</tertiary>
2216       </indexterm>
2217
2218       <indexterm>
2219         <primary>Solaris</primary>
2220
2221         <secondary>fsck program</secondary>
2222
2223         <tertiary>on first AFS machine</tertiary>
2224       </indexterm>
2225     </sect2>
2226
2227     <sect2 id="HDRWQ47">
2228       <title>Configuring the AFS-modified fsck Program on Solaris Systems</title>
2229
2230       <para>In this section, you make modifications to guarantee that the appropriate <emphasis role="bold">fsck</emphasis> program
2231       runs on AFS server partitions. The <emphasis role="bold">fsck</emphasis> program provided with the operating system must never
2232       run on AFS server partitions. Because it does not recognize the structures that the File Server uses to organize volume data,
2233       it removes all of the data. To repeat:</para>
2234
2235       <para><emphasis role="bold">Never run the standard fsck program on AFS server partitions. It discards AFS volumes.</emphasis>
2236       <orderedlist>
2237           <listitem>
2238             <para>Create the <emphasis role="bold">/usr/lib/fs/afs</emphasis> directory to house the AFS-modified <emphasis
2239             role="bold">fsck</emphasis> program and related files. <programlisting>
2240    # <emphasis role="bold">mkdir /usr/lib/fs/afs</emphasis>
2241    # <emphasis role="bold">cd /usr/lib/fs/afs</emphasis>  
2242 </programlisting></para>
2243           </listitem>
2244
2245           <listitem>
2246             <para>Copy the <emphasis role="bold">vfsck</emphasis> binary to the newly created directory, changing the name as you do
2247             so. <programlisting>
2248    # <emphasis role="bold">cp  /tmp/afsdist/sun4x_56/root.server/etc/vfsck  fsck</emphasis>
2249 </programlisting></para>
2250           </listitem>
2251
2252           <listitem>
2253             <para>Working in the <emphasis role="bold">/usr/lib/fs/afs</emphasis> directory, create the following links to Solaris
2254             libraries: <programlisting>
2255    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/clri</emphasis>  
2256    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/df</emphasis>
2257    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/edquota</emphasis>
2258    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/ff</emphasis>
2259    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/fsdb</emphasis>  
2260    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/fsirand</emphasis>
2261    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/fstyp</emphasis>
2262    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/labelit</emphasis>
2263    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/lockfs</emphasis>
2264    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/mkfs</emphasis>  
2265    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/mount</emphasis>
2266    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/ncheck</emphasis>
2267    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/newfs</emphasis>
2268    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/quot</emphasis>
2269    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/quota</emphasis>
2270    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/quotaoff</emphasis>
2271    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/quotaon</emphasis>
2272    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/repquota</emphasis>
2273    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/tunefs</emphasis>
2274    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/ufsdump</emphasis>
2275    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/ufsrestore</emphasis>
2276    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/volcopy</emphasis>
2277 </programlisting></para>
2278           </listitem>
2279
2280           <listitem>
2281             <para>Append the following line to the end of the file <emphasis role="bold">/etc/dfs/fstypes</emphasis>.
2282             <programlisting>
2283    afs AFS Utilities
2284 </programlisting></para>
2285           </listitem>
2286
2287           <listitem>
2288             <para>Edit the <emphasis role="bold">/sbin/mountall</emphasis> file, making two changes. <itemizedlist>
2289                 <listitem>
2290                   <para>Add an entry for AFS to the <computeroutput>case</computeroutput> statement for option 2, so that it reads
2291                   as follows: <programlisting>
2292    case "$2" in
2293    ufs)    foptions="-o p"
2294            ;;
2295    afs)    foptions="-o p"
2296            ;;
2297    s5)     foptions="-y -t /var/tmp/tmp$$ -D"
2298            ;;
2299    *)      foptions="-y"
2300            ;;
2301 </programlisting></para>
2302                 </listitem>
2303
2304                 <listitem>
2305                   <para>Edit the file so that all AFS and UFS partitions are checked in parallel. Replace the following section of
2306                   code: <programlisting>
2307    # For  fsck purposes, we make a distinction between ufs and
2308    # other file systems
2309    #
2310    if [ "$fstype" = "ufs" ]; then
2311         ufs_fscklist="$ufs_fscklist $fsckdev"
2312         saveentry $fstype "$OPTIONS" $special $mountp
2313         continue
2314    fi  
2315 </programlisting></para>
2316
2317                   <para>with the following section of code:</para>
2318
2319                   <programlisting>
2320    # For fsck purposes, we make a distinction between ufs/afs
2321    # and other file systems.
2322    #
2323    if [ "$fstype" = "ufs" -o "$fstype" = "afs" ]; then
2324         ufs_fscklist="$ufs_fscklist $fsckdev"
2325         saveentry $fstype "$OPTIONS" $special $mountp
2326         continue
2327    fi
2328 </programlisting>
2329                 </listitem>
2330               </itemizedlist></para>
2331           </listitem>
2332         </orderedlist></para>
2333
2334       <indexterm>
2335         <primary>configuring</primary>
2336
2337         <secondary>AFS server partition on first AFS machine</secondary>
2338
2339         <tertiary>Solaris</tertiary>
2340       </indexterm>
2341
2342       <indexterm>
2343         <primary>AFS server partition</primary>
2344
2345         <secondary>configuring on first AFS machine</secondary>
2346
2347         <tertiary>Solaris</tertiary>
2348       </indexterm>
2349
2350       <indexterm>
2351         <primary>first AFS machine</primary>
2352
2353         <secondary>AFS server partition</secondary>
2354
2355         <tertiary>on Solaris</tertiary>
2356       </indexterm>
2357
2358       <indexterm>
2359         <primary>Solaris</primary>
2360
2361         <secondary>AFS server partition</secondary>
2362
2363         <tertiary>on first AFS machine</tertiary>
2364       </indexterm>
2365     </sect2>
2366
2367     <sect2 id="HDRWQ48">
2368       <title>Configuring Server Partitions on Solaris Systems</title>
2369
2370       <para>Every AFS file server machine must have at least one partition or logical volume dedicated to storing AFS volumes. Each
2371       server partition is mounted at a directory named <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>, where
2372       <replaceable>xx</replaceable> is one or two lowercase letters. The <emphasis
2373       role="bold">/vicep</emphasis><replaceable>xx</replaceable> directories must reside in the file server machine's root
2374       directory, not in one of its subdirectories (for example, <emphasis role="bold">/usr/vicepa</emphasis> is not an acceptable
2375       directory location). For additional information, see <link linkend="HDRWQ20">Performing Platform-Specific Procedures</link>.
2376       <orderedlist>
2377           <listitem>
2378             <para>Create a directory called <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable> for each AFS server
2379             partition you are configuring (there must be at least one). Repeat the command for each partition. <programlisting>
2380    # <emphasis role="bold">mkdir /vicep</emphasis><replaceable>xx</replaceable>
2381 </programlisting></para>
2382           </listitem>
2383
2384           <listitem>
2385             <para>Add a line with the following format to the file systems registry file, <emphasis
2386             role="bold">/etc/vfstab</emphasis>, for each partition to be mounted on a directory created in the previous step. Note
2387             the value <computeroutput>afs</computeroutput> in the fourth field, which tells Solaris to use the AFS-modified
2388             <emphasis role="bold">fsck</emphasis> program on this partition. <programlisting>
2389    /dev/dsk/<replaceable>disk</replaceable>   /dev/rdsk/<replaceable>disk</replaceable>   /vicep<replaceable>xx</replaceable>   afs   <replaceable>boot_order</replaceable>  yes  
2390 </programlisting></para>
2391
2392             <para>The following is an example for the first partition being configured.</para>
2393
2394             <programlisting>
2395    /dev/dsk/c0t6d0s1 /dev/rdsk/c0t6d0s1 /vicepa afs 3 yes
2396 </programlisting>
2397           </listitem>
2398
2399           <listitem>
2400             <para>Create a file system on each partition that is to be mounted at a <emphasis
2401             role="bold">/vicep</emphasis><replaceable>xx</replaceable> directory. The following command is probably appropriate, but
2402             consult the Solaris documentation for more information. <programlisting>
2403    # <emphasis role="bold">newfs -v /dev/rdsk/</emphasis><replaceable>disk</replaceable>
2404 </programlisting></para>
2405           </listitem>
2406
2407           <listitem>
2408             <para>Issue the <emphasis role="bold">mountall</emphasis> command to mount all partitions at once.</para>
2409           </listitem>
2410
2411           <listitem>
2412             <para>If you plan to retain client functionality on this machine after completing the installation, proceed to <link
2413             linkend="HDRWQ49">Enabling AFS Login and Editing the File Systems Clean-up Script on Solaris Systems</link>. Otherwise,
2414             proceed to <link linkend="HDRWQ50">Starting the BOS Server</link>.</para>
2415           </listitem>
2416         </orderedlist></para>
2417     </sect2>
2418
2419     <sect2 id="HDRWQ49">
2420       <title>Enabling AFS Login on Solaris Systems</title>
2421       <indexterm>
2422         <primary>enabling AFS login</primary>
2423
2424         <secondary>file server machine</secondary>
2425
2426         <tertiary>Solaris</tertiary>
2427       </indexterm>
2428
2429       <indexterm>
2430         <primary>AFS login</primary>
2431
2432         <secondary>on file server machine</secondary>
2433
2434         <tertiary>Solaris</tertiary>
2435       </indexterm>
2436
2437       <indexterm>
2438         <primary>first AFS machine</primary>
2439
2440         <secondary>AFS login</secondary>
2441
2442         <tertiary>on Solaris</tertiary>
2443       </indexterm>
2444
2445       <indexterm>
2446         <primary>Solaris</primary>
2447
2448         <secondary>AFS login</secondary>
2449
2450         <tertiary>on file server machine</tertiary>
2451       </indexterm>
2452
2453       <indexterm>
2454         <primary>PAM</primary>
2455
2456         <secondary>on Solaris</secondary>
2457
2458         <tertiary>file server machine</tertiary>
2459       </indexterm>
2460
2461       <note>
2462         <para>If you plan to remove client functionality from this machine after completing the installation, skip this section and
2463         proceed to <link linkend="HDRWQ50">Starting the BOS Server</link>.</para>
2464       </note>
2465
2466       <para>At this point you incorporate AFS into the operating system's
2467       Pluggable Authentication Module (PAM) scheme.  PAM integrates all
2468       authentication mechanisms on the machine, including login, to provide
2469       the security infrastructure for authenticated access to and from the
2470       machine.</para>
2471
2472       <para>Explaining PAM is beyond the scope of this document.  It is
2473       assumed that you understand the syntax and meanings of settings in the
2474       PAM configuration file (for example, how the
2475       <computeroutput>other</computeroutput> entry works, the effect of
2476       marking an entry as <computeroutput>required</computeroutput>,
2477       <computeroutput>optional</computeroutput>, or
2478       <computeroutput>sufficient</computeroutput>, and so on).</para>
2479
2480       <para>You should first configure your system to obtain Kerberos v5
2481       tickets as part of the authentication process, and then run an AFS PAM
2482       module to obtain tokens from those tickets after authentication.
2483       Current versions of Solaris come with a Kerberos v5 PAM module that
2484       will work, or you can download and install <ulink
2485       url="http://www.eyrie.org/~eagle/software/pam-krb5">Russ Allbery's
2486       Kerberos v5 PAM module</ulink>, which is tested regularly with AFS.
2487       See the instructions of whatever PAM module you use for how to
2488       configure it.</para>
2489
2490       <para>Some Kerberos v5 PAM modules do come with native AFS support
2491       (usually requiring the Heimdal Kerberos implementation rather than the
2492       MIT Kerberos implementation).  If you are using one of those PAM
2493       modules, you can configure it to obtain AFS tokens.  It's more common,
2494       however, to separate the AFS token acquisition into a separate PAM
2495       module.</para>
2496
2497       <para>The recommended AFS PAM module is <ulink
2498       url="http://www.eyrie.org/~eagle/software/pam-afs-session/">Russ
2499       Allbery's pam-afs-session module</ulink>.  It should work with any of
2500       the Kerberos v5 PAM modules.  To add it to the PAM configuration, you
2501       often only need to add configuration to the session group in
2502       <filename>pam.conf</filename>:</para>
2503
2504       <example>
2505         <title>Solaris PAM session example</title>
2506         <literallayout>login session required pam_afs_session.so</literallayout>
2507       </example>
2508
2509       <para>This example enables PAM authentication only for console login.
2510       You may want to add a similar line for the ssh service and for any
2511       other login service that you use, including possibly the
2512       <literal>other</literal> service (which serves as a catch-all).  You
2513       may also want to add options to the AFS PAM session module
2514       (particularly <literal>retain_after_close</literal>, which is
2515       necessary for some versions of Solaris.</para>
2516
2517       <para>For additional configuration examples and the configuration
2518       options of the AFS PAM module, see its documentation.  For more
2519       details on the available options for the PAM configuration, see the
2520       <filename>pam.conf</filename> manual page.</para>
2521
2522       <para>Sites which still require <emphasis
2523       role="bold">kaserver</emphasis> or external Kerberos v4 authentication
2524       should consult <link linkend="KAS016">"Enabling kaserver based AFS
2525       Login on Solaris Systems"</link> for details of how to enable AFS
2526       login on Solaris.</para>
2527
2528       <para>Proceed to <link linkend="HDRWQ49a">Editing the File Systems 
2529       Clean-up Script on Solaris Systems</link></para>
2530     </sect2>
2531     <sect2 id="HDRWQ49a">
2532       <title>Editing the File Systems Clean-up Script on Solaris Systems</title>
2533       <indexterm>
2534         <primary>Solaris</primary>
2535
2536         <secondary>file systems clean-up script</secondary>
2537
2538         <tertiary>on file server machine</tertiary>
2539       </indexterm>
2540
2541       <indexterm>
2542         <primary>file systems clean-up script (Solaris)</primary>
2543
2544         <secondary>file server machine</secondary>
2545       </indexterm>
2546
2547       <indexterm>
2548         <primary>scripts</primary>
2549
2550         <secondary>file systems clean-up (Solaris)</secondary>
2551
2552         <tertiary>file server machine</tertiary>
2553       </indexterm>
2554
2555       
2556         <orderedlist>
2557           <listitem>
2558             <para>Some Solaris distributions include a script that locates and removes unneeded files from various file systems. Its
2559             conventional location is <emphasis role="bold">/usr/lib/fs/nfs/nfsfind</emphasis>. The script generally uses an argument
2560             to the <emphasis role="bold">find</emphasis> command to define which file systems to search. In this step you modify the
2561             command to exclude the <emphasis role="bold">/afs</emphasis> directory. Otherwise, the command traverses the AFS
2562             filespace of every cell that is accessible from the machine, which can take many hours. The following alterations are
2563             possibilities, but you must verify that they are appropriate for your cell.</para>
2564
2565             <para>The first possible alteration is to add the <emphasis role="bold">-local</emphasis> flag to the existing command,
2566             so that it looks like the following:</para>
2567
2568             <programlisting>
2569    find $dir -local -name .nfs\* -mtime +7 -mount -exec rm -f {} \;   
2570 </programlisting>
2571
2572             <para>Another alternative is to exclude any directories whose names begin with the lowercase letter <emphasis
2573             role="bold">a</emphasis> or a non-alphabetic character.</para>
2574
2575             <programlisting>
2576    find /[A-Zb-z]*  <replaceable>remainder of existing command</replaceable>   
2577 </programlisting>
2578
2579             <para>Do not use the following command, which still searches under the <emphasis role="bold">/afs</emphasis> directory,
2580             looking for a subdirectory of type <emphasis role="bold">4.2</emphasis>.</para>
2581
2582             <programlisting>
2583    find / -fstype 4.2     /* <replaceable>do not use</replaceable> */
2584 </programlisting>
2585           </listitem>
2586
2587           <listitem>
2588             <para>Proceed to <link linkend="HDRWQ50">Starting the BOS Server</link> (or if referring to these instructions while
2589             installing an additional file server machine, return to <link linkend="HDRWQ108">Starting Server
2590             Programs</link>).</para>
2591           </listitem>
2592         </orderedlist>
2593
2594       <indexterm>
2595         <primary>Basic OverSeer Server</primary>
2596
2597         <see>BOS Server</see>
2598       </indexterm>
2599
2600       <indexterm>
2601         <primary>BOS Server</primary>
2602
2603         <secondary>starting</secondary>
2604
2605         <tertiary>first AFS machine</tertiary>
2606       </indexterm>
2607
2608       <indexterm>
2609         <primary>starting</primary>
2610
2611         <secondary>BOS Server</secondary>
2612
2613         <tertiary>first AFS machine</tertiary>
2614       </indexterm>
2615
2616       <indexterm>
2617         <primary>first AFS machine</primary>
2618
2619         <secondary>BOS Server</secondary>
2620       </indexterm>
2621
2622       <indexterm>
2623         <primary>authorization checking (disabling)</primary>
2624
2625         <secondary>first AFS machine</secondary>
2626       </indexterm>
2627
2628       <indexterm>
2629         <primary>disabling authorization checking</primary>
2630
2631         <secondary>first AFS machine</secondary>
2632       </indexterm>
2633
2634       <indexterm>
2635         <primary>first AFS machine</primary>
2636
2637         <secondary>authorization checking (disabling)</secondary>
2638       </indexterm>
2639     </sect2>
2640   </sect1>
2641   <sect1 id="HDRWQ50">
2642     <title>Starting the BOS Server</title>
2643
2644     <para>You are now ready to start the AFS server processes on this machine. 
2645     If you are not working from a packaged distribution, begin by copying the 
2646     AFS server binaries from the distribution to the conventional local disk
2647     location, the <emphasis role="bold">/usr/afs/bin</emphasis> directory. The 
2648     following instructions also create files in other subdirectories of the 
2649     <emphasis role="bold">/usr/afs</emphasis> directory.</para>
2650
2651     <para>Then issue the <emphasis role="bold">bosserver</emphasis> command to initialize the Basic OverSeer (BOS) Server, which
2652     monitors and controls other AFS server processes on its server machine. Include the <emphasis role="bold">-noauth</emphasis>
2653     flag to disable authorization checking. Because you have not yet configured your cell's AFS authentication and authorization
2654     mechanisms, the BOS Server cannot perform authorization checking as it does during normal operation. In no-authorization mode,
2655     it does not verify the identity or privilege of the issuer of a <emphasis role="bold">bos</emphasis> command, and so performs
2656     any operation for anyone.</para>
2657
2658     <para>Disabling authorization checking gravely compromises cell security. You must complete all subsequent steps in one
2659     uninterrupted pass and must not leave the machine unattended until you restart the BOS Server with authorization checking
2660     enabled, in <link linkend="HDRWQ72">Verifying the AFS Initialization Script</link>.</para>
2661
2662     <para>As it initializes for the first time, the BOS Server creates the following directories and files, setting the owner to the
2663     local superuser <emphasis role="bold">root</emphasis> and the mode bits to limit the ability to write (and in some cases, read)
2664     them. For a description of the contents and function of these directories and files, see the chapter in the <emphasis>OpenAFS
2665     Administration Guide</emphasis> about administering server machines. For further discussion of the mode bit settings, see <link
2666     linkend="HDRWQ96">Protecting Sensitive AFS Directories</link>. <indexterm>
2667         <primary>Binary Distribution</primary>
2668
2669         <secondary>copying server files from</secondary>
2670
2671         <tertiary>first AFS machine</tertiary>
2672       </indexterm> <indexterm>
2673         <primary>first AFS machine</primary>
2674
2675         <secondary>subdirectories of /usr/afs</secondary>
2676       </indexterm> <indexterm>
2677         <primary>creating</primary>
2678
2679         <secondary>/usr/afs/bin directory</secondary>
2680
2681         <tertiary>first AFS machine</tertiary>
2682       </indexterm> <indexterm>
2683         <primary>creating</primary>
2684
2685         <secondary>/usr/afs/etc directory</secondary>
2686
2687         <tertiary>first AFS machine</tertiary>
2688       </indexterm> <indexterm>
2689         <primary>copying</primary>
2690
2691         <secondary>server files to local disk</secondary>
2692
2693         <tertiary>first AFS machine</tertiary>
2694       </indexterm> <indexterm>
2695         <primary>first AFS machine</primary>
2696
2697         <secondary>copying</secondary>
2698
2699         <tertiary>server files to local disk</tertiary>
2700       </indexterm> <indexterm>
2701         <primary>usr/afs/bin directory</primary>
2702
2703         <secondary>first AFS machine</secondary>
2704       </indexterm> <indexterm>
2705         <primary>usr/afs/etc directory</primary>
2706
2707         <secondary>first AFS machine</secondary>
2708       </indexterm> <indexterm>
2709         <primary>usr/afs/db directory</primary>
2710       </indexterm> <indexterm>
2711         <primary>usr/afs/local directory</primary>
2712       </indexterm> <indexterm>
2713         <primary>usr/afs/logs directory</primary>
2714       </indexterm> <itemizedlist>
2715         <listitem>
2716           <para><emphasis role="bold">/usr/afs/db</emphasis></para>
2717         </listitem>
2718
2719         <listitem>
2720           <para><emphasis role="bold">/usr/afs/etc/CellServDB</emphasis></para>
2721         </listitem>
2722
2723         <listitem>
2724           <para><emphasis role="bold">/usr/afs/etc/ThisCell</emphasis></para>
2725         </listitem>
2726
2727         <listitem>
2728           <para><emphasis role="bold">/usr/afs/local</emphasis></para>
2729         </listitem>
2730
2731         <listitem>
2732           <para><emphasis role="bold">/usr/afs/logs</emphasis></para>
2733         </listitem>
2734       </itemizedlist></para>
2735
2736     <para>The BOS Server also creates symbolic links called <emphasis role="bold">/usr/vice/etc/ThisCell</emphasis> and <emphasis
2737     role="bold">/usr/vice/etc/CellServDB</emphasis> to the corresponding files in the <emphasis role="bold">/usr/afs/etc</emphasis>
2738     directory. The AFS command interpreters consult the <emphasis role="bold">CellServDB</emphasis> and <emphasis
2739     role="bold">ThisCell</emphasis> files in the <emphasis role="bold">/usr/vice/etc</emphasis> directory because they generally run
2740     on client machines. On machines that are AFS servers only (as this machine currently is), the files reside only in the <emphasis
2741     role="bold">/usr/afs/etc</emphasis> directory; the links enable the command interpreters to retrieve the information they need.
2742     Later instructions for installing the client functionality replace the links with actual files. <orderedlist>
2743         <listitem>
2744           <para>If you are not working from a packaged distribution, you may need to copy files from the distribution media to the local <emphasis role="bold">/usr/afs</emphasis> directory. 
2745 <programlisting>
2746    # <emphasis role="bold">cd /tmp/afsdist/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/root.server/usr/afs</emphasis>
2747    # <emphasis role="bold">cp -rp  *  /usr/afs</emphasis>
2748 </programlisting> <indexterm>
2749               <primary>commands</primary>
2750
2751               <secondary>bosserver</secondary>
2752             </indexterm> <indexterm>
2753               <primary>bosserver command</primary>
2754             </indexterm></para>
2755         </listitem>
2756
2757         <listitem>
2758           <para>Issue the <emphasis role="bold">bosserver</emphasis> command. Include the <emphasis role="bold">-noauth</emphasis>
2759           flag to disable authorization checking. <programlisting>
2760    # <emphasis role="bold">/usr/afs/bin/bosserver -noauth &amp;</emphasis>
2761 </programlisting></para>
2762         </listitem>
2763
2764         <listitem>
2765           <para>Verify that the BOS Server created <emphasis role="bold">/usr/vice/etc/ThisCell</emphasis> and <emphasis
2766           role="bold">/usr/vice/etc/CellServDB</emphasis> as symbolic links to the corresponding files in the <emphasis
2767           role="bold">/usr/afs/etc</emphasis> directory. <programlisting>
2768    # <emphasis role="bold">ls -l  /usr/vice/etc</emphasis>
2769 </programlisting></para>
2770
2771           <para>If either or both of <emphasis role="bold">/usr/vice/etc/ThisCell</emphasis> and <emphasis
2772           role="bold">/usr/vice/etc/CellServDB</emphasis> do not exist, or are not links, issue the following commands.</para>
2773
2774           <programlisting>
2775    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
2776    # <emphasis role="bold">ln -s /usr/afs/etc/ThisCell</emphasis>
2777    # <emphasis role="bold">ln -s /usr/afs/etc/CellServDB</emphasis> 
2778 </programlisting>
2779         </listitem>
2780       </orderedlist></para>
2781
2782     <indexterm>
2783       <primary>cell name</primary>
2784
2785       <secondary>defining during installation of first machine</secondary>
2786     </indexterm>
2787
2788     <indexterm>
2789       <primary>defining</primary>
2790
2791       <secondary>cell name during installation of first machine</secondary>
2792     </indexterm>
2793
2794     <indexterm>
2795       <primary>cell name</primary>
2796
2797       <secondary>setting in server ThisCell file</secondary>
2798
2799       <tertiary>first AFS machine</tertiary>
2800     </indexterm>
2801
2802     <indexterm>
2803       <primary>setting</primary>
2804
2805       <secondary>cell name in server ThisCell file</secondary>
2806
2807       <tertiary>first AFS machine</tertiary>
2808     </indexterm>
2809
2810     <indexterm>
2811       <primary>first AFS machine</primary>
2812
2813       <secondary>ThisCell file (server)</secondary>
2814     </indexterm>
2815
2816     <indexterm>
2817       <primary>usr/afs/etc/ThisCell</primary>
2818
2819       <see>ThisCell file (server)</see>
2820     </indexterm>
2821
2822     <indexterm>
2823       <primary>ThisCell file (server)</primary>
2824
2825       <secondary>first AFS machine</secondary>
2826     </indexterm>
2827
2828     <indexterm>
2829       <primary>files</primary>
2830
2831       <secondary>ThisCell (server)</secondary>
2832     </indexterm>
2833
2834     <indexterm>
2835       <primary>database server machine</primary>
2836
2837       <secondary>entry in server CellServDB file</secondary>
2838
2839       <tertiary>on first AFS machine</tertiary>
2840     </indexterm>
2841
2842     <indexterm>
2843       <primary>first AFS machine</primary>
2844
2845       <secondary>cell membership, defining</secondary>
2846
2847       <tertiary>for server processes</tertiary>
2848     </indexterm>
2849
2850     <indexterm>
2851       <primary>usr/afs/etc/CellServDB file</primary>
2852
2853       <see>CellServDB file (server)</see>
2854     </indexterm>
2855
2856     <indexterm>
2857       <primary>CellServDB file (server)</primary>
2858
2859       <secondary>creating</secondary>
2860
2861       <tertiary>on first AFS machine</tertiary>
2862     </indexterm>
2863
2864     <indexterm>
2865       <primary>creating</primary>
2866
2867       <secondary>CellServDB file (server)</secondary>
2868
2869       <tertiary>first AFS machine</tertiary>
2870     </indexterm>
2871
2872     <indexterm>
2873       <primary>files</primary>
2874
2875       <secondary>CellServDB (server)</secondary>
2876     </indexterm>
2877
2878     <indexterm>
2879       <primary>first AFS machine</primary>
2880
2881       <secondary>CellServDB file (server)</secondary>
2882     </indexterm>
2883
2884     <indexterm>
2885       <primary>first AFS machine</primary>
2886
2887       <secondary>defining</secondary>
2888
2889       <tertiary>as database server</tertiary>
2890     </indexterm>
2891
2892     <indexterm>
2893       <primary>defining</primary>
2894
2895       <secondary>first AFS machine as database server</secondary>
2896     </indexterm>
2897   </sect1>
2898
2899   <sect1 id="HDRWQ51">
2900     <title>Defining Cell Name and Membership for Server Processes</title>
2901
2902     <para>Now assign your cell's name. The chapter in the <emphasis>OpenAFS Administration Guide</emphasis> about cell configuration
2903     and administration issues discusses the important considerations, explains why changing the name is difficult, and outlines the
2904     restrictions on name format. Two of the most important restrictions are that the name cannot include uppercase letters or more
2905     than 64 characters.</para>
2906
2907     <para>Use the <emphasis role="bold">bos setcellname</emphasis> command to assign the cell name. It creates two files:
2908     <itemizedlist>
2909         <listitem>
2910           <para><emphasis role="bold">/usr/afs/etc/ThisCell</emphasis>, which defines this machine's cell membership</para>
2911         </listitem>
2912
2913         <listitem>
2914           <para><emphasis role="bold">/usr/afs/etc/CellServDB</emphasis>, which lists the cell's database server machines; the
2915           machine named on the command line is placed on the list automatically</para>
2916         </listitem>
2917       </itemizedlist> <note>
2918         <para>In the following and every instruction in this guide, for the <replaceable>machine name</replaceable> argument
2919         substitute the fully-qualified hostname (such as <emphasis role="bold">fs1.example.com</emphasis>) of the machine you are
2920         installing. For the <replaceable>cell name</replaceable> argument substitute your cell's complete name (such as <emphasis
2921         role="bold">example.com</emphasis>).</para>
2922       </note></para>
2923
2924     <indexterm>
2925       <primary>commands</primary>
2926
2927       <secondary>bos setcellname</secondary>
2928     </indexterm>
2929
2930     <indexterm>
2931       <primary>bos commands</primary>
2932
2933       <secondary>setcellname</secondary>
2934     </indexterm>
2935
2936     <orderedlist>
2937       <listitem>
2938         <para>If necessary, add the directory containing the <emphasis role="bold">bos</emphasis> command to your path.
2939       <programlisting>
2940    # <emphasis role="bold">export PATH=$PATH:/usr/afs/bin</emphasis>
2941       </programlisting>
2942         </para>
2943       </listitem>
2944
2945       <listitem>
2946         <para>Issue the <emphasis role="bold">bos setcellname</emphasis> command to set the cell name. <programlisting>
2947    # <emphasis role="bold">bos setcellname</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>cell name</replaceable>&gt; <emphasis
2948               role="bold">-noauth</emphasis>
2949 </programlisting></para>
2950
2951         <para>Because you are not authenticated and authorization checking is disabled, the <emphasis role="bold">bos</emphasis>
2952         command interpreter possibly produces error messages about being unable to obtain tickets and running unauthenticated. You
2953         can safely ignore the messages. <indexterm>
2954             <primary>commands</primary>
2955
2956             <secondary>bos listhosts</secondary>
2957           </indexterm> <indexterm>
2958             <primary>bos commands</primary>
2959
2960             <secondary>listhosts</secondary>
2961           </indexterm> <indexterm>
2962             <primary>CellServDB file (server)</primary>
2963
2964             <secondary>displaying entries</secondary>
2965           </indexterm> <indexterm>
2966             <primary>displaying</primary>
2967
2968             <secondary>CellServDB file (server) entries</secondary>
2969           </indexterm></para>
2970       </listitem>
2971
2972       <listitem>
2973         <para>Issue the <emphasis role="bold">bos listhosts</emphasis> command to verify that the machine you are installing is now
2974         registered as the cell's first database server machine. <programlisting>
2975    # <emphasis role="bold">bos listhosts</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">-noauth</emphasis>
2976    Cell name is <replaceable>cell_name</replaceable>
2977        Host 1 is <replaceable>machine_name</replaceable>
2978 </programlisting></para>
2979       </listitem>
2980     </orderedlist>
2981
2982     <indexterm>
2983       <primary>database server machine</primary>
2984
2985       <secondary>installing</secondary>
2986
2987       <tertiary>first</tertiary>
2988     </indexterm>
2989
2990     <indexterm>
2991       <primary>instructions</primary>
2992
2993       <secondary>database server machine, installing first</secondary>
2994     </indexterm>
2995
2996     <indexterm>
2997       <primary>installing</primary>
2998
2999       <secondary>database server machine</secondary>
3000
3001       <tertiary>first</tertiary>
3002     </indexterm>
3003
3004     <indexterm>
3005       <primary>Backup Server</primary>
3006
3007       <secondary>starting</secondary>
3008
3009       <tertiary>first AFS machine</tertiary>
3010     </indexterm>
3011
3012     <indexterm>
3013       <primary>buserver process</primary>
3014
3015       <see>Backup Server</see>
3016     </indexterm>
3017
3018     <indexterm>
3019       <primary>starting</primary>
3020
3021       <secondary>Backup Server</secondary>
3022
3023       <tertiary>first AFS machine</tertiary>
3024     </indexterm>
3025
3026     <indexterm>
3027       <primary>first AFS machine</primary>
3028
3029       <secondary>Backup Server</secondary>
3030     </indexterm>
3031
3032     <indexterm>
3033       <primary>Protection Server</primary>
3034
3035       <secondary>starting</secondary>
3036
3037       <tertiary>first AFS machine</tertiary>
3038     </indexterm>
3039
3040     <indexterm>
3041       <primary>ptserver process</primary>
3042
3043       <see>Protection Server</see>
3044     </indexterm>
3045
3046     <indexterm>
3047       <primary>starting</primary>
3048
3049       <secondary>Protection Server</secondary>
3050
3051       <tertiary>first AFS machine</tertiary>
3052     </indexterm>
3053
3054     <indexterm>
3055       <primary>first AFS machine</primary>
3056
3057       <secondary>Protection Server</secondary>
3058     </indexterm>
3059
3060     <indexterm>
3061       <primary>VL Server (vlserver process)</primary>
3062
3063       <secondary>starting</secondary>
3064
3065       <tertiary>first AFS machine</tertiary>
3066     </indexterm>
3067
3068     <indexterm>
3069       <primary>Volume Location Server</primary>
3070
3071       <see>VL Server</see>
3072     </indexterm>
3073
3074     <indexterm>
3075       <primary>starting</primary>
3076
3077       <secondary>VL Server</secondary>
3078
3079       <tertiary>first AFS machine</tertiary>
3080     </indexterm>
3081
3082     <indexterm>
3083       <primary>first AFS machine</primary>
3084
3085       <secondary>VL Server</secondary>
3086     </indexterm>
3087
3088     <indexterm>
3089       <primary>usr/afs/local/BosConfig</primary>
3090
3091       <see>BosConfig file</see>
3092     </indexterm>
3093
3094     <indexterm>
3095       <primary>BosConfig file</primary>
3096
3097       <secondary>adding entries</secondary>
3098
3099       <tertiary>first AFS machine</tertiary>
3100     </indexterm>
3101
3102     <indexterm>
3103       <primary>adding</primary>
3104
3105       <secondary>entries to BosConfig file</secondary>
3106
3107       <tertiary>first AFS machine</tertiary>
3108     </indexterm>
3109
3110     <indexterm>
3111       <primary>files</primary>
3112
3113       <secondary>BosConfig</secondary>
3114     </indexterm>
3115
3116     <indexterm>
3117       <primary>initializing</primary>
3118
3119       <secondary>server process</secondary>
3120
3121       <see>starting</see>
3122     </indexterm>
3123
3124     <indexterm>
3125       <primary>server process</primary>
3126
3127       <secondary>see also entry for each server's name</secondary>
3128     </indexterm>
3129   </sect1>
3130
3131   <sect1 id="HDRWQ52">
3132     <title>Starting the Database Server Processes</title>
3133
3134     <para>Next use the <emphasis role="bold">bos create</emphasis> command to create entries for the three database server processes
3135     in the <emphasis role="bold">/usr/afs/local/BosConfig</emphasis> file and start them running. The three processes run on database
3136     server machines only: <itemizedlist>
3137
3138         <listitem>
3139           <para>The Backup Server (the <emphasis role="bold">buserver</emphasis> process) maintains the Backup Database</para>
3140         </listitem>
3141
3142         <listitem>
3143           <para>The Protection Server (the <emphasis role="bold">ptserver</emphasis> process) maintains the Protection
3144           Database</para>
3145         </listitem>
3146
3147         <listitem>
3148           <para>The Volume Location (VL) Server (the <emphasis role="bold">vlserver</emphasis> process) maintains the Volume
3149           Location Database (VLDB)</para>
3150         </listitem>
3151       </itemizedlist></para>
3152
3153     <indexterm>
3154       <primary>Kerberos</primary>
3155     </indexterm>
3156
3157     <note>
3158       <para>AFS ships with an additional database server named 'kaserver', which
3159       was historically used to provide authentication services to AFS cells.
3160       kaserver was based on <emphasis>Kerberos v4</emphasis>, as such, it is
3161       not recommended for new cells. This guide assumes you have already
3162       configured a Kerberos v5 realm for your site, and details the procedures 
3163       required to use AFS with this realm. If you do wish to use
3164       <emphasis role="bold">kaserver</emphasis>, please see the modifications
3165       to these instructions detailed in 
3166       <link linkend="KAS006">Starting the kaserver Database Server Process</link>
3167       </para>
3168     </note>
3169
3170     <para>The remaining instructions in this chapter include the <emphasis role="bold">-cell</emphasis> argument on all applicable
3171     commands. Provide the cell name you assigned in <link linkend="HDRWQ51">Defining Cell Name and Membership for Server
3172     Processes</link>. If a command appears on multiple lines, it is only for legibility. <indexterm>
3173         <primary>commands</primary>
3174
3175         <secondary>bos create</secondary>
3176       </indexterm> <indexterm>
3177         <primary>bos commands</primary>
3178
3179         <secondary>create</secondary>
3180       </indexterm> <orderedlist>
3181         <listitem>
3182           <para>Issue the <emphasis role="bold">bos create</emphasis> command to start the Backup Server. <programlisting>
3183    # <emphasis role="bold">./bos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">buserver simple /usr/afs/bin/buserver</emphasis>  <emphasis role="bold">-noauth</emphasis>
3184 </programlisting></para>
3185         </listitem>
3186
3187         <listitem>
3188           <para>Issue the <emphasis role="bold">bos create</emphasis> command to start the Protection Server. <programlisting>
3189    # <emphasis role="bold">./bos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">ptserver simple /usr/afs/bin/ptserver</emphasis> <emphasis role="bold">-noauth</emphasis>
3190 </programlisting></para>
3191         </listitem>
3192
3193         <listitem>
3194           <para>Issue the <emphasis role="bold">bos create</emphasis> command to start the VL Server. <programlisting>
3195    # <emphasis role="bold">./bos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">vlserver simple /usr/afs/bin/vlserver</emphasis> <emphasis role="bold">-noauth</emphasis>
3196 </programlisting></para>
3197         </listitem>
3198       </orderedlist></para>
3199
3200     <indexterm>
3201       <primary>admin account</primary>
3202
3203       <secondary>creating</secondary>
3204     </indexterm>
3205
3206     <indexterm>
3207       <primary>afs entry in Kerberos Database</primary>
3208     </indexterm>
3209
3210     <indexterm>
3211       <primary>Kerberos Database</primary>
3212     </indexterm>
3213
3214     <indexterm>
3215       <primary>creating</primary>
3216
3217       <secondary>afs entry in Kerberos Database</secondary>
3218     </indexterm>
3219
3220     <indexterm>
3221       <primary>creating</primary>
3222
3223       <secondary>admin account in Kerberos Database</secondary>
3224     </indexterm>
3225
3226     <indexterm>
3227       <primary>security</primary>
3228
3229       <secondary>initializing cell-wide</secondary>
3230     </indexterm>
3231
3232     <indexterm>
3233       <primary>cell</primary>
3234
3235       <secondary>initializing security mechanisms</secondary>
3236     </indexterm>
3237
3238     <indexterm>
3239       <primary>initializing</primary>
3240
3241       <secondary>cell security mechanisms</secondary>
3242     </indexterm>
3243
3244     <indexterm>
3245       <primary>usr/afs/etc/KeyFile</primary>
3246
3247       <see>KeyFile file</see>
3248     </indexterm>
3249
3250     <indexterm>
3251       <primary>KeyFile file</primary>
3252
3253       <secondary>first AFS machine</secondary>
3254     </indexterm>
3255
3256     <indexterm>
3257       <primary>files</primary>
3258
3259       <secondary>KeyFile</secondary>
3260     </indexterm>
3261
3262     <indexterm>
3263       <primary>key</primary>
3264
3265       <see>server encryption key</see>
3266     </indexterm>
3267
3268     <indexterm>
3269       <primary>encryption key</primary>
3270
3271       <see>server encryption key</see>
3272     </indexterm>
3273   </sect1>
3274
3275   <sect1 id="HDRWQ53">
3276     <title>Initializing Cell Security </title>
3277
3278     <para>If you are working with an existing cell which uses
3279     <emphasis role="bold">kaserver</emphasis> or Kerberos v4 for authentication,
3280     please see 
3281     <link linkend="HDRWQ53">Initializing Cell Security with kaserver</link>
3282     for installation instructions which replace this section.</para>
3283     
3284     <para>Now initialize the cell's security mechanisms. Begin by creating the following two entires in your site's Kerberos database: <itemizedlist>
3285         <listitem>
3286           <para>A generic administrative account, called <emphasis role="bold">admin</emphasis> by convention. If you choose to
3287           assign a different name, substitute it throughout the remainder of this document.</para>
3288
3289           <para>After you complete the installation of the first machine, you can continue to have all administrators use the
3290           <emphasis role="bold">admin</emphasis> account, or you can create a separate administrative account for each of them. The
3291           latter scheme implies somewhat more overhead, but provides a more informative audit trail for administrative
3292           operations.</para>
3293         </listitem>
3294
3295         <listitem>
3296           <para>The entry for AFS server processes, called either 
3297           <emphasis role="bold">afs</emphasis> or 
3298           <emphasis role="bold">afs/<replaceable>cell</replaceable></emphasis>. 
3299           The latter form is preferred since it works regardless of whether
3300           your cell name matches your Kerberos realm name and allows multiple
3301           AFS cells to be served from a single Kerberos realm.  
3302           No user logs in under this identity, but it is used to encrypt the
3303           server tickets that granted to AFS clients for presentation to 
3304           server processes during mutual authentication. (The
3305           chapter in the <emphasis>OpenAFS Administration Guide</emphasis> about cell configuration and administration describes the
3306           role of server encryption keys in mutual authentication.)</para>
3307
3308           <para>In Step <link linkend="LIWQ58">7</link>, you also place the initial AFS server encryption key into the <emphasis
3309           role="bold">/usr/afs/etc/KeyFile</emphasis> file. The AFS server processes refer to this file to learn the server
3310           encryption key when they need to decrypt server tickets.</para>
3311         </listitem>
3312       </itemizedlist></para>
3313
3314     <para>You also issue several commands that enable the new <emphasis role="bold">admin</emphasis> user to issue privileged
3315     commands in all of the AFS suites.</para>
3316
3317     <para>The following instructions do not configure all of the security mechanisms related to the AFS Backup System. See the
3318     chapter in the <emphasis>OpenAFS Administration Guide</emphasis> about configuring the Backup System.</para>
3319
3320     <para>The examples below assume you are using MIT Kerberos. Please refer 
3321     to the documentation for your KDC's administrative interface if you are 
3322     using a different vendor</para>