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