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