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