Kill FBSD4X with fire
[openafs.git] / README
1 Copyright 2000, International Business Machines Corporation and others.
2 All Rights Reserved.
3
4 This software has been released under the terms of the IBM Public
5 License.  For details, see the LICENSE file in the top-level source
6 directory or online at http://www.openafs.org/dl/license10.html
7
8 Short instructions for sites upgrading from a previous version of AFS:
9 % ./configure --enable-transarc-paths
10 % make
11 % make dest
12
13 will create a Transarc-style dest tree in ${SYS_NAME}/dest where
14 ${SYS_NAME} is the AFS sysname of the system you built for.
15 This assumes if you're building for Linux that your kernel source is
16 in /usr/src/linux.
17
18 Otherwise, please read on.
19
20 Building OpenAFS on UNIX and Linux
21 ----------------------------------
22
23 A  Configuring
24
25    Uncompress the source into a directory of your choice. A directory
26    in afs space is also valid. In the directory that you uncompressed the
27    source in, you will only have an src/ directory.
28
29    1. Pick a system to build for, and note its default AFS sys_name.
30       A directory will be automatically created for binaries to be written 
31       into with this name when you build.
32
33       alpha_dux40, alpha_dux50, alpha_dux51
34       alpha_linux22, alpha_linux24, alpha_linux26
35       alpha_nbsd15, alpha_nbsd16
36       amd64_fbsd_53 (client does not work)
37       amd64_linux24, amd64_linux26
38       amd64_nbsd20, amd64_nbsd30, amd64_nbsd40
39       arm_linux24, arm_linux26
40       hp_ux11i, hp_ux110, hp_ux1123 (See notes below for information on
41          getting missing header)
42       hp_ux102 (Client port possible, but db servers and utilities work)
43       i386_fbsd_50, i386_fbsd_51, i386_fbsd_52, i386_fbsd_53,
44          i386_fbsd_60, i386_fbsd_61, i386_fbsd_62, i386_fbsd_70,
45          i386_fbsd_80, i386_fbsd_81, i386_fbsd_90, amd64_fbsd_50,
46          amd64_fbsd_51, amd64_fbsd_52, amd64_fbsd_53, amd64_fbsd_60,
47          amd64_fbsd_61, amd64_fbsd_62, amd64_fbsd_70, amd64_fbsd_80,
48          amd64_fbsd_81, amd64_fbsd_90
49          (client may work on 70 and later)
50       i386_linux22, i386_linux24, i386_linux26
51       i386_nbsd15, i386_nbsd16, i386_nbsd20, i386_nbsd21, i386_nbsd30,
52          i386_nbsd40
53       i386_obsd31, i386_obsd32, i386_obsd33, i386_obsd34, i386_obsd35,
54          i386_obsd36, i386_obsd37, i386_obsd38, i386_obsd39, i386_obsd40,
55          i386_obsd41
56       i386_umlinux22, i386_umlinux24, i386_umlinux26
57       ia64_hpux1122, ia64_hpux1123
58       ia64_linux24, ia64_linux26
59       parisc_linux24
60       ppc64_linux24, ppc64_linux26
61       ppc_darwin_12, ppc_darwin_13, ppc_darwin_14, ppc_darwin_60,
62          ppc_darwin_70, ppc_darwin_80, ppc_darwin_90
63       ppc_linux22, ppc_linux24, ppc_linux26
64       ppc_nbsd16, ppc_nbsd20
65       rs_aix42, rs_aix51, rs_aix52, rs_aix53, rs_aix61
66       s390_linux22, s390_linux24, s390_linux26
67       s390x_linux24, s390x_linux26
68       sgi_62, sgi_63, sgi_64, sgi_65 (file server not tested)
69       sparc64_linux22, sparc64_linux24, sparc64_linux26
70       sparc_linux22, sparc_linux24
71       sun4_413 (No client support, no fileserver support, db servers only)
72       sun4x_56, sun4x_57, sun4x_58, sun4x_59, sun4x_510, sun4x_511
73          (logging UFS not supported for mixed-use partitions containing
74          client cache)
75       sunx86_57, sunx86_58, sunx86_59, sunx86_510, sunx86_511
76          (logging UFS not supported for mixed-use partitions containing
77          client cache)
78       x86_darwin_80, x86_darwin90
79
80    2. Using configure in the top level directory, configure for your
81       AFS system type, providing the necessary flags:
82       % ./configure --with-afs-sysname=sun4x_58 --enable-transarc-paths
83
84       If you do not have the "configure" script, or if you modify the
85       source files, you can re-create it by running regen.sh.  You will
86       need autoconf to do this.
87
88       For some systems you need also provide the path in which your kernel
89       headers for your configured kernel can be found.  See the
90       system-specific Notes sections below for details.  If you want to
91       build only the user-space programs and servers and not the kernel
92       module, specify the --disable-kernel-module option on the
93       ./configure command line.
94
95       All binaries, except for the 'fileserver' and 'volserver'
96       executables, are stripped of their symbol table information by
97       default.  To enable a debugging build, specify the --enable-debug
98       option on the ./configure command line.  This builds with debugging
99       compiler options and disables stripping of binaries.
100
101       You can also use different combinations of --enable-debug and
102       --enable (or --disable)-strip-binaries for finer control.  One can,
103       for example, compile binaries for debug and strip them anyway.
104       Alternatively, one can compile without debug and force the binaries
105       to not be stripped.  Note that these combinations are not
106       necessarily useful.
107
108       The two binaries noted above, 'fileserver' and 'volserver' will
109       never be stripped, regardless of any options given to configure.
110
111    There are two modes for directory path handling: "Transarc mode" and
112    "default mode":
113
114    - In Transarc mode, we retain compatibility with Transarc/IBM AFS tools
115      by putting client configuaration files in /usr/vice/etc, and server
116      files in /usr/afs under the traditional directory layout.
117    - In default mode, files are located in standardized locations, usually
118      under $(prefix).
119    - Client programs, libraries, and related files always go in standard
120      directories under $(prefix).  This rule covers things that would go
121      into $(bindir), $(includedir), $(libdir), $(mandir), and $(sbindir).
122    - Other files get located in the following places:
123
124     Directory     Transarc Mode              Default Mode
125     ============  =========================  ==============================
126     viceetcdir    /usr/vice/etc              $(sysconfdir)/openafs
127     afssrvdir     /usr/afs/bin (servers)     $(libexecdir)/openafs
128     afsconfdir    /usr/afs/etc               $(sysconfdir)/openafs/server
129     afslocaldir   /usr/afs/local             $(localstatedir)/openafs
130     afsdbdir      /usr/afs/db                $(localstatedir)/openafs/db
131     afslogdir     /usr/afs/logs              $(localstatedir)/openafs/logs
132     afsbosconfig  $(afslocaldir)/BosConfig   $(afsconfdir)/BosConfig
133     afsbosserver  $(afsbindir)/bosserver     $(sbindir)/bosserver
134
135    The Demand Attach Fileserver (DAFS), is built by providing the
136    --enable-demand-attach-fs argument to configure.  Note that the
137    bosserver must be built with DAFS in order to be able to create the
138    dafs instance, which will be used in place of the fs instance.  In
139    addition, the fileserver, volserver, salvager, salvage, and
140    salvageserver binaries must be built for DAFS.
141
142    For additional options, see section H below.
143
144 B  Building
145
146    1. Now, you can build OpenAFS. 
147
148       % make
149
150    2. Install your build using either "make install" to install 
151       into the current system (you will need to be root, and files
152       will be placed as appropriate for Transarc or standard paths),
153       "make install DESTDIR=/some/path" to install into an alternate 
154       directory tree, or if you configured with --enable-transarc-paths
155       make dest to create a complete binary tree in the dest directory      
156       under the directory named for the sys_name you built for,
157       e.g. sun4x_57/dest or i386_linux22/dest 
158
159    2. As appropriate you can clean up or, if you're using Linux, build for
160       another kernel version.
161       To clean up:
162          % make clean
163
164 C  Problems
165
166    If you have a problem building this source, you may want to visit
167    http://www.openafs.org/ to see if any problems have been reported 
168    or to find out how to get more help.
169
170    Mailing lists have been set up to help; More details can be found
171    on the openafs.org site.
172
173 D  Linux Notes
174
175    For Linux systems you need also provide the path in which your
176    kernel headers for your configured kernel can be found. This should
177    be the path of the directory containing a child directory named
178    "include". So if your version file was 
179    /usr/src/linux/include/linux/version.h you would invoke:
180    % ./configure --with-afs-sysname=i386_linux24 \
181        --with-linux-kernel-headers=/usr/src/linux
182
183    Currently you can build for only one Linux kernel at a time,
184    and the version is extracted from the kernel headers in the root
185    you specify.
186
187    To build for another Linux kernel version:
188    the system type defined in step A1.
189       % ./configure --with-afs-sysname=i386_linux24 \
190           --with-linux-kernel-headers=/usr/src/linux-2.2.19-i686
191       % make 
192
193    Your dest tree will now include an additional kernel module for your
194    additional kernel headers. Be aware that if the kernel version string
195    which UTS_RELEASE is defined to in include/linux/version.h matches the
196    last kernel you built for, the previous kernel module will be
197    overwritten.
198
199 E  HP-UX 11.0 Notes
200
201    HP-UX 11.0 requires a header called vfs_vm.h which HP has provided on
202    their web site.  Go to http://www.hp.com/dspp, choose Software
203    downloads from the side menu, and select Software: HP operating systems
204    and then Operating systems: HP-UX from the select boxes.  The last
205    select box will have an option for downloading vfs_vm.h.
206
207 F  OpenBSD Notes
208
209    If you need to run regen.sh to make the configure script, you should
210    first install autoconf-2.59, then setenv AUTOCONF_VERSION 2.59.
211
212    You need kernel source installed to build OpenAFS.  Use the
213    --with-bsd-kernel-headers= configure option if your kernel source is
214    not in /usr/src/sys.
215
216    If you want to build src/aklog, add the following options to your
217    configure.  Note that you shouldn't need aklog because heimdal afslog
218    does (almost) the same thing.
219      --with-krb5 KRB5CFLAGS=-I/usr/include/kerberosV KRB5LIBS=-lcrypto
220
221    src/packaging/OpenBSD/buildpkg.sh will make a tar file for installing
222    the client.  There is no server package, but I am told that "make
223    install" will put server binaries in /usr/afs.
224
225    Your kernel may panic when you try to shutdown after running the
226    OpenAFS client.  To prevent this, change the "dangling vnode" panic in
227    sys/kern/vfs_syscalls.c to a printf and build a new kernel.
228
229    You can't run arla and OpenAFS at the same time.
230
231 G  FreeBSD Notes
232
233    The FreeBSD client may now work; It is tested on 7.0 and on current
234    as of the commit date.
235
236
237    You need kernel source installed to build OpenAFS.  Use the
238    --with-bsd-kernel-headers= configure option if your kernel source is
239    not in /usr/src/sys.
240
241    You also need access to your kernel build directory for the opt_global.h
242    include file.  Use the --with-bsd-kernel-build= configure option if your
243    kernel build is not GENERIC in the standard place. If 
244    /usr/src/sys/${CPUARCH}/compile/GENERIC does not point to 
245    /usr/obj/usr/src/sys/GENERIC you may need to resolve that and retry the 
246    build.
247
248    There is no server package, but I am told that "make install" will put
249    server binaries in /usr/afs.
250
251    You can't run arla and OpenAFS at the same time.
252
253 H  AIX notes
254
255    Make sure that your default build environment is 32bit, ie.
256    the OBJECT_MODE environment variable is either unset or set to "32".
257
258    Verify this before doing configure and make. For example, assuming ksh/bash:
259    export OBJECT_MODE=32
260
261    To build aklog (in order to be able to get tokens from your KRB5 ticket)
262    you have to supply --with-krb5 to configure, the following example is for
263    building on AIX 6.1 with the IBM Kerberos5 (krb5.client.rte and
264    krb5.toolkit.adt on the Expansion Pack):
265
266    ./configure --with-afs-sysname=rs_aix61 --enable-transarc-paths \
267         --enable-supergroups \
268         --with-krb5 KRB5CFLAGS=-I/usr/include KRB5LIBS=-lkrb5
269
270 I  Other configure options
271
272    AFS has a ton of other optional features that must be enabled using
273    configure options.  Here is a summary:
274
275    --enable-bitmap-later
276        Speeds the startup of the fileserver by deferring reading volume
277        bitmaps until necessary.  Demand attach is a better solution to the
278        same problem.
279
280    --enable-bos-new-config
281        A bosserver built with this option will look for BosConfig.new when
282        it restarts and, if present, replace BosConfig with that file
283        before reading its configuration.
284
285    --enable-bos-restricted-mode
286        Enables support for restricted mode in the bosserver.  This mode
287        can be enabled or disabled via a command-line switch and a signal
288        and can be enabled (but not disabled) remotely.  When enabled,
289        bosserver will not permit any operations that change the local file
290        system (install, uninstall, prune), run commands on the server
291        (exec, create, delete), or view files (getlog).
292
293    --enable-demand-attach-fs
294        Enable Demand Attach file servers.  Demand Attach is an extensive
295        re-engineering of the file server that avoids the long startup and
296        shutdown delays of the traditional file server by enabling
297        persistance of file server state to disk.  It is still very new,
298        but is expected to become the default in a future version of
299        OpenAFS.
300
301    --enable-disconnected
302        Enable disconnected support in the cache manager (EXPERIMENTAL).
303
304    --enable-fast-restart
305        When restarting the fileserver, don't salvage volumes.  Instead,
306        assume all volumes are okay and only take them off-line if that
307        assumption is incorrect.  Using this option safely requires
308        scanning the fileserver log for error messages when volumes are
309        taken off-line and salvaging them manually.  Not recommended; use
310        demand attach instead.
311
312    --enable-icmp-pmtu-discovery
313        Enable path MTU discovery in the Rx libraries by decoding ICMP
314        unreachable packets.
315
316    --enable-namei-fileserver
317        Forces the namei fileserver on platforms (like Solaris) where the
318        inode fileserver is the default.
319
320    --enable-pthreaded-ubik
321        Enable the threaded version of Ubik and install the threaded
322        versions of Ubik servers.  See README.PTHREADED_UBIK for more
323        information.  (EXPERIMENTAL)
324
325    --enable-supergroups
326        Enables support of nested groups in the ptserver.  WARNING: Once
327        you make use of this option by nesting one group inside another,
328        the resulting PTS database cannot be correctly and safely used by a
329        ptserver built without this option.
330
331    --enable-tivoli-tsm
332        Build with the Tivoli TSM API libraries for butc support of the
333        Tivoli backup system.
334
335    --enable-unix-sockets
336        Enable use of UNIX domain sockets for fssync.
337
338    It's also possible to disable some standard features.  None of these
339    options are recommended but may be useful in unusual circumstances:
340
341    --disable-afsdb
342        Disable AFSDB DNS record support in the cache manager, normally
343        used to find cell VLDB servers.
344
345    --disable-full-vos-listvol-switch
346        Removes support for the -format option to vos listvol and also
347        suppresses some additional fields that were added to vos examine
348        output but may confuse older software.
349
350    --disable-largefile-fileserver
351        Disable large file (>2GB) support in the fileserver.
352
353    --disable-pam
354        Do not build the AFS PAM modules.  Normally building them is
355        harmless, but the PAM modules that come with OpenAFS are deprecated
356        and should not be used unless you're still using the OpenAFS
357        kaserver (which is itself deprecated and should not be used).