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. Creating the proper directory structure.
  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
  34       alpha_dux50 (only tested on 5.0A, does not work with 5.1)
  35       i386_fbsd_42, i386_fbsd_43, i386_fbsd_44, i386_fbsd_45,
  36          i386_fbsd_46, i386_fbsd_47, i386_fbsd_50, i386_fbsd_51,
  37          i386_fbsd_52, i386_fbsd_53, i386_fbsd_60, i386_fbsd_61
  38          (client does not work)
  39       i386_linux22, i386_linux24, i386_linux26
  40       i386_umlinux22, i386_umlinux24
  41       i386_obsd31, i386_obsd32, i386_obsd33, i386_obsd34, i386_obsd35,
  42          i386_obsd36, i386_obsd37, i386_obsd38, i386_obsd39
  43       rs_aix42
  44       sgi_65 (file server not tested)
  45       sun4_413 (No client support, no fileserver support, db servers only)
  46       sun4x_56, sun4x_57, sun4x_58, sun4x_59 (logging UFS not supported
  47          for mixed-use partitions containing client cache)
  48       ppc_darwin_70
  49       ppc_linux22, ppc_linux24
  50       alpha_linux22, alpha_linux24
  51       ia64_linux24, ia64_linux26
  52       sparc_linux22, sparc_linux24
  53       sparc64_linux22, sparc64_linux24
  54       hp_ux110 (See notes below for information on getting missing header)
  55       hp_ux102 (Client port possible, but db servers and utilities work)
  56
  57    2. Using configure in the top level directory, configure for your
  58       AFS system type, providing the necessary flags:
  59       % ./configure --with-afs-sysname=sun4x_58 --enable-transarc-paths
  60
  61       If you do not have the "configure" script you can re-create it by
  62       running regen.sh.  You will need autoconf to do this.
  63
  64       For some systems you need also provide the path in which your kernel
  65       headers for your configured kernel can be found.  See the
  66       system-specific Notes sections below for details.
  67
  68   There are two modes for directory path handling: "Transarc mode" and "default mode":
  69   - In Transarc mode, we retain compatibility with Transarc/IBM AFS tools
  70     by putting client configuaration files in /usr/vice/etc, and server
  71     files in /usr/afs under the traditional directory layout.
  72   - In default mode, files are located in standardized locations, usually
  73     under $(prefix).
  74   - Client programs, libraries, and related files always go in standard
  75     directories under $(prefix).  This rule covers things that would go
  76     into $(bindir), $(includedir), $(libdir), $(mandir), and $(sbindir).
  77   - Other files get located in the following places:
  78
  79     Directory     Transarc Mode              Default Mode
  80     ============  =========================  ==============================
  81     viceetcdir    /usr/vice/etc              $(sysconfdir)/openafs
  82     afssrvdir     /usr/afs/bin (servers)     $(libexecdir)/openafs
  83     afsconfdir    /usr/afs/etc               $(sysconfdir)/openafs/server
  84     afslocaldir   /usr/afs/local             $(localstatedir)/openafs
  85     afsdbdir      /usr/afs/db                $(localstatedir)/openafs/db
  86     afslogdir     /usr/afs/logs              $(localstatedir)/openafs/logs
  87     afsbosconfig  $(afslocaldir)/BosConfig   $(afsconfdir)/BosConfig
  88     afsbosserver  $(afsbindir)/bosserver     $(sbindir)/bosserver
  89
  90
  91 B  Building
  92
  93    1. Now, you can build OpenAFS.
  94
  95       % make
  96
  97    2. Install your build using either "make install" to install
  98       into the current system (you will need to be root, and files
  99       will be placed as appropriate for Transarc or standard paths),
 100       "make install DESTDIR=/some/path" to install into an alternate
 101       directory tree, or if you configured with --enable-transarc-paths
 102       make dest to create a complete binary tree in the dest directory
 103       under the directory named for the sys_name you built for,
 104       e.g. sun4x_57/dest or i386_linux22/dest
 105
 106    2. As appropriate you can clean up or, if you're using Linux, build for
 107       another kernel version.
 108       To clean up:
 109          % make clean
 110
 111 C  Problems
 112
 113    If you have a problem building this source, you may want to visit
 114    http://www.openafs.org/ to see if any problems have been reported
 115    or to find out how to get more help.
 116
 117    Mailing lists have been set up to help; More details can be found
 118    on the openafs.org site.
 119
 120 D  Linux Notes
 121
 122    For Linux systems you need also provide the path in which your
 123    kernel headers for your configured kernel can be found. This should
 124    be the path of the directory containing a child directory named
 125    "include". So if your version file was
 126    /usr/src/linux/include/linux/version.h you would invoke:
 127    % ./configure --with-afs-sysname=i386_linux24 --with-linux-kernel-headers=/usr/src/linux
 128
 129    Currently you can build for only one Linux kernel at a time,
 130    and the version is extracted from the kernel headers in the root
 131    you specify.
 132
 133    To build for another Linux kernel version:
 134    the system type defined in step A1.
 135       % ./configure --with-afs-sysname=i386_linux24 --with-linux-kernel-headers=/usr/src/linux-2.2.19-i686
 136       % make
 137
 138    Your dest tree will now include an additional kernel module for your
 139    additional kernel headers. Be aware that if the kernel version string
 140    which UTS_RELEASE is defined to in include/linux/version.h matches the
 141    last kernel you built for, the previous kernel module will be
 142    overwritten.
 143
 144 E  HP-UX 11.0 Notes
 145
 146    HP-UX 11.0 requires a header called vfs_vm.h which HP has provided on their
 147    web site: http://h21007.www2.hp.com/dspp/tech/tech_TechSoftwareDetailPage_IDX/1,1703,687,00.html
 148    To navigate down from the top level of the portal, one would do
 149
 150         www.hp.com/dspp -> i want to... -> download software -> operating systems
 151
 152    to get to the same page.
 153
 154 F  OpenBSD Notes
 155
 156    We recommend you build with the following options to configure:
 157      --enable-namei-fileserver
 158      --enable-largefile-fileserver
 159      --enable-supergroups
 160
 161    If you need to run regen.sh to make the configure script, you should
 162    first install autoconf-2.59, then setenv AUTOCONF_VERSION 2.59.
 163
 164    You need kernel source installed to build OpenAFS.  Use the
 165    --with-bsd-kernel-headers= configure option if your kernel source is not
 166    in /usr/src/sys.
 167
 168    If you want to build src/aklog, add the following options to your
 169    configure.  Note that you shouldn't need aklog because heimdal afslog
 170    does (almost) the same thing.
 171      --with-krb5 KRB5CFLAGS=-I/usr/include/kerberosV KRB5LIBS=-lcrypto
 172
 173    src/packaging/OpenBSD/buildpkg.sh will make a tar file for installing the
 174    client.  There is no server package, but I am told that "make install"
 175    will put server binaries in /usr/afs.
 176
 177    Your kernel may panic when you try to shutdown after running the OpenAFS
 178    client.  To prevent this, change the "dangling vnode" panic in
 179    sys/kern/vfs_syscalls.c to a printf and build a new kernel.
 180
 181    You can't run arla and OpenAFS at the same time.
 182
 183 G  FreeBSD Notes
 184
 185    The FreeBSD client does not currently work.  The remaining problems
 186    mostly have to do with locking, vnode refcounting, and packaging.  The
 187    server should work.
 188
 189    We recommend you build with --enable-namei-fileserver and
 190    --enable-largefile-fileserver options.
 191
 192    You need kernel source installed to build OpenAFS.  Use the
 193    --with-bsd-kernel-headers= configure option if your kernel source is not
 194    in /usr/src/sys.
 195
 196    You also need access to your kernel build directory for the opt_global.h
 197    include file.  Use the --with-bsd-kernel-build= configure option if your
 198    kernel build is not GENERIC in the standard place.
 199
 200    There is a package builder in src/packaging/OpenBSD.  "sh buildpkg.sh"
 201    should make a package for the client.  Use pkg_add to install.  The
 202    package will install using transarc-paths, regardless of how you
 203    configured.  The builder uses an old version of the /usr/vice/etc/rc file
 204    that probably won't work.  You might be able to replace it with something
 205    like "kldload libafs.ko; /usr/vice/etc/afsd".
 206
 207    There is no server package, but I am told that "make install" will put
 208    server binaries in /usr/afs.