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