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